Go to the first, previous, next, last section, table of contents.
host_processor_sets gets send rights to the name
port for each processor set currently assigned to host.
host_processor_set_priv can be used to obtain the control ports
from these if desired. processor_sets is an array that is
created as a result of this call. The caller may wish to
vm_deallocate this array when the data is no longer needed.
processor_sets_count is set to the number of processor sets in the
processor_sets.
This function returns KERN_SUCCESS if the call succeeded and
KERN_INVALID_ARGUMENT if host is not a host.
host_processor_set_priv allows a privileged
application to obtain the control port set for an existing
processor set from its name port set_name. The privileged host
port host_priv is required.
This function returns KERN_SUCCESS if the call succeeded and
KERN_INVALID_ARGUMENT if host_priv is not a valid host
control port.
processor_set_default returns the default processor
set of host in default_set. The default processor set is
used by all threads, tasks, and processors that are not explicitly
assigned to other sets. processor_set_default returns a port that can
be used to obtain information about this set (e.g. how many threads are
assigned to it). This port cannot be used to perform operations on that
set.
This function returns KERN_SUCCESS if the call succeeded,
KERN_INVALID_ARGUMENT if host is not a host and
KERN_INVALID_ADDRESS if default_set points to
inaccessible memory.
processor_set_create creates a new processor set on
host and returns the two ports associated with it. The port
returned in new_set is the actual port representing the set. It
is used to perform operations such as assigning processors, tasks, or
threads. The port returned in new_name identifies the set, and is
used to obtain information about the set.
This function returns KERN_SUCCESS if the call succeeded,
KERN_INVALID_ARGUMENT if host is not a host,
KERN_INVALID_ADDRESS if new_set or new_name points to
inaccessible memory and KERN_FAILURE is the operating system does
not support processor allocation.
processor_set_destroy destroys the specified
processor set. Any assigned processors, tasks, or threads are
reassigned to the default set. The object port for the processor set is
required (not the name port). The default processor set cannot be
destroyed.
This function returns KERN_SUCCESS if the set was destroyed,
KERN_FAILURE if an attempt was made to destroy the default
processor set, or the operating system does not support processor
allocation, and KERN_INVALID_ARGUMENT if processor_set is
not a valid processor set control port.
processor_set_tasks gets send rights to the kernel
port for each task currently assigned to processor_set.
task_list is an array that is created as a result of this call.
The caller may wish to vm_deallocate this array when the data is
no longer needed. task_count is set to the number of tasks in the
task_list.
This function returns KERN_SUCCESS if the call succeeded and
KERN_INVALID_ARGUMENT if processor_set is not a processor
set.
processor_set_thread gets send rights to the kernel
port for each thread currently assigned to processor_set.
thread_list is an array that is created as a result of this call.
The caller may wish to vm_deallocate this array when the data is
no longer needed. thread_count is set to the number of threads in
the thread_list.
This function returns KERN_SUCCESS if the call succeeded and
KERN_INVALID_ARGUMENT if processor_set is not a processor
set.
task_assign assigns task the set
processor_set. This assignment is for the purposes of determining
the initial assignment of newly created threads in task. Any previous
assignment of the task is nullified. Existing threads within the task
are also reassigned if assign_threads is TRUE. They are
not affected if it is FALSE.
This function returns KERN_SUCCESS if the assignment has been
performed and KERN_INVALID_ARGUMENT if task is not a task,
or processor_set is not a processor set on the same host as
task.
task_assign_default is a variant of
task_assign that assigns the task to the default processor set on
that task's host. This variant exists because the control port for the
default processor set is privileged and not ususally available to users.
This function returns KERN_SUCCESS if the assignment has been
performed and KERN_INVALID_ARGUMENT if task is not a task.
task_get_assignment returns the name of the
processor set to which the thread is currently assigned in
processor_set. This port can only be used to obtain information
about the processor set.
This function returns KERN_SUCCESS if the assignment has been
performed, KERN_INVALID_ADDRESS if processor_set points to
inaccessible memory, and KERN_INVALID_ARGUMENT if task is
not a task.
thread_assign assigns thread the set
processor_set. After the assignment is completed, the thread only
executes on processors assigned to the designated processor set. If
there are no such processors, then the thread is unable to execute. Any
previous assignment of the thread is nullified. Unix system call
compatibility code may temporarily force threads to execute on the
master processor.
This function returns KERN_SUCCESS if the assignment has been
performed and KERN_INVALID_ARGUMENT if thread is not a
thread, or processor_set is not a processor set on the same host
as thread.
thread_assign_default is a variant of
thread_assign that assigns the thread to the default processor
set on that thread's host. This variant exists because the control port
for the default processor set is privileged and not ususally available
to users.
This function returns KERN_SUCCESS if the assignment has been
performed and KERN_INVALID_ARGUMENT if thread is not a
thread.
thread_get_assignment returns the name of the
processor set to which the thread is currently assigned in
processor_set. This port can only be used to obtain information
about the processor set.
This function returns KERN_SUCCESS if the assignment has been
performed, KERN_INVALID_ADDRESS if processor_set points to
inaccessible memory, and KERN_INVALID_ARGUMENT if thread is
not a thread.
processor_set_max_priority is used to set the
maximum priority for a processor set. The priority of a processor set
is used only for newly created threads (thread's maximum priority is set
to processor set's) and the assignment of threads to the set (thread's
maximum priority is reduced if it exceeds the set's maximum priority,
thread's priority is similarly reduced). processor_set_max_priority
changes this priority. It also sets the maximum priority of all threads
assigned to the processor set to this new priority if
change_threads is TRUE. If this maximum priority is less
than the priorities of any of these threads, their priorities will also
be set to this new value.
This function returns KERN_SUCCESS if the call succeeded and
KERN_INVALID_ARGUMENT if processor_set is not a processor
set or priority is not a valid priority.
processor_set_info.
Timesharing may not be forbidden by any processor set. This is a
compromise to reduce the complexity of the assign operation; any thread
whose policy is forbidden by the target processor set has its policy
reset to timesharing. If the change_threads argument to
processor_set_policy_disable is true, threads currently assigned
to this processor set and using the newly disabled policy will have
their policy reset to timesharing.
`mach/policy.h' contains the allowed policies; it is included by `mach.h'. Not all policies (e.g. fixed priority) are supported by all systems.
This function returns KERN_SUCCESS if the operation was completed
successfully and KERN_INVALID_ARGUMENT if processor_set is
not a processor set or policy is not a valid policy, or an attempt
was made to disable timesharing.
processor_set_info returns the selected information array
for a processor set, as specified by flavor.
host is set to the host on which the processor set resides. This is the non-privileged host port.
processor_set_info is an array of integers that is supplied by the
caller and returned filled with specified information.
processor_set_infoCnt is supplied as the maximum number of
integers in processor_set_info. On return, it contains the actual
number of integers in processor_set_info. The maximum number of
integers by any flavor is PROCESSOR_SET_INFO_MAX.
The type of information returned is defined by flavor, which can be one of the following:
PROCESSOR_SET_BASIC_INFO
processor_set_basic_info_t. This includes the number
of tasks and threads assigned to the processor set. The number of
integers returned is PROCESSOR_SET_BASIC_INFO_COUNT.
PROCESSOR_SET_SCHED_INFO
processor_set_sched_info_t. The
number of integers returned is PROCESSOR_SET_SCHED_INFO_COUNT.
Some machines may define additional (machine-dependent) flavors.
The function returns KERN_SUCCESS if the call succeeded and
KERN_INVALID_ARGUMENT if processor_set is not a processor
set or flavor is not recognized. The function returns
MIG_ARRAY_TOO_LARGE if the returned info array is too large for
processor_set_info. In this case, processor_set_info is
filled as much as possible and processor_set_infoCnt is set to the
number of elements that would have been returned if there were enough
room.
processor_set_info function and provides basic information about
the processor set. You can cast a variable of type
processor_set_info_t to a pointer of this type if you provided it
as the processor_set_info parameter for the
PROCESSOR_SET_BASIC_INFO flavor of processor_set_info. It
has the following members:
int processor_count
int task_count
int thread_count
int load_average
int mach_factor
struct processor_set_basic_info.
processor_set_info function and provides schedule information
about the processor set. You can cast a variable of type
processor_set_info_t to a pointer of this type if you provided it
as the processor_set_info parameter for the
PROCESSOR_SET_SCHED_INFO flavor of processor_set_info. It
has the following members:
int policies
int max_priority
struct processor_set_sched_info.
host_processors gets send rights to the processor
port for each processor existing on host_priv. This is the
privileged port that allows its holder to control a processor.
processor_list is an array that is created as a result of this
call. The caller may wish to vm_deallocate this array when the
data is no longer needed. processor_count is set to the number of
processors in the processor_list.
This function returns KERN_SUCCESS if the call succeeded,
KERN_INVALID_ARGUMENT if host_priv is not a privileged host
port, and KERN_INVALID_ADDRESS if processor_count points to
inaccessible memory.
processor_start, processor_exit, and
processor_control operations implement this. The interpretation
of the command in cmd is machine dependent. A newly started
processor is assigned to the default processor set. An exited processor
is removed from the processor set to which it was assigned and ceases to
be active.
count contains the length of the command cmd as a number of ints.
Availability limited. All of these operations are machine-dependent. They may do nothing. The ability to restart an exited processor is also machine-dependent.
This function returns KERN_SUCCESS if the operation was
performed, KERN_FAILURE if the operation was not performed (a
likely reason is that it is not supported on this processor),
KERN_INVALID_ARGUMENT if processor is not a processor, and
KERN_INVALID_ADDRESS if cmd points to inaccessible memory.
processor_assign assigns processor to the the
set processor_set. After the assignment is completed, the
processor only executes threads that are assigned to that processor set.
Any previous assignment of the processor is nullified. The master
processor cannot be reassigned. All processors take clock interrupts at
all times. The wait argument indicates whether the caller should
wait for the assignment to be completed or should return immediately.
Dedicated kernel threads are used to perform processor assignment, so
setting wait to FALSE allows assignment requests to be queued and
performed faster, especially if the kernel has more than one dedicated
internal thread for processor assignment. Redirection of other device
interrupts away from processors assigned to other than the default
processor set is machine-dependent. Intermediaries that interpose on
ports must be sure to interpose on both ports involved in this call if
they interpose on either.
This function returns KERN_SUCCESS if the assignment has been
performed, KERN_INVALID_ARGUMENT if processor is not a
processor, or processor_set is not a processor set on the same
host as processor.
processor_get_assignment obtains the current
assignment of a processor. The name port of the processor set is
returned in assigned_set.
processor_info returns the selected information array
for a processor, as specified by flavor.
host is set to the host on which the processor set resides. This is the non-privileged host port.
processor_info is an array of integers that is supplied by the
caller and returned filled with specified information.
processor_infoCnt is supplied as the maximum number of integers in
processor_info. On return, it contains the actual number of
integers in processor_info. The maximum number of integers by any
flavor is PROCESSOR_INFO_MAX.
The type of information returned is defined by flavor, which can be one of the following:
PROCESSOR_BASIC_INFO
processor_basic_info_t. This includes the slot number of the
processor. The number of integers returned is
PROCESSOR_BASIC_INFO_COUNT.
Machines which require more configuration information beyond the slot number are expected to define additional (machine-dependent) flavors.
The function returns KERN_SUCCESS if the call succeeded and
KERN_INVALID_ARGUMENT if processor is not a processor or
flavor is not recognized. The function returns
MIG_ARRAY_TOO_LARGE if the returned info array is too large for
processor_info. In this case, processor_info is filled as
much as possible and processor_infoCnt is set to the number of
elements that would have been returned if there were enough room.
processor_info function and provides basic information about the
processor. You can cast a variable of type processor_info_t to a
pointer of this type if you provided it as the processor_info
parameter for the PROCESSOR_BASIC_INFO flavor of
processor_info. It has the following members:
cpu_type_t cpu_type
cpu_subtype_t cpu_subtype
boolean_t running
int slot_num
boolean_t is_master
struct processor_basic_info.
Go to the first, previous, next, last section, table of contents.