home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 April / macformat-049.iso / mac / Shareware Plus / Developers / dropg++ / usr / include / net / if.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-02-20  |  13.3 KB  |  364 lines  |  [TEXT/R*ch]
  1. /*
  2.  * Copyright (c) 1982, 1986, 1989, 1993
  3.  *    The Regents of the University of California.  All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    @(#)if.h    8.1 (Berkeley) 6/10/93
  34.  */
  35.  
  36. /*
  37.  * Structures defining a network interface, providing a packet
  38.  * transport mechanism (ala level 0 of the PUP protocols).
  39.  *
  40.  * Each interface accepts output datagrams of a specified maximum
  41.  * length, and provides higher level routines with input datagrams
  42.  * received from its medium.
  43.  *
  44.  * Output occurs when the routine if_output is called, with three parameters:
  45.  *    (*ifp->if_output)(ifp, m, dst, rt)
  46.  * Here m is the mbuf chain to be sent and dst is the destination address.
  47.  * The output routine encapsulates the supplied datagram if necessary,
  48.  * and then transmits it on its medium.
  49.  *
  50.  * On input, each interface unwraps the data received by it, and either
  51.  * places it on the input queue of a internetwork datagram routine
  52.  * and posts the associated software interrupt, or passes the datagram to a raw
  53.  * packet input routine.
  54.  *
  55.  * Routines exist for locating interfaces by their addresses
  56.  * or for locating a interface on a certain network, as well as more general
  57.  * routing and gateway routines maintaining information used to locate
  58.  * interfaces.  These routines live in the files if.c and route.c
  59.  */
  60. #ifndef _TIME_ /*  XXX fast fix for SNMP, going away soon */
  61. #include <sys/time.h>
  62. #endif
  63.  
  64. #ifdef __STDC__
  65. /*
  66.  * Forward structure declarations for function prototypes [sic].
  67.  */
  68. struct    mbuf;
  69. struct    proc;
  70. struct    rtentry;    
  71. struct    socket;
  72. struct    ether_header;
  73. #endif
  74. /*
  75.  * Structure describing information about an interface
  76.  * which may be of interest to management entities.
  77.  */
  78. /*
  79.  * Structure defining a queue for a network interface.
  80.  *
  81.  * (Would like to call this struct ``if'', but C isn't PL/1.)
  82.  */
  83.  
  84. struct ifnet {
  85.     char    *if_name;        /* name, e.g. ``en'' or ``lo'' */
  86.     struct    ifnet *if_next;        /* all struct ifnets are chained */
  87.     struct    ifaddr *if_addrlist;    /* linked list of addresses per if */
  88.         int    if_pcount;        /* number of promiscuous listeners */
  89.     caddr_t    if_bpf;            /* packet filter structure */
  90.     u_short    if_index;        /* numeric abbreviation for this if  */
  91.     short    if_unit;        /* sub-unit for lower level driver */
  92.     short    if_timer;        /* time 'til if_watchdog called */
  93.     short    if_flags;        /* up/down, broadcast, etc. */
  94.     struct    if_data {
  95. /* generic interface information */
  96.         u_char    ifi_type;    /* ethernet, tokenring, etc */
  97.         u_char    ifi_addrlen;    /* media address length */
  98.         u_char    ifi_hdrlen;    /* media header length */
  99.         u_long    ifi_mtu;    /* maximum transmission unit */
  100.         u_long    ifi_metric;    /* routing metric (external only) */
  101.         u_long    ifi_baudrate;    /* linespeed */
  102. /* volatile statistics */
  103.         u_long    ifi_ipackets;    /* packets received on interface */
  104.         u_long    ifi_ierrors;    /* input errors on interface */
  105.         u_long    ifi_opackets;    /* packets sent on interface */
  106.         u_long    ifi_oerrors;    /* output errors on interface */
  107.         u_long    ifi_collisions;    /* collisions on csma interfaces */
  108.         u_long    ifi_ibytes;    /* total number of octets received */
  109.         u_long    ifi_obytes;    /* total number of octets sent */
  110.         u_long    ifi_imcasts;    /* packets received via multicast */
  111.         u_long    ifi_omcasts;    /* packets sent via multicast */
  112.         u_long    ifi_iqdrops;    /* dropped on input, this interface */
  113.         u_long    ifi_noproto;    /* destined for unsupported protocol */
  114.         struct    timeval ifi_lastchange;/* last updated */
  115.     }    if_data;
  116. /* procedure handles */
  117.     int    (*if_init)        /* init routine */
  118.         __P((int));
  119.     int    (*if_output)        /* output routine (enqueue) */
  120.         __P((struct ifnet *, struct mbuf *, struct sockaddr *,
  121.              struct rtentry *));
  122.     int    (*if_start)        /* initiate output routine */
  123.         __P((struct ifnet *));
  124.     int    (*if_done)        /* output complete routine */
  125.         __P((struct ifnet *));    /* (XXX not used; fake prototype) */
  126.     int    (*if_ioctl)        /* ioctl routine */
  127.         __P((struct ifnet *, int, caddr_t));
  128.     int    (*if_reset)    
  129.         __P((int));        /* new autoconfig will permit removal */
  130.     int    (*if_watchdog)        /* timer routine */
  131.         __P((int));
  132.     struct    ifqueue {
  133.         struct    mbuf *ifq_head;
  134.         struct    mbuf *ifq_tail;
  135.         int    ifq_len;
  136.         int    ifq_maxlen;
  137.         int    ifq_drops;
  138.     } if_snd;            /* output queue */
  139. };
  140. #define    if_mtu        if_data.ifi_mtu
  141. #define    if_type        if_data.ifi_type
  142. #define    if_addrlen    if_data.ifi_addrlen
  143. #define    if_hdrlen    if_data.ifi_hdrlen
  144. #define    if_metric    if_data.ifi_metric
  145. #define    if_baudrate    if_data.ifi_baudrate
  146. #define    if_ipackets    if_data.ifi_ipackets
  147. #define    if_ierrors    if_data.ifi_ierrors
  148. #define    if_opackets    if_data.ifi_opackets
  149. #define    if_oerrors    if_data.ifi_oerrors
  150. #define    if_collisions    if_data.ifi_collisions
  151. #define    if_ibytes    if_data.ifi_ibytes
  152. #define    if_obytes    if_data.ifi_obytes
  153. #define    if_imcasts    if_data.ifi_imcasts
  154. #define    if_omcasts    if_data.ifi_omcasts
  155. #define    if_iqdrops    if_data.ifi_iqdrops
  156. #define    if_noproto    if_data.ifi_noproto
  157. #define    if_lastchange    if_data.ifi_lastchange
  158.  
  159. #define    IFF_UP        0x1        /* interface is up */
  160. #define    IFF_BROADCAST    0x2        /* broadcast address valid */
  161. #define    IFF_DEBUG    0x4        /* turn on debugging */
  162. #define    IFF_LOOPBACK    0x8        /* is a loopback net */
  163. #define    IFF_POINTOPOINT    0x10        /* interface is point-to-point link */
  164. #define    IFF_NOTRAILERS    0x20        /* avoid use of trailers */
  165. #define    IFF_RUNNING    0x40        /* resources allocated */
  166. #define    IFF_NOARP    0x80        /* no address resolution protocol */
  167. #define    IFF_PROMISC    0x100        /* receive all packets */
  168. #define    IFF_ALLMULTI    0x200        /* receive all multicast packets */
  169. #define    IFF_OACTIVE    0x400        /* transmission in progress */
  170. #define    IFF_SIMPLEX    0x800        /* can't hear own transmissions */
  171. #define    IFF_LINK0    0x1000        /* per link layer defined bit */
  172. #define    IFF_LINK1    0x2000        /* per link layer defined bit */
  173. #define    IFF_LINK2    0x4000        /* per link layer defined bit */
  174. #define    IFF_MULTICAST    0x8000        /* supports multicast */
  175.  
  176. /* flags set internally only: */
  177. #define    IFF_CANTCHANGE \
  178.     (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
  179.         IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
  180.  
  181. /*
  182.  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
  183.  * input routines have queues of messages stored on ifqueue structures
  184.  * (defined above).  Entries are added to and deleted from these structures
  185.  * by these macros, which should be called with ipl raised to splimp().
  186.  */
  187. #define    IF_QFULL(ifq)        ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
  188. #define    IF_DROP(ifq)        ((ifq)->ifq_drops++)
  189. #define    IF_ENQUEUE(ifq, m) { \
  190.     (m)->m_nextpkt = 0; \
  191.     if ((ifq)->ifq_tail == 0) \
  192.         (ifq)->ifq_head = m; \
  193.     else \
  194.         (ifq)->ifq_tail->m_nextpkt = m; \
  195.     (ifq)->ifq_tail = m; \
  196.     (ifq)->ifq_len++; \
  197. }
  198. #define    IF_PREPEND(ifq, m) { \
  199.     (m)->m_nextpkt = (ifq)->ifq_head; \
  200.     if ((ifq)->ifq_tail == 0) \
  201.         (ifq)->ifq_tail = (m); \
  202.     (ifq)->ifq_head = (m); \
  203.     (ifq)->ifq_len++; \
  204. }
  205. #define    IF_DEQUEUE(ifq, m) { \
  206.     (m) = (ifq)->ifq_head; \
  207.     if (m) { \
  208.         if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
  209.             (ifq)->ifq_tail = 0; \
  210.         (m)->m_nextpkt = 0; \
  211.         (ifq)->ifq_len--; \
  212.     } \
  213. }
  214.  
  215. #define    IFQ_MAXLEN    50
  216. #define    IFNET_SLOWHZ    1        /* granularity is 1 second */
  217.  
  218. /*
  219.  * The ifaddr structure contains information about one address
  220.  * of an interface.  They are maintained by the different address families,
  221.  * are allocated and attached when an address is set, and are linked
  222.  * together so all addresses for an interface can be located.
  223.  */
  224. struct ifaddr {
  225.     struct    sockaddr *ifa_addr;    /* address of interface */
  226.     struct    sockaddr *ifa_dstaddr;    /* other end of p-to-p link */
  227. #define    ifa_broadaddr    ifa_dstaddr    /* broadcast address interface */
  228.     struct    sockaddr *ifa_netmask;    /* used to determine subnet */
  229.     struct    ifnet *ifa_ifp;        /* back-pointer to interface */
  230.     struct    ifaddr *ifa_next;    /* next address for interface */
  231.     void    (*ifa_rtrequest)();    /* check or clean routes (+ or -)'d */
  232.     u_short    ifa_flags;        /* mostly rt_flags for cloning */
  233.     short    ifa_refcnt;        /* extra to malloc for link info */
  234.     int    ifa_metric;        /* cost of going out this interface */
  235. #ifdef notdef
  236.     struct    rtentry *ifa_rt;    /* XXXX for ROUTETOIF ????? */
  237. #endif
  238. };
  239. #define    IFA_ROUTE    RTF_UP        /* route installed */
  240.  
  241. /*
  242.  * Message format for use in obtaining information about interfaces
  243.  * from getkerninfo and the routing socket
  244.  */
  245. struct if_msghdr {
  246.     u_short    ifm_msglen;    /* to skip over non-understood messages */
  247.     u_char    ifm_version;    /* future binary compatability */
  248.     u_char    ifm_type;    /* message type */
  249.     int    ifm_addrs;    /* like rtm_addrs */
  250.     int    ifm_flags;    /* value of if_flags */
  251.     u_short    ifm_index;    /* index for associated ifp */
  252.     struct    if_data ifm_data;/* statistics and other data about if */
  253. };
  254.  
  255. /*
  256.  * Message format for use in obtaining information about interface addresses
  257.  * from getkerninfo and the routing socket
  258.  */
  259. struct ifa_msghdr {
  260.     u_short    ifam_msglen;    /* to skip over non-understood messages */
  261.     u_char    ifam_version;    /* future binary compatability */
  262.     u_char    ifam_type;    /* message type */
  263.     int    ifam_addrs;    /* like rtm_addrs */
  264.     int    ifam_flags;    /* value of ifa_flags */
  265.     u_short    ifam_index;    /* index for associated ifp */
  266.     int    ifam_metric;    /* value of ifa_metric */
  267. };
  268.  
  269. /*
  270.  * Interface request structure used for socket
  271.  * ioctl's.  All interface ioctl's must have parameter
  272.  * definitions which begin with ifr_name.  The
  273.  * remainder may be interface specific.
  274.  */
  275. struct    ifreq {
  276. #define    IFNAMSIZ    16
  277.     char    ifr_name[IFNAMSIZ];        /* if name, e.g. "en0" */
  278.     union {
  279.         struct    sockaddr ifru_addr;
  280.         struct    sockaddr ifru_dstaddr;
  281.         struct    sockaddr ifru_broadaddr;
  282.         short    ifru_flags;
  283.         int    ifru_metric;
  284.         caddr_t    ifru_data;
  285.     } ifr_ifru;
  286. #define    ifr_addr    ifr_ifru.ifru_addr    /* address */
  287. #define    ifr_dstaddr    ifr_ifru.ifru_dstaddr    /* other end of p-to-p link */
  288. #define    ifr_broadaddr    ifr_ifru.ifru_broadaddr    /* broadcast address */
  289. #define    ifr_flags    ifr_ifru.ifru_flags    /* flags */
  290. #define    ifr_metric    ifr_ifru.ifru_metric    /* metric */
  291. #define    ifr_data    ifr_ifru.ifru_data    /* for use by interface */
  292. };
  293.  
  294. struct ifaliasreq {
  295.     char    ifra_name[IFNAMSIZ];        /* if name, e.g. "en0" */
  296.     struct    sockaddr ifra_addr;
  297.     struct    sockaddr ifra_broadaddr;
  298.     struct    sockaddr ifra_mask;
  299. };
  300.  
  301. /*
  302.  * Structure used in SIOCGIFCONF request.
  303.  * Used to retrieve interface configuration
  304.  * for machine (useful for programs which
  305.  * must know all networks accessible).
  306.  */
  307. struct    ifconf {
  308.     int    ifc_len;        /* size of associated buffer */
  309.     union {
  310.         caddr_t    ifcu_buf;
  311.         struct    ifreq *ifcu_req;
  312.     } ifc_ifcu;
  313. #define    ifc_buf    ifc_ifcu.ifcu_buf    /* buffer address */
  314. #define    ifc_req    ifc_ifcu.ifcu_req    /* array of structures returned */
  315. };
  316.  
  317. #include <net/if_arp.h>
  318.  
  319. #ifdef KERNEL
  320. #define    IFAFREE(ifa) \
  321.     if ((ifa)->ifa_refcnt <= 0) \
  322.         ifafree(ifa); \
  323.     else \
  324.         (ifa)->ifa_refcnt--;
  325.  
  326. struct    ifnet    *ifnet;
  327.  
  328. void    ether_ifattach __P((struct ifnet *));
  329. void    ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *));
  330. int    ether_output __P((struct ifnet *,
  331.        struct mbuf *, struct sockaddr *, struct rtentry *));
  332. char    *ether_sprintf __P((u_char *));
  333.  
  334. void    if_attach __P((struct ifnet *));
  335. void    if_down __P((struct ifnet *));
  336. void    if_qflush __P((struct ifqueue *));
  337. void    if_slowtimo __P((void *));
  338. void    if_up __P((struct ifnet *));
  339. #ifdef vax
  340. void    ifubareset __P((int));
  341. #endif
  342. int    ifconf __P((int, caddr_t));
  343. void    ifinit __P((void));
  344. int    ifioctl __P((struct socket *, int, caddr_t, struct proc *));
  345. int    ifpromisc __P((struct ifnet *, int));
  346. struct    ifnet *ifunit __P((char *));
  347.  
  348. struct    ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
  349. struct    ifaddr *ifa_ifwithaf __P((int));
  350. struct    ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
  351. struct    ifaddr *ifa_ifwithnet __P((struct sockaddr *));
  352. struct    ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
  353.                     struct sockaddr *));
  354. struct    ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
  355. void    ifafree __P((struct ifaddr *));
  356. void    link_rtrequest __P((int, struct rtentry *, struct sockaddr *));
  357.  
  358. int    loioctl __P((struct ifnet *, int, caddr_t));
  359. void    loopattach __P((int));
  360. int    looutput __P((struct ifnet *,
  361.        struct mbuf *, struct sockaddr *, struct rtentry *));
  362. void    lortrequest __P((int, struct rtentry *, struct sockaddr *));
  363. #endif
  364.