## processor_set_info

Function - Return processor set state according to caller-specified flavor.

### SYNOPSIS

    kern_return_t	processor_set_info
    		(processor_set_name_t	processor_set_name,
    		int	flavor,
    		host_t	host,
    		processor_set_info_t	processor_set_info,
    		mach_msg_type_number_t	processor_set_info_count);

### PARAMETERS

processor_set_name
  [in processor-set-name send right] A processor set name (or control) port for which information is desired.
flavor
  [in scalar] The type of information requested.
  PROCESSOR_SET_BASIC_INFO
    Basic information concerning the processor set (number of assigned processors and default policy). The returned structure is defined by processor_set_basic_info.
  PROCESSOR_SET_TIMESHARE_DEFAULT
    The base attributes for the timeshare scheduling policy. The returned structure is policy_timeshare_base.
  PROCESSOR_SET_FIFO_DEFAULT
    The base attributes for the FIFO scheduling policy. The returned structure is policy_fifo_base.
  PROCESSOR_SET_RR_DEFAULT
    The base attributes for the round-robin scheduling policy. The returned structure is policy_rr_base.
  PROCESSOR_SET_TIMESHARE_LIMITS
    Limits on the allowed timeshare policy attributes. The returned structure is defined by policy_timeshare_limit.
  PROCESSOR_SET_RR_LIMITS
    Limits on the allowed round robin policy attributes. The returned structure is defined by policy_rr_limit.
  PROCESSOR_SET_FIFO_LIMITS
    Limits on the allowed first-in, first-out policy attributes. The returned structure is defined by policy_fifo_limit.
  PROCESSOR_SET_ENABLED_POLICIES
    The set of enabled policies. The returned data is a bit-vector.
host
  [out host-name send right] The name port for the host on which the processor set resides.
processor_set_info
  [out structure] Information about the processor set.
processor_set_info_count
  [in/out scalar] On input, the maximum size of the buffer; on output, the size returned (in natural-sized units).

### DESCRIPTION

The processor_set_info function returns selected information for a processor set, as specified by flavor.

### NOTES

A processor set has a single default scheduling policy in effect for it (as returned by PROCESSOR_SET_BASIC_INFO), so only one of the default scheduling structures has valid information. On the other hand, a processor set maintains limits for all defined scheduling policies, so all of the scheduling limit structures return valid values.

### RETURN VALUES

Only generic errors apply.

### RELATED INFORMATION

Functions: processor_set_statistics, processor_set_create, processor_set_default, processor_assign, processor_set_policy_control.

Data Structures: processor_set_basic_info, policy_timeshare_info, policy_rr_info, policy_fifo_info.