xnu-2422.90.20.tar.gz

[apple/xnu.git] / osfmk / mach / thread_policy.h

diff --git a/osfmk/mach/thread_policy.h b/osfmk/mach/thread_policy.h
index 057d26831969a3b1afb4b9a1541bed31223dff2e..a0662cae65fc06cb3dea6c85724b5b3aadb0aba7 100644 (file)
--- a/osfmk/mach/thread_policy.h
+++ b/osfmk/mach/thread_policy.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2007 Apple Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.

  * 
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 
 #ifndef _MACH_THREAD_POLICY_H_
  */
 
 #ifndef _MACH_THREAD_POLICY_H_


@@ -177,4 +183,76 @@ typedef struct thread_precedence_policy            *thread_precedence_policy_t;
 #define THREAD_PRECEDENCE_POLICY_COUNT ((mach_msg_type_number_t) \
        (sizeof (thread_precedence_policy_data_t) / sizeof (integer_t)))
 
 #define THREAD_PRECEDENCE_POLICY_COUNT ((mach_msg_type_number_t) \
        (sizeof (thread_precedence_policy_data_t) / sizeof (integer_t)))
 

+/*
+ * THREAD_AFFINITY_POLICY:
+ *
+ * This policy is experimental.
+ * This may be used to express affinity relationships 
+ * between threads in the task. Threads with the same affinity tag will
+ * be scheduled to share an L2 cache if possible. That is, affinity tags
+ * are a hint to the scheduler for thread placement. 
+ *
+ * The namespace of affinity tags is generally local to one task. However,
+ * a child task created after the assignment of affinity tags by its parent
+ * will share that namespace. In particular, a family of forked processes
+ * may be created with a shared affinity namespace.
+ *
+ * Parameters:
+ * tag: The affinity set identifier.
+ */
+
+#define THREAD_AFFINITY_POLICY         4
+
+struct thread_affinity_policy {
+       integer_t       affinity_tag;
+};
+
+#define THREAD_AFFINITY_TAG_NULL               0
+
+typedef struct thread_affinity_policy          thread_affinity_policy_data_t;
+typedef struct thread_affinity_policy          *thread_affinity_policy_t;
+
+#define THREAD_AFFINITY_POLICY_COUNT   ((mach_msg_type_number_t) \
+       (sizeof (thread_affinity_policy_data_t) / sizeof (integer_t)))
+
+/*
+ * THREAD_BACKGROUND_POLICY:
+ */
+
+#define THREAD_BACKGROUND_POLICY       5
+
+struct thread_background_policy {
+       integer_t       priority;
+};
+
+typedef struct thread_background_policy                thread_background_policy_data_t;
+typedef struct thread_background_policy        *thread_background_policy_t;
+
+#define THREAD_BACKGROUND_POLICY_COUNT ((mach_msg_type_number_t) \
+       (sizeof (thread_background_policy_data_t) / sizeof (integer_t)))
+
+
+
+#ifdef PRIVATE
+
+/*
+ * THREAD_POLICY_STATE:
+ */
+#define THREAD_POLICY_STATE            6
+
+struct thread_policy_state {
+       integer_t requested;
+       integer_t effective;
+       integer_t pending;
+       integer_t reserved[13];
+};
+
+typedef struct thread_policy_state             thread_policy_state_data_t;
+typedef struct thread_policy_state             *thread_policy_state_t;
+
+#define THREAD_POLICY_STATE_COUNT      ((mach_msg_type_number_t) \
+       (sizeof (thread_policy_state_data_t) / sizeof (integer_t)))
+
+#endif /* PRIVATE */
+

 #endif /* _MACH_THREAD_POLICY_H_ */
 #endif /* _MACH_THREAD_POLICY_H_ */