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/sys/protosw.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 /*-
    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  * 4. Neither the name of the University nor the names of its contributors
   14  *    may be used to endorse or promote products derived from this software
   15  *    without specific prior written permission.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  *
   29  *      @(#)protosw.h   8.1 (Berkeley) 6/2/93
   30  * $FreeBSD: releng/6.4/sys/sys/protosw.h 159517 2006-06-11 17:01:36Z rwatson $
   31  */
   32 
   33 #ifndef _SYS_PROTOSW_H_
   34 #define _SYS_PROTOSW_H_
   35 
   36 /* Forward declare these structures referenced from prototypes below. */
   37 struct mbuf;
   38 struct thread;
   39 struct sockaddr;
   40 struct socket;
   41 struct sockopt;
   42 
   43 /*#ifdef _KERNEL*/
   44 /*
   45  * Protocol switch table.
   46  *
   47  * Each protocol has a handle initializing one of these structures,
   48  * which is used for protocol-protocol and system-protocol communication.
   49  *
   50  * A protocol is called through the pr_init entry before any other.
   51  * Thereafter it is called every 200ms through the pr_fasttimo entry and
   52  * every 500ms through the pr_slowtimo for timer based actions.
   53  * The system will call the pr_drain entry if it is low on space and
   54  * this should throw away any non-critical data.
   55  *
   56  * Protocols pass data between themselves as chains of mbufs using
   57  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
   58  * the users) and pr_output passes it down (towards the interfaces); control
   59  * information passes up and down on pr_ctlinput and pr_ctloutput.
   60  * The protocol is responsible for the space occupied by any the
   61  * arguments to these entries and must dispose it.
   62  *
   63  * In retrospect, it would be a lot nicer to use an interface
   64  * similar to the vnode VOP interface.
   65  */
   66 /* USE THESE FOR YOUR PROTOTYPES ! */
   67 typedef void    pr_input_t (struct mbuf *, int);
   68 typedef int     pr_input6_t (struct mbuf **, int*, int);  /* XXX FIX THIS */
   69 typedef void    pr_in_input_t (struct mbuf *, int, int); /* XXX FIX THIS */
   70 typedef int     pr_output_t (struct mbuf *, struct socket *);
   71 typedef int     pr_in_output_t (struct mbuf *, struct socket *, struct sockaddr *);
   72 typedef void    pr_ctlinput_t (int, struct sockaddr *, void *);
   73 typedef int     pr_ctloutput_t (struct socket *, struct sockopt *);
   74 typedef void    pr_init_t (void);
   75 typedef void    pr_fasttimo_t (void);
   76 typedef void    pr_slowtimo_t (void);
   77 typedef void    pr_drain_t (void);
   78 
   79 typedef int     pr_usrreq_t(struct socket *, int, struct mbuf *,
   80                              struct mbuf *, struct mbuf *, struct thread *);
   81 
   82 struct protosw {
   83         short   pr_type;                /* socket type used for */
   84         struct  domain *pr_domain;      /* domain protocol a member of */
   85         short   pr_protocol;            /* protocol number */
   86         short   pr_flags;               /* see below */
   87 /* protocol-protocol hooks */
   88         pr_input_t *pr_input;           /* input to protocol (from below) */
   89         pr_output_t *pr_output;         /* output to protocol (from above) */
   90         pr_ctlinput_t *pr_ctlinput;     /* control input (from below) */
   91         pr_ctloutput_t *pr_ctloutput;   /* control output (from above) */
   92 /* user-protocol hook */
   93         pr_usrreq_t     *pr_ousrreq;
   94 /* utility hooks */
   95         pr_init_t *pr_init;
   96         pr_fasttimo_t *pr_fasttimo;     /* fast timeout (200ms) */
   97         pr_slowtimo_t *pr_slowtimo;     /* slow timeout (500ms) */
   98         pr_drain_t *pr_drain;           /* flush any excess space possible */
   99 
  100         struct  pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
  101 };
  102 /*#endif*/
  103 
  104 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
  105 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
  106 
  107 /*
  108  * This number should be defined again within each protocol family to avoid
  109  * confusion.
  110  */
  111 #define PROTO_SPACER    32767           /* spacer for loadable protocols */
  112 
  113 /*
  114  * Values for pr_flags.
  115  * PR_ADDR requires PR_ATOMIC;
  116  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
  117  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
  118  *      and the protocol understands the MSG_EOF flag.  The first property is
  119  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
  120  *      anyhow).
  121  */
  122 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
  123 #define PR_ADDR         0x02            /* addresses given with messages */
  124 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
  125 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
  126 #define PR_RIGHTS       0x10            /* passes capabilities */
  127 #define PR_IMPLOPCL     0x20            /* implied open/close */
  128 #define PR_LASTHDR      0x40            /* enforce ipsec policy; last header */
  129 
  130 /*
  131  * In earlier BSD network stacks, a single pr_usrreq() function pointer was
  132  * invoked with an operation number indicating what operation was desired.
  133  * We now provide individual function pointers which protocols can implement,
  134  * which offers a number of benefits (such as type checking for arguments).
  135  * These older constants are still present in order to support TCP debugging.
  136  *
  137  * The arguments to usrreq were:
  138  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
  139  * where up is a (struct socket *), req is one of these requests,
  140  * m is an optional mbuf chain containing a message,
  141  * nam is an optional mbuf chain containing an address,
  142  * and opt is a pointer to a socketopt structure or nil.
  143  * The protocol is responsible for disposal of the mbuf chain m,
  144  * the caller is responsible for any space held by nam and opt.
  145  * A non-zero return from usrreq gives an
  146  * UNIX error number which should be passed to higher level software.
  147  */
  148 #define PRU_ATTACH              0       /* attach protocol to up */
  149 #define PRU_DETACH              1       /* detach protocol from up */
  150 #define PRU_BIND                2       /* bind socket to address */
  151 #define PRU_LISTEN              3       /* listen for connection */
  152 #define PRU_CONNECT             4       /* establish connection to peer */
  153 #define PRU_ACCEPT              5       /* accept connection from peer */
  154 #define PRU_DISCONNECT          6       /* disconnect from peer */
  155 #define PRU_SHUTDOWN            7       /* won't send any more data */
  156 #define PRU_RCVD                8       /* have taken data; more room now */
  157 #define PRU_SEND                9       /* send this data */
  158 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
  159 #define PRU_CONTROL             11      /* control operations on protocol */
  160 #define PRU_SENSE               12      /* return status into m */
  161 #define PRU_RCVOOB              13      /* retrieve out of band data */
  162 #define PRU_SENDOOB             14      /* send out of band data */
  163 #define PRU_SOCKADDR            15      /* fetch socket's address */
  164 #define PRU_PEERADDR            16      /* fetch peer's address */
  165 #define PRU_CONNECT2            17      /* connect two sockets */
  166 /* begin for protocols internal use */
  167 #define PRU_FASTTIMO            18      /* 200ms timeout */
  168 #define PRU_SLOWTIMO            19      /* 500ms timeout */
  169 #define PRU_PROTORCV            20      /* receive from below */
  170 #define PRU_PROTOSEND           21      /* send to below */
  171 /* end for protocol's internal use */
  172 #define PRU_SEND_EOF            22      /* send and close */
  173 #define PRU_NREQ                22
  174 
  175 #ifdef PRUREQUESTS
  176 const char *prurequests[] = {
  177         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
  178         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
  179         "RCVD",         "SEND",         "ABORT",        "CONTROL",
  180         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
  181         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
  182         "PROTORCV",     "PROTOSEND",
  183         "SEND_EOF",
  184 };
  185 #endif
  186 
  187 #ifdef  _KERNEL                 /* users shouldn't see this decl */
  188 
  189 struct ifnet;
  190 struct stat;
  191 struct ucred;
  192 struct uio;
  193 
  194 /*
  195  * If the ordering here looks odd, that's because it's alphabetical.  These
  196  * should eventually be merged back into struct protosw.
  197  *
  198  * Some fields initialized to defaults if they are NULL.
  199  * See uipc_domain.c:net_init_domain()
  200  */
  201 struct pr_usrreqs {
  202         double  __Break_the_struct_layout_for_now;
  203         int     (*pru_abort)(struct socket *so);
  204         int     (*pru_accept)(struct socket *so, struct sockaddr **nam);
  205         int     (*pru_attach)(struct socket *so, int proto, struct thread *td);
  206         int     (*pru_bind)(struct socket *so, struct sockaddr *nam,
  207                     struct thread *td);
  208         int     (*pru_connect)(struct socket *so, struct sockaddr *nam,
  209                     struct thread *td);
  210         int     (*pru_connect2)(struct socket *so1, struct socket *so2);
  211         int     (*pru_control)(struct socket *so, u_long cmd, caddr_t data,
  212                     struct ifnet *ifp, struct thread *td);
  213         int     (*pru_detach)(struct socket *so);
  214         int     (*pru_disconnect)(struct socket *so);
  215         int     (*pru_listen)(struct socket *so, struct thread *td);
  216         int     (*pru_peeraddr)(struct socket *so, struct sockaddr **nam);
  217         int     (*pru_rcvd)(struct socket *so, int flags);
  218         int     (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags);
  219         int     (*pru_send)(struct socket *so, int flags, struct mbuf *m, 
  220                     struct sockaddr *addr, struct mbuf *control,
  221                     struct thread *td);
  222 #define PRUS_OOB        0x1
  223 #define PRUS_EOF        0x2
  224 #define PRUS_MORETOCOME 0x4
  225         int     (*pru_sense)(struct socket *so, struct stat *sb);
  226         int     (*pru_shutdown)(struct socket *so);
  227         int     (*pru_sockaddr)(struct socket *so, struct sockaddr **nam);
  228          
  229         /*
  230          * These four added later, so they are out of order.  They are used
  231          * for shortcutting (fast path input/output) in some protocols.
  232          * XXX - that's a lie, they are not implemented yet
  233          * Rather than calling sosend() etc. directly, calls are made
  234          * through these entry points.  For protocols which still use
  235          * the generic code, these just point to those routines.
  236          */
  237         int     (*pru_sosend)(struct socket *so, struct sockaddr *addr,
  238                     struct uio *uio, struct mbuf *top, struct mbuf *control,
  239                     int flags, struct thread *td);
  240         int     (*pru_soreceive)(struct socket *so, struct sockaddr **paddr,
  241                     struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
  242                     int *flagsp);
  243         int     (*pru_sopoll)(struct socket *so, int events,
  244                     struct ucred *cred, struct thread *td);
  245         void    (*pru_sosetlabel)(struct socket *so);
  246 };
  247 
  248 /*
  249  * The dummy protocol specific user requests function pointer array is
  250  * initialized to the functions below.  All functions return EOPNOTSUPP.
  251  */
  252 extern  struct pr_usrreqs nousrreqs;
  253 
  254 int     pru_abort_notsupp(struct socket *so);
  255 int     pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
  256 int     pru_attach_notsupp(struct socket *so, int proto, struct thread *td);
  257 int     pru_bind_notsupp(struct socket *so, struct sockaddr *nam,
  258             struct thread *td);
  259 int     pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
  260             struct thread *td);
  261 int     pru_connect2_notsupp(struct socket *so1, struct socket *so2);
  262 int     pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
  263             struct ifnet *ifp, struct thread *td);
  264 int     pru_detach_notsupp(struct socket *so);
  265 int     pru_disconnect_notsupp(struct socket *so);
  266 int     pru_listen_notsupp(struct socket *so, struct thread *td);
  267 int     pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam);
  268 int     pru_rcvd_notsupp(struct socket *so, int flags);
  269 int     pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags);
  270 int     pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
  271             struct sockaddr *addr, struct mbuf *control, struct thread *td);
  272 int     pru_sense_null(struct socket *so, struct stat *sb);
  273 int     pru_shutdown_notsupp(struct socket *so);
  274 int     pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam);
  275 int     pru_sosend_notsupp(struct socket *so, struct sockaddr *addr,
  276             struct uio *uio, struct mbuf *top, struct mbuf *control, int flags,
  277             struct thread *td);
  278 int     pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
  279             struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
  280             int *flagsp);
  281 int     pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
  282             struct thread *td);
  283 void    pru_sosetlabel_null(struct socket *so);
  284 
  285 #endif /* _KERNEL */
  286 
  287 /*
  288  * The arguments to the ctlinput routine are
  289  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
  290  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
  291  * and arg is a `void *' argument used within a protocol family.
  292  */
  293 #define PRC_IFDOWN              0       /* interface transition */
  294 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
  295 #define PRC_IFUP                2       /* interface has come back up */
  296 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
  297 #define PRC_QUENCH              4       /* some one said to slow down */
  298 #define PRC_MSGSIZE             5       /* message size forced drop */
  299 #define PRC_HOSTDEAD            6       /* host appears to be down */
  300 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
  301 #define PRC_UNREACH_NET         8       /* no route to network */
  302 #define PRC_UNREACH_HOST        9       /* no route to host */
  303 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
  304 #define PRC_UNREACH_PORT        11      /* bad port # */
  305 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
  306 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
  307 #define PRC_REDIRECT_NET        14      /* net routing redirect */
  308 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
  309 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
  310 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
  311 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
  312 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
  313 #define PRC_PARAMPROB           20      /* header incorrect */
  314 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
  315 
  316 #define PRC_NCMDS               22
  317 
  318 #define PRC_IS_REDIRECT(cmd)    \
  319         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
  320 
  321 #ifdef PRCREQUESTS
  322 char    *prcrequests[] = {
  323         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
  324         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
  325         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
  326         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
  327         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
  328         "PARAMPROB", "ADMIN-UNREACH"
  329 };
  330 #endif
  331 
  332 /*
  333  * The arguments to ctloutput are:
  334  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
  335  * req is one of the actions listed below, so is a (struct socket *),
  336  * level is an indication of which protocol layer the option is intended.
  337  * optname is a protocol dependent socket option request,
  338  * optval is a pointer to a mbuf-chain pointer, for value-return results.
  339  * The protocol is responsible for disposal of the mbuf chain *optval
  340  * if supplied,
  341  * the caller is responsible for any space held by *optval, when returned.
  342  * A non-zero return from usrreq gives an
  343  * UNIX error number which should be passed to higher level software.
  344  */
  345 #define PRCO_GETOPT     0
  346 #define PRCO_SETOPT     1
  347 
  348 #define PRCO_NCMDS      2
  349 
  350 #ifdef PRCOREQUESTS
  351 char    *prcorequests[] = {
  352         "GETOPT", "SETOPT",
  353 };
  354 #endif
  355 
  356 #ifdef _KERNEL
  357 void    pfctlinput(int, struct sockaddr *);
  358 void    pfctlinput2(int, struct sockaddr *, void *);
  359 struct protosw *pffindproto(int family, int protocol, int type);
  360 struct protosw *pffindtype(int family, int type);
  361 int     pf_proto_register(int family, struct protosw *npr);
  362 int     pf_proto_unregister(int family, int protocol, int type);
  363 #endif
  364 
  365 #endif

Cache object: 7eba8dc7ceb8b8d8c5c0faf1f84a833d


[ 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.