xnu-7195.101.1.tar.gz

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

diff --git a/osfmk/man/policy_fifo_info.html b/osfmk/man/policy_fifo_info.html
old mode 100755 (executable)
new mode 100644 (file)
index 2e8acea..32ba90c
--- a/osfmk/man/policy_fifo_info.html
+++ b/osfmk/man/policy_fifo_info.html
@@ -1 +1,75 @@
-<h2>policy_fifo_info</h2>\r<hr>\r<p>\r<strong>Structure</strong> - Specifies information associated with the system's First-In-First-Out scheduling policy.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>struct policy_fifo_limit</strong>\r<strong>{</strong>\r       <strong>int</strong>                    <var>max_priority</var><strong>;</strong>\r<strong>};</strong>\r\r<strong>struct policy_fifo_base</strong>\r<strong>{</strong>\r       <strong>int</strong>                  <var>base_priority</var><strong>;</strong>\r<strong>};</strong>\r\r<strong>struct policy_fifo_info</strong>\r<strong>{</strong>\r       <strong>int</strong>                   <var>max_priority</var><strong>;</strong>\r       <strong>int</strong>                  <var>base_priority</var><strong>;</strong>\r       <strong>boolean_t</strong>                <var>depressed</var><strong>;</strong>\r       <strong>int</strong>               <var>depress_priority</var><strong>;</strong>\r<strong>};</strong>\r</pre>\r<h3>FIELDS</h3>\r<dl>\r<dt> <var>max_priority</var>\r<dd>\rMaximum scheduling priority\r<p>\r<dt> <var>base_priority</var>\r<dd>\rScheduling priority\r<p>\r<dt> <var>depressed</var>\r<dd>\rTrue if scheduling priority is depressed\r<p>\r<dt> <var>depress_priority</var>\r<dd>\rScheduling priority from which depressed\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>policy_fifo_info</strong> structure defines the first-in-first-out\rscheduling policy information.\rFIFO threads have two priorities associated with them by the system:\r<ul>\r  <p>\r<li>\rA maximum priority value which can be raised only via privileged operation \rso that users may not unfairly compete with other users in their processor \rset.  Newly created threads obtain their maximum priority from that of their \rassigned processor set.\r     <p>\r<li>\rA priority value which can be set by the thread to any value up to a\rmaximum priority.  Newly created threads obtain their priority from their task.\r</ul>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="thread_info.html"><strong>thread_info</strong></a>,\r<a href="task_info.html"><strong>task_info</strong></a>,\r<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,\r<a href="P_set_policy_control.html"><strong>processor_set_policy_control</strong></a>,\r<a href="P_set_policy_disable.html"><strong>processor_set_policy_disable</strong></a>,\r<a href="P_set_policy_enable.html"><strong>processor_set_policy_enable</strong></a>,\r<a href="task_policy.html"><strong>task_policy</strong></a>,\r<a href="thread_policy.html"><strong>thread_policy</strong></a>,\r<a href="thread_set_policy.html"><strong>thread_set_policy</strong></a>.\r<p>\rData Structures:\r<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,\r<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.\r
\ No newline at end of file
+<h2>policy_fifo_info</h2>
+<hr>
+<p>
+<strong>Structure</strong> - Specifies information associated with the system's First-In-First-Out scheduling policy.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>struct policy_fifo_limit</strong>
+<strong>{</strong>
+       <strong>int</strong>                    <var>max_priority</var><strong>;</strong>
+<strong>};</strong>
+
+<strong>struct policy_fifo_base</strong>
+<strong>{</strong>
+       <strong>int</strong>                  <var>base_priority</var><strong>;</strong>
+<strong>};</strong>
+
+<strong>struct policy_fifo_info</strong>
+<strong>{</strong>
+       <strong>int</strong>                   <var>max_priority</var><strong>;</strong>
+       <strong>int</strong>                  <var>base_priority</var><strong>;</strong>
+       <strong>boolean_t</strong>                <var>depressed</var><strong>;</strong>
+       <strong>int</strong>               <var>depress_priority</var><strong>;</strong>
+<strong>};</strong>
+</pre>
+<h3>FIELDS</h3>
+<dl>
+<dt> <var>max_priority</var>
+<dd>
+Maximum scheduling priority
+<p>
+<dt> <var>base_priority</var>
+<dd>
+Scheduling priority
+<p>
+<dt> <var>depressed</var>
+<dd>
+True if scheduling priority is depressed
+<p>
+<dt> <var>depress_priority</var>
+<dd>
+Scheduling priority from which depressed
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>policy_fifo_info</strong> structure defines the first-in-first-out
+scheduling policy information.
+FIFO threads have two priorities associated with them by the system:
+<ul>
+  <p>
+<li>
+A maximum priority value which can be raised only via privileged operation 
+so that users may not unfairly compete with other users in their processor 
+set.  Newly created threads obtain their maximum priority from that of their 
+assigned processor set.
+     <p>
+<li>
+A priority value which can be set by the thread to any value up to a
+maximum priority.  Newly created threads obtain their priority from their task.
+</ul>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="thread_info.html"><strong>thread_info</strong></a>,
+<a href="task_info.html"><strong>task_info</strong></a>,
+<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
+<a href="P_set_policy_control.html"><strong>processor_set_policy_control</strong></a>,
+<a href="P_set_policy_disable.html"><strong>processor_set_policy_disable</strong></a>,
+<a href="P_set_policy_enable.html"><strong>processor_set_policy_enable</strong></a>,
+<a href="task_policy.html"><strong>task_policy</strong></a>,
+<a href="thread_policy.html"><strong>thread_policy</strong></a>,
+<a href="thread_set_policy.html"><strong>thread_set_policy</strong></a>.
+<p>
+Data Structures:
+<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,
+<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.