+#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
+ notification of a client connecting to the kernel control.
+ @param kctlref The control ref for the kernel control the client is
+ connecting to.
+ @param sac The address used to connect to this control. The field sc_unit
+ contains the unit number of the kernel control instance the client is
+ connecting to. If CTL_FLAG_REG_ID_UNIT was set when the kernel control
+ was registered, sc_unit is the ctl_unit of the kern_ctl_reg structure.
+ 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 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,
+ void **unitinfo);
+
+/*!
+ @typedef ctl_disconnect_func
+ @discussion The ctl_disconnect_func is used to receive notification
+ that a client has disconnected from the kernel control. This
+ usually happens when the socket is closed. If this is the last
+ socket attached to your kernel control, you may unregister your
+ kernel control from this callback.
+ @param kctlref The control ref for the kernel control instance the client has
+ disconnected from.
+ @param unit The unit number of the kernel control instance the client has
+ disconnected from.
+ @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 ctl_send_func
+ @discussion The ctl_send_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 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).
+ */
+typedef errno_t (*ctl_send_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo,
+ mbuf_t m, int flags);
+
+/*!
+ @typedef ctl_setopt_func
+ @discussion The ctl_setopt_func is used to handle set socket option
+ 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 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 len The length of the socket option data.
+ */
+typedef errno_t (*ctl_setopt_func)(kern_ctl_ref kctlref, u_int32_t unit, void *unitinfo,
+ int opt, void *data, size_t len);
+
+/*!
+ @typedef ctl_getopt_func
+ @discussion The ctl_getopt_func is used to handle client get socket
+ option requests for the SYSPROTO_CONTROL option level. A buffer
+ is allocated for storage and passed to your function. The length
+ of that buffer is also passed. Upon return, you should set *len
+ to length of the buffer used. In some cases, data may be NULL.
+ When this happens, *len should be set to the length you would
+ have returned had data not been NULL. If the buffer is too small,
+ 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 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 len A pointer to the length of the buffer. This should be set
+ to the length of the buffer used before returning.
+ */
+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.
projects / apple / xnu.git / blobdiff