osfmk/mach/thread_info.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * @OSF_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  36  * All Rights Reserved.
  37  *
  38  * Permission to use, copy, modify and distribute this software and its
  39  * documentation is hereby granted, provided that both the copyright
  40  * notice and this permission notice appear in all copies of the
  41  * software, derivative works or modified versions, and any portions
  42  * thereof, and that both notices appear in supporting documentation.
  43  *
  44  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  45  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  46  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  47  *
  48  * Carnegie Mellon requests users of this software to return to
  49  *
  50  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  51  *  School of Computer Science
  52  *  Carnegie Mellon University
  53  *  Pittsburgh PA 15213-3890
  54  *
  55  * any improvements or extensions that they make and grant Carnegie Mellon
  56  * the rights to redistribute these changes.
  57  */
  58 /*
  59  */
  60 /*
  61  *      File:   mach/thread_info
  62  *
  63  *      Thread information structure and definitions.
  64  *
  65  *      The defintions in this file are exported to the user.  The kernel
  66  *      will translate its internal data structures to these structures
  67  *      as appropriate.
  68  *
  69  */
  70
  71 #ifndef _MACH_THREAD_INFO_H_
  72 #define _MACH_THREAD_INFO_H_
  73
  74 #include <mach/boolean.h>
  75 #include <mach/policy.h>
  76 #include <mach/time_value.h>
  77 #include <mach/message.h>
  78 #include <mach/machine/vm_types.h>
  79
  80 /*
  81  *      Generic information structure to allow for expansion.
  82  */
  83 typedef natural_t       thread_flavor_t;
  84 typedef integer_t       *thread_info_t;         /* varying array of int */
  85
  86 #define THREAD_INFO_MAX         (1024)  /* maximum array size */
  87 typedef integer_t       thread_info_data_t[THREAD_INFO_MAX];
  88
  89 /*
  90  *      Currently defined information.
  91  */
  92 #define THREAD_BASIC_INFO               3     /* basic information */
  93
  94 struct thread_basic_info {
  95         time_value_t    user_time;      /* user run time */
  96         time_value_t    system_time;    /* system run time */
  97         integer_t       cpu_usage;      /* scaled cpu usage percentage */
  98         policy_t        policy;         /* scheduling policy in effect */
  99         integer_t       run_state;      /* run state (see below) */
 100         integer_t       flags;          /* various flags (see below) */
 101         integer_t       suspend_count;  /* suspend count for thread */
 102         integer_t       sleep_time;     /* number of seconds that thread
 103                                            has been sleeping */
 104 };
 105
 106 typedef struct thread_basic_info  thread_basic_info_data_t;
 107 typedef struct thread_basic_info  *thread_basic_info_t;
 108 #define THREAD_BASIC_INFO_COUNT   ((mach_msg_type_number_t) \
 109                 (sizeof(thread_basic_info_data_t) / sizeof(natural_t)))
 110
 111 /*
 112  *      Scale factor for usage field.
 113  */
 114
 115 #define TH_USAGE_SCALE  1000
 116
 117 /*
 118  *      Thread run states (state field).
 119  */
 120
 121 #define TH_STATE_RUNNING        1       /* thread is running normally */
 122 #define TH_STATE_STOPPED        2       /* thread is stopped */
 123 #define TH_STATE_WAITING        3       /* thread is waiting normally */
 124 #define TH_STATE_UNINTERRUPTIBLE 4      /* thread is in an uninterruptible
 125                                            wait */
 126 #define TH_STATE_HALTED         5       /* thread is halted at a
 127                                            clean point */
 128
 129 /*
 130  *      Thread flags (flags field).
 131  */
 132 #define TH_FLAGS_SWAPPED        0x1     /* thread is swapped out */
 133 #define TH_FLAGS_IDLE           0x2     /* thread is an idle thread */
 134
 135 /*
 136  * Obsolete interfaces.
 137  */
 138
 139 #define THREAD_SCHED_TIMESHARE_INFO     10
 140 #define THREAD_SCHED_RR_INFO            11
 141 #define THREAD_SCHED_FIFO_INFO          12
 142
 143 #endif  /* _MACH_THREAD_INFO_H_ */