sys/netgraph/netgraph.h

   1
   2 /*
   3  * netgraph.h
   4  *
   5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
   6  * All rights reserved.
   7  *
   8  * Subject to the following obligations and disclaimer of warranty, use and
   9  * redistribution of this software, in source or object code forms, with or
  10  * without modifications are expressly permitted by Whistle Communications;
  11  * provided, however, that:
  12  * 1. Any and all reproductions of the source or object code must include the
  13  *    copyright notice above and the following disclaimer of warranties; and
  14  * 2. No rights are granted, in any manner or form, to use Whistle
  15  *    Communications, Inc. trademarks, including the mark "WHISTLE
  16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  17  *    such appears in the above copyright notice or in the software.
  18  *
  19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  35  * OF SUCH DAMAGE.
  36  *
  37  * Author: Julian Elischer <julian@freebsd.org>
  38  *
  39  * $FreeBSD: src/sys/netgraph/netgraph.h,v 1.6.2.7 2002/04/14 23:31:08 julian Exp $
  40  * $Whistle: netgraph.h,v 1.29 1999/11/01 07:56:13 julian Exp $
  41  */
  42
  43 #ifndef _NETGRAPH_NETGRAPH_H_
  44 #define _NETGRAPH_NETGRAPH_H_
  45
  46 #ifndef _SYS_QUEUE_H_
  47 #include <sys/queue.h>
  48 #endif
  49 #ifndef _SYS_MALLOC_H_
  50 #include <sys/malloc.h>
  51 #endif
  52 #ifndef _SYS_MODULE_H_
  53 #include <sys/module.h>
  54 #endif
  55 #ifndef _SYS_MBUF_H_
  56 #include <sys/mbuf.h>
  57 #endif
  58 #ifndef _NETGRAPH_NG_MESSAGE_H_
  59 #include <netgraph/ng_message.h>
  60 #endif
  61
  62 #ifndef _KERNEL
  63 #error "This file should not be included in user level programs"
  64 #endif
  65
  66 #define NG_ABI_VERSION NG_VERSION
  67
  68 /*
  69  * Structure of a hook
  70  */
  71 struct ng_hook {
  72         char   *name;           /* what this node knows this link as */
  73         void   *private;        /* node dependant ID for this hook */
  74         int     flags;          /* info about this hook/link */
  75         int     refs;           /* dont actually free this till 0 */
  76         struct  ng_hook *peer;  /* the other end of this link */
  77         struct  ng_node *node;  /* The node this hook is attached to */
  78         LIST_ENTRY(ng_hook) hooks;      /* linked list of all hooks on node */
  79 };
  80 typedef struct ng_hook *hook_p;
  81
  82 /* Flags for a hook */
  83 #define HK_INVALID              0x0001  /* don't trust it! */
  84
  85 void ng_unref_hook(hook_p hook); /* don't move this */
  86 #define NG_HOOK_REF(hook)       atomic_add_int(&(hook)->refs, 1)
  87 #define NG_HOOK_NAME(hook)      ((hook)->name)
  88 #define NG_HOOK_UNREF(hook)     ng_unref_hook(hook)
  89 #define NG_HOOK_SET_PRIVATE(hook, val)  do {(hook)->private = val;} while (0)
  90 #define NG_HOOK_SET_RCVMSG(hook, val)   do {(hook)->rcvmsg = val;} while (0)
  91 #define NG_HOOK_SET_RCVDATA(hook, val)  do {(hook)->rcvdata = val;} while (0)
  92 #define NG_HOOK_PRIVATE(hook)   ((hook)->private)
  93 #define NG_HOOK_NOT_VALID(hook) ((hook)->flags & HK_INVALID)
  94 #define NG_HOOK_IS_VALID(hook)  (!((hook)->flags & HK_INVALID))
  95 #define NG_HOOK_NODE(hook)      ((hook)->node) /* only rvalue! */
  96 #define NG_HOOK_PEER(hook)      ((hook)->peer) /* only rvalue! */
  97
  98 /* Some shortcuts */
  99 #define NG_PEER_NODE(hook)      NG_HOOK_NODE(NG_HOOK_PEER(hook))
 100 #define NG_PEER_HOOK_NAME(hook) NG_HOOK_NAME(NG_HOOK_PEER(hook))
 101 #define NG_PEER_NODE_NAME(hook) NG_NODE_NAME(NG_PEER_NODE(hook))
 102
 103 /*
 104  * Structure of a node
 105  */
 106 struct ng_node {
 107         char   *name;           /* optional globally unique name */
 108         struct  ng_type *type;  /* the installed 'type' */
 109         int     flags;          /* see below for bit definitions */
 110         int     sleepers;       /* #procs sleeping on this node */
 111         int     refs;           /* number of references to this node */
 112         int     numhooks;       /* number of hooks */
 113         int     colour;         /* for graph colouring algorithms */
 114         void   *private;        /* node type dependant node ID */
 115         ng_ID_t         ID;     /* Unique per node */
 116         LIST_HEAD(hooks, ng_hook) hooks;        /* linked list of node hooks */
 117         LIST_ENTRY(ng_node)       nodes;        /* linked list of all nodes */
 118         LIST_ENTRY(ng_node)       idnodes;      /* ID hash collision list */
 119 };
 120 typedef struct ng_node *node_p;
 121
 122 /* Flags for a node */
 123 #define NG_INVALID      0x001   /* free when all sleepers and refs go to 0 */
 124 #define NG_BUSY         0x002   /* callers should sleep or wait */
 125 #define NG_TOUCHED      0x004   /* to avoid cycles when 'flooding' */
 126 #define NGF_TYPE1       0x10000000      /* reserved for type specific storage */
 127 #define NGF_TYPE2       0x20000000      /* reserved for type specific storage */
 128 #define NGF_TYPE3       0x40000000      /* reserved for type specific storage */
 129 #define NGF_TYPE4       0x80000000      /* reserved for type specific storage */
 130
 131 void    ng_unref_node(node_p node); /* don't move this */
 132 #define NG_NODE_NAME(node)      ((node)->name + 0)
 133 #define NG_NODE_HAS_NAME(node)  ((node)->name[0] + 0)
 134 #define NG_NODE_ID(node)        ((node)->ID + 0)
 135 #define NG_NODE_REF(node)       atomic_add_int(&(node)->refs, 1)
 136 #define NG_NODE_UNREF(node)     ng_unref(node)
 137 #define NG_NODE_SET_PRIVATE(node, val)  do {(node)->private = val;} while (0)
 138 #define NG_NODE_PRIVATE(node)   ((node)->private)
 139 #define NG_NODE_IS_VALID(node)  (!((node)->flags & NG_INVALID))
 140 #define NG_NODE_NOT_VALID(node) ((node)->flags & NG_INVALID)
 141 #define NG_NODE_NUMHOOKS(node)  ((node)->numhooks + 0) /* rvalue */
 142
 143 /*
 144  * The structure that holds meta_data about a data packet (e.g. priority)
 145  * Nodes might add or subtract options as needed if there is room.
 146  * They might reallocate the struct to make more room if they need to.
 147  * Meta-data is still experimental.
 148  */
 149 struct meta_field_header {
 150         u_long  cookie;         /* cookie for the field. Skip fields you don't
 151                                  * know about (same cookie as in messgaes) */
 152         u_short type;           /* field ID */
 153         u_short len;            /* total len of this field including extra
 154                                  * data */
 155         char    data[0];        /* data starts here */
 156 };
 157
 158 /* To zero out an option 'in place' set it's cookie to this */
 159 #define NGM_INVALID_COOKIE      865455152
 160
 161 /* This part of the metadata is always present if the pointer is non NULL */
 162 struct ng_meta {
 163         char    priority;       /* -ve is less priority,  0 is default */
 164         char    discardability; /* higher is less valuable.. discard first */
 165         u_short allocated_len;  /* amount malloc'd */
 166         u_short used_len;       /* sum of all fields, options etc. */
 167         u_short flags;          /* see below.. generic flags */
 168         struct meta_field_header options[0];    /* add as (if) needed */
 169 };
 170 typedef struct ng_meta *meta_p;
 171
 172 /* Flags for meta-data */
 173 #define NGMF_TEST       0x01    /* discard at the last moment before sending */
 174 #define NGMF_TRACE      0x02    /* trace when handing this data to a node */
 175
 176 /* node method definitions */
 177 typedef int     ng_constructor_t(node_p *node);
 178 typedef int     ng_rcvmsg_t(node_p node, struct ng_mesg *msg,
 179                         const char *retaddr, struct ng_mesg **resp);
 180 typedef int     ng_shutdown_t(node_p node);
 181 typedef int     ng_newhook_t(node_p node, hook_p hook, const char *name);
 182 typedef hook_p  ng_findhook_t(node_p node, const char *name);
 183 typedef int     ng_connect_t(hook_p hook);
 184 typedef int     ng_rcvdata_t(hook_p hook, struct mbuf *m, meta_p meta);
 185 typedef int     ng_disconnect_t(hook_p hook);
 186
 187 /*
 188  * Command list -- each node type specifies the command that it knows
 189  * how to convert between ASCII and binary using an array of these.
 190  * The last element in the array must be a terminator with cookie=0.
 191  */
 192
 193 struct ng_cmdlist {
 194         u_int32_t                       cookie;         /* command typecookie */
 195         int                             cmd;            /* command number */
 196         const char                      *name;          /* command name */
 197         const struct ng_parse_type      *mesgType;      /* args if !NGF_RESP */
 198         const struct ng_parse_type      *respType;      /* args if NGF_RESP */
 199 };
 200
 201 /*
 202  * Structure of a node type
 203  */
 204 struct ng_type {
 205
 206         u_int32_t       version;        /* must equal NG_VERSION */
 207         const char      *name;          /* Unique type name */
 208         modeventhand_t  mod_event;      /* Module event handler (optional) */
 209         ng_constructor_t *constructor;  /* Node constructor */
 210         ng_rcvmsg_t     *rcvmsg;        /* control messages come here */
 211         ng_shutdown_t   *shutdown;      /* reset, and free resources */
 212         ng_newhook_t    *newhook;       /* first notification of new hook */
 213         ng_findhook_t   *findhook;      /* only if you have lots of hooks */
 214         ng_connect_t    *connect;       /* final notification of new hook */
 215         ng_rcvdata_t    *rcvdata;       /* date comes here */
 216         ng_rcvdata_t    *rcvdataq;      /* or here if being queued */
 217         ng_disconnect_t *disconnect;    /* notify on disconnect */
 218
 219         const struct    ng_cmdlist *cmdlist;    /* commands we can convert */
 220
 221         /* R/W data private to the base netgraph code DON'T TOUCH! */
 222         LIST_ENTRY(ng_type) types;              /* linked list of all types */
 223         int                 refs;               /* number of instances */
 224 };
 225
 226 /* Send data packet with meta-data */
 227 #define NG_SEND_DATA(error, hook, m, a)                                 \
 228         do {                                                            \
 229                 (error) = ng_send_data((hook), (m), (a));               \
 230                 (m) = NULL;                                             \
 231                 (a) = NULL;                                             \
 232         } while (0)
 233
 234 #define NG_SEND_DATA_ONLY(error, hook, m)                               \
 235         do {                                                            \
 236                 (error) = ng_send_data((hook), (m), NULL);              \
 237                 (m) = NULL;                                             \
 238         } while (0)
 239
 240 /* Send  queued data packet with meta-data */
 241 #define NG_SEND_DATAQ(error, hook, m, a)                                \
 242         do {                                                            \
 243                 (error) = ng_send_dataq((hook), (m), (a));              \
 244                 (m) = NULL;                                             \
 245                 (a) = NULL;                                             \
 246         } while (0)
 247
 248 #define NG_RESPOND_MSG(error, here, retaddr, resp, rptr)                \
 249         do {                                                            \
 250                 if (rptr) {                                             \
 251                         *rptr = resp;                                   \
 252                 } else if (resp) {                                      \
 253                         if (retaddr) {                                  \
 254                                 error = ng_queue_msg(here, resp, retaddr); \
 255                         } else {                                        \
 256                                 kfree(resp, M_NETGRAPH);                \
 257                         }                                               \
 258                 }                                                       \
 259         } while (0)
 260
 261 #define NG_FREE_MSG(msg)                                                \
 262         do {                                                            \
 263                 if ((msg)) {                                            \
 264                         kfree((msg), M_NETGRAPH);                       \
 265                         (msg) = NULL;                                   \
 266                 }                                                       \
 267         } while (0)
 268
 269 #define NG_FREE_META(a)                                                 \
 270         do {                                                            \
 271                 if ((a)) {                                              \
 272                         kfree((a), M_NETGRAPH);                         \
 273                         (a) = NULL;                                     \
 274                 }                                                       \
 275         } while (0)
 276
 277 #define NG_FREE_M(m)                                                    \
 278         do {                                                            \
 279                 if ((m)) {                                              \
 280                         m_freem((m));                                   \
 281                         (m) = NULL;                                     \
 282                 }                                                       \
 283         } while (0)
 284
 285 /* Free any data packet and/or meta-data */
 286 #define NG_FREE_DATA(m, a)                                              \
 287         do {                                                            \
 288                 NG_FREE_M((m));                                         \
 289                 NG_FREE_META((a));                                      \
 290         } while (0)
 291
 292 /*
 293  * Use the NETGRAPH_INIT() macro to link a node type into the
 294  * netgraph system. This works for types compiled into the kernel
 295  * as well as KLD modules. The first argument should be the type
 296  * name (eg, echo) and the second a pointer to the type struct.
 297  *
 298  * If a different link time is desired, e.g., a device driver that
 299  * needs to install its netgraph type before probing, use the
 300  * NETGRAPH_INIT_ORDERED() macro instead. Deivce drivers probably
 301  * want to use SI_SUB_DRIVERS instead of SI_SUB_PSEUDO.
 302  */
 303
 304 #define NETGRAPH_INIT_ORDERED(typename, typestructp, sub, order)        \
 305 static moduledata_t ng_##typename##_mod = {                             \
 306         "ng_" #typename,                                                \
 307         ng_mod_event,                                                   \
 308         (typestructp)                                                   \
 309 };                                                                      \
 310 DECLARE_MODULE(ng_##typename, ng_##typename##_mod, sub, order);         \
 311 MODULE_VERSION(ng_##typename, NG_ABI_VERSION);                          \
 312 MODULE_DEPEND(ng_##typename, netgraph,  NG_ABI_VERSION,                 \
 313                                         NG_ABI_VERSION,                 \
 314                                         NG_ABI_VERSION)
 315 #define NETGRAPH_INIT(tn, tp)                                           \
 316         NETGRAPH_INIT_ORDERED(tn, tp, SI_SUB_PSEUDO, SI_ORDER_ANY)
 317
 318 /* Special malloc() type for netgraph structs and ctrl messages */
 319 MALLOC_DECLARE(M_NETGRAPH);
 320
 321 /* declare the base of the netgraph sysctl hierarchy */
 322 /* but only if this file cares about sysctls */
 323 #ifdef  SYSCTL_DECL
 324 SYSCTL_DECL(_net_graph);
 325 #endif
 326
 327 int     ng_bypass(hook_p hook1, hook_p hook2);
 328 void    ng_cutlinks(node_p node);
 329 int     ng_con_nodes(node_p node,
 330              const char *name, node_p node2, const char *name2);
 331 meta_p  ng_copy_meta(meta_p meta);
 332 void    ng_destroy_hook(hook_p hook);
 333 hook_p  ng_findhook(node_p node, const char *name);
 334 node_p  ng_findname(node_p node, const char *name);
 335 struct  ng_type *ng_findtype(const char *type);
 336 int     ng_make_node(const char *type, node_p *nodepp);
 337 int     ng_make_node_common(struct ng_type *typep, node_p *nodep);
 338 int     ng_mkpeer(node_p node, const char *name, const char *name2, char *type);
 339 int     ng_mod_event(module_t mod, int what, void *arg);
 340 int     ng_name_node(node_p node, const char *name);
 341 int     ng_newtype(struct ng_type *tp);
 342 ng_ID_t ng_node2ID(node_p node);
 343 int     ng_path2node(node_p here, const char *path, node_p *dest, char **rtnp);
 344 int     ng_path_parse(char *addr, char **node, char **path, char **hook);
 345 int     ng_queue_data(hook_p hook, struct mbuf *m, meta_p meta);
 346 int     ng_queue_msg(node_p here, struct ng_mesg *msg, const char *address);
 347 void    ng_release_node(node_p node);
 348 void    ng_rmnode(node_p node);
 349 int     ng_send_data(hook_p hook, struct mbuf *m, meta_p meta);
 350 int     ng_send_dataq(hook_p hook, struct mbuf *m, meta_p meta);
 351 int     ng_send_msg(node_p here, struct ng_mesg *msg,
 352             const char *address, struct ng_mesg **resp);
 353 void    ng_unname(node_p node);
 354 void    ng_unref(node_p node);
 355 int     ng_wait_node(node_p node, char *msg);
 356
 357 #endif  /* _NETGRAPH_NETGRAPH_H_ */