bsd/sys/sys_domain.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30
  31
  32 #ifndef _SYSTEM_DOMAIN_H_
  33 #define _SYSTEM_DOMAIN_H_
  34
  35
  36 #include <sys/appleapiopts.h>
  37 #include <sys/cdefs.h>
  38 #include <sys/types.h>
  39
  40 #ifdef KERNEL_PRIVATE
  41 #include <sys/queue.h>
  42 #include <libkern/locks.h>
  43 #include <sys/kern_control.h>
  44 #endif /* KERNEL_PRIVATE */
  45
  46 /* Kernel Events Protocol */
  47 #define SYSPROTO_EVENT          1       /* kernel events protocol */
  48
  49 /* Kernel Control Protocol */
  50 #define SYSPROTO_CONTROL        2       /* kernel control protocol */
  51 #define AF_SYS_CONTROL          2       /* corresponding sub address type */
  52
  53 /* System family socket address */
  54 struct sockaddr_sys
  55 {
  56         u_char  ss_len;                         /* sizeof(struct sockaddr_sys) */
  57         u_char  ss_family;                      /* AF_SYSTEM */
  58         u_int16_t       ss_sysaddr;     /* protocol address in AF_SYSTEM */
  59         u_int32_t       ss_reserved[7]; /* reserved to the protocol use */
  60 };
  61
  62
  63 #ifdef KERNEL_PRIVATE
  64
  65 /*
  66  * internal structure maintained for each register controller
  67  */
  68 struct ctl_cb;
  69 struct socket;
  70
  71 struct kctl
  72 {
  73         TAILQ_ENTRY(kctl)               next;                                   /* controller chain */
  74
  75         /* controller information provided when registering */
  76         char                                    name[MAX_KCTL_NAME];    /* unique nke identifier, provided by DTS */
  77         u_int32_t                               id;
  78         u_int32_t                               reg_unit;
  79
  80         /* misc communication information */
  81         u_int32_t                               flags;                                  /* support flags */
  82         u_int32_t                               recvbufsize;                    /* request more than the default buffer size */
  83         u_int32_t                               sendbufsize;                    /* request more than the default buffer size */
  84
  85         /* Dispatch functions */
  86         ctl_connect_func                connect;                                /* Make contact */
  87         ctl_disconnect_func             disconnect;                             /* Break contact */
  88         ctl_send_func                   send;                                   /* Send data to nke */
  89         ctl_setopt_func                 setopt;                                 /* set kctl configuration */
  90         ctl_getopt_func                 getopt;                                 /* get kctl configuration */
  91
  92         TAILQ_HEAD(, ctl_cb)    kcb_head;
  93         u_int32_t                               lastunit;
  94 };
  95
  96 struct ctl_cb {
  97         TAILQ_ENTRY(ctl_cb)             next;                                   /* controller chain */
  98         lck_mtx_t                               *mtx;
  99         struct socket                   *so;                                    /* controlling socket */
 100         struct kctl                             *kctl;                                  /* back pointer to controller */
 101         u_int32_t                               unit;
 102         void                                    *userdata;
 103 };
 104
 105
 106 extern struct domain systemdomain;
 107
 108 /* built in system domain protocols init function */
 109 __BEGIN_DECLS
 110 int kern_event_init(void);
 111 int kern_control_init(void);
 112 __END_DECLS
 113
 114 #endif /* KERNEL_PRIVATE */
 115
 116 #endif /* _SYSTEM_DOMAIN_H_ */
 117
 118