master
  1/*
  2 * Copyright (c) 2000-2005 Apple Computer, 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/*
 29 * @OSF_COPYRIGHT@
 30 */
 31/*
 32 * Mach Operating System
 33 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
 34 * All Rights Reserved.
 35 *
 36 * Permission to use, copy, modify and distribute this software and its
 37 * documentation is hereby granted, provided that both the copyright
 38 * notice and this permission notice appear in all copies of the
 39 * software, derivative works or modified versions, and any portions
 40 * thereof, and that both notices appear in supporting documentation.
 41 *
 42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 43 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 45 *
 46 * Carnegie Mellon requests users of this software to return to
 47 *
 48 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 49 *  School of Computer Science
 50 *  Carnegie Mellon University
 51 *  Pittsburgh PA 15213-3890
 52 *
 53 * any improvements or extensions that they make and grant Carnegie Mellon
 54 * the rights to redistribute these changes.
 55 */
 56/*
 57 */
 58
 59/*
 60 *	File:	mach/processor_info.h
 61 *	Author:	David L. Black
 62 *	Date:	1988
 63 *
 64 *	Data structure definitions for processor_info, processor_set_info
 65 */
 66
 67#ifndef _MACH_PROCESSOR_INFO_H_
 68#define _MACH_PROCESSOR_INFO_H_
 69
 70#include <mach/message.h>
 71#include <mach/machine.h>
 72#include <mach/machine/processor_info.h>
 73
 74/*
 75 *	Generic information structure to allow for expansion.
 76 */
 77typedef integer_t       *processor_info_t;      /* varying array of int. */
 78typedef integer_t       *processor_info_array_t;  /* varying array of int */
 79
 80#define PROCESSOR_INFO_MAX      (1024)  /* max array size */
 81typedef integer_t       processor_info_data_t[PROCESSOR_INFO_MAX];
 82
 83
 84typedef integer_t       *processor_set_info_t;  /* varying array of int. */
 85
 86#define PROCESSOR_SET_INFO_MAX  (1024)  /* max array size */
 87typedef integer_t       processor_set_info_data_t[PROCESSOR_SET_INFO_MAX];
 88
 89/*
 90 *	Currently defined information.
 91 */
 92typedef int     processor_flavor_t;
 93#define PROCESSOR_BASIC_INFO    1               /* basic information */
 94#define PROCESSOR_CPU_LOAD_INFO 2       /* cpu load information */
 95#define PROCESSOR_PM_REGS_INFO  0x10000001      /* performance monitor register info */
 96#define PROCESSOR_TEMPERATURE   0x10000002      /* Processor core temperature */
 97
 98struct processor_basic_info {
 99	cpu_type_t      cpu_type;       /* type of cpu */
100	cpu_subtype_t   cpu_subtype;    /* subtype of cpu */
101	boolean_t       running;        /* is processor running */
102	int             slot_num;       /* slot number */
103	union {
104		boolean_t       is_master;  /* deprecated */
105		boolean_t       is_main;    /* is this the main processor */
106	};
107};
108
109typedef struct processor_basic_info     processor_basic_info_data_t;
110typedef struct processor_basic_info     *processor_basic_info_t;
111#define PROCESSOR_BASIC_INFO_COUNT      ((mach_msg_type_number_t) \
112	        (sizeof(processor_basic_info_data_t)/sizeof(natural_t)))
113
114struct processor_cpu_load_info {             /* number of ticks while running... */
115	unsigned int    cpu_ticks[CPU_STATE_MAX]; /* ... in the given mode */
116};
117
118typedef struct processor_cpu_load_info  processor_cpu_load_info_data_t;
119typedef struct processor_cpu_load_info  *processor_cpu_load_info_t;
120#define PROCESSOR_CPU_LOAD_INFO_COUNT   ((mach_msg_type_number_t) \
121	        (sizeof(processor_cpu_load_info_data_t)/sizeof(natural_t)))
122
123/*
124 *	Scaling factor for load_average, mach_factor.
125 */
126#define LOAD_SCALE      1000
127
128typedef int     processor_set_flavor_t;
129#define PROCESSOR_SET_BASIC_INFO        5       /* basic information */
130
131struct processor_set_basic_info {
132	int             processor_count;        /* How many processors */
133	int             default_policy;         /* When others not enabled */
134};
135
136typedef struct processor_set_basic_info processor_set_basic_info_data_t;
137typedef struct processor_set_basic_info *processor_set_basic_info_t;
138#define PROCESSOR_SET_BASIC_INFO_COUNT  ((mach_msg_type_number_t) \
139	        (sizeof(processor_set_basic_info_data_t)/sizeof(natural_t)))
140
141#define PROCESSOR_SET_LOAD_INFO         4       /* scheduling statistics */
142
143struct processor_set_load_info {
144	int             task_count;             /* How many tasks */
145	int             thread_count;           /* How many threads */
146	integer_t       load_average;           /* Scaled */
147	integer_t       mach_factor;            /* Scaled */
148};
149
150typedef struct processor_set_load_info processor_set_load_info_data_t;
151typedef struct processor_set_load_info *processor_set_load_info_t;
152#define PROCESSOR_SET_LOAD_INFO_COUNT   ((mach_msg_type_number_t) \
153	        (sizeof(processor_set_load_info_data_t)/sizeof(natural_t)))
154
155
156#endif  /* _MACH_PROCESSOR_INFO_H_ */