xnu-3789.31.2.tar.gz

[apple/xnu.git] / bsd / sys / kern_control.h

diff --git a/bsd/sys/kern_control.h b/bsd/sys/kern_control.h
index f032e79a2455e9d5fd2706a0f555d4c9107ebc48..ba5f6be3778f77a2e2997f40389f2af62fb5cc2c 100644 (file)
--- a/bsd/sys/kern_control.h
+++ b/bsd/sys/kern_control.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2004, 2012-2016 Apple Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.

  * 
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*!
        @header kern_control.h
  */
 /*!
        @header kern_control.h


@@ -129,14 +135,66 @@ struct ctl_info {
        @field sc_reserved Reserved, must be set to zero.
 */
 struct sockaddr_ctl {
        @field sc_reserved Reserved, must be set to zero.
 */
 struct sockaddr_ctl {

-    u_char             sc_len;         /* depends on size of bundle ID string */
-    u_char             sc_family;      /* AF_SYSTEM */
+    u_char     sc_len;         /* depends on size of bundle ID string */
+    u_char     sc_family;      /* AF_SYSTEM */

     u_int16_t  ss_sysaddr;     /* AF_SYS_KERNCONTROL */
     u_int32_t  sc_id;          /* Controller unique identifier  */
     u_int32_t  sc_unit;        /* Developer private unit number */
     u_int32_t  sc_reserved[5];
 };
 
     u_int16_t  ss_sysaddr;     /* AF_SYS_KERNCONTROL */
     u_int32_t  sc_id;          /* Controller unique identifier  */
     u_int32_t  sc_unit;        /* Developer private unit number */
     u_int32_t  sc_reserved[5];
 };
 

+#ifdef PRIVATE
+
+struct xkctl_reg {
+       u_int32_t       xkr_len;
+       u_int32_t       xkr_kind;
+       u_int32_t       xkr_id;
+       u_int32_t       xkr_reg_unit;
+       u_int32_t       xkr_flags;
+       u_int64_t       xkr_kctlref;
+       u_int32_t       xkr_recvbufsize;
+       u_int32_t       xkr_sendbufsize;
+       u_int32_t       xkr_lastunit;
+       u_int32_t       xkr_pcbcount;
+       u_int64_t       xkr_connect;
+       u_int64_t       xkr_disconnect;
+       u_int64_t       xkr_send;
+       u_int64_t       xkr_send_list;
+       u_int64_t       xkr_setopt;
+       u_int64_t       xkr_getopt;
+       u_int64_t       xkr_rcvd;
+       char            xkr_name[MAX_KCTL_NAME];
+};
+
+struct xkctlpcb {
+       u_int32_t       xkp_len;
+       u_int32_t       xkp_kind;
+       u_int64_t       xkp_kctpcb;
+       u_int32_t       xkp_unit;
+       u_int32_t       xkp_kctlid;
+       u_int64_t       xkp_kctlref;
+       char            xkp_kctlname[MAX_KCTL_NAME];
+};
+
+struct kctlstat {
+       u_int64_t       kcs_reg_total __attribute__((aligned(8)));
+       u_int64_t       kcs_reg_count __attribute__((aligned(8)));
+       u_int64_t       kcs_pcbcount __attribute__((aligned(8)));
+       u_int64_t       kcs_gencnt __attribute__((aligned(8)));
+       u_int64_t       kcs_connections __attribute__((aligned(8)));
+       u_int64_t       kcs_conn_fail __attribute__((aligned(8)));
+       u_int64_t       kcs_send_fail __attribute__((aligned(8)));
+       u_int64_t       kcs_send_list_fail __attribute__((aligned(8)));
+       u_int64_t       kcs_enqueue_fail __attribute__((aligned(8)));
+       u_int64_t       kcs_enqueue_fullsock __attribute__((aligned(8)));
+       u_int64_t       kcs_bad_kctlref __attribute__((aligned(8)));
+       u_int64_t       kcs_tbl_size_too_big __attribute__((aligned(8)));
+       u_int64_t       kcs_enqdata_mb_alloc_fail __attribute__((aligned(8)));
+       u_int64_t       kcs_enqdata_sbappend_fail __attribute__((aligned(8)));
+};
+
+#endif /* PRIVATE */
+

 #ifdef KERNEL
 
 #include <sys/kpi_mbuf.h>
 #ifdef KERNEL
 
 #include <sys/kpi_mbuf.h>


@@ -176,6 +234,22 @@ typedef void * kern_ctl_ref;
 */
 #define CTL_FLAG_REG_SOCK_STREAM       0x4
 
 */
 #define CTL_FLAG_REG_SOCK_STREAM       0x4
 

+#ifdef KERNEL_PRIVATE
+/*!
+       @defined CTL_FLAG_REG_EXTENDED
+    @discussion This flag indicates that this kernel control utilizes the
+       the extended fields within the kern_ctl_reg structure.
+*/
+#define CTL_FLAG_REG_EXTENDED  0x8
+
+/*!
+       @defined CTL_FLAG_REG_CRIT
+    @discussion This flag indicates that this kernel control utilizes the
+       the extended fields within the kern_ctl_reg structure.
+*/
+#define CTL_FLAG_REG_CRIT      0x10
+#endif /* KERNEL_PRIVATE */
+

 /* Data flags for controllers */
 /*!
        @defined CTL_DATA_NOWAKEUP
 /* Data flags for controllers */
 /*!
        @defined CTL_DATA_NOWAKEUP


@@ -186,13 +260,26 @@ typedef void * kern_ctl_ref;
        the client after all of the data has been enqueued.
 */
 #define CTL_DATA_NOWAKEUP      0x1
        the client after all of the data has been enqueued.
 */
 #define CTL_DATA_NOWAKEUP      0x1

+

 /*!
        @defined CTL_DATA_EOR
 /*!
        @defined CTL_DATA_EOR

-    @discussion The CTL_DATA_NOWAKEUP flag can be used for the enqueue
+    @discussion The CTL_DATA_EOR flag can be used for the enqueue

        data and enqueue mbuf functions to mark the end of a record.
 */
 #define CTL_DATA_EOR           0x2
 
        data and enqueue mbuf functions to mark the end of a record.
 */
 #define CTL_DATA_EOR           0x2
 

+#ifdef KERNEL_PRIVATE
+/*!
+       @defined CTL_DATA_CRIT
+       @discussion This flag indicates the data is critical to the client
+               and that it needs to be forced into the socket buffer
+               by resizing it if needed.
+*/
+#define CTL_DATA_CRIT  0x4
+#endif /* KERNEL_PRIVATE */
+
+__BEGIN_DECLS
+

 /*!
        @typedef ctl_connect_func
        @discussion The ctl_connect_func is used to receive
 /*!
        @typedef ctl_connect_func
        @discussion The ctl_connect_func is used to receive


@@ -206,8 +293,13 @@ typedef void * kern_ctl_ref;
                If CTL_FLAG_REG_ID_UNIT was not set when the kernel control was 
                registered, sc_unit is the dynamically allocated unit number of 
                the new kernel control instance that is used for this connection.
                If CTL_FLAG_REG_ID_UNIT was not set when the kernel control was 
                registered, sc_unit is the dynamically allocated unit number of 
                the new kernel control instance that is used for this connection.

-       @param unitinfo A place for the kernel control to store a pointer to
-               per-connection data.
+       @param unitinfo A placeholder for a pointer to the optional user-defined
+               private data associated with this kernel control instance.  This
+               opaque info will be provided to the user when the rest of the
+               callback routines are executed.  For example, it can be used
+               to pass a pointer to an instance-specific data structure in
+               order for the user to keep track of the states related to this
+               kernel control instance.

  */
 typedef errno_t (*ctl_connect_func)(kern_ctl_ref kctlref, 
                                                                        struct sockaddr_ctl *sac,
  */
 typedef errno_t (*ctl_connect_func)(kern_ctl_ref kctlref, 
                                                                        struct sockaddr_ctl *sac,


@@ -224,8 +316,8 @@ typedef errno_t (*ctl_connect_func)(kern_ctl_ref kctlref,
                disconnected from.
        @param unit The unit number of the kernel control instance the client has
                disconnected from.  
                disconnected from.
        @param unit The unit number of the kernel control instance the client has
                disconnected from.  

-       @param unitinfo The unitinfo value specified by the connect function
-               when the client connected.
+       @param unitinfo The user-defined private data initialized by the
+               ctl_connect_func callback.

  */
 typedef errno_t (*ctl_disconnect_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo);
 
  */
 typedef errno_t (*ctl_disconnect_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo);
 


@@ -236,9 +328,10 @@ typedef errno_t (*ctl_disconnect_func)(kern_ctl_ref kctlref, u_int32_t unit, voi
        @param kctlref The control ref of the kernel control.
        @param unit The unit number of the kernel control instance the client has
                connected to.
        @param kctlref The control ref of the kernel control.
        @param unit The unit number of the kernel control instance the client has
                connected to.

-       @param unitinfo The unitinfo value specified by the connect function
-               when the client connected.
+       @param unitinfo The user-defined private data initialized by the
+               ctl_connect_func callback.

        @param m The data sent by the client to the kernel control in an
        @param m The data sent by the client to the kernel control in an

+               mbuf chain. Your function is responsible for releasing the

                mbuf chain.
        @param flags The flags specified by the client when calling
                send/sendto/sendmsg (MSG_OOB/MSG_DONTROUTE).
                mbuf chain.
        @param flags The flags specified by the client when calling
                send/sendto/sendmsg (MSG_OOB/MSG_DONTROUTE).


@@ -252,8 +345,8 @@ typedef errno_t (*ctl_send_func)(kern_ctl_ref kctlref, u_int32_t unit, void *uni
                calls for the SYSPROTO_CONTROL option level.
        @param kctlref The control ref of the kernel control.
        @param unit The unit number of the kernel control instance.
                calls for the SYSPROTO_CONTROL option level.
        @param kctlref The control ref of the kernel control.
        @param unit The unit number of the kernel control instance.

-       @param unitinfo The unitinfo value specified by the connect function
-               when the client connected.
+       @param unitinfo The user-defined private data initialized by the
+               ctl_connect_func callback.

        @param opt The socket option.
        @param data A pointer to the socket option data. The data has
                already been copied in to the kernel for you.
        @param opt The socket option.
        @param data A pointer to the socket option data. The data has
                already been copied in to the kernel for you.


@@ -274,8 +367,8 @@ typedef errno_t (*ctl_setopt_func)(kern_ctl_ref kctlref, u_int32_t unit, void *u
                return an error.
        @param kctlref The control ref of the kernel control.
        @param unit The unit number of the kernel control instance.
                return an error.
        @param kctlref The control ref of the kernel control.
        @param unit The unit number of the kernel control instance.

-       @param unitinfo The unitinfo value specified by the connect function
-               when the client connected.
+       @param unitinfo The user-defined private data initialized by the
+               ctl_connect_func callback.

        @param opt The socket option.
        @param data A buffer to copy the results in to. May be NULL, see
                discussion.
        @param opt The socket option.
        @param data A buffer to copy the results in to. May be NULL, see
                discussion.


@@ -285,6 +378,44 @@ typedef errno_t (*ctl_setopt_func)(kern_ctl_ref kctlref, u_int32_t unit, void *u
 typedef errno_t (*ctl_getopt_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo,
                                                                   int opt, void *data, size_t *len);
 
 typedef errno_t (*ctl_getopt_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo,
                                                                   int opt, void *data, size_t *len);
 

+#ifdef KERNEL_PRIVATE
+/*!
+       @typedef ctl_rcvd_func
+       @discussion The ctl_rcvd_func is called when the client reads data from
+               the kernel control socket. The kernel control can use this callback
+               in combination with ctl_getenqueuespace() to avoid overflowing
+               the socket's receive buffer. When ctl_getenqueuespace() returns
+               0 or ctl_enqueuedata()/ctl_enqueuembuf() return ENOBUFS, the
+               kernel control can wait until this callback is called before
+               trying to enqueue the data again.
+       @param kctlref The control ref of the kernel control.
+       @param unit The unit number of the kernel control instance.
+       @param unitinfo The user-defined private data initialized by the
+               ctl_connect_func callback.
+       @param flags The recv flags. See the recv(2) man page.
+ */
+typedef void (*ctl_rcvd_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo,
+                               int flags);
+
+/*!
+       @typedef ctl_send_list_func
+       @discussion The ctl_send_list_func is used to receive data sent from
+               the client to the kernel control.
+       @param kctlref The control ref of the kernel control.
+       @param unit The unit number of the kernel control instance the client has
+               connected to.
+       @param unitinfo The user-defined private data initialized by the
+               ctl_connect_func callback.
+       @param m The data sent by the client to the kernel control in an
+               mbuf packet chain. Your function is responsible for releasing 
+               mbuf packet chain.
+       @param flags The flags specified by the client when calling
+               send/sendto/sendmsg (MSG_OOB/MSG_DONTROUTE).
+ */
+typedef errno_t (*ctl_send_list_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo,
+                                       mbuf_t m, int flags);
+#endif /* KERNEL_PRIVATE */
+

 /*!
        @struct kern_ctl_reg
        @discussion This structure defines the properties of a kernel
 /*!
        @struct kern_ctl_reg
        @discussion This structure defines the properties of a kernel


@@ -337,6 +468,10 @@ struct kern_ctl_reg
     ctl_send_func              ctl_send;
     ctl_setopt_func            ctl_setopt;
     ctl_getopt_func            ctl_getopt;
     ctl_send_func              ctl_send;
     ctl_setopt_func            ctl_setopt;
     ctl_getopt_func            ctl_getopt;

+#ifdef KERNEL_PRIVATE
+    ctl_rcvd_func              ctl_rcvd;       /* Only valid if CTL_FLAG_REG_EXTENDED is set */
+    ctl_send_list_func         ctl_send_list;  /* Only valid if CTL_FLAG_REG_EXTENDED is set */
+#endif /* KERNEL_PRIVATE */

 };
 
 /*!
 };
 
 /*!


@@ -379,8 +514,8 @@ ctl_deregister(kern_ctl_ref kctlref);
        @param unit The unit number of the kernel control instance.
        @param data A pointer to the data to send.
        @param len The length of data to send.
        @param unit The unit number of the kernel control instance.
        @param data A pointer to the data to send.
        @param len The length of data to send.

-       @param flags Send flags. CTL_DATA_NOWAKEUP is currently the only
-               supported flag.
+       @param flags Send flags. CTL_DATA_NOWAKEUP and CTL_DATA_EOR are currently
+               the only supported flags.

        @result 0 - Data was enqueued to be read by the client.
                EINVAL - Invalid parameters.
                EMSGSIZE - The buffer is too large.
        @result 0 - Data was enqueued to be read by the client.
                EINVAL - Invalid parameters.
                EMSGSIZE - The buffer is too large.


@@ -397,8 +532,8 @@ ctl_enqueuedata(kern_ctl_ref kctlref, u_int32_t unit, void *data, size_t len, u_
        @param kctlref The control reference of the kernel control.
        @param unit The unit number of the kernel control instance.
        @param m An mbuf chain containing the data to send to the client.
        @param kctlref The control reference of the kernel control.
        @param unit The unit number of the kernel control instance.
        @param m An mbuf chain containing the data to send to the client.

-       @param flags Send flags. CTL_DATA_NOWAKEUP is currently the only
-               supported flag.
+       @param flags Send flags. CTL_DATA_NOWAKEUP and CTL_DATA_EOR are currently
+               the only supported flags.

        @result 0 - Data was enqueued to be read by the client.
                EINVAL - Invalid parameters.
                ENOBUFS - The queue is full.
        @result 0 - Data was enqueued to be read by the client.
                EINVAL - Invalid parameters.
                ENOBUFS - The queue is full.


@@ -406,6 +541,42 @@ ctl_enqueuedata(kern_ctl_ref kctlref, u_int32_t unit, void *data, size_t len, u_
 errno_t 
 ctl_enqueuembuf(kern_ctl_ref kctlref, u_int32_t unit, mbuf_t m, u_int32_t flags);
 
 errno_t 
 ctl_enqueuembuf(kern_ctl_ref kctlref, u_int32_t unit, mbuf_t m, u_int32_t flags);
 

+#ifdef PRIVATE
+/*!
+       @function ctl_enqueuembuf_list
+       @discussion Send data stored in an mbuf packet chain from the kernel
+               control to the client. The caller is responsible for freeing
+               the mbuf chain if ctl_enqueuembuf returns an error.
+               Not valid if ctl_flags contains CTL_FLAG_REG_SOCK_STREAM.
+       @param kctlref The control reference of the kernel control.
+       @param unit The unit number of the kernel control instance.
+       @param m_list An mbuf chain containing the data to send to the client.
+       @param flags Send flags. CTL_DATA_NOWAKEUP is
+               the only supported flags.
+       @param m_remain A pointer to the list of mbuf packets in the chain that
+               could not be enqueued.  
+       @result 0 - Data was enqueued to be read by the client.
+               EINVAL - Invalid parameters.
+               ENOBUFS - The queue is full.
+ */
+errno_t 
+ctl_enqueuembuf_list(kern_ctl_ref kctlref, u_int32_t unit, mbuf_t m_list,
+       u_int32_t flags, mbuf_t *m_remain);
+
+/*!
+       @function ctl_getenqueuepacketcount
+       @discussion Retrieve the number of packets in the socket
+               receive buffer.
+       @param kctlref The control reference of the kernel control.
+       @param unit The unit number of the kernel control instance.
+       @param pcnt The address where to return the current count. 
+       @result 0 - Success; the packet count is returned to caller.
+               EINVAL - Invalid parameters.
+ */
+errno_t
+ctl_getenqueuepacketcount(kern_ctl_ref kctlref, u_int32_t unit, u_int32_t *pcnt);
+
+#endif /* PRIVATE */

 
 /*!
        @function ctl_getenqueuespace
 
 /*!
        @function ctl_getenqueuespace


@@ -414,13 +585,48 @@ ctl_enqueuembuf(kern_ctl_ref kctlref, u_int32_t unit, mbuf_t m, u_int32_t flags)
        @param kctlref The control reference of the kernel control.
        @param unit The unit number of the kernel control instance.
        @param space The address where to return the current space available 
        @param kctlref The control reference of the kernel control.
        @param unit The unit number of the kernel control instance.
        @param space The address where to return the current space available 

-       @result 0 - Data was enqueued to be read by the client.
+       @result 0 - Success; the amount of space is returned to caller.

                EINVAL - Invalid parameters.
  */
 errno_t 
 ctl_getenqueuespace(kern_ctl_ref kctlref, u_int32_t unit, size_t *space);
 
                EINVAL - Invalid parameters.
  */
 errno_t 
 ctl_getenqueuespace(kern_ctl_ref kctlref, u_int32_t unit, size_t *space);
 

+/*!
+ @function ctl_getenqueuereadable
+ @discussion Retrieve the difference between enqueued bytes and
+       low-water mark for the socket receive buffer.
+ @param kctlref The control reference of the kernel control.
+ @param unit The unit number of the kernel control instance.
+ @param difference The address at which to return the current difference
+       between the low-water mark for the socket and the number of bytes
+       enqueued. 0 indicates that the socket is readable by the client
+       (the number of bytes in the buffer is above the low-water mark).
+ @result 0 - Success; the difference is returned to caller.
+ EINVAL - Invalid parameters.
+ */
+errno_t
+ctl_getenqueuereadable(kern_ctl_ref kctlref, u_int32_t unit, u_int32_t *difference);
+
+#ifdef KERNEL_PRIVATE
+
+#include <sys/queue.h>
+#include <libkern/locks.h>
+
+/*
+ * internal structure maintained for each register controller
+ */
+struct ctl_cb;
+struct kctl;
+struct socket;
+struct socket_info;
+
+void kctl_fill_socketinfo(struct socket *, struct socket_info *);
+
+u_int32_t ctl_id_by_name(const char *name);
+errno_t ctl_name_by_id(u_int32_t id, char *out_name, size_t maxsize);
+#endif /* KERNEL_PRIVATE */

 
 

+__END_DECLS

 #endif /* KERNEL */
 
 #endif /* KPI_KERN_CONTROL_H */
 #endif /* KERNEL */
 
 #endif /* KPI_KERN_CONTROL_H */