X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/743b15655a24ee3fe9f458f383003e011db0558f..13fec9890cf095cc781fdf7b8917cb03bf32dd4c:/osfmk/man/thread_set_policy.html diff --git a/osfmk/man/thread_set_policy.html b/osfmk/man/thread_set_policy.html index ea36db885..5bdc54d44 100755 --- a/osfmk/man/thread_set_policy.html +++ b/osfmk/man/thread_set_policy.html @@ -1 +1,82 @@ -

thread_set_policy


Function - Set target thread's scheduling policy state. (Protected Interface.)

SYNOPSIS

kern_return_t   thread_set_policy
                (thread_act_t                            thread,
                 processor_set_t                  processor_set,
                 policy_t                                policy,
                 policy_base_t                             base,
                 mach_msg_type_number_t              base_count,
                 policy_limit_t                           limit,
                 mach_msg_type_number_              limit_count);

PARAMETERS

thread
[in thread send right] The thread scheduling policy is to be set.

processor_set
[in processor-set-control send right] The control port for the processor set to which the thread is currently assigned.

policy
[in scalar] Policy to be set. The values currently defined are POLICY_TIMESHARE, POLICY_RR (round robin) and POLICY_FIFO (firstin, first-out).

base
[pointer to in structure] Base policy specific data, policy_fifo_base, policy_rr_base or policy_timeshare_base.

base_count
[in scalar] The size of the buffer (in natural-sized units).

limit
[pointer to in structure] Policy specific limits, policy_fifo_limit, policy_rr_limit or policy_timeshare_limit.

limit_count
[in scalar] The size of the buffer (in natural-sized units).

DESCRIPTION

The thread_set_policy function sets the scheduling attributes, both base and limit, for thread. policy may be any policy implemented by the processor set whether or not it is enabled.

RETURN VALUES

KERN_INVALID_PROCESSOR_SET
processor_set is not the thread's processor set control port.

RELATED INFORMATION

Functions: processor_set_policy_control, thread_policy, task_policy, task_set_policy.

Data Structures: policy_fifo_info, policy_rr_info, policy_timeshare_info. \ No newline at end of file +

thread_set_policy

+
+

+Function - Set target thread's scheduling policy state. (Protected Interface.) +

SYNOPSIS

+
+kern_return_t   thread_set_policy
+                (thread_act_t                            thread,
+                 processor_set_t                  processor_set,
+                 policy_t                                policy,
+                 policy_base_t                             base,
+                 mach_msg_type_number_t              base_count,
+                 policy_limit_t                           limit,
+                 mach_msg_type_number_              limit_count);
+
+

PARAMETERS

+
+

+

thread +
+[in thread send right] +The thread scheduling policy is to be set. +

+

processor_set +
+[in processor-set-control send right] +The control port for the processor +set to which the thread is currently assigned. +

+

policy +
+[in scalar] +Policy to be set. The values currently defined are POLICY_TIMESHARE, +POLICY_RR (round robin) and POLICY_FIFO (firstin, first-out). +

+

base +
+[pointer to in structure] +Base policy specific data, policy_fifo_base, +policy_rr_base or policy_timeshare_base. +

+

base_count +
+[in scalar] +The size of the buffer (in natural-sized units). +

+

limit +
+[pointer to in structure] +Policy specific limits, policy_fifo_limit, +policy_rr_limit or policy_timeshare_limit. +

+

limit_count +
+[in scalar] +The size of the buffer (in natural-sized units). +
+

DESCRIPTION

+

+The thread_set_policy function sets the scheduling +attributes, both base and limit, for thread. +policy may be any policy implemented by the processor set +whether or not it is enabled. +

RETURN VALUES

+
+

+

KERN_INVALID_PROCESSOR_SET +
+processor_set is not the thread's processor set control port. +
+

RELATED INFORMATION

+

+Functions: +processor_set_policy_control, +thread_policy, +task_policy, +task_set_policy. +

+Data Structures: +policy_fifo_info, +policy_rr_info, +policy_timeshare_info.