osfmk/man/norma_port_location_hint.html

   1 <h2>norma_port_location_hint</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Guess a port's current location.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   norma_port_location_hint</strong>
   8                 <strong>(task_t</strong>                                    <var>task</var>,
   9                  <strong>mach_port_t</strong>                               <var>name</var>,
  10                  <strong>int</strong>                                       <var>node</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <p>
  15 <dt> <var>task</var>
  16 <dd>
  17 [in task send right]
  18 Task containing the right to locate
  19 <p>
  20 <dt> <var>name</var>
  21 <dd>
  22 [in scalar]
  23 Name of the right to locate
  24 <p>
  25 <dt> <var>node</var>
  26 <dd>
  27 [out scalar]
  28 Port location hint
  29 </dl>
  30 <h3>DESCRIPTION</h3>
  31 <p>
  32 The <strong>norma_port_location_hint</strong> function returns the best
  33 guess of <var>name</var>'s
  34 current location.  The hint is guaranteed to be a node where
  35 the port once was; it is
  36 guaranteed to be accurate if port has never moved.  This can be used to
  37 determine residence node for hosts, tasks, threads, etc.
  38 <h3>RETURN VALUES</h3>
  39 <p>
  40 Only generic errors apply.
  41 <h3>RELATED INFORMATION</h3>
  42 <p>
  43 Functions:
  44 <a href="norma_task_create.html"><strong>norma_task_create</strong></a>.