[apple/xnu.git] / osfmk / man / norma_get_special_port.html

<h2>norma_get_special_port</h2>\r<hr>\r<p>\r<strong>Function</strong> - Acquire a send right for a specified node-specific special port.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   norma_get_special_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>int</strong>                                       <var>node</var>,\r                 <strong>int</strong>                                 <var>which_port</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r</pre>\r<h4>Macro forms:</h4>\r<pre>\r\r<strong>#include&ltmach/norma_special_ports.h&gt</strong>\r\r<strong>kern_return_t   norma_get_device_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>int</strong>                                       <var>node</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r<strong>kern_return_t   norma_get_host_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>int</strong>                                       <var>node</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r<strong>kern_return_t   norma_get_host_priv_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>int</strong>                                       <var>node</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r\r<strong>kern_return_t   norma_get_nameserver_port</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>int</strong>                                       <var>node</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>host_priv</var> \r<dd>\r[in host-control send right]\rThe control port for the host for which to \rreturn the special port's send right.\r<p>\r<dt> <var>node</var> \r<dd>\r[in scalar]\rThe index of the node for which the port is desired.\r<p>\r<dt> <var>which_port</var> \r<dd>\r[in scalar]\rThe index of the special port for which the send right is\rrequested.  Valid values are:\r     <dl>\r       <p>\r<dt> <strong>NORMA_DEVICE_PORT</strong>\r<dd>\r[device-master send right] The device master port for the \rnode.\r<p>\r<dt> <strong>NORMA_HOST_PORT</strong>\r<dd>\r[host-name send right] The host name port for the node.\r<p>\r<dt> <strong>NORMA_HOST_PRIV_PORT</strong>\r<dd>\r[host-control send right] The host control port for the node.\r<p>\r<dt> <strong>NORMA_NAMESERVER_PORT</strong>\r<dd>\r[name-server send right] The registered name server port for \rthe node.\r</dl>\r<p>\r<dt> <var>special_port</var> \r<dd>\r[out norma-special send right]\rThe returned value for the port.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>norma_get_special_port</strong> function returns a send\rright for a special port belonging to <var>node</var> on <var>host_priv</var>.\r<p>\rEach node maintains a (small) set of node specific ports.  The device master \rport,  host name, and host control ports are\rmaintained by the kernel.  The kernel also permits a small set\rof server specified \rnode specific ports; the name server port is an example and is given (by\rconvention) an assigned special port index.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_host_self.html"><strong>mach_host_self</strong></a>,\r<a href="norma_set_special_port.html"><strong>norma_get_special_port</strong></a>,\r<a href="bootstrap_ports.html"><strong>bootstrap_ports</strong></a>.\r