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  -  FREEBSD11  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  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  * 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  * $FreeBSD: src/sys/sys/protosw.h,v 1.42 2003/11/18 00:39:07 rwatson Exp $
   35  */
   36 
   37 #ifndef _SYS_PROTOSW_H_
   38 #define _SYS_PROTOSW_H_
   39 
   40 /* Forward declare these structures referenced from prototypes below. */
   41 struct mbuf;
   42 struct thread;
   43 struct sockaddr;
   44 struct socket;
   45 struct sockopt;
   46 
   47 /*#ifdef _KERNEL*/
   48 /*
   49  * Protocol switch table.
   50  *
   51  * Each protocol has a handle initializing one of these structures,
   52  * which is used for protocol-protocol and system-protocol communication.
   53  *
   54  * A protocol is called through the pr_init entry before any other.
   55  * Thereafter it is called every 200ms through the pr_fasttimo entry and
   56  * every 500ms through the pr_slowtimo for timer based actions.
   57  * The system will call the pr_drain entry if it is low on space and
   58  * this should throw away any non-critical data.
   59  *
   60  * Protocols pass data between themselves as chains of mbufs using
   61  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
   62  * the users) and pr_output passes it down (towards the interfaces); control
   63  * information passes up and down on pr_ctlinput and pr_ctloutput.
   64  * The protocol is responsible for the space occupied by any the
   65  * arguments to these entries and must dispose it.
   66  *
   67  * In retrospect, it would be a lot nicer to use an interface
   68  * similar to the vnode VOP interface.
   69  */
   70 /* USE THESE FOR YOUR PROTOTYPES ! */
   71 typedef void    pr_input_t (struct mbuf *, int);
   72 typedef int     pr_input6_t (struct mbuf **, int*, int);  /* XXX FIX THIS */
   73 typedef void    pr_in_input_t (struct mbuf *, int, int); /* XXX FIX THIS */
   74 typedef int     pr_output_t (struct mbuf *, struct socket *);
   75 typedef int     pr_in_output_t (struct mbuf *, struct socket *, struct sockaddr *);
   76 typedef void    pr_ctlinput_t (int, struct sockaddr *, void *);
   77 typedef int     pr_ctloutput_t (struct socket *, struct sockopt *);
   78 typedef void    pr_init_t (void);
   79 typedef void    pr_fasttimo_t (void);
   80 typedef void    pr_slowtimo_t (void);
   81 typedef void    pr_drain_t (void);
   82 
   83 typedef int     pr_usrreq_t(struct socket *, int, struct mbuf *,
   84                              struct mbuf *, struct mbuf *, struct thread *);
   85 
   86 struct protosw {
   87         short   pr_type;                /* socket type used for */
   88         struct  domain *pr_domain;      /* domain protocol a member of */
   89         short   pr_protocol;            /* protocol number */
   90         short   pr_flags;               /* see below */
   91 /* protocol-protocol hooks */
   92         pr_input_t *pr_input;           /* input to protocol (from below) */
   93         pr_output_t *pr_output;         /* output to protocol (from above) */
   94         pr_ctlinput_t *pr_ctlinput;     /* control input (from below) */
   95         pr_ctloutput_t *pr_ctloutput;   /* control output (from above) */
   96 /* user-protocol hook */
   97         pr_usrreq_t     *pr_ousrreq;
   98 /* utility hooks */
   99         pr_init_t *pr_init;
  100         pr_fasttimo_t *pr_fasttimo;     /* fast timeout (200ms) */
  101         pr_slowtimo_t *pr_slowtimo;     /* slow timeout (500ms) */
  102         pr_drain_t *pr_drain;           /* flush any excess space possible */
  103 
  104         struct  pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
  105 };
  106 /*#endif*/
  107 
  108 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
  109 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
  110 
  111 /*
  112  * Values for pr_flags.
  113  * PR_ADDR requires PR_ATOMIC;
  114  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
  115  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
  116  *      and the protocol understands the MSG_EOF flag.  The first property is
  117  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
  118  *      anyhow).
  119  */
  120 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
  121 #define PR_ADDR         0x02            /* addresses given with messages */
  122 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
  123 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
  124 #define PR_RIGHTS       0x10            /* passes capabilities */
  125 #define PR_IMPLOPCL     0x20            /* implied open/close */
  126 #define PR_LASTHDR      0x40            /* enforce ipsec policy; last header */
  127 
  128 /*
  129  * The arguments to usrreq are:
  130  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
  131  * where up is a (struct socket *), req is one of these requests,
  132  * m is an optional mbuf chain containing a message,
  133  * nam is an optional mbuf chain containing an address,
  134  * and opt is a pointer to a socketopt structure or nil.
  135  * The protocol is responsible for disposal of the mbuf chain m,
  136  * the caller is responsible for any space held by nam and opt.
  137  * A non-zero return from usrreq gives an
  138  * UNIX error number which should be passed to higher level software.
  139  */
  140 #define PRU_ATTACH              0       /* attach protocol to up */
  141 #define PRU_DETACH              1       /* detach protocol from up */
  142 #define PRU_BIND                2       /* bind socket to address */
  143 #define PRU_LISTEN              3       /* listen for connection */
  144 #define PRU_CONNECT             4       /* establish connection to peer */
  145 #define PRU_ACCEPT              5       /* accept connection from peer */
  146 #define PRU_DISCONNECT          6       /* disconnect from peer */
  147 #define PRU_SHUTDOWN            7       /* won't send any more data */
  148 #define PRU_RCVD                8       /* have taken data; more room now */
  149 #define PRU_SEND                9       /* send this data */
  150 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
  151 #define PRU_CONTROL             11      /* control operations on protocol */
  152 #define PRU_SENSE               12      /* return status into m */
  153 #define PRU_RCVOOB              13      /* retrieve out of band data */
  154 #define PRU_SENDOOB             14      /* send out of band data */
  155 #define PRU_SOCKADDR            15      /* fetch socket's address */
  156 #define PRU_PEERADDR            16      /* fetch peer's address */
  157 #define PRU_CONNECT2            17      /* connect two sockets */
  158 /* begin for protocols internal use */
  159 #define PRU_FASTTIMO            18      /* 200ms timeout */
  160 #define PRU_SLOWTIMO            19      /* 500ms timeout */
  161 #define PRU_PROTORCV            20      /* receive from below */
  162 #define PRU_PROTOSEND           21      /* send to below */
  163 /* end for protocol's internal use */
  164 #define PRU_SEND_EOF            22      /* send and close */
  165 #define PRU_NREQ                22
  166 
  167 #ifdef PRUREQUESTS
  168 const char *prurequests[] = {
  169         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
  170         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
  171         "RCVD",         "SEND",         "ABORT",        "CONTROL",
  172         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
  173         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
  174         "PROTORCV",     "PROTOSEND",
  175         "SEND_EOF",
  176 };
  177 #endif
  178 
  179 #ifdef  _KERNEL                 /* users shouldn't see this decl */
  180 
  181 struct ifnet;
  182 struct stat;
  183 struct ucred;
  184 struct uio;
  185 
  186 /*
  187  * If the ordering here looks odd, that's because it's alphabetical.
  188  * Having this structure separated out from the main protoswitch is allegedly
  189  * a big (12 cycles per call) lose on high-end CPUs.  We will eventually
  190  * migrate this stuff back into the main structure.
  191  */
  192 struct pr_usrreqs {
  193         int     (*pru_abort)(struct socket *so);
  194         int     (*pru_accept)(struct socket *so, struct sockaddr **nam);
  195         int     (*pru_attach)(struct socket *so, int proto, struct thread *td);
  196         int     (*pru_bind)(struct socket *so, struct sockaddr *nam,
  197                     struct thread *td);
  198         int     (*pru_connect)(struct socket *so, struct sockaddr *nam,
  199                     struct thread *td);
  200         int     (*pru_connect2)(struct socket *so1, struct socket *so2);
  201         int     (*pru_control)(struct socket *so, u_long cmd, caddr_t data,
  202                     struct ifnet *ifp, struct thread *td);
  203         int     (*pru_detach)(struct socket *so);
  204         int     (*pru_disconnect)(struct socket *so);
  205         int     (*pru_listen)(struct socket *so, struct thread *td);
  206         int     (*pru_peeraddr)(struct socket *so, struct sockaddr **nam);
  207         int     (*pru_rcvd)(struct socket *so, int flags);
  208         int     (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags);
  209         int     (*pru_send)(struct socket *so, int flags, struct mbuf *m, 
  210                     struct sockaddr *addr, struct mbuf *control,
  211                     struct thread *td);
  212 #define PRUS_OOB        0x1
  213 #define PRUS_EOF        0x2
  214 #define PRUS_MORETOCOME 0x4
  215         int     (*pru_sense)(struct socket *so, struct stat *sb);
  216         int     (*pru_shutdown)(struct socket *so);
  217         int     (*pru_sockaddr)(struct socket *so, struct sockaddr **nam);
  218          
  219         /*
  220          * These three added later, so they are out of order.  They are used
  221          * for shortcutting (fast path input/output) in some protocols.
  222          * XXX - that's a lie, they are not implemented yet
  223          * Rather than calling sosend() etc. directly, calls are made
  224          * through these entry points.  For protocols which still use
  225          * the generic code, these just point to those routines.
  226          */
  227         int     (*pru_sosend)(struct socket *so, struct sockaddr *addr,
  228                     struct uio *uio, struct mbuf *top, struct mbuf *control,
  229                     int flags, struct thread *td);
  230         int     (*pru_soreceive)(struct socket *so, struct sockaddr **paddr,
  231                     struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
  232                     int *flagsp);
  233         int     (*pru_sopoll)(struct socket *so, int events,
  234                     struct ucred *cred, struct thread *td);
  235         void    (*pru_sosetlabel)(struct socket *so);
  236 };
  237 
  238 int     pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
  239 int     pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
  240             struct thread *td);
  241 int     pru_connect2_notsupp(struct socket *so1, struct socket *so2);
  242 int     pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
  243             struct ifnet *ifp, struct thread *td);
  244 int     pru_listen_notsupp(struct socket *so, struct thread *td);
  245 int     pru_rcvd_notsupp(struct socket *so, int flags);
  246 int     pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags);
  247 int     pru_sense_null(struct socket *so, struct stat *sb);
  248 void    pru_sosetlabel_null(struct socket *so);
  249 
  250 #endif /* _KERNEL */
  251 
  252 /*
  253  * The arguments to the ctlinput routine are
  254  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
  255  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
  256  * and arg is a `void *' argument used within a protocol family.
  257  */
  258 #define PRC_IFDOWN              0       /* interface transition */
  259 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
  260 #define PRC_IFUP                2       /* interface has come back up */
  261 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
  262 #define PRC_QUENCH              4       /* some one said to slow down */
  263 #define PRC_MSGSIZE             5       /* message size forced drop */
  264 #define PRC_HOSTDEAD            6       /* host appears to be down */
  265 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
  266 #define PRC_UNREACH_NET         8       /* no route to network */
  267 #define PRC_UNREACH_HOST        9       /* no route to host */
  268 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
  269 #define PRC_UNREACH_PORT        11      /* bad port # */
  270 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
  271 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
  272 #define PRC_REDIRECT_NET        14      /* net routing redirect */
  273 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
  274 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
  275 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
  276 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
  277 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
  278 #define PRC_PARAMPROB           20      /* header incorrect */
  279 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
  280 
  281 #define PRC_NCMDS               22
  282 
  283 #define PRC_IS_REDIRECT(cmd)    \
  284         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
  285 
  286 #ifdef PRCREQUESTS
  287 char    *prcrequests[] = {
  288         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
  289         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
  290         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
  291         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
  292         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
  293         "PARAMPROB", "ADMIN-UNREACH"
  294 };
  295 #endif
  296 
  297 /*
  298  * The arguments to ctloutput are:
  299  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
  300  * req is one of the actions listed below, so is a (struct socket *),
  301  * level is an indication of which protocol layer the option is intended.
  302  * optname is a protocol dependent socket option request,
  303  * optval is a pointer to a mbuf-chain pointer, for value-return results.
  304  * The protocol is responsible for disposal of the mbuf chain *optval
  305  * if supplied,
  306  * the caller is responsible for any space held by *optval, when returned.
  307  * A non-zero return from usrreq gives an
  308  * UNIX error number which should be passed to higher level software.
  309  */
  310 #define PRCO_GETOPT     0
  311 #define PRCO_SETOPT     1
  312 
  313 #define PRCO_NCMDS      2
  314 
  315 #ifdef PRCOREQUESTS
  316 char    *prcorequests[] = {
  317         "GETOPT", "SETOPT",
  318 };
  319 #endif
  320 
  321 #ifdef _KERNEL
  322 void    pfctlinput(int, struct sockaddr *);
  323 void    pfctlinput2(int, struct sockaddr *, void *);
  324 struct protosw *pffindproto(int family, int protocol, int type);
  325 struct protosw *pffindtype(int family, int type);
  326 #endif
  327 
  328 #endif

Cache object: 4a2a6f651bf935fa75d3ee374f1d00b3


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