2 * Copyright (c) 2000-2004, 2012-2016 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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 License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 @header kern_control.h
30 This header defines an API to communicate between a kernel
31 extension and a process outside of the kernel.
34 #ifndef KPI_KERN_CONTROL_H
35 #define KPI_KERN_CONTROL_H
38 #include <sys/appleapiopts.h>
41 * Define Controller event subclass, and associated events.
42 * Subclass of KEV_SYSTEM_CLASS
46 @defined KEV_CTL_SUBCLASS
47 @discussion The kernel event subclass for kernel control events.
49 #define KEV_CTL_SUBCLASS 2
52 @defined KEV_CTL_REGISTERED
53 @discussion The event code indicating a new controller was
54 registered. The data portion will contain a ctl_event_data.
56 #define KEV_CTL_REGISTERED 1 /* a new controller appears */
59 @defined KEV_CTL_DEREGISTERED
60 @discussion The event code indicating a controller was unregistered.
61 The data portion will contain a ctl_event_data.
63 #define KEV_CTL_DEREGISTERED 2 /* a controller disappears */
66 @struct ctl_event_data
67 @discussion This structure is used for KEV_CTL_SUBCLASS kernel
69 @field ctl_id The kernel control id.
70 @field ctl_unit The kernel control unit.
72 struct ctl_event_data
{
73 u_int32_t ctl_id
; /* Kernel Controller ID */
78 * Controls destined to the Controller Manager.
83 @discussion The CTLIOCGCOUNT ioctl can be used to determine the
84 number of kernel controllers registered.
86 #define CTLIOCGCOUNT _IOR('N', 2, int) /* get number of control structures registered */
90 @discussion The CTLIOCGINFO ioctl can be used to convert a kernel
91 control name to a kernel control id.
93 #define CTLIOCGINFO _IOWR('N', 3, struct ctl_info) /* get id from name */
97 @defined MAX_KCTL_NAME
98 @discussion Kernel control names must be no longer than
101 #define MAX_KCTL_NAME 96
104 * Controls destined to the Controller Manager.
109 @discussion This structure is used with the CTLIOCGINFO ioctl to
110 translate from a kernel control name to a control id.
111 @field ctl_id The kernel control id, filled out upon return.
112 @field ctl_name The kernel control name to find.
115 u_int32_t ctl_id
; /* Kernel Controller ID */
116 char ctl_name
[MAX_KCTL_NAME
]; /* Kernel Controller Name (a C string) */
122 @discussion The controller address structure is used to establish
123 contact between a user client and a kernel controller. The
124 sc_id/sc_unit uniquely identify each controller. sc_id is a
125 unique identifier assigned to the controller. The identifier can
126 be assigned by the system at registration time or be a 32-bit
127 creator code obtained from Apple Computer. sc_unit is a unit
128 number for this sc_id, and is privately used by the kernel
129 controller to identify several instances of the controller.
130 @field sc_len The length of the structure.
131 @field sc_family AF_SYSTEM.
132 @field ss_sysaddr AF_SYS_KERNCONTROL.
133 @field sc_id Controller unique identifier.
134 @field sc_unit Kernel controller private unit number.
135 @field sc_reserved Reserved, must be set to zero.
137 struct sockaddr_ctl
{
138 u_char sc_len
; /* depends on size of bundle ID string */
139 u_char sc_family
; /* AF_SYSTEM */
140 u_int16_t ss_sysaddr
; /* AF_SYS_KERNCONTROL */
141 u_int32_t sc_id
; /* Controller unique identifier */
142 u_int32_t sc_unit
; /* Developer private unit number */
143 u_int32_t sc_reserved
[5];
152 u_int32_t xkr_reg_unit
;
154 u_int64_t xkr_kctlref
;
155 u_int32_t xkr_recvbufsize
;
156 u_int32_t xkr_sendbufsize
;
157 u_int32_t xkr_lastunit
;
158 u_int32_t xkr_pcbcount
;
159 u_int64_t xkr_connect
;
160 u_int64_t xkr_disconnect
;
162 u_int64_t xkr_send_list
;
163 u_int64_t xkr_setopt
;
164 u_int64_t xkr_getopt
;
166 char xkr_name
[MAX_KCTL_NAME
];
172 u_int64_t xkp_kctpcb
;
174 u_int32_t xkp_kctlid
;
175 u_int64_t xkp_kctlref
;
176 char xkp_kctlname
[MAX_KCTL_NAME
];
180 u_int64_t kcs_reg_total
__attribute__((aligned(8)));
181 u_int64_t kcs_reg_count
__attribute__((aligned(8)));
182 u_int64_t kcs_pcbcount
__attribute__((aligned(8)));
183 u_int64_t kcs_gencnt
__attribute__((aligned(8)));
184 u_int64_t kcs_connections
__attribute__((aligned(8)));
185 u_int64_t kcs_conn_fail
__attribute__((aligned(8)));
186 u_int64_t kcs_send_fail
__attribute__((aligned(8)));
187 u_int64_t kcs_send_list_fail
__attribute__((aligned(8)));
188 u_int64_t kcs_enqueue_fail
__attribute__((aligned(8)));
189 u_int64_t kcs_enqueue_fullsock
__attribute__((aligned(8)));
190 u_int64_t kcs_bad_kctlref
__attribute__((aligned(8)));
191 u_int64_t kcs_tbl_size_too_big
__attribute__((aligned(8)));
192 u_int64_t kcs_enqdata_mb_alloc_fail
__attribute__((aligned(8)));
193 u_int64_t kcs_enqdata_sbappend_fail
__attribute__((aligned(8)));
200 #include <sys/kpi_mbuf.h>
203 @typedef kern_ctl_ref
204 @discussion A control reference is used to track an attached kernel
205 control. Registering a kernel control will create a kernel
206 control reference. This reference is required for sending data
207 or removing the kernel control. This reference will be passed to
208 callbacks for that kernel control.
210 typedef void * kern_ctl_ref
;
213 @defined CTL_FLAG_PRIVILEGED
214 @discussion The CTL_FLAG_PRIVILEGED flag is passed in ctl_flags. If
215 this flag is set, only privileged processes may attach to this
218 #define CTL_FLAG_PRIVILEGED 0x1
220 @defined CTL_FLAG_REG_ID_UNIT
221 @discussion The CTL_FLAG_REG_ID_UNIT flag is passed to indicate that
222 the ctl_id specified should be used. If this flag is not
223 present, a unique ctl_id will be dynamically assigned to your
224 kernel control. The CTLIOCGINFO ioctl can be used by the client
225 to find the dynamically assigned id based on the control name
226 specified in ctl_name.
228 #define CTL_FLAG_REG_ID_UNIT 0x2
230 @defined CTL_FLAG_REG_SOCK_STREAM
231 @discussion Use the CTL_FLAG_REG_SOCK_STREAM flag when client need to open
232 socket of type SOCK_STREAM to communicate with the kernel control.
233 By default kernel control sockets are of type SOCK_DGRAM.
235 #define CTL_FLAG_REG_SOCK_STREAM 0x4
237 #ifdef KERNEL_PRIVATE
239 @defined CTL_FLAG_REG_EXTENDED
240 @discussion This flag indicates that this kernel control utilizes the
241 the extended fields within the kern_ctl_reg structure.
243 #define CTL_FLAG_REG_EXTENDED 0x8
246 @defined CTL_FLAG_REG_CRIT
247 @discussion This flag indicates that this kernel control utilizes the
248 the extended fields within the kern_ctl_reg structure.
250 #define CTL_FLAG_REG_CRIT 0x10
251 #endif /* KERNEL_PRIVATE */
253 /* Data flags for controllers */
255 @defined CTL_DATA_NOWAKEUP
256 @discussion The CTL_DATA_NOWAKEUP flag can be used for the enqueue
257 data and enqueue mbuf functions to indicate that the process
258 should not be woken up yet. This is useful when you want to
259 enqueue data using more than one call but only want to wake up
260 the client after all of the data has been enqueued.
262 #define CTL_DATA_NOWAKEUP 0x1
265 @defined CTL_DATA_EOR
266 @discussion The CTL_DATA_EOR flag can be used for the enqueue
267 data and enqueue mbuf functions to mark the end of a record.
269 #define CTL_DATA_EOR 0x2
271 #ifdef KERNEL_PRIVATE
273 @defined CTL_DATA_CRIT
274 @discussion This flag indicates the data is critical to the client
275 and that it needs to be forced into the socket buffer
276 by resizing it if needed.
278 #define CTL_DATA_CRIT 0x4
279 #endif /* KERNEL_PRIVATE */
284 @typedef ctl_connect_func
285 @discussion The ctl_connect_func is used to receive
286 notification of a client connecting to the kernel control.
287 @param kctlref The control ref for the kernel control the client is
289 @param sac The address used to connect to this control. The field sc_unit
290 contains the unit number of the kernel control instance the client is
291 connecting to. If CTL_FLAG_REG_ID_UNIT was set when the kernel control
292 was registered, sc_unit is the ctl_unit of the kern_ctl_reg structure.
293 If CTL_FLAG_REG_ID_UNIT was not set when the kernel control was
294 registered, sc_unit is the dynamically allocated unit number of
295 the new kernel control instance that is used for this connection.
296 @param unitinfo A placeholder for a pointer to the optional user-defined
297 private data associated with this kernel control instance. This
298 opaque info will be provided to the user when the rest of the
299 callback routines are executed. For example, it can be used
300 to pass a pointer to an instance-specific data structure in
301 order for the user to keep track of the states related to this
302 kernel control instance.
304 typedef errno_t (*ctl_connect_func
)(kern_ctl_ref kctlref
,
305 struct sockaddr_ctl
*sac
,
309 @typedef ctl_disconnect_func
310 @discussion The ctl_disconnect_func is used to receive notification
311 that a client has disconnected from the kernel control. This
312 usually happens when the socket is closed. If this is the last
313 socket attached to your kernel control, you may unregister your
314 kernel control from this callback.
315 @param kctlref The control ref for the kernel control instance the client has
317 @param unit The unit number of the kernel control instance the client has
319 @param unitinfo The user-defined private data initialized by the
320 ctl_connect_func callback.
322 typedef errno_t (*ctl_disconnect_func
)(kern_ctl_ref kctlref
, u_int32_t unit
, void *unitinfo
);
325 @typedef ctl_send_func
326 @discussion The ctl_send_func is used to receive data sent from
327 the client to the kernel control.
328 @param kctlref The control ref of the kernel control.
329 @param unit The unit number of the kernel control instance the client has
331 @param unitinfo The user-defined private data initialized by the
332 ctl_connect_func callback.
333 @param m The data sent by the client to the kernel control in an
334 mbuf chain. Your function is responsible for releasing the
336 @param flags The flags specified by the client when calling
337 send/sendto/sendmsg (MSG_OOB/MSG_DONTROUTE).
339 typedef errno_t (*ctl_send_func
)(kern_ctl_ref kctlref
, u_int32_t unit
, void *unitinfo
,
340 mbuf_t m
, int flags
);
343 @typedef ctl_setopt_func
344 @discussion The ctl_setopt_func is used to handle set socket option
345 calls for the SYSPROTO_CONTROL option level.
346 @param kctlref The control ref of the kernel control.
347 @param unit The unit number of the kernel control instance.
348 @param unitinfo The user-defined private data initialized by the
349 ctl_connect_func callback.
350 @param opt The socket option.
351 @param data A pointer to the socket option data. The data has
352 already been copied in to the kernel for you.
353 @param len The length of the socket option data.
355 typedef errno_t (*ctl_setopt_func
)(kern_ctl_ref kctlref
, u_int32_t unit
, void *unitinfo
,
356 int opt
, void *data
, size_t len
);
359 @typedef ctl_getopt_func
360 @discussion The ctl_getopt_func is used to handle client get socket
361 option requests for the SYSPROTO_CONTROL option level. A buffer
362 is allocated for storage and passed to your function. The length
363 of that buffer is also passed. Upon return, you should set *len
364 to length of the buffer used. In some cases, data may be NULL.
365 When this happens, *len should be set to the length you would
366 have returned had data not been NULL. If the buffer is too small,
368 @param kctlref The control ref of the kernel control.
369 @param unit The unit number of the kernel control instance.
370 @param unitinfo The user-defined private data initialized by the
371 ctl_connect_func callback.
372 @param opt The socket option.
373 @param data A buffer to copy the results in to. May be NULL, see
375 @param len A pointer to the length of the buffer. This should be set
376 to the length of the buffer used before returning.
378 typedef errno_t (*ctl_getopt_func
)(kern_ctl_ref kctlref
, u_int32_t unit
, void *unitinfo
,
379 int opt
, void *data
, size_t *len
);
381 #ifdef KERNEL_PRIVATE
383 @typedef ctl_rcvd_func
384 @discussion The ctl_rcvd_func is called when the client reads data from
385 the kernel control socket. The kernel control can use this callback
386 in combination with ctl_getenqueuespace() to avoid overflowing
387 the socket's receive buffer. When ctl_getenqueuespace() returns
388 0 or ctl_enqueuedata()/ctl_enqueuembuf() return ENOBUFS, the
389 kernel control can wait until this callback is called before
390 trying to enqueue the data again.
391 @param kctlref The control ref of the kernel control.
392 @param unit The unit number of the kernel control instance.
393 @param unitinfo The user-defined private data initialized by the
394 ctl_connect_func callback.
395 @param flags The recv flags. See the recv(2) man page.
397 typedef void (*ctl_rcvd_func
)(kern_ctl_ref kctlref
, u_int32_t unit
, void *unitinfo
,
401 @typedef ctl_send_list_func
402 @discussion The ctl_send_list_func is used to receive data sent from
403 the client to the kernel control.
404 @param kctlref The control ref of the kernel control.
405 @param unit The unit number of the kernel control instance the client has
407 @param unitinfo The user-defined private data initialized by the
408 ctl_connect_func callback.
409 @param m The data sent by the client to the kernel control in an
410 mbuf packet chain. Your function is responsible for releasing
412 @param flags The flags specified by the client when calling
413 send/sendto/sendmsg (MSG_OOB/MSG_DONTROUTE).
415 typedef errno_t (*ctl_send_list_func
)(kern_ctl_ref kctlref
, u_int32_t unit
, void *unitinfo
,
416 mbuf_t m
, int flags
);
417 #endif /* KERNEL_PRIVATE */
421 @discussion This structure defines the properties of a kernel
422 control being registered.
423 @field ctl_name A Bundle ID string of up to MAX_KCTL_NAME bytes (including the ending zero).
424 This string should not be empty.
425 @field ctl_id The control ID may be dynamically assigned or it can be a
426 32-bit creator code assigned by DTS.
427 For a DTS assigned creator code the CTL_FLAG_REG_ID_UNIT flag must be set.
428 For a dynamically assigned control ID, do not set the CTL_FLAG_REG_ID_UNIT flag.
429 The value of the dynamically assigned control ID is set to this field
430 when the registration succeeds.
431 @field ctl_unit A separate unit number to register multiple units that
432 share the same control ID with DTS assigned creator code when
433 the CTL_FLAG_REG_ID_UNIT flag is set.
434 This field is ignored for a dynamically assigned control ID.
435 @field ctl_flags CTL_FLAG_PRIVILEGED and/or CTL_FLAG_REG_ID_UNIT.
436 @field ctl_sendsize Override the default send size. If set to zero,
437 the default send size will be used, and this default value
438 is set to this field to be retrieved by the caller.
439 @field ctl_recvsize Override the default receive size. If set to
440 zero, the default receive size will be used, and this default value
441 is set to this field to be retrieved by the caller.
442 @field ctl_connect Specify the function to be called whenever a client
443 connects to the kernel control. This field must be specified.
444 @field ctl_disconnect Specify a function to be called whenever a
445 client disconnects from the kernel control.
446 @field ctl_send Specify a function to handle data send from the
447 client to the kernel control.
448 @field ctl_setopt Specify a function to handle set socket option
449 operations for the kernel control.
450 @field ctl_getopt Specify a function to handle get socket option
451 operations for the kernel control.
455 /* control information */
456 char ctl_name
[MAX_KCTL_NAME
];
460 /* control settings */
462 u_int32_t ctl_sendsize
;
463 u_int32_t ctl_recvsize
;
465 /* Dispatch functions */
466 ctl_connect_func ctl_connect
;
467 ctl_disconnect_func ctl_disconnect
;
468 ctl_send_func ctl_send
;
469 ctl_setopt_func ctl_setopt
;
470 ctl_getopt_func ctl_getopt
;
471 #ifdef KERNEL_PRIVATE
472 ctl_rcvd_func ctl_rcvd
; /* Only valid if CTL_FLAG_REG_EXTENDED is set */
473 ctl_send_list_func ctl_send_list
; /* Only valid if CTL_FLAG_REG_EXTENDED is set */
474 #endif /* KERNEL_PRIVATE */
478 @function ctl_register
479 @discussion Register a kernel control. This will enable clients to
480 connect to the kernel control using a PF_SYSTEM socket.
481 @param userkctl A structure defining the kernel control to be
482 attached. The ctl_connect callback must be specified, the other callbacks
483 are optional. If ctl_connect is set to zero, ctl_register fails with
484 the error code EINVAL.
485 @param kctlref Upon successful return, the kctlref will contain a
486 reference to the attached kernel control. This reference is used
487 to unregister the kernel control. This reference will also be
488 passed in to the callbacks each time they are called.
489 @result 0 - Kernel control was registered.
490 EINVAL - The registration structure was not valid.
491 ENOMEM - There was insufficient memory.
492 EEXIST - A controller with that id/unit is already registered.
495 ctl_register(struct kern_ctl_reg
*userkctl
, kern_ctl_ref
*kctlref
);
498 @function ctl_deregister
499 @discussion Unregister a kernel control. A kernel extension must
500 unregister it's kernel control(s) before unloading. If a kernel
501 control has clients attached, this call will fail.
502 @param kctlref The control reference of the control to unregister.
503 @result 0 - Kernel control was unregistered.
504 EINVAL - The kernel control reference was invalid.
505 EBUSY - The kernel control has clients still attached.
508 ctl_deregister(kern_ctl_ref kctlref
);
511 @function ctl_enqueuedata
512 @discussion Send data from the kernel control to the client.
513 @param kctlref The control reference of the kernel control.
514 @param unit The unit number of the kernel control instance.
515 @param data A pointer to the data to send.
516 @param len The length of data to send.
517 @param flags Send flags. CTL_DATA_NOWAKEUP and CTL_DATA_EOR are currently
518 the only supported flags.
519 @result 0 - Data was enqueued to be read by the client.
520 EINVAL - Invalid parameters.
521 EMSGSIZE - The buffer is too large.
522 ENOBUFS - The queue is full or there are no free mbufs.
525 ctl_enqueuedata(kern_ctl_ref kctlref
, u_int32_t unit
, void *data
, size_t len
, u_int32_t flags
);
528 @function ctl_enqueuembuf
529 @discussion Send data stored in an mbuf chain from the kernel
530 control to the client. The caller is responsible for freeing
531 the mbuf chain if ctl_enqueuembuf returns an error.
532 @param kctlref The control reference of the kernel control.
533 @param unit The unit number of the kernel control instance.
534 @param m An mbuf chain containing the data to send to the client.
535 @param flags Send flags. CTL_DATA_NOWAKEUP and CTL_DATA_EOR are currently
536 the only supported flags.
537 @result 0 - Data was enqueued to be read by the client.
538 EINVAL - Invalid parameters.
539 ENOBUFS - The queue is full.
542 ctl_enqueuembuf(kern_ctl_ref kctlref
, u_int32_t unit
, mbuf_t m
, u_int32_t flags
);
546 @function ctl_enqueuembuf_list
547 @discussion Send data stored in an mbuf packet chain from the kernel
548 control to the client. The caller is responsible for freeing
549 the mbuf chain if ctl_enqueuembuf returns an error.
550 Not valid if ctl_flags contains CTL_FLAG_REG_SOCK_STREAM.
551 @param kctlref The control reference of the kernel control.
552 @param unit The unit number of the kernel control instance.
553 @param m_list An mbuf chain containing the data to send to the client.
554 @param flags Send flags. CTL_DATA_NOWAKEUP is
555 the only supported flags.
556 @param m_remain A pointer to the list of mbuf packets in the chain that
557 could not be enqueued.
558 @result 0 - Data was enqueued to be read by the client.
559 EINVAL - Invalid parameters.
560 ENOBUFS - The queue is full.
563 ctl_enqueuembuf_list(kern_ctl_ref kctlref
, u_int32_t unit
, mbuf_t m_list
,
564 u_int32_t flags
, mbuf_t
*m_remain
);
567 @function ctl_getenqueuepacketcount
568 @discussion Retrieve the number of packets in the socket
570 @param kctlref The control reference of the kernel control.
571 @param unit The unit number of the kernel control instance.
572 @param pcnt The address where to return the current count.
573 @result 0 - Success; the packet count is returned to caller.
574 EINVAL - Invalid parameters.
577 ctl_getenqueuepacketcount(kern_ctl_ref kctlref
, u_int32_t unit
, u_int32_t
*pcnt
);
582 @function ctl_getenqueuespace
583 @discussion Retrieve the amount of space currently available for data to be sent
584 from the kernel control to the client.
585 @param kctlref The control reference of the kernel control.
586 @param unit The unit number of the kernel control instance.
587 @param space The address where to return the current space available
588 @result 0 - Success; the amount of space is returned to caller.
589 EINVAL - Invalid parameters.
592 ctl_getenqueuespace(kern_ctl_ref kctlref
, u_int32_t unit
, size_t *space
);
595 @function ctl_getenqueuereadable
596 @discussion Retrieve the difference between enqueued bytes and
597 low-water mark for the socket receive buffer.
598 @param kctlref The control reference of the kernel control.
599 @param unit The unit number of the kernel control instance.
600 @param difference The address at which to return the current difference
601 between the low-water mark for the socket and the number of bytes
602 enqueued. 0 indicates that the socket is readable by the client
603 (the number of bytes in the buffer is above the low-water mark).
604 @result 0 - Success; the difference is returned to caller.
605 EINVAL - Invalid parameters.
608 ctl_getenqueuereadable(kern_ctl_ref kctlref
, u_int32_t unit
, u_int32_t
*difference
);
610 #ifdef KERNEL_PRIVATE
612 #include <sys/queue.h>
613 #include <libkern/locks.h>
616 * internal structure maintained for each register controller
623 void kctl_fill_socketinfo(struct socket
*, struct socket_info
*);
625 u_int32_t
ctl_id_by_name(const char *name
);
626 errno_t
ctl_name_by_id(u_int32_t id
, char *out_name
, size_t maxsize
);
627 #endif /* KERNEL_PRIVATE */
632 #endif /* KPI_KERN_CONTROL_H */