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  * 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: src/sys/sys/protosw.h,v 1.43 2004/04/07 04:19:49 imp Exp $
   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  * Values for pr_flags.
  109  * PR_ADDR requires PR_ATOMIC;
  110  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
  111  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
  112  *      and the protocol understands the MSG_EOF flag.  The first property is
  113  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
  114  *      anyhow).
  115  */
  116 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
  117 #define PR_ADDR         0x02            /* addresses given with messages */
  118 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
  119 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
  120 #define PR_RIGHTS       0x10            /* passes capabilities */
  121 #define PR_IMPLOPCL     0x20            /* implied open/close */
  122 #define PR_LASTHDR      0x40            /* enforce ipsec policy; last header */
  123 
  124 /*
  125  * The arguments to usrreq are:
  126  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
  127  * where up is a (struct socket *), req is one of these requests,
  128  * m is an optional mbuf chain containing a message,
  129  * nam is an optional mbuf chain containing an address,
  130  * and opt is a pointer to a socketopt structure or nil.
  131  * The protocol is responsible for disposal of the mbuf chain m,
  132  * the caller is responsible for any space held by nam and opt.
  133  * A non-zero return from usrreq gives an
  134  * UNIX error number which should be passed to higher level software.
  135  */
  136 #define PRU_ATTACH              0       /* attach protocol to up */
  137 #define PRU_DETACH              1       /* detach protocol from up */
  138 #define PRU_BIND                2       /* bind socket to address */
  139 #define PRU_LISTEN              3       /* listen for connection */
  140 #define PRU_CONNECT             4       /* establish connection to peer */
  141 #define PRU_ACCEPT              5       /* accept connection from peer */
  142 #define PRU_DISCONNECT          6       /* disconnect from peer */
  143 #define PRU_SHUTDOWN            7       /* won't send any more data */
  144 #define PRU_RCVD                8       /* have taken data; more room now */
  145 #define PRU_SEND                9       /* send this data */
  146 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
  147 #define PRU_CONTROL             11      /* control operations on protocol */
  148 #define PRU_SENSE               12      /* return status into m */
  149 #define PRU_RCVOOB              13      /* retrieve out of band data */
  150 #define PRU_SENDOOB             14      /* send out of band data */
  151 #define PRU_SOCKADDR            15      /* fetch socket's address */
  152 #define PRU_PEERADDR            16      /* fetch peer's address */
  153 #define PRU_CONNECT2            17      /* connect two sockets */
  154 /* begin for protocols internal use */
  155 #define PRU_FASTTIMO            18      /* 200ms timeout */
  156 #define PRU_SLOWTIMO            19      /* 500ms timeout */
  157 #define PRU_PROTORCV            20      /* receive from below */
  158 #define PRU_PROTOSEND           21      /* send to below */
  159 /* end for protocol's internal use */
  160 #define PRU_SEND_EOF            22      /* send and close */
  161 #define PRU_NREQ                22
  162 
  163 #ifdef PRUREQUESTS
  164 const char *prurequests[] = {
  165         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
  166         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
  167         "RCVD",         "SEND",         "ABORT",        "CONTROL",
  168         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
  169         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
  170         "PROTORCV",     "PROTOSEND",
  171         "SEND_EOF",
  172 };
  173 #endif
  174 
  175 #ifdef  _KERNEL                 /* users shouldn't see this decl */
  176 
  177 struct ifnet;
  178 struct stat;
  179 struct ucred;
  180 struct uio;
  181 
  182 /*
  183  * If the ordering here looks odd, that's because it's alphabetical.
  184  * Having this structure separated out from the main protoswitch is allegedly
  185  * a big (12 cycles per call) lose on high-end CPUs.  We will eventually
  186  * migrate this stuff back into the main structure.
  187  */
  188 struct pr_usrreqs {
  189         int     (*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         int     (*pru_detach)(struct socket *so);
  200         int     (*pru_disconnect)(struct socket *so);
  201         int     (*pru_listen)(struct socket *so, struct thread *td);
  202         int     (*pru_peeraddr)(struct socket *so, struct sockaddr **nam);
  203         int     (*pru_rcvd)(struct socket *so, int flags);
  204         int     (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags);
  205         int     (*pru_send)(struct socket *so, int flags, struct mbuf *m, 
  206                     struct sockaddr *addr, struct mbuf *control,
  207                     struct thread *td);
  208 #define PRUS_OOB        0x1
  209 #define PRUS_EOF        0x2
  210 #define PRUS_MORETOCOME 0x4
  211         int     (*pru_sense)(struct socket *so, struct stat *sb);
  212         int     (*pru_shutdown)(struct socket *so);
  213         int     (*pru_sockaddr)(struct socket *so, struct sockaddr **nam);
  214          
  215         /*
  216          * These three added later, so they are out of order.  They are used
  217          * for shortcutting (fast path input/output) in some protocols.
  218          * XXX - that's a lie, they are not implemented yet
  219          * Rather than calling sosend() etc. directly, calls are made
  220          * through these entry points.  For protocols which still use
  221          * the generic code, these just point to those routines.
  222          */
  223         int     (*pru_sosend)(struct socket *so, struct sockaddr *addr,
  224                     struct uio *uio, struct mbuf *top, struct mbuf *control,
  225                     int flags, struct thread *td);
  226         int     (*pru_soreceive)(struct socket *so, struct sockaddr **paddr,
  227                     struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
  228                     int *flagsp);
  229         int     (*pru_sopoll)(struct socket *so, int events,
  230                     struct ucred *cred, struct thread *td);
  231         void    (*pru_sosetlabel)(struct socket *so);
  232 };
  233 
  234 int     pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
  235 int     pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
  236             struct thread *td);
  237 int     pru_connect2_notsupp(struct socket *so1, struct socket *so2);
  238 int     pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
  239             struct ifnet *ifp, struct thread *td);
  240 int     pru_listen_notsupp(struct socket *so, struct thread *td);
  241 int     pru_rcvd_notsupp(struct socket *so, int flags);
  242 int     pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags);
  243 int     pru_sense_null(struct socket *so, struct stat *sb);
  244 void    pru_sosetlabel_null(struct socket *so);
  245 
  246 #endif /* _KERNEL */
  247 
  248 /*
  249  * The arguments to the ctlinput routine are
  250  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
  251  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
  252  * and arg is a `void *' argument used within a protocol family.
  253  */
  254 #define PRC_IFDOWN              0       /* interface transition */
  255 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
  256 #define PRC_IFUP                2       /* interface has come back up */
  257 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
  258 #define PRC_QUENCH              4       /* some one said to slow down */
  259 #define PRC_MSGSIZE             5       /* message size forced drop */
  260 #define PRC_HOSTDEAD            6       /* host appears to be down */
  261 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
  262 #define PRC_UNREACH_NET         8       /* no route to network */
  263 #define PRC_UNREACH_HOST        9       /* no route to host */
  264 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
  265 #define PRC_UNREACH_PORT        11      /* bad port # */
  266 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
  267 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
  268 #define PRC_REDIRECT_NET        14      /* net routing redirect */
  269 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
  270 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
  271 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
  272 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
  273 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
  274 #define PRC_PARAMPROB           20      /* header incorrect */
  275 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
  276 
  277 #define PRC_NCMDS               22
  278 
  279 #define PRC_IS_REDIRECT(cmd)    \
  280         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
  281 
  282 #ifdef PRCREQUESTS
  283 char    *prcrequests[] = {
  284         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
  285         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
  286         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
  287         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
  288         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
  289         "PARAMPROB", "ADMIN-UNREACH"
  290 };
  291 #endif
  292 
  293 /*
  294  * The arguments to ctloutput are:
  295  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
  296  * req is one of the actions listed below, so is a (struct socket *),
  297  * level is an indication of which protocol layer the option is intended.
  298  * optname is a protocol dependent socket option request,
  299  * optval is a pointer to a mbuf-chain pointer, for value-return results.
  300  * The protocol is responsible for disposal of the mbuf chain *optval
  301  * if supplied,
  302  * the caller is responsible for any space held by *optval, when returned.
  303  * A non-zero return from usrreq gives an
  304  * UNIX error number which should be passed to higher level software.
  305  */
  306 #define PRCO_GETOPT     0
  307 #define PRCO_SETOPT     1
  308 
  309 #define PRCO_NCMDS      2
  310 
  311 #ifdef PRCOREQUESTS
  312 char    *prcorequests[] = {
  313         "GETOPT", "SETOPT",
  314 };
  315 #endif
  316 
  317 #ifdef _KERNEL
  318 void    pfctlinput(int, struct sockaddr *);
  319 void    pfctlinput2(int, struct sockaddr *, void *);
  320 struct protosw *pffindproto(int family, int protocol, int type);
  321 struct protosw *pffindtype(int family, int type);
  322 #endif
  323 
  324 #endif

Cache object: 7a5e5c4da4eca32ce35499187c6dc705


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