bsd/net/dlil.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  *      Copyright (c) 1999 Apple Computer, Inc.
  24  *
  25  *      Data Link Inteface Layer
  26  *      Author: Ted Walker
  27  */
  28
  29
  30 #ifndef DLIL_H
  31 #define DLIL_H
  32 #include <sys/appleapiopts.h>
  33
  34 #if __STDC__
  35
  36 struct ifnet;
  37 struct mbuf;
  38 struct ether_header;
  39
  40 #endif
  41
  42
  43 #ifdef __APPLE_API_UNSTABLE
  44 #define DLIL_LAST_FILTER   -1
  45 #define DLIL_NULL_FILTER   -2
  46
  47 #define DLIL_WAIT_FOR_FREE -2
  48
  49 #define DLIL_BLUEBOX 1
  50
  51
  52
  53 #include <net/if.h>
  54 #include <net/if_var.h>
  55 #include <sys/kern_event.h>
  56
  57 enum {
  58         BPF_TAP_DISABLE,
  59         BPF_TAP_INPUT,
  60         BPF_TAP_OUTPUT,
  61         BPF_TAP_INPUT_OUTPUT
  62 };
  63
  64
  65 struct dl_tag_attr_str {
  66     u_long      dl_tag;
  67     short       if_flags;
  68     short       if_unit;
  69     u_long      if_family;
  70     u_long      protocol_family;
  71 };
  72
  73
  74 struct dlil_pr_flt_str {
  75     caddr_t      cookie;
  76
  77     int (*filter_dl_input)(caddr_t      cookie,
  78                            struct mbuf  **m,
  79                            char         **frame_header,
  80                            struct ifnet **ifp);
  81
  82
  83     int (*filter_dl_output)(caddr_t         cookie,
  84                             struct mbuf     **m,
  85                             struct ifnet    **ifp,
  86                             struct sockaddr **dest,
  87                             char            *dest_linkaddr,
  88                             char            *frame_type);
  89
  90     int (*filter_dl_event)(caddr_t            cookie,
  91                            struct kern_event_msg   *event_msg);
  92
  93     int (*filter_dl_ioctl)(caddr_t      cookie,
  94                            struct ifnet *ifp,
  95                            u_long       ioctl_cmd,
  96                            caddr_t      ioctl_arg);
  97
  98     int (*filter_detach)(caddr_t  cookie);
  99     u_long      reserved[2];
 100 };
 101
 102 struct dlil_if_flt_str {
 103     caddr_t                                cookie;
 104     int (*filter_if_input)(caddr_t         cookie,
 105                            struct ifnet    **ifnet_ptr,
 106                            struct mbuf     **mbuf_ptr,
 107                            char            **frame_ptr);
 108
 109     int (*filter_if_event)(caddr_t          cookie,
 110                            struct ifnet     **ifnet_ptr,
 111                            struct kern_event_msg **event_msg_ptr);
 112
 113     int (*filter_if_output)(caddr_t      cookie,
 114                             struct ifnet **ifnet_ptr,
 115                             struct mbuf  **mbuf_ptr);
 116
 117
 118     int (*filter_if_ioctl)(caddr_t       cookie,
 119                            struct ifnet  *ifnet_ptr,
 120                            u_long        ioctl_code_ptr,
 121                            caddr_t       ioctl_arg_ptr);
 122
 123     int (*filter_if_free)(caddr_t      cookie,
 124                           struct ifnet *ifnet_ptr);
 125
 126     int (*filter_detach)(caddr_t  cookie);
 127     u_long      reserved[2];
 128 };
 129
 130
 131 #define DLIL_PR_FILTER  1
 132 #define DLIL_IF_FILTER  2
 133
 134
 135
 136 typedef int (*dl_input_func)(struct mbuf *m, char *frame_header,
 137                              struct ifnet *ifp, u_long  dl_tag, int sync_ok);
 138 typedef int (*dl_pre_output_func)(struct ifnet          *ifp,
 139                                   struct mbuf           **m,
 140                                   struct sockaddr       *dest,
 141                                   caddr_t               route_entry,
 142                                   char                  *frame_type,
 143                                   char                  *dst_addr,
 144                                   u_long                dl_tag);
 145
 146 typedef int (*dl_event_func)(struct kern_event_msg  *event,
 147                              u_long            dl_tag);
 148
 149 typedef int (*dl_offer_func)(struct mbuf *m, char *frame_header);
 150 typedef int (*dl_ioctl_func)(u_long     dl_tag,
 151                              struct ifnet *ifp,
 152                              u_long     ioctl_cmd,
 153                              caddr_t    ioctl_arg);
 154
 155
 156
 157 #ifdef __APPLE_API_PRIVATE
 158 struct dlil_filterq_entry {
 159     TAILQ_ENTRY(dlil_filterq_entry) que;
 160     u_long       filter_id;
 161     int          type;
 162     union {
 163         struct dlil_if_flt_str if_filter;
 164         struct dlil_pr_flt_str pr_filter;
 165     } variants;
 166 };
 167 #else
 168 struct dlil_filterq_entry;
 169 #endif /* __APPLE_API_PRIVATE */
 170
 171 TAILQ_HEAD(dlil_filterq_head, dlil_filterq_entry);
 172
 173
 174 struct if_proto {
 175     TAILQ_ENTRY(if_proto)                       next;
 176     u_long                                      dl_tag;
 177     struct dlil_filterq_head                    pr_flt_head;
 178     struct ifnet                *ifp;
 179     dl_input_func               dl_input;
 180     dl_pre_output_func          dl_pre_output;
 181     dl_event_func               dl_event;
 182     dl_offer_func               dl_offer;
 183     dl_ioctl_func               dl_ioctl;
 184     u_long                      protocol_family;
 185     u_long                      reserved[4];
 186
 187 };
 188
 189 #ifdef __APPLE_API_PRIVATE
 190 TAILQ_HEAD(dlil_proto_head, if_proto);
 191
 192 struct dlil_tag_list_entry {
 193     TAILQ_ENTRY(dlil_tag_list_entry) next;
 194     struct ifnet                   *ifp;
 195     u_long                         dl_tag;
 196 };
 197 #endif /* __APPLE_API_PRIVATE */
 198
 199
 200 #ifdef __APPLE_API_OBSOLETE
 201 /* Obsolete types */
 202 #define DLIL_DESC_RAW           1
 203 #define DLIL_DESC_802_2         2
 204 #define DLIL_DESC_802_2_SNAP    3
 205 /*
 206  * DLIL_DESC_RAW - obsolete type, data in variants.bitmask or native_type
 207  *                                 if variants.bitmask.proto_id_length, native_type in host
 208  *                                 byte order.
 209  * DLIL_DESC_802_2 - obsolete, data in variants.desc_802_2
 210  * DLIL_DESC_802_2_SNAP - obsolete, data in variants.desc_802_2_SNAP
 211  *                                                protocol field in host byte order
 212  */
 213 #endif /* __APPLE_API_OBSOLETE */
 214
 215 /* Ehernet specific types */
 216 #define DLIL_DESC_ETYPE2        4
 217 #define DLIL_DESC_SAP           5
 218 #define DLIL_DESC_SNAP          6
 219 /*
 220  * DLIL_DESC_ETYPE2 - native_type must point to 2 byte ethernet raw protocol,
 221  *                    variants.native_type_length must be set to 2
 222  * DLIL_DESC_SAP - native_type must point to 3 byte SAP protocol
 223  *                 variants.native_type_length must be set to 3
 224  * DLIL_DESC_SNAP - native_type must point to 5 byte SNAP protocol
 225  *                  variants.native_type_length must be set to 5
 226  *
 227  * All protocols must be in Network byte order.
 228  *
 229  * Future interface families may define more protocol types they know about.
 230  * The type implies the offset and context of the protocol data at native_type.
 231  * The length of the protocol data specified at native_type must be set in
 232  * variants.native_type_length.
 233  */
 234
 235 struct dlil_demux_desc {
 236     TAILQ_ENTRY(dlil_demux_desc) next;
 237
 238     int         type;
 239     u_char      *native_type;
 240
 241     union {
 242         /* Structs in this union are obsolete. They exist for binary compatability only */
 243         /* Only the native_type_length is used */
 244         struct {
 245             u_long   proto_id_length; /* IN LONGWORDS!!! */
 246             u_char   *proto_id;           /* No longer supported by Ethernet family */
 247             u_char   *proto_id_mask;
 248         } bitmask;
 249
 250         struct {
 251             u_char   dsap;
 252             u_char   ssap;
 253             u_char   control_code;
 254             u_char   pad;
 255         } desc_802_2;
 256
 257         struct {
 258             u_char   dsap;                      /* Ignored, assumed to be 0xAA */
 259             u_char   ssap;                      /* Ignored, assumed to be 0xAA */
 260             u_char   control_code;      /* Ignored, assumed to be 0x03 */
 261             u_char   org[3];
 262             u_short  protocol_type; /* In host byte order */
 263         } desc_802_2_SNAP;
 264
 265         /* Length of data pointed to by native_type, must be set correctly */
 266         u_int32_t       native_type_length;
 267     } variants;
 268 };
 269
 270 TAILQ_HEAD(ddesc_head_str, dlil_demux_desc);
 271
 272
 273 struct dlil_proto_reg_str {
 274     struct ddesc_head_str       demux_desc_head;
 275     u_long                      interface_family;
 276     u_long                      protocol_family;
 277     short                       unit_number;
 278     int                         default_proto; /* 0 or 1 */
 279     dl_input_func               input;
 280     dl_pre_output_func  pre_output;
 281     dl_event_func               event;
 282     dl_offer_func               offer;
 283     dl_ioctl_func               ioctl;
 284     u_long                      reserved[4];
 285 };
 286
 287
 288 int dlil_attach_interface_filter(struct ifnet              *ifnet_ptr,
 289                                  struct dlil_if_flt_str    *interface_filter,
 290                                  u_long                    *filter_id,
 291                                  int                       insertion_point);
 292
 293 int
 294 dlil_input(struct ifnet  *ifp, struct mbuf *m_head, struct mbuf *m_tail);
 295
 296 int
 297 dlil_output(u_long              dl_tag,
 298             struct mbuf         *m,
 299             caddr_t             route,
 300             struct sockaddr     *dest,
 301             int                 raw);
 302
 303
 304 int
 305 dlil_ioctl(u_long       proto_family,
 306            struct ifnet *ifp,
 307            u_long       ioctl_code,
 308            caddr_t      ioctl_arg);
 309
 310 int
 311 dlil_attach_protocol(struct dlil_proto_reg_str   *proto,
 312                      u_long                      *dl_tag);
 313
 314 int
 315 dlil_detach_protocol(u_long     dl_tag);
 316
 317 int
 318 dlil_if_attach(struct ifnet     *ifp);
 319
 320 int
 321 dlil_attach_protocol_filter(u_long                  dl_tag,
 322                             struct dlil_pr_flt_str  *proto_filter,
 323                             u_long                  *filter_id,
 324                             int                     insertion_point);
 325 int
 326 dlil_detach_filter(u_long       filter_id);
 327
 328 struct dlil_ifmod_reg_str {
 329     int (*add_if)(struct ifnet *ifp);
 330     int (*del_if)(struct ifnet *ifp);
 331     int (*add_proto)(struct ddesc_head_str   *demux_desc_head,
 332                      struct if_proto  *proto, u_long dl_tag);
 333     int (*del_proto)(struct if_proto  *proto, u_long dl_tag);
 334     int (*ifmod_ioctl)(struct ifnet *ifp, u_long ioctl_cmd, caddr_t data);
 335     int (*shutdown)();
 336     int (*init_if)(struct ifnet *ifp);
 337     u_long      reserved[3];
 338 };
 339
 340
 341 int dlil_reg_if_modules(u_long  interface_family,
 342                         struct dlil_ifmod_reg_str  *ifmod_reg);
 343
 344 struct dlil_protomod_reg_str {
 345     /*
 346      *   attach the protocol to the interface and return the dl_tag
 347      */
 348     int (*attach_proto)(struct ifnet *ifp, u_long *dl_tag);
 349
 350     /*
 351      *   detach the protocol from the interface.
 352      *   this is optionnal. If it is NULL, DLIL will use 0 default detach function.
 353      */
 354     int (*detach_proto)(struct ifnet *ifp, u_long dl_tag);
 355
 356     /*
 357      *   reserved for future use. MUST be NULL.
 358      */
 359     u_long      reserved[4];
 360 };
 361
 362 /*
 363
 364 Function : dlil_reg_proto_module
 365
 366     A DLIL protocol module is a piece of code that know how to handle a certain type
 367     of protocol (PF_INET, PF_INET6, ...) for a certain family of interface (APPLE_IF_FAM_ETHERNET,
 368     APPLE_IF_FAM_PPP, ...).
 369
 370     dlil_reg_proto_module() allows the registration of such a protocol/interface handler before any
 371     interface is attached.
 372     Typically, the attach and detach function of the protocol handler will call
 373     dlil_{attach/detach}_protocol with the parameter specific to the protocol.
 374
 375     The goal of this modules is to insulate the actual protocol (IP, IPv6) from the DLIL details.
 376
 377 Parameters :
 378     'protocol_family' is PF_INET, PF_INET6, ...
 379     'interface_family' is APPLE_IF_FAM_ETHERNET, APPLE_IF_FAM_PPP, ...
 380     'protomod_reg' is the protocol registration structure.
 381             'attach_proto' funtion is mandatory.
 382             'detach_proto' funtion is optional (DLIL will manage it).
 383
 384 Return code :
 385
 386 0 :
 387
 388     No error.
 389
 390 ENOMEM:
 391
 392     No memory can be allocated for internal data structure.
 393
 394 EEXIST:
 395
 396     The protocol family has already been registered for this interface family.
 397
 398 EINVAL:
 399
 400     The dlil_protomod_reg_str structure contains incorrect values.
 401
 402 */
 403
 404 int dlil_reg_proto_module(u_long protocol_family, u_long interface_family,
 405                         struct dlil_protomod_reg_str  *protomod_reg);
 406
 407 /*
 408
 409 Function : dlil_dereg_proto_module
 410
 411     dlil_dereg_proto_module() will unregister the protocol module previously
 412     registered with dlil_dereg_proto_module().
 413
 414     There is no restriction when to call it.
 415     Interfaces or protoco can be attached, it will not prevent the deregistration of the module.
 416
 417 Parameters :
 418     'protocol_family' is PF_INET, PF_INET6, ...
 419     'interface_family' is APPLE_IF_FAM_ETHERNET, APPLE_IF_FAM_PPP, ...
 420
 421 Return code :
 422
 423 0 :
 424
 425     No error.
 426
 427 ENOENT:
 428
 429     No module was registered..
 430
 431 */
 432
 433 int dlil_dereg_proto_module(u_long protocol_family, u_long interface_family);
 434
 435 /*
 436
 437 Function : dlil_plumb_protocol
 438
 439     dlil_plumb_protocol() will plumb a protocol to an actual interface.
 440     This will find a registered protocol module and call its attach function.
 441     The module will typically call dlil_attach_protocol with the appropriate parameters,
 442     and will return the dl_tag of the attachement.
 443     It is up to the caller to handle the dl_tag.
 444     Some protocol (IPv4) will stick it in their internal structure for future use.
 445     Some other protocol (IPv6) can ignore the dl_tag.
 446
 447 Parameters :
 448     'protocol_family' is PF_INET, PF_INET6, ...
 449     'ifp' is the interface to plumb the protocol to.
 450     'dl_tag' is the tag returned from the succesful attachement.
 451
 452 Return code :
 453
 454 0 :
 455
 456     No error.
 457
 458 ENOENT:
 459
 460     No module was registered.
 461
 462 other:
 463
 464     Error returned by the attach_proto function
 465
 466 */
 467 int dlil_plumb_protocol(u_long protocol_family, struct ifnet *ifp, u_long *dl_tag);
 468
 469 /*
 470
 471 Function : dlil_unplumb_protocol
 472
 473     dlil_unplumb_protocol() will unplumb a protocol from an interface.
 474     This will find a registered protocol module and call its detach function.
 475     The module will typically call dlil_detach_protocol with the appropriate parameters.
 476     If no module is found, this function will call dlil_detach_protocol directly.
 477
 478 Parameters :
 479     'protocol_family' is PF_INET, PF_INET6, ...
 480     'ifp' is APPLE_IF_FAM_ETHERNET, APPLE_IF_FAM_PPP, ...
 481
 482 Return code :
 483
 484 0 :
 485
 486     No error.
 487
 488 ENOENT:
 489
 490     No module was registered.
 491
 492 other:
 493
 494     Error returned by the attach_proto function
 495
 496 */
 497 int dlil_unplumb_protocol(u_long protocol_family, struct ifnet *ifp);
 498
 499 int
 500 dlil_inject_if_input(struct mbuf *m, char *frame_header, u_long from_id);
 501
 502 int
 503 dlil_inject_pr_input(struct mbuf *m, char *frame_header, u_long from_id);
 504
 505 int
 506 dlil_inject_pr_output(struct mbuf               *m,
 507                       struct sockaddr           *dest,
 508                       int                       raw,
 509                       char                      *frame_type,
 510                       char                      *dst_linkaddr,
 511                       u_long                    from_id);
 512
 513 int
 514 dlil_inject_if_output(struct mbuf *m, u_long from_id);
 515
 516 int
 517 dlil_find_dltag(u_long if_family, short unit, u_long proto_family, u_long *dl_tag);
 518
 519
 520 int
 521 dlil_event(struct ifnet *ifp, struct kern_event_msg *event);
 522
 523 int dlil_dereg_if_modules(u_long interface_family);
 524
 525 int
 526 dlil_if_detach(struct ifnet *ifp);
 527
 528
 529 /*
 530
 531 Function : dlil_if_acquire
 532
 533     DLIL manages the list of ifnet interfaces allocated using the dlil_if_acquire
 534     function. This list if not the same as the list of attached interfaces,
 535     visible with ifconfig.
 536     This list contains attached as well as detached interfaces.
 537         Detached interfaces are kept in the list to prevent the kernel from crashing
 538         by using an old ifp.
 539
 540     if it succeeds, dlil_if_acquire returns an ifnet data structure.
 541     This ifnet can either be a new allocated block of memory, or an ifnet
 542     that already existed and that DLIL has found in its list of unused
 543     interface and that matches the family/uniqueid tuple.
 544
 545     dlil_if_acquire can fail if the requested interface is already in use,
 546     or if no memory is available to create a new interface.
 547
 548     The typical sequence of call for a driver will be :
 549     dlil_if_acquire(... &ifp)
 550     ... Fill in the ifnet ...
 551     dlil_if_attach(ifp)
 552     ... Driver work ...
 553     dlil_if_detach(ifp)
 554     dlil_if_release(ifp)
 555
 556     Important : ifnet allocated by DLIL are managed by DLIL. DLIL takes care
 557     of them, and keeps them until a driver wants to reuse them, but DLIL may
 558     also decide to free them when not in use by a driver.
 559
 560     Note : the structure returned will actually be large enough to contain
 561     an arpcom structure (ifnet + ethernet) structure.
 562     Drivers cannot extend the structure and must to store their private
 563     information in if_sofc and if_private.
 564
 565 Parameters :
 566     'family' uniquely identifies DLIL interface family.
 567     'uniqueid' is a unique identifier for that interface, managed by the
 568         driver (for example MAC address for ethernet).
 569     'uniqueid_len' is the length of the unique id.
 570     'ifp' contains on output the allocated ifnet.
 571
 572 Return code :
 573
 574 0 :
 575
 576     If an ifnet matching the uniqueid is found, the matching ifnet is returned
 577     in ifp and the flags IFEF_REUSE and IF_INUSE are set in the if_eflags.
 578     The fields in the ifnet are NOT zeroed and may contain old values that
 579     the driver can reuse. [They are not necessarily the values that were
 580     there when the driver released the ifnet, as protocol might have
 581     continued to update them].
 582
 583     If no matching ifnet is found, a new structure is allocated and returned
 584     in ifp with all fields initialized to 0.
 585     The flag IF_INUSE is set in the if_eflags. IFEF_REUSE is NOT set.
 586     dlil_if_acquire will copy the uniqueid and keep it for matching purpose.
 587
 588     If 'uniqueid' is NULL, then dlil_if_acquire will return the first
 589     ifnet that contains a null uniqueid for that family, with the flags
 590     IFEF_REUSE and IF_INUSE set.
 591     If no ifnet is available, a new one will be created.
 592
 593 ENOMEM:
 594
 595     If no matching interface is found, and no memory can be allocated,
 596     dlil_if_acquire will return ENOMEM.
 597
 598
 599 EBUSY:
 600
 601     If the unique id matches the id of an interface currently in use,
 602     dlil_if_acquire will return EBUSY.
 603     An interface 'in use' is an allocated interface, not necessarily attached.
 604
 605 */
 606
 607 int dlil_if_acquire(u_long family, void *uniqueid, size_t uniqueid_len,
 608                         struct ifnet **ifp);
 609
 610
 611 /*
 612
 613 Function : dlil_if_release
 614
 615         dlil_if_release will transfer control of the ifnet to DLIL.
 616         DLIL will keep the interface in its list, marking it unused.
 617         The fields will be left in their current state, so the driver can reuse
 618         the ifnet later, by calling dlil_if_acquire.
 619         The if_eflags IF_INUSE will be cleared.
 620         The fields if_output, if_ioctl, if_free and if_set_bpf_tap will be changed
 621         to point to DLIL private functions.
 622         After calling dlil_if_acquire, the driver can safely terminate and
 623         unload if necessary.
 624         Note : if the call to dlil_if_detach returns DLIL_WAIT_FOR_FREE, the
 625         driver can safely ignore it and call dlil_if_release.
 626
 627 Parameters :
 628         ifp is the pointer to the ifnet to release.
 629
 630 */
 631
 632 void dlil_if_release(struct ifnet *ifp);
 633
 634 #endif /* __APPLE_API_UNSTABLE */
 635 #endif /* DLIL_H */