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-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: 1f6eb69e193a6f87020f138f0ab79031


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