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

Cache object: 87ae6a6c7572c690d8eaf5597075f1af


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