assign_cpu_to_pset(3) [osf1 man page]
assign_cpu_to_pset(3) Library Functions Manual assign_cpu_to_pset(3) NAME
assign_cpu_to_pset - Assigns a processor to a processor set LIBRARY
Pset Library (libpset.a) Mach Library (libmach.a) SYNOPSIS
#include <sys/types.h> #include <sys/processor.h> int assign_cpu_to_pset( unsigned long cpu, long pset_id , long option ); PARAMETERS
Processor or processors to assign to the specified processor set. Processor set identifier, which is returned by the create_pset function. Specifies a bit mask. Currently, only the ANY_CPU bit is supported. If this bit is set, the value specified by the cpu variable is the number of processors to be assigned to the specified processor set from the default processor set. If the ANY_CPU bit is not set, the value specified by the cpu variable is the mask of processors to be assigned to the processor set. DESCRIPTION
The assign_cpu_to_pset function removes processors from their current processor set and assigns them to the processor set specified by the pset_id variable. This function requires root privileges. If the ANY_CPU option is specified, the number of processors specified by the cpu variable are assigned from the default processor set to the processor set that is specified with the pset_id variable. If the specified number of processors are not available in the default pro- cessor set, an error is returned and no processors are assigned. If the ANY_CPU option is not set, the value specified by the cpu variable is a mask of processors to be assigned to the specified processor set. For example, if you specify a cpu value of 6, then processors 2 and 3 are assigned to the processor set. Note that processors are not required to start in slot 0 on some platforms. For example, you may see a three-processor system with proces- sors in slots 6, 7, and 8. The console assigns the master processor at power up, which is usually the processor in slot 0 if it is occu- pied. However, there is no requirement that slot 0 must be populated or that the master is the first processor on the bus. In the example of the three-processor (slots 6, 7, and 8) system, the master processor will be the one in slot 6. Processor assignments are logged in the /var/adm/wtmp file. RETURN VALUES
If the processor assignment is successful, the assign_cpu_to_pset function returns zero (0). If the assignment is unsuccessful, the func- tion returns a negative number. Use the print_pset_error function to print a message that describes the error. FILES
/var/adm/wtmp RELATED INFORMATION
bind_to_cpu(3), create_pset(3), destroy_pset(3), assign_pid_to_pset(3), print_pset_error(3), processor_sets(4), pset_create(1) delim off assign_cpu_to_pset(3)
Check Out this Related Man Page
pset_create(2) System Calls pset_create(2) NAME
pset_create, pset_destroy, pset_assign - manage sets of processors SYNOPSIS
#include <sys/pset.h> int pset_create(psetid_t *newpset); int pset_destroy(psetid_t pset); int pset_assign(psetid_t pset, processorid_t cpu, psetid_t *opset); DESCRIPTION
These functions control the creation and management of sets of processors. Processor sets allow a subset of the system's processors to be set aside for exclusive use by specified LWPs and processes. The binding of LWPs and processes to processor sets is controlled by pset_bind(2). The pset_create() function creates an empty processor set that contains no processors. On successful return, newpset will contain the ID of the new processor set. The pset_destroy() function destroys the processor set pset, releasing its constituent processors and processes. If pset is PS_MYID, the processor set to which the caller is bound is destroyed. The pset_assign() function assigns the processor cpu to the processor set pset. A processor that has been assigned to a processor set will run only LWPs and processes that have been explicitly bound to that processor set, unless another LWP requires a resource that is only available on that processor. On successful return, if opset is non-null, opset will contain the processor set ID of the former processor set of the processor. If pset is PS_NONE, pset_assign() releases processor cpu from its current processor set. If pset is PS_QUERY, pset_assign() makes no change to processor sets, but returns the current processor set ID of processor cpu in opset. If pset is PS_MYID, processor cpu is assigned to the processor set to which the caller belongs. If the caller does not belong to a proces- sor set, processor cpu is released from its current processor set. These functions are restricted to privileged processes, except for pset_assign() when pset is PS_QUERY. RETURN VALUES
Upon successful completion, these functions return 0. Otherwise, -1 is returned and errno is set to indicate the error. ERRORS
These functions will fail if: EBUSY The processor could not be moved to the specified processor set. EFAULT The location pointed to by newpset was not writable by the user, or the location pointed to by opset was not NULL and not writable by the user. EINVAL The specified processor does not exist, the specified processor is not on-line, or an invalid processor set was specified. ENOMEM There was insufficient space for pset_create to create a new processor set. ENOTSUP The pools facility is active. See pooladm(1M) and pool_set_status(3POOL) for information about enabling and disabling the pools facility. EPERM The {PRIV_SYS_RES_CONFIG} privilege is not asserted in the effective set of the calling process. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |Async-Signal-Safe | +-----------------------------+-----------------------------+ SEE ALSO
pooladm(1M), psradm(1M), psrinfo(1M), psrset(1M), p_online(2), processor_bind(2), pset_bind(2), pset_info(2), pool_set_status(3POOL), pset_getloadavg(3C), attributes(5), privileges(5) NOTES
The processor set type of PS_SYSTEM is no longer supported. Processors with LWPs bound to them using processor_bind(2) cannot be assigned to a new processor set. If this is attempted, pset_assign() will fail and set errno to EBUSY. SunOS 5.11 22 Feb 2008 pset_create(2)