udpsock.c

Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2001-2003 by egnite Software GmbH. All rights reserved.
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions
00006  * are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holders nor the names of
00014  *    contributors may be used to endorse or promote products derived
00015  *    from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00018  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00019  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00020  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00021  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00022  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00023  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00024  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00025  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00026  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00027  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00028  * SUCH DAMAGE.
00029  *
00030  * For additional information see http://www.ethernut.de/
00031  *
00032  * -
00033  * Portions Copyright (C) 2000 David J. Hudson <dave@humbug.demon.co.uk>
00034  *
00035  * This file is distributed in the hope that it will be useful, but WITHOUT
00036  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00037  * FITNESS FOR A PARTICULAR PURPOSE.
00038  *
00039  * You can redistribute this file and/or modify it under the terms of the GNU
00040  * General Public License (GPL) as published by the Free Software Foundation;
00041  * either version 2 of the License, or (at your discretion) any later version.
00042  * See the accompanying file "copying-gpl.txt" for more details.
00043  *
00044  * As a special exception to the GPL, permission is granted for additional
00045  * uses of the text contained in this file.  See the accompanying file
00046  * "copying-liquorice.txt" for details.
00047  * -
00048  * Portions Copyright (c) 1983, 1993 by
00049  *  The Regents of the University of California.  All rights reserved.
00050  *
00051  * Redistribution and use in source and binary forms, with or without
00052  * modification, are permitted provided that the following conditions
00053  * are met:
00054  * 1. Redistributions of source code must retain the above copyright
00055  *    notice, this list of conditions and the following disclaimer.
00056  * 2. Redistributions in binary form must reproduce the above copyright
00057  *    notice, this list of conditions and the following disclaimer in the
00058  *    documentation and/or other materials provided with the distribution.
00059  * 3. Neither the name of the University nor the names of its contributors
00060  *    may be used to endorse or promote products derived from this software
00061  *    without specific prior written permission.
00062  *
00063  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00064  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00065  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00066  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00067  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00068  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00069  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00070  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00071  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00072  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00073  * SUCH DAMAGE.
00074  * -
00075  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
00076  *
00077  * Permission to use, copy, modify, and distribute this software for any
00078  * purpose with or without fee is hereby granted, provided that the above
00079  * copyright notice and this permission notice appear in all copies, and that
00080  * the name of Digital Equipment Corporation not be used in advertising or
00081  * publicity pertaining to distribution of the document or software without
00082  * specific, written prior permission.
00083  * 
00084  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
00085  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
00086  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
00087  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
00088  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
00089  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
00090  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
00091  * SOFTWARE.
00092  */
00093 
00094 /*
00095  * $Log: udpsock.c,v $
00096  * Revision 1.7  2005/08/02 17:47:03  haraldkipp
00097  * Major API documentation update.
00098  *
00099  * Revision 1.6  2005/04/08 15:20:51  olereinhardt
00100  * added <sys/types.h> (__APPLE__) and <netinet/in.h> (__linux__)
00101  * for htons and simmilar.
00102  *
00103  * Revision 1.5  2003/11/26 12:55:12  drsung
00104  * Portability issues ... again
00105  *
00106  * Revision 1.4  2003/11/24 21:01:04  drsung
00107  * Packet queue added for UDP sockets.
00108  *
00109  * Revision 1.3  2003/08/14 15:07:18  haraldkipp
00110  * Optimization
00111  *
00112  * Revision 1.2  2003/07/20 16:01:01  haraldkipp
00113  * Bugfix: Send crashed on routing problems.
00114  *
00115  * Revision 1.1.1.1  2003/05/09 14:41:46  haraldkipp
00116  * Initial using 3.2.1
00117  *
00118  * Revision 1.13  2003/05/06 18:21:52  harald
00119  * Memory hole fixed
00120  *
00121  * Revision 1.12  2003/04/21 17:04:57  harald
00122  * Bugfix: Return port number in host byte order
00123  *
00124  * Revision 1.11  2003/02/04 18:14:57  harald
00125  * Version 3 released
00126  *
00127  * Revision 1.10  2002/06/26 17:29:36  harald
00128  * First pre-release with 2.4 stack
00129  *
00130  */
00131 
00132 #include <string.h>
00133 
00134 #include <sys/heap.h>
00135 #include <sys/event.h>
00136 #include <sys/types.h>
00137 #include <netinet/ip.h>
00138 #include <netinet/udp.h>
00139 #include <netinet/in.h>
00140 #include <sys/socket.h>
00141 
00142 
00147 
00148 
00149 UDPSOCKET *udpSocketList;       
00150 static u_short last_local_port = 4096;  /* Unassigned local port. */
00151 
00163 UDPSOCKET *NutUdpCreateSocket(u_short port)
00164 {
00165     UDPSOCKET *sock;
00166 
00167     if (port == 0) {
00168         do {
00169             if (++last_local_port == 0)
00170                 last_local_port = 4096;
00171             port = htons(last_local_port);
00172             sock = udpSocketList;
00173             while (sock) {
00174                 if (sock->so_local_port == port)
00175                     break;
00176                 sock = sock->so_next;
00177             }
00178         } while (sock);
00179         port = last_local_port;
00180     }
00181     if ((sock = NutHeapAllocClear(sizeof(UDPSOCKET))) != 0) {
00182         sock->so_local_port = htons(port);
00183         sock->so_next = udpSocketList;
00184         udpSocketList = sock;
00185     }
00186     return sock;
00187 }
00188 
00201 int NutUdpSendTo(UDPSOCKET * sock, u_long addr, u_short port, void *data, u_short len)
00202 {
00203     int rc;
00204     NETBUF *nb;
00205 
00206     if ((nb = NutNetBufAlloc(0, NBAF_APPLICATION, len)) == 0) {
00207         return -1;
00208     }
00209     memcpy(nb->nb_ap.vp, data, len);
00210 
00211     /* Bugfix by Ralph Mason. We should not free the NETBUF in case of an error. */
00212     if ((rc = NutUdpOutput(sock, addr, port, nb)) == 0)
00213         NutNetBufFree(nb);
00214 
00215     return rc;
00216 }
00217 
00234  /* @@@ 2003-10-24: modified by OS for udp packet queue */
00235 int NutUdpReceiveFrom(UDPSOCKET * sock, u_long * addr, u_short * port, void *data, u_short size, u_long timeout)
00236 {
00237     IPHDR *ip;
00238     UDPHDR *uh;
00239     NETBUF *nb;
00240 
00241     if (sock->so_rx_nb == 0)
00242         NutEventWait(&sock->so_rx_rdy, timeout);
00243 
00244     if ((nb = sock->so_rx_nb) == 0)
00245         return 0;
00246 
00247     /* forward the queue's head to the next packet */
00248     sock->so_rx_nb = nb->nb_next;
00249 
00250     ip = nb->nb_nw.vp;
00251     *addr = ip->ip_src;
00252 
00253     uh = nb->nb_tp.vp;
00254     *port = htons(uh->uh_sport);
00255 
00256     if (size > nb->nb_ap.sz)
00257         size = nb->nb_ap.sz;
00258 
00259     sock->so_rx_cnt -= nb->nb_ap.sz;    /* decrement input buffer count */
00260 
00261     memcpy(data, nb->nb_ap.vp, size);
00262     NutNetBufFree(nb);
00263 
00264     return size;
00265 }
00266 
00279  /* @@@ 2003-10-24: modified by OS for udp packet queue */
00280 int NutUdpDestroySocket(UDPSOCKET * sock)
00281 {
00282     UDPSOCKET *sp;
00283     UDPSOCKET **spp;
00284     int rc = -1;
00285     NETBUF *nb;
00286 
00287     spp = &udpSocketList;
00288     sp = udpSocketList;
00289 
00290     while (sp) {
00291         if (sp == sock) {
00292             *spp = sock->so_next;
00293             /* packets may have arrived that the application 
00294                did not read before closing the socket. */
00295             while ((nb = sock->so_rx_nb) != 0) {
00296                 sock->so_rx_nb = nb->nb_next;
00297                 NutNetBufFree(nb);
00298             }
00299             NutHeapFree(sock);
00300             rc = 0;
00301             break;
00302         }
00303         spp = &sp->so_next;
00304         sp = sp->so_next;
00305     }
00306     return rc;
00307 }
00308 
00320 UDPSOCKET *NutUdpFindSocket(u_short port)
00321 {
00322     UDPSOCKET *sp;
00323     UDPSOCKET *sock = 0;
00324 
00325     for (sp = udpSocketList; sp; sp = sp->so_next) {
00326         if (sp->so_local_port == port) {
00327             sock = sp;
00328             break;
00329         }
00330     }
00331     return sock;
00332 }
00333 
00348 int NutUdpSetSockOpt(UDPSOCKET * sock, int optname, CONST void *optval, int optlen)
00349 {
00350     int rc = -1;
00351 
00352     if (sock == 0)
00353         return -1;
00354     switch (optname) {
00355 
00356     case SO_RCVBUF:
00357         if (optval != 0 && optlen == sizeof(u_short)) {
00358             sock->so_rx_bsz = *((u_short *) optval);
00359             rc = 0;
00360         }
00361         break;
00362 
00363     default:
00364         /* sock->so_last_error = ENOPROTOOPT; */
00365         break;
00366     }
00367     return rc;
00368 }
00369 
00385 int NutUdpGetSockOpt(UDPSOCKET * sock, int optname, void *optval, int optlen)
00386 {
00387     int rc = -1;
00388 
00389     if (sock == 0)
00390         return -1;
00391     switch (optname) {
00392 
00393     case SO_RCVBUF:
00394         if (optval != 0 && optlen == sizeof(u_short)) {
00395             *((u_short *) optval) = sock->so_rx_bsz;
00396             rc = 0;
00397         }
00398         break;
00399 
00400     default:
00401         /* sock->so_last_error = ENOPROTOOPT; */
00402         break;
00403     }
00404     return rc;
00405 }
00406 
00407 

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/