The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/net/net_osdep.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $FreeBSD$       */
    2 /*      $KAME: net_osdep.h,v 1.68 2001/12/21 08:14:58 itojun Exp $      */
    3 
    4 /*
    5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
    6  * All rights reserved.
    7  *
    8  * Redistribution and use in source and binary forms, with or without
    9  * modification, are permitted provided that the following conditions
   10  * are met:
   11  * 1. Redistributions of source code must retain the above copyright
   12  *    notice, this list of conditions and the following disclaimer.
   13  * 2. Redistributions in binary form must reproduce the above copyright
   14  *    notice, this list of conditions and the following disclaimer in the
   15  *    documentation and/or other materials provided with the distribution.
   16  * 3. Neither the name of the project nor the names of its contributors
   17  *    may be used to endorse or promote products derived from this software
   18  *    without specific prior written permission.
   19  *
   20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
   21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
   24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   30  * SUCH DAMAGE.
   31  */
   32 /*
   33  * glue for kernel code programming differences.
   34  */
   35 
   36 /*
   37  * OS dependencies:
   38  * - ioctl
   39  *   FreeBSD 3 and later warn when sys/ioctl.h is included in a kernel source
   40  *   file.  For socket ioctl, we are suggested to use sys/sockio.h.
   41  *
   42  * - RTFREE()
   43  *   bsdi does not escape this macro using do-clause, so it is recommended
   44  *   to escape the macro explicitly.
   45  *   e.g.
   46  *      if (rt) {
   47  *              RTFREE(rt);
   48  *      }
   49  *
   50  * - whether the IPv4 input routine convert the byte order of some fileds
   51  *   of the IP header (x: convert to the host byte order, s: strip the header
   52  *   length for possible reassembly)
   53  *             ip_len ip_id ip_off
   54  * bsdi3:          xs     x      x
   55  * bsdi4:          xs            x
   56  * freebsd[23]:    xs     x      x 
   57  * freebsd4:       xs            x
   58  * NetBSD:          x            x
   59  * OpenBSD:        xs     x      x
   60  *
   61  * - ifa_ifwithaf()
   62  *   bsdi[34], netbsd, and openbsd define it in sys/net/if.c
   63  *   freebsd (all versions) does not have it.
   64  *  
   65  * - struct rt_addrinfo
   66  *   bsdi4, netbsd 1.5R and beyond: rti_addrs, rti_info[], rti_flags, rti_ifa,
   67  *      rti_ifp, and rti_rtm.
   68  *   others: rti_addrs and rti_info[] only.
   69  *
   70  * - ifa->ifa_rtrequest
   71  *   bsdi4, netbsd 1.5R and beyond: rt_addrinfo *
   72  *   others: sockaddr * (note that sys/net/route.c:rtrequest() has an unsafe
   73  *      typecast code, from 4.3BSD-reno)
   74  *
   75  * - side effects of rtrequest{,1}(RTM_DELETE)
   76  *      BSDI[34]: delete all cloned routes underneath the route.
   77  *      FreeBSD[234]: delete all protocol-cloned routes underneath the route.
   78  *                    note that cloned routes from an interface direct route
   79  *                    still remain.
   80  *      NetBSD: 1.5 have no side effects.  KAME/netbsd15, and post-1.5R, have
   81  *              the same effects as of BSDI.
   82  *      OpenBSD: have no side effects.  KAME/openbsd has the same effects as
   83  *              of BSDI (the change is not merged - yet).
   84  *
   85  * - privileged process
   86  *      NetBSD, FreeBSD 3
   87  *              struct proc *p;
   88  *              if (p && !suser(p->p_ucred, &p->p_acflag))
   89  *                      privileged;
   90  *      FreeBSD 4
   91  *              struct proc *p;
   92  *              if (p && !suser(p))
   93  *                      privileged;
   94  *      OpenBSD, BSDI [34], FreeBSD 2
   95  *              struct socket *so;
   96  *              if (so->so_state & SS_PRIV)
   97  *                      privileged;
   98  * - foo_control
   99  *      NetBSD, FreeBSD 3
  100  *              needs to give struct proc * as argument
  101  *      OpenBSD, BSDI [34], FreeBSD 2
  102  *              do not need struct proc *
  103  *
  104  * - bpf:
  105  *      OpenBSD, NetBSD 1.5, BSDI [34]
  106  *              need caddr_t * (= if_bpf **) and struct ifnet *
  107  *      FreeBSD 2, FreeBSD 3, NetBSD post-1.5N
  108  *              need only struct ifnet * as argument
  109  *
  110  * - struct ifnet
  111  *                      use queue.h?    member names    if name
  112  *                      ---             ---             ---
  113  *      FreeBSD 2       no              old standard    if_name+unit
  114  *      FreeBSD 3       yes             strange         if_name+unit
  115  *      OpenBSD         yes             standard        if_xname
  116  *      NetBSD          yes             standard        if_xname
  117  *      BSDI [34]       no              old standard    if_name+unit
  118  *
  119  * - usrreq
  120  *      NetBSD, OpenBSD, BSDI [34], FreeBSD 2
  121  *              single function with PRU_xx, arguments are mbuf
  122  *      FreeBSD 3
  123  *              separates functions, non-mbuf arguments
  124  *
  125  * - {set,get}sockopt
  126  *      NetBSD, OpenBSD, BSDI [34], FreeBSD 2
  127  *              manipulation based on mbuf
  128  *      FreeBSD 3
  129  *              non-mbuf manipulation using sooptcopy{in,out}()
  130  *
  131  * - timeout() and untimeout()
  132  *      NetBSD 1.4.x, OpenBSD, BSDI [34], FreeBSD 2
  133  *              timeout() is a void function
  134  *      FreeBSD 3
  135  *              timeout() is non-void, must keep returned value for untimeout()
  136  *              callout_xx is also available (sys/callout.h)
  137  *      NetBSD 1.5
  138  *              timeout() is obsoleted, use callout_xx (sys/callout.h)
  139  *      OpenBSD 2.8
  140  *              timeout_{add,set,del} is encouraged (sys/timeout.h)
  141  *
  142  * - kernel internal time structure
  143  *      FreeBSD 2, NetBSD, OpenBSD, BSD/OS
  144  *              mono_time.tv_u?sec, time.tv_u?sec
  145  *      FreeBSD [34]
  146  *              time_second
  147  *      if you need portability, #ifdef out FreeBSD[34], or use microtime(&tv)
  148  *      then touch tv.tv_sec (note: microtime is an expensive operation).
  149  *
  150  * - sysctl
  151  *      NetBSD, OpenBSD
  152  *              foo_sysctl()
  153  *      BSDI [34]
  154  *              foo_sysctl() but with different style.  sysctl_int_arr() takes
  155  *              care of most of the cases.
  156  *      FreeBSD
  157  *              linker hack.  however, there are freebsd version differences
  158  *              (how wonderful!).
  159  *              on FreeBSD[23] function arg #define includes paren.
  160  *                      int foo SYSCTL_HANDLER_ARGS;
  161  *              on FreeBSD4, function arg #define does not include paren.
  162  *                      int foo(SYSCTL_HANDLER_ARGS);
  163  *              on some versions, forward reference to the tree is okay.
  164  *              on some versions, you need SYSCTL_DECL().  you need things
  165  *              like this.
  166  *                      #ifdef SYSCTL_DECL
  167  *                      SYSCTL_DECL(net_inet_ip6);
  168  *                      #endif
  169  *              it is hard to share functions between freebsd and non-freebsd.
  170  *
  171  * - if_ioctl
  172  *      NetBSD, FreeBSD 3, BSDI [34]
  173  *              2nd argument is u_long cmd
  174  *      FreeBSD 2
  175  *              2nd argument is int cmd
  176  *
  177  * - if attach routines
  178  *      NetBSD
  179  *              void xxattach(int);
  180  *      FreeBSD 2, FreeBSD 3
  181  *              void xxattach(void *);
  182  *              PSEUDO_SET(xxattach, if_xx);
  183  *
  184  * - ovbcopy()
  185  *      in NetBSD 1.4 or later, ovbcopy() is not supplied in the kernel.
  186  *      we have updated sys/systm.h to include declaration.
  187  *
  188  * - splnet()
  189  *      NetBSD 1.4 or later requires splsoftnet().
  190  *      other operating systems use splnet().
  191  *
  192  * - splimp()
  193  *      NetBSD-current (2001/4/13): use splnet() in network, splvm() in vm.
  194  *      other operating systems: use splimp().
  195  *
  196  * - dtom()
  197  *      NEVER USE IT!
  198  *
  199  * - struct ifnet for loopback interface
  200  *      BSDI3: struct ifnet loif;
  201  *      BSDI4: struct ifnet *loifp;
  202  *      NetBSD, OpenBSD 2.8, FreeBSD2: struct ifnet loif[NLOOP];
  203  *      OpenBSD 2.9: struct ifnet *lo0ifp;
  204  *
  205  *      odd thing is that many of them refers loif as ifnet *loif,
  206  *      not loif[NLOOP], from outside of if_loop.c.
  207  *
  208  * - number of bpf pseudo devices
  209  *      others: bpfilter.h, NBPFILTER
  210  *      FreeBSD4: bpf.h, NBPF
  211  *      solution:
  212  *              #if defined(__FreeBSD__) && __FreeBSD__ >= 4
  213  *              #include "bpf.h"
  214  *              #define NBPFILTER       NBPF
  215  *              #else
  216  *              #include "bpfilter.h"
  217  *              #endif
  218  *
  219  * - protosw for IPv4 (sys/netinet)
  220  *      FreeBSD4: struct ipprotosw in netinet/ipprotosw.h
  221  *      others: struct protosw in sys/protosw.h
  222  *
  223  * - protosw in general.
  224  *      NetBSD 1.5 has extra member for ipfilter (netbsd-current dropped
  225  *      it so it will go away in 1.6).
  226  *      NetBSD 1.5 requires PR_LISTEN flag bit with protocols that permit
  227  *      listen/accept (like tcp).
  228  *
  229  * - header files with defopt (opt_xx.h)
  230  *      FreeBSD3: opt_{inet,ipsec,ip6fw,altq}.h
  231  *      FreeBSD4: opt_{inet,inet6,ipsec,ip6fw,altq}.h
  232  *      NetBSD: opt_{inet,ipsec,altq}.h
  233  *      others: does not use defopt
  234  *
  235  * - (m->m_flags & M_EXT) != 0 does *not* mean that the max data length of
  236  *   the mbuf == MCLBYTES.
  237  *
  238  * - sys/kern/uipc_mbuf.c:m_dup()
  239  *      freebsd[34]: copies the whole mbuf chain.
  240  *      netbsd: similar arg with m_copym().
  241  *      others: no m_dup().
  242  *
  243  * - ifa_refcnt (struct ifaddr) management (IFAREF/IFAFREE).
  244  *      NetBSD 1.5: always use IFAREF whenever reference gets added.
  245  *              always use IFAFREE whenever reference gets freed.
  246  *              IFAFREE frees ifaddr when ifa_refcnt reaches 0.
  247  *      others: do not increase refcnt for ifp->if_addrlist and in_ifaddr.
  248  *              use IFAFREE once when ifaddr is disconnected from
  249  *              ifp->if_addrlist and in_ifaddr.  IFAFREE frees ifaddr when
  250  *              ifa_refcnt goes negative.  in KAME environment, IFAREF is
  251  *              provided as a compatibility wrapper (use it instead of
  252  *              ifa_refcnt++ to reduce #ifdef).
  253  *
  254  * - ifnet.if_lastchange
  255  *      freebsd, bsdi, netbsd-current (jun 14 2001-),
  256  *      openbsd-current (jun 15 2001-): updated only when IFF_UP changes.
  257  *              (RFC1573 ifLastChange interpretation)
  258  *      netbsd151, openbsd29: updated whenever packets go through the interface.
  259  *              (4.4BSD interpretation)
  260  *
  261  * - kernel compilation options ("options HOGE" in kernel config file)
  262  *      freebsd4: sys/conf/options has to have mapping between option
  263  *              and a header file (opt_hoge.h).
  264  *      netbsd: by default, -DHOGE will go into
  265  *              sys/arch/foo/compile/BAR/Makefile.
  266  *              if you define mapping in sys/conf/files, you can create
  267  *              a header file like opt_hoge.h to help make dependencies.
  268  *      bsdi/openbsd: always use -DHOGE in Makefile.  there's no need/way
  269  *              to have opt_hoge.h.
  270  *
  271  *      therefore, opt_hoge.h is mandatory on freebsd4 only.
  272  *
  273  * - MALLOC() macro
  274  *      Use it only if the size of the allocation is constant.
  275  *      When we do NOT collect statistics about kernel memory usage, the result
  276  *      of macro expansion contains a large set of condition branches.  If the
  277  *      size is not constant, compilation optimization cannot be applied, and
  278  *      a bunch of the large branch will be embedded in the kernel code.
  279  *
  280  * - M_COPY_PKTHDR
  281  *      openbsd30: M_COPY_PKTHDR is deprecated.  use M_MOVE_PKTHDR or
  282  *              M_DUP_PKTHDR, depending on how you want to handle m_tag.
  283  *      others: M_COPY_PKTHDR is available as usual.
  284  */
  285 
  286 #ifndef __NET_NET_OSDEP_H_DEFINED_
  287 #define __NET_NET_OSDEP_H_DEFINED_
  288 #ifdef _KERNEL
  289 
  290 struct ifnet;
  291 extern const char *if_name __P((struct ifnet *));
  292 
  293 #define HAVE_OLD_BPF
  294 
  295 #define ifa_list        ifa_link
  296 #define if_addrlist     if_addrhead
  297 #define if_list         if_link
  298 
  299 /* sys/net/if.h */
  300 #define IFAREF(ifa)     do { ++(ifa)->ifa_refcnt; } while (0)
  301 
  302 #define WITH_CONVERT_AND_STRIP_IP_LEN
  303 
  304 #if 1                           /* at this moment, all OSes do this */
  305 #define WITH_CONVERT_IP_OFF
  306 #endif
  307 
  308 #endif /*_KERNEL*/
  309 #endif /*__NET_NET_OSDEP_H_DEFINED_ */

Cache object: 179da4b8fd38900e3166b8d5c64d6b55


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.