reactos/drivers/lib/oskittcp/include/freebsd/src/sys/sys/protosw.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 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  *      @(#)protosw.h   8.1 (Berkeley) 6/2/93
  34  */
  35
  36 #ifndef _SYS_PROTOSW_H_
  37 #define _SYS_PROTOSW_H_
  38
  39 /*
  40  * Protocol switch table.
  41  *
  42  * Each protocol has a handle initializing one of these structures,
  43  * which is used for protocol-protocol and system-protocol communication.
  44  *
  45  * A protocol is called through the pr_init entry before any other.
  46  * Thereafter it is called every 200ms through the pr_fasttimo entry and
  47  * every 500ms through the pr_slowtimo for timer based actions.
  48  * The system will call the pr_drain entry if it is low on space and
  49  * this should throw away any non-critical data.
  50  *
  51  * Protocols pass data between themselves as chains of mbufs using
  52  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
  53  * UNIX) and pr_output passes it down (towards the imps); control
  54  * information passes up and down on pr_ctlinput and pr_ctloutput.
  55  * The protocol is responsible for the space occupied by any the
  56  * arguments to these entries and must dispose it.
  57  *
  58  * The userreq routine interfaces protocols to the system and is
  59  * described below.
  60  */
  61 struct protosw {
  62         short   pr_type;                /* socket type used for */
  63         struct  domain *pr_domain;      /* domain protocol a member of */
  64         short   pr_protocol;            /* protocol number */
  65         short   pr_flags;               /* see below */
  66 /* protocol-protocol hooks */
  67         void    (*pr_input)();          /* input to protocol (from below) */
  68         int     (*pr_output)();         /* output to protocol (from above) */
  69         void    (*pr_ctlinput)();       /* control input (from below) */
  70         int     (*pr_ctloutput)();      /* control output (from above) */
  71 /* user-protocol hook */
  72         int     (*pr_usrreq)();         /* user request: see list below */
  73 /* utility hooks */
  74         void    (*pr_init)();           /* initialization hook */
  75         void    (*pr_fasttimo)();       /* fast timeout (200ms) */
  76         void    (*pr_slowtimo)();       /* slow timeout (500ms) */
  77         void    (*pr_drain)();          /* flush any excess space possible */
  78         int     (*pr_sysctl)();         /* sysctl for protocol */
  79 };
  80
  81 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
  82 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
  83
  84 /*
  85  * Values for pr_flags.
  86  * PR_ADDR requires PR_ATOMIC;
  87  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
  88  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
  89  *      and the protocol understands the MSG_EOF flag.  The first property is
  90  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
  91  *      anyhow).
  92  */
  93 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
  94 #define PR_ADDR         0x02            /* addresses given with messages */
  95 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
  96 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
  97 #define PR_RIGHTS       0x10            /* passes capabilities */
  98 #define PR_IMPLOPCL     0x20            /* implied open/close */
  99
 100 /*
 101  * The arguments to usrreq are:
 102  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
 103  * where up is a (struct socket *), req is one of these requests,
 104  * m is a optional mbuf chain containing a message,
 105  * nam is an optional mbuf chain containing an address,
 106  * and opt is a pointer to a socketopt structure or nil.
 107  * The protocol is responsible for disposal of the mbuf chain m,
 108  * the caller is responsible for any space held by nam and opt.
 109  * A non-zero return from usrreq gives an
 110  * UNIX error number which should be passed to higher level software.
 111  */
 112 #define PRU_ATTACH              0       /* attach protocol to up */
 113 #define PRU_DETACH              1       /* detach protocol from up */
 114 #define PRU_BIND                2       /* bind socket to address */
 115 #define PRU_LISTEN              3       /* listen for connection */
 116 #define PRU_CONNECT             4       /* establish connection to peer */
 117 #define PRU_ACCEPT              5       /* accept connection from peer */
 118 #define PRU_DISCONNECT          6       /* disconnect from peer */
 119 #define PRU_SHUTDOWN            7       /* won't send any more data */
 120 #define PRU_RCVD                8       /* have taken data; more room now */
 121 #define PRU_SEND                9       /* send this data */
 122 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
 123 #define PRU_CONTROL             11      /* control operations on protocol */
 124 #define PRU_SENSE               12      /* return status into m */
 125 #define PRU_RCVOOB              13      /* retrieve out of band data */
 126 #define PRU_SENDOOB             14      /* send out of band data */
 127 #define PRU_SOCKADDR            15      /* fetch socket's address */
 128 #define PRU_PEERADDR            16      /* fetch peer's address */
 129 #define PRU_CONNECT2            17      /* connect two sockets */
 130 /* begin for protocols internal use */
 131 #define PRU_FASTTIMO            18      /* 200ms timeout */
 132 #define PRU_SLOWTIMO            19      /* 500ms timeout */
 133 #define PRU_PROTORCV            20      /* receive from below */
 134 #define PRU_PROTOSEND           21      /* send to below */
 135 #define PRU_SEND_EOF            22      /* send and close */
 136 #define PRU_NREQ                22
 137
 138 #ifdef PRUREQUESTS
 139 char *prurequests[] = {
 140         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
 141         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
 142         "RCVD",         "SEND",         "ABORT",        "CONTROL",
 143         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
 144         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
 145         "PROTORCV",     "PROTOSEND",
 146         "SEND_EOF",
 147 };
 148 #endif
 149
 150 /*
 151  * The arguments to the ctlinput routine are
 152  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 153  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 154  * and arg is an optional caddr_t argument used within a protocol family.
 155  */
 156 #define PRC_IFDOWN              0       /* interface transition */
 157 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
 158 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
 159 #define PRC_QUENCH              4       /* some one said to slow down */
 160 #define PRC_MSGSIZE             5       /* message size forced drop */
 161 #define PRC_HOSTDEAD            6       /* host appears to be down */
 162 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
 163 #define PRC_UNREACH_NET         8       /* no route to network */
 164 #define PRC_UNREACH_HOST        9       /* no route to host */
 165 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
 166 #define PRC_UNREACH_PORT        11      /* bad port # */
 167 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
 168 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
 169 #define PRC_REDIRECT_NET        14      /* net routing redirect */
 170 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
 171 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
 172 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
 173 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
 174 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
 175 #define PRC_PARAMPROB           20      /* header incorrect */
 176
 177 #define PRC_NCMDS               21
 178
 179 #define PRC_IS_REDIRECT(cmd)    \
 180         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
 181
 182 #ifdef PRCREQUESTS
 183 char    *prcrequests[] = {
 184         "IFDOWN", "ROUTEDEAD", "#2", "DEC-BIT-QUENCH2",
 185         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
 186         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
 187         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
 188         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
 189         "PARAMPROB"
 190 };
 191 #endif
 192
 193 /*
 194  * The arguments to ctloutput are:
 195  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval);
 196  * req is one of the actions listed below, so is a (struct socket *),
 197  * level is an indication of which protocol layer the option is intended.
 198  * optname is a protocol dependent socket option request,
 199  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 200  * The protocol is responsible for disposal of the mbuf chain *optval
 201  * if supplied,
 202  * the caller is responsible for any space held by *optval, when returned.
 203  * A non-zero return from usrreq gives an
 204  * UNIX error number which should be passed to higher level software.
 205  */
 206 #define PRCO_GETOPT     0
 207 #define PRCO_SETOPT     1
 208
 209 #define PRCO_NCMDS      2
 210
 211 #ifdef PRCOREQUESTS
 212 char    *prcorequests[] = {
 213         "GETOPT", "SETOPT",
 214 };
 215 #endif
 216
 217 #ifdef KERNEL
 218 extern  struct protosw *pffindproto(), *pffindtype();
 219 #endif
 220
 221 #endif