(libc.info.gz) CPU Affinity

Info Catalog (libc.info.gz) Traditional Scheduling (libc.info.gz) Priority
 
 22.3.5 Limiting execution to certain CPUs
 -----------------------------------------
 
 On a multi-processor system the operating system usually distributes the
 different processes which are runnable on all available CPUs in a way
 which allows the system to work most efficiently.  Which processes and
 threads run can be to some extend be control with the scheduling
 functionality described in the last sections.  But which CPU finally
 executes which process or thread is not covered.
 
    There are a number of reasons why a program might want to have
 control over this aspect of the system as well:
 
    * One thread or process is responsible for absolutely critical work
      which under no circumstances must be interrupted or hindered from
      making process by other process or threads using CPU resources.  In
      this case the special process would be confined to a CPU which no
      other process or thread is allowed to use.
 
    * The access to certain resources (RAM, I/O ports) has different
      costs from different CPUs.  This is the case in NUMA (Non-Uniform
      Memory Architecture) machines.  Preferably memory should be
      accessed locally but this requirement is usually not visible to the
      scheduler.  Therefore forcing a process or thread to the CPUs which
      have local access to the mostly used memory helps to significantly
      boost the performance.
 
    * In controlled runtimes resource allocation and book-keeping work
      (for instance garbage collection) is performance local to
      processors.  This can help to reduce locking costs if the resources
      do not have to be protected from concurrent accesses from different
      processors.
 
    The POSIX standard up to this date is of not much help to solve this
 problem.  The Linux kernel provides a set of interfaces to allow
 specifying _affinity sets_ for a process.  The scheduler will schedule
 the thread or process on CPUs specified by the affinity masks.  The
 interfaces which the GNU C Library define follow to some extend the
 Linux kernel interface.
 
  -- Data Type: cpu_set_t
      This data set is a bitset where each bit represents a CPU. How the
      system's CPUs are mapped to bits in the bitset is system dependent.
      The data type has a fixed size; in the unlikely case that the
      number of bits are not sufficient to describe the CPUs of the
      system a different interface has to be used.
 
      This type is a GNU extension and is defined in 'sched.h'.
 
    To manipulate the bitset, to set and reset bits, a number of macros
 is defined.  Some of the macros take a CPU number as a parameter.  Here
 it is important to never exceed the size of the bitset.  The following
 macro specifies the number of bits in the 'cpu_set_t' bitset.
 
  -- Macro: int CPU_SETSIZE
      The value of this macro is the maximum number of CPUs which can be
      handled with a 'cpu_set_t' object.
 
    The type 'cpu_set_t' should be considered opaque; all manipulation
 should happen via the next four macros.
 
  -- Macro: void CPU_ZERO (cpu_set_t *SET)
      Preliminary: | MT-Safe | AS-Safe | AC-Safe |  POSIX Safety
      Concepts.
 
      This macro initializes the CPU set SET to be the empty set.
 
      This macro is a GNU extension and is defined in 'sched.h'.
 
  -- Macro: void CPU_SET (int CPU, cpu_set_t *SET)
      Preliminary: | MT-Safe | AS-Safe | AC-Safe |  POSIX Safety
      Concepts.
 
      This macro adds CPU to the CPU set SET.
 
      The CPU parameter must not have side effects since it is evaluated
      more than once.
 
      This macro is a GNU extension and is defined in 'sched.h'.
 
  -- Macro: void CPU_CLR (int CPU, cpu_set_t *SET)
      Preliminary: | MT-Safe | AS-Safe | AC-Safe |  POSIX Safety
      Concepts.
 
      This macro removes CPU from the CPU set SET.
 
      The CPU parameter must not have side effects since it is evaluated
      more than once.
 
      This macro is a GNU extension and is defined in 'sched.h'.
 
  -- Macro: int CPU_ISSET (int CPU, const cpu_set_t *SET)
      Preliminary: | MT-Safe | AS-Safe | AC-Safe |  POSIX Safety
      Concepts.
 
      This macro returns a nonzero value (true) if CPU is a member of the
      CPU set SET, and zero (false) otherwise.
 
      The CPU parameter must not have side effects since it is evaluated
      more than once.
 
      This macro is a GNU extension and is defined in 'sched.h'.
 
    CPU bitsets can be constructed from scratch or the currently
 installed affinity mask can be retrieved from the system.
 
  -- Function: int sched_getaffinity (pid_t PID, size_t CPUSETSIZE,
           cpu_set_t *CPUSET)
      Preliminary: | MT-Safe | AS-Safe | AC-Safe |  POSIX Safety
      Concepts.
 
      This functions stores the CPU affinity mask for the process or
      thread with the ID PID in the CPUSETSIZE bytes long bitmap pointed
      to by CPUSET.  If successful, the function always initializes all
      bits in the 'cpu_set_t' object and returns zero.
 
      If PID does not correspond to a process or thread on the system the
      or the function fails for some other reason, it returns '-1' and
      'errno' is set to represent the error condition.
 
      'ESRCH'
           No process or thread with the given ID found.
 
      'EFAULT'
           The pointer CPUSET is does not point to a valid object.
 
      This function is a GNU extension and is declared in 'sched.h'.
 
    Note that it is not portably possible to use this information to
 retrieve the information for different POSIX threads.  A separate
 interface must be provided for that.
 
  -- Function: int sched_setaffinity (pid_t PID, size_t CPUSETSIZE, const
           cpu_set_t *CPUSET)
      Preliminary: | MT-Safe | AS-Safe | AC-Safe |  POSIX Safety
      Concepts.
 
      This function installs the CPUSETSIZE bytes long affinity mask
      pointed to by CPUSET for the process or thread with the ID PID.  If
      successful the function returns zero and the scheduler will in
      future take the affinity information into account.
 
      If the function fails it will return '-1' and 'errno' is set to the
      error code:
 
      'ESRCH'
           No process or thread with the given ID found.
 
      'EFAULT'
           The pointer CPUSET is does not point to a valid object.
 
      'EINVAL'
           The bitset is not valid.  This might mean that the affinity
           set might not leave a processor for the process or thread to
           run on.
 
      This function is a GNU extension and is declared in 'sched.h'.
 
Info Catalog (libc.info.gz) Traditional Scheduling (libc.info.gz) Priority
automatically generated by info2html