osfmk/kern/affinity.h

   1 /*
   2  * Copyright (c) 2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 #ifndef _KERN_CPU_AFFINITY_H_
  29 #define _KERN_CPU_AFFINITY_H_
  30
  31 #include <kern/queue.h>
  32 #include <kern/processor.h>
  33 #include <kern/lock.h>
  34
  35 /*
  36  * An affinity set object represents a set of threads identified by the user
  37  * to be sharing (cache) affinity. A task may have multiple affinity sets
  38  * defined. Each set has dis-affinity other sets. Tasks related by inheritance
  39  * may share the same affinity set namespace.
  40  * Affinity sets are used to advise (hint) thread placement.
  41  */
  42 struct affinity_set {
  43         struct affinity_space *aset_space;      /* namespace */
  44         queue_chain_t   aset_affinities;        /* links affinities in group */
  45         queue_head_t    aset_threads;           /* threads in affinity set */
  46         uint32_t        aset_thread_count;      /* num threads in set */
  47         uint32_t        aset_tag;               /* user-assigned tag */
  48         uint32_t        aset_num;               /* kernel-assigned affinity */
  49         processor_set_t aset_pset;              /* processor set */
  50 };
  51
  52 extern boolean_t        thread_affinity_is_supported(void);
  53 extern kern_return_t    thread_affinity_set(thread_t thread, uint32_t tag);
  54 extern uint32_t         thread_affinity_get(thread_t thread);
  55 extern void             thread_affinity_dup(thread_t parent, thread_t child);
  56 extern void             thread_affinity_terminate(thread_t thread);
  57 extern void             task_affinity_create(
  58                                         task_t,
  59                                         task_t);
  60 extern void             task_affinity_deallocate(
  61                                         task_t);
  62 extern kern_return_t    task_affinity_info(
  63                                         task_t,
  64                                         task_info_t,
  65                                         mach_msg_type_number_t  *);
  66
  67 #endif  /* _KERN_CPU_AFFINITY_H_ */