xref: /haiku/headers/os/kernel/OS.h (revision 3a5082aa46f958b1f49398c8b69458fa12dd581e)
1 /*
2  * Copyright 2004-2009, Haiku Inc. All Rights Reserved.
3  * Distributed under the terms of the MIT License.
4  */
5 #ifndef _OS_H
6 #define _OS_H
7 
8 //! Kernel specific structures and functions
9 
10 #include <pthread.h>
11 #include <stdarg.h>
12 
13 #include <SupportDefs.h>
14 #include <StorageDefs.h>
15 
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 /* System constants */
22 
23 #define B_OS_NAME_LENGTH	32
24 #define B_PAGE_SIZE			4096
25 #define B_INFINITE_TIMEOUT	(9223372036854775807LL)
26 
27 enum {
28 	B_TIMEOUT						= 0x8,	/* relative timeout */
29 	B_RELATIVE_TIMEOUT				= 0x8,	/* fails after a relative timeout
30 												with B_TIMED_OUT */
31 	B_ABSOLUTE_TIMEOUT				= 0x10,	/* fails after an absolute timeout
32 												with B_TIMED_OUT */
33 
34 	/* experimental Haiku only API */
35 	B_TIMEOUT_REAL_TIME_BASE		= 0x40,
36 	B_ABSOLUTE_REAL_TIME_TIMEOUT	= B_ABSOLUTE_TIMEOUT
37 										| B_TIMEOUT_REAL_TIME_BASE
38 };
39 
40 
41 /* Types */
42 
43 typedef int32 area_id;
44 typedef int32 port_id;
45 typedef int32 sem_id;
46 typedef int32 team_id;
47 typedef int32 thread_id;
48 
49 
50 /* Areas */
51 
52 typedef struct area_info {
53 	area_id		area;
54 	char		name[B_OS_NAME_LENGTH];
55 	size_t		size;
56 	uint32		lock;
57 	uint32		protection;
58 	team_id		team;
59 	uint32		ram_size;
60 	uint32		copy_count;
61 	uint32		in_count;
62 	uint32		out_count;
63 	void		*address;
64 } area_info;
65 
66 /* area locking */
67 #define B_NO_LOCK				0
68 #define B_LAZY_LOCK				1
69 #define B_FULL_LOCK				2
70 #define B_CONTIGUOUS			3
71 #define	B_LOMEM					4	/* B_CONTIGUOUS, < 16 MB physical address */
72 #define	B_32_BIT_FULL_LOCK		5	/* B_FULL_LOCK, < 4 GB physical addresses */
73 #define	B_32_BIT_CONTIGUOUS		6	/* B_CONTIGUOUS, < 4 GB physical address */
74 
75 /* address spec for create_area(), and clone_area() */
76 #define B_ANY_ADDRESS			0
77 #define B_EXACT_ADDRESS			1
78 #define B_BASE_ADDRESS			2
79 #define B_CLONE_ADDRESS			3
80 #define	B_ANY_KERNEL_ADDRESS	4
81 
82 /* area protection */
83 #define B_READ_AREA				1
84 #define B_WRITE_AREA			2
85 
86 extern area_id		create_area(const char *name, void **startAddress,
87 						uint32 addressSpec, size_t size, uint32 lock,
88 						uint32 protection);
89 extern area_id		clone_area(const char *name, void **destAddress,
90 						uint32 addressSpec, uint32 protection, area_id source);
91 extern area_id		find_area(const char *name);
92 extern area_id		area_for(void *address);
93 extern status_t		delete_area(area_id id);
94 extern status_t		resize_area(area_id id, size_t newSize);
95 extern status_t		set_area_protection(area_id id, uint32 newProtection);
96 
97 /* system private, use macros instead */
98 extern status_t		_get_area_info(area_id id, area_info *areaInfo, size_t size);
99 extern status_t		_get_next_area_info(team_id team, int32 *cookie,
100 						area_info *areaInfo, size_t size);
101 
102 #define get_area_info(id, areaInfo) \
103 	_get_area_info((id), (areaInfo),sizeof(*(areaInfo)))
104 #define get_next_area_info(team, cookie, areaInfo) \
105 	_get_next_area_info((team), (cookie), (areaInfo), sizeof(*(areaInfo)))
106 
107 
108 /* Ports */
109 
110 typedef struct port_info {
111 	port_id		port;
112 	team_id		team;
113 	char		name[B_OS_NAME_LENGTH];
114 	int32		capacity;		/* queue depth */
115 	int32		queue_count;	/* # msgs waiting to be read */
116 	int32		total_count;	/* total # msgs read so far */
117 } port_info;
118 
119 extern port_id		create_port(int32 capacity, const char *name);
120 extern port_id		find_port(const char *name);
121 extern ssize_t		read_port(port_id port, int32 *code, void *buffer,
122 						size_t bufferSize);
123 extern ssize_t		read_port_etc(port_id port, int32 *code, void *buffer,
124 						size_t bufferSize, uint32 flags, bigtime_t timeout);
125 extern status_t		write_port(port_id port, int32 code, const void *buffer,
126 						size_t bufferSize);
127 extern status_t		write_port_etc(port_id port, int32 code, const void *buffer,
128 						size_t bufferSize, uint32 flags, bigtime_t timeout);
129 extern status_t		close_port(port_id port);
130 extern status_t		delete_port(port_id port);
131 
132 extern ssize_t		port_buffer_size(port_id port);
133 extern ssize_t		port_buffer_size_etc(port_id port, uint32 flags,
134 						bigtime_t timeout);
135 extern ssize_t		port_count(port_id port);
136 extern status_t		set_port_owner(port_id port, team_id team);
137 
138 /* system private, use the macros instead */
139 extern status_t		_get_port_info(port_id port, port_info *portInfo,
140 						size_t portInfoSize);
141 extern status_t		_get_next_port_info(team_id team, int32 *cookie,
142 						port_info *portInfo, size_t portInfoSize);
143 
144 #define get_port_info(port, info) \
145 	_get_port_info((port), (info), sizeof(*(info)))
146 #define get_next_port_info(team, cookie, info) \
147 	_get_next_port_info((team), (cookie), (info), sizeof(*(info)))
148 
149 
150 /* WARNING: The following is Haiku experimental API. It might be removed or
151    changed in the future. */
152 
153 typedef struct port_message_info {
154 	size_t		size;
155 	uid_t		sender;
156 	gid_t		sender_group;
157 	team_id		sender_team;
158 } port_message_info;
159 
160 /* similar to port_buffer_size_etc(), but returns (more) info */
161 extern status_t		_get_port_message_info_etc(port_id port,
162 						port_message_info *info, size_t infoSize, uint32 flags,
163 						bigtime_t timeout);
164 
165 #define get_port_message_info_etc(port, info, flags, timeout) \
166 	_get_port_message_info_etc((port), (info), sizeof(*(info)), flags, timeout)
167 
168 
169 /* Semaphores */
170 
171 typedef struct sem_info {
172 	sem_id		sem;
173 	team_id		team;
174 	char		name[B_OS_NAME_LENGTH];
175 	int32		count;
176 	thread_id	latest_holder;
177 } sem_info;
178 
179 /* semaphore flags */
180 enum {
181 	B_CAN_INTERRUPT				= 0x01,	/* acquisition of the semaphore can be
182 										   interrupted (system use only) */
183 	B_CHECK_PERMISSION			= 0x04,	/* ownership will be checked (system use
184 										   only) */
185 	B_KILL_CAN_INTERRUPT		= 0x20,	/* acquisition of the semaphore can be
186 										   interrupted by SIGKILL[THR], even
187 										   if not B_CAN_INTERRUPT (system use
188 										   only) */
189 
190 	/* release_sem_etc() only flags */
191 	B_DO_NOT_RESCHEDULE			= 0x02,	/* thread is not rescheduled */
192 	B_RELEASE_ALL				= 0x08,	/* all waiting threads will be woken up,
193 										   count will be zeroed */
194 	B_RELEASE_IF_WAITING_ONLY	= 0x10	/* release count only if there are any
195 										   threads waiting */
196 };
197 
198 extern sem_id		create_sem(int32 count, const char *name);
199 extern status_t		delete_sem(sem_id id);
200 extern status_t		acquire_sem(sem_id id);
201 extern status_t		acquire_sem_etc(sem_id id, int32 count, uint32 flags,
202 						bigtime_t timeout);
203 extern status_t		release_sem(sem_id id);
204 extern status_t		release_sem_etc(sem_id id, int32 count, uint32 flags);
205 /* TODO: the following two calls are not part of the BeOS API, and might be
206    changed or even removed for the final release of Haiku R1 */
207 extern status_t		switch_sem(sem_id semToBeReleased, sem_id id);
208 extern status_t		switch_sem_etc(sem_id semToBeReleased, sem_id id,
209 						int32 count, uint32 flags, bigtime_t timeout);
210 extern status_t		get_sem_count(sem_id id, int32 *threadCount);
211 extern status_t		set_sem_owner(sem_id id, team_id team);
212 
213 /* system private, use the macros instead */
214 extern status_t		_get_sem_info(sem_id id, struct sem_info *info,
215 						size_t infoSize);
216 extern status_t		_get_next_sem_info(team_id team, int32 *cookie,
217 						struct sem_info *info, size_t infoSize);
218 
219 #define get_sem_info(sem, info) \
220 	_get_sem_info((sem), (info), sizeof(*(info)))
221 
222 #define get_next_sem_info(team, cookie, info) \
223 	_get_next_sem_info((team), (cookie), (info), sizeof(*(info)))
224 
225 
226 /* Teams */
227 
228 typedef struct {
229 	team_id			team;
230 	int32			thread_count;
231 	int32			image_count;
232 	int32			area_count;
233 	thread_id		debugger_nub_thread;
234 	port_id			debugger_nub_port;
235 	int32			argc;
236 	char			args[64];
237 	uid_t			uid;
238 	gid_t			gid;
239 } team_info;
240 
241 #define B_CURRENT_TEAM	0
242 #define B_SYSTEM_TEAM	1
243 
244 extern status_t		kill_team(team_id team);
245 	/* see also: send_signal() */
246 
247 /* system private, use macros instead */
248 extern status_t		_get_team_info(team_id id, team_info *info, size_t size);
249 extern status_t		_get_next_team_info(int32 *cookie, team_info *info,
250 						size_t size);
251 
252 #define get_team_info(id, info) \
253 	_get_team_info((id), (info), sizeof(*(info)))
254 
255 #define get_next_team_info(cookie, info) \
256 	_get_next_team_info((cookie), (info), sizeof(*(info)))
257 
258 /* team usage info */
259 
260 typedef struct {
261 	bigtime_t		user_time;
262 	bigtime_t		kernel_time;
263 } team_usage_info;
264 
265 enum {
266 	/* compatible to sys/resource.h RUSAGE_SELF and RUSAGE_CHILDREN */
267 	B_TEAM_USAGE_SELF		= 0,
268 	B_TEAM_USAGE_CHILDREN	= -1
269 };
270 
271 /* system private, use macros instead */
272 extern status_t		_get_team_usage_info(team_id team, int32 who,
273 						team_usage_info *info, size_t size);
274 
275 #define get_team_usage_info(team, who, info) \
276 	_get_team_usage_info((team), (who), (info), sizeof(*(info)))
277 
278 
279 /* Threads */
280 
281 typedef enum {
282 	B_THREAD_RUNNING	= 1,
283 	B_THREAD_READY,
284 	B_THREAD_RECEIVING,
285 	B_THREAD_ASLEEP,
286 	B_THREAD_SUSPENDED,
287 	B_THREAD_WAITING
288 } thread_state;
289 
290 typedef struct {
291 	thread_id		thread;
292 	team_id			team;
293 	char			name[B_OS_NAME_LENGTH];
294 	thread_state	state;
295 	int32			priority;
296 	sem_id			sem;
297 	bigtime_t		user_time;
298 	bigtime_t		kernel_time;
299 	void			*stack_base;
300 	void			*stack_end;
301 } thread_info;
302 
303 #define B_IDLE_PRIORITY					0
304 #define B_LOWEST_ACTIVE_PRIORITY		1
305 #define B_LOW_PRIORITY					5
306 #define B_NORMAL_PRIORITY				10
307 #define B_DISPLAY_PRIORITY				15
308 #define	B_URGENT_DISPLAY_PRIORITY		20
309 #define	B_REAL_TIME_DISPLAY_PRIORITY	100
310 #define	B_URGENT_PRIORITY				110
311 #define B_REAL_TIME_PRIORITY			120
312 
313 #define B_SYSTEM_TIMEBASE				0
314 
315 #define B_FIRST_REAL_TIME_PRIORITY		B_REAL_TIME_DISPLAY_PRIORITY
316 
317 typedef status_t (*thread_func)(void *);
318 #define thread_entry thread_func
319 	/* thread_entry is for backward compatibility only! Use thread_func */
320 
321 extern thread_id	spawn_thread(thread_func, const char *name, int32 priority,
322 						void *data);
323 extern status_t		kill_thread(thread_id thread);
324 extern status_t		resume_thread(thread_id thread);
325 extern status_t		suspend_thread(thread_id thread);
326 
327 extern status_t		rename_thread(thread_id thread, const char *newName);
328 extern status_t		set_thread_priority(thread_id thread, int32 newPriority);
329 extern void			exit_thread(status_t status);
330 extern status_t		wait_for_thread(thread_id thread, status_t *returnValue);
331 extern status_t		on_exit_thread(void (*callback)(void *), void *data);
332 
333 extern thread_id 	find_thread(const char *name);
334 
335 extern status_t		send_data(thread_id thread, int32 code, const void *buffer,
336 						size_t bufferSize);
337 extern int32		receive_data(thread_id *sender, void *buffer,
338 						size_t bufferSize);
339 extern bool			has_data(thread_id thread);
340 
341 extern status_t		snooze(bigtime_t amount);
342 extern status_t		snooze_etc(bigtime_t amount, int timeBase, uint32 flags);
343 extern status_t		snooze_until(bigtime_t time, int timeBase);
344 
345 /* system private, use macros instead */
346 extern status_t		_get_thread_info(thread_id id, thread_info *info, size_t size);
347 extern status_t		_get_next_thread_info(team_id team, int32 *cookie,
348 						thread_info *info, size_t size);
349 
350 #define get_thread_info(id, info) \
351 	_get_thread_info((id), (info), sizeof(*(info)))
352 
353 #define get_next_thread_info(team, cookie, info) \
354 	_get_next_thread_info((team), (cookie), (info), sizeof(*(info)))
355 
356 /* bridge to the pthread API */
357 extern thread_id	get_pthread_thread_id(pthread_t thread);
358 /* TODO: Would be nice to have, but we use TLS to associate a thread with its
359    pthread object. So this is not trivial to implement.
360 extern status_t		convert_to_pthread(thread_id thread, pthread_t *_thread);
361 */
362 
363 
364 /* Time */
365 
366 extern uint32		real_time_clock(void);
367 extern void			set_real_time_clock(uint32 secsSinceJan1st1970);
368 extern bigtime_t	real_time_clock_usecs(void);
369 extern bigtime_t	system_time(void);
370 						/* time since booting in microseconds */
371 extern nanotime_t	system_time_nsecs();
372 						/* time since booting in nanoseconds */
373 
374 					// deprecated (is no-op)
375 extern status_t		set_timezone(const char *timezone);
376 
377 /* Alarm */
378 
379 enum {
380 	B_ONE_SHOT_ABSOLUTE_ALARM	= 1,
381 	B_ONE_SHOT_RELATIVE_ALARM,
382 	B_PERIODIC_ALARM			/* "when" specifies the period */
383 };
384 
385 extern bigtime_t	set_alarm(bigtime_t when, uint32 flags);
386 
387 
388 /* Debugger */
389 
390 extern void			debugger(const char *message);
391 
392 /*
393    calling this function with a non-zero value will cause your thread
394    to receive signals for any exceptional conditions that occur (i.e.
395    you'll get SIGSEGV for data access exceptions, SIGFPE for floating
396    point errors, SIGILL for illegal instructions, etc).
397 
398    to re-enable the default debugger pass a zero.
399 */
400 extern int			disable_debugger(int state);
401 
402 /* TODO: Remove. Temporary debug helper. */
403 extern void			debug_printf(const char *format, ...)
404 						__attribute__ ((format (__printf__, 1, 2)));
405 extern void			debug_vprintf(const char *format, va_list args);
406 extern void			ktrace_printf(const char *format, ...)
407 						__attribute__ ((format (__printf__, 1, 2)));
408 extern void			ktrace_vprintf(const char *format, va_list args);
409 
410 
411 /* System information */
412 
413 #if __INTEL__
414 #	define B_MAX_CPU_COUNT	8
415 #elif __POWERPC__
416 #	define B_MAX_CPU_COUNT	8
417 #elif __M68K__
418 #	define B_MAX_CPU_COUNT	1
419 #elif __ARM__
420 #	define B_MAX_CPU_COUNT	1
421 #elif __MIPSEL__
422 #	define B_MAX_CPU_COUNT	1
423 #else
424 #	warning Unknown cpu
425 #	define B_MAX_CPU_COUNT	1
426 #endif
427 
428 typedef enum cpu_types {
429 	/* TODO: add latest models */
430 
431 	/* Motorola/IBM */
432 	B_CPU_PPC_UNKNOWN					= 0,
433 	B_CPU_PPC_601						= 1,
434 	B_CPU_PPC_602						= 7,
435 	B_CPU_PPC_603						= 2,
436 	B_CPU_PPC_603e						= 3,
437 	B_CPU_PPC_603ev						= 8,
438 	B_CPU_PPC_604						= 4,
439 	B_CPU_PPC_604e						= 5,
440 	B_CPU_PPC_604ev						= 9,
441 	B_CPU_PPC_620						= 10,
442 	B_CPU_PPC_750   					= 6,
443 	B_CPU_PPC_686						= 13,
444 	B_CPU_PPC_860						= 25,
445 	B_CPU_PPC_7400						= 26,
446 	B_CPU_PPC_7410						= 27,
447 	B_CPU_PPC_7447A						= 28,
448 	B_CPU_PPC_7448						= 29,
449 	B_CPU_PPC_7450						= 30,
450 	B_CPU_PPC_7455						= 31,
451 	B_CPU_PPC_7457						= 32,
452 	B_CPU_PPC_8240						= 33,
453 	B_CPU_PPC_8245						= 34,
454 
455 	B_CPU_PPC_IBM_401A1					= 35,
456 	B_CPU_PPC_IBM_401B2					= 36,
457 	B_CPU_PPC_IBM_401C2					= 37,
458 	B_CPU_PPC_IBM_401D2					= 38,
459 	B_CPU_PPC_IBM_401E2					= 39,
460 	B_CPU_PPC_IBM_401F2					= 40,
461 	B_CPU_PPC_IBM_401G2					= 41,
462 	B_CPU_PPC_IBM_403					= 42,
463 	B_CPU_PPC_IBM_405GP					= 43,
464 	B_CPU_PPC_IBM_405L					= 44,
465 	B_CPU_PPC_IBM_750FX					= 45,
466 	B_CPU_PPC_IBM_POWER3				= 46,
467 
468 	/* Intel */
469 
470 	/* Updated according to Intel(R) Processor Identification and
471 	 * the  CPUID instruction (Table 4)
472 	 * AP-485 Intel - 24161832.pdf
473 	 */
474 	B_CPU_INTEL_x86						= 0x1000,
475 	B_CPU_INTEL_PENTIUM					= 0x1051,
476 	B_CPU_INTEL_PENTIUM75,
477 	B_CPU_INTEL_PENTIUM_486_OVERDRIVE,
478 	B_CPU_INTEL_PENTIUM_MMX,
479 	B_CPU_INTEL_PENTIUM_MMX_MODEL_4		= B_CPU_INTEL_PENTIUM_MMX,
480 	B_CPU_INTEL_PENTIUM_MMX_MODEL_8		= 0x1058,
481 	B_CPU_INTEL_PENTIUM75_486_OVERDRIVE,
482 	B_CPU_INTEL_PENTIUM_PRO				= 0x1061,
483 	B_CPU_INTEL_PENTIUM_II				= 0x1063,
484 	B_CPU_INTEL_PENTIUM_II_MODEL_3		= 0x1063,
485 	B_CPU_INTEL_PENTIUM_II_MODEL_5		= 0x1065,
486 	B_CPU_INTEL_CELERON					= 0x1066,
487 	B_CPU_INTEL_CELERON_MODEL_22		= 0x11066,
488 	B_CPU_INTEL_PENTIUM_III				= 0x1067,
489 	B_CPU_INTEL_PENTIUM_III_MODEL_8		= 0x1068,
490 	B_CPU_INTEL_PENTIUM_M				= 0x1069,
491 	B_CPU_INTEL_PENTIUM_III_XEON		= 0x106a,
492 	B_CPU_INTEL_PENTIUM_III_MODEL_11 	= 0x106b,
493 	B_CPU_INTEL_ATOM			= 0x1106c,
494 	B_CPU_INTEL_PENTIUM_M_MODEL_13		= 0x106d, /* Dothan */
495 	B_CPU_INTEL_PENTIUM_CORE,
496 	B_CPU_INTEL_PENTIUM_CORE_2,
497 	B_CPU_INTEL_PENTIUM_CORE_2_45_NM	= 0x11067, /* Core 2 on 45 nm
498 	                                                   (Core 2 Extreme,
499 	                                                   Xeon model 23 or
500 	                                                   Core 2 Duo/Quad) */
501 	B_CPU_INTEL_PENTIUM_CORE_I5_M430	= 0x21065, /* Core i5 M 430 @ 2.27 */
502 	B_CPU_INTEL_PENTIUM_CORE_I7			= 0x1106a, /* Core i7 920 @ 2.6(6) */
503 	B_CPU_INTEL_PENTIUM_CORE_I7_Q720	= 0x1106e, /* Core i7 Q720 @ 1.6 */
504 	B_CPU_INTEL_PENTIUM_IV				= 0x10f0,
505 	B_CPU_INTEL_PENTIUM_IV_MODEL_1,
506 	B_CPU_INTEL_PENTIUM_IV_MODEL_2,
507 	B_CPU_INTEL_PENTIUM_IV_MODEL_3,
508 	B_CPU_INTEL_PENTIUM_IV_MODEL_4,
509 
510 	/* AMD */
511 
512 	/* Checked with "AMD Processor Recognition Application Note"
513 	 * (Table 3)
514 	 * 20734.pdf
515 	 */
516 	B_CPU_AMD_x86						= 0x1100,
517 	B_CPU_AMD_K5_MODEL_0				= 0x1150,
518 	B_CPU_AMD_K5_MODEL_1,
519 	B_CPU_AMD_K5_MODEL_2,
520 	B_CPU_AMD_K5_MODEL_3,
521 	B_CPU_AMD_K6_MODEL_6				= 0x1156,
522 	B_CPU_AMD_K6_MODEL_7				= 0x1157,
523 	B_CPU_AMD_K6_MODEL_8				= 0x1158,
524 	B_CPU_AMD_K6_2						= 0x1158,
525 	B_CPU_AMD_K6_MODEL_9				= 0x1159,
526 	B_CPU_AMD_K6_III					= 0x1159,
527 	B_CPU_AMD_K6_III_MODEL_13			= 0x115d,
528 
529 	B_CPU_AMD_ATHLON_MODEL_1			= 0x1161,
530 	B_CPU_AMD_ATHLON_MODEL_2			= 0x1162,
531 
532 	B_CPU_AMD_DURON 					= 0x1163,
533 
534 	B_CPU_AMD_ATHLON_THUNDERBIRD		= 0x1164,
535 	B_CPU_AMD_ATHLON_XP 				= 0x1166,
536 	B_CPU_AMD_ATHLON_XP_MODEL_7,
537 	B_CPU_AMD_ATHLON_XP_MODEL_8,
538 	B_CPU_AMD_ATHLON_XP_MODEL_10		= 0x116a, /* Barton */
539 
540 	B_CPU_AMD_SEMPRON_MODEL_8			= B_CPU_AMD_ATHLON_XP_MODEL_8,
541 	B_CPU_AMD_SEMPRON_MODEL_10			= B_CPU_AMD_ATHLON_XP_MODEL_10,
542 
543 	/* According to "Revision Guide for AMD Family 10h
544 	 * Processors" (41322.pdf)
545 	 */
546 	B_CPU_AMD_PHENOM					= 0x11f2,
547 
548 	/* According to "Revision guide for AMD Athlon 64
549 	 * and AMD Opteron Processors" (25759.pdf)
550 	 */
551 	B_CPU_AMD_ATHLON_64_MODEL_3			= 0x11f3,
552 	B_CPU_AMD_ATHLON_64_MODEL_4,
553 	B_CPU_AMD_ATHLON_64_MODEL_5,
554 	B_CPU_AMD_OPTERON					= B_CPU_AMD_ATHLON_64_MODEL_5,
555 	B_CPU_AMD_ATHLON_64_FX				= B_CPU_AMD_ATHLON_64_MODEL_5,
556 	B_CPU_AMD_ATHLON_64_MODEL_7			= 0x11f7,
557 	B_CPU_AMD_ATHLON_64_MODEL_8,
558 	B_CPU_AMD_ATHLON_64_MODEL_11		= 0x11fb,
559 	B_CPU_AMD_ATHLON_64_MODEL_12,
560 	B_CPU_AMD_ATHLON_64_MODEL_14		= 0x11fe,
561 	B_CPU_AMD_ATHLON_64_MODEL_15,
562 
563 	B_CPU_AMD_GEODE_LX					= 0x115a,
564 
565 	/* VIA/Cyrix */
566 	B_CPU_CYRIX_x86						= 0x1200,
567 	B_CPU_VIA_CYRIX_x86					= 0x1200,
568 	B_CPU_CYRIX_GXm						= 0x1254,
569 	B_CPU_CYRIX_6x86MX					= 0x1260,
570 
571 	/* VIA/IDT */
572 	B_CPU_IDT_x86						= 0x1300,
573 	B_CPU_VIA_IDT_x86					= 0x1300,
574 	B_CPU_IDT_WINCHIP_C6				= 0x1354,
575 	B_CPU_IDT_WINCHIP_2					= 0x1358,
576 	B_CPU_IDT_WINCHIP_3,
577 	B_CPU_VIA_C3_SAMUEL					= 0x1366,
578 	B_CPU_VIA_C3_SAMUEL_2				= 0x1367,
579 	B_CPU_VIA_C3_EZRA_T					= 0x1368,
580 	B_CPU_VIA_C3_NEHEMIAH				= 0x1369,
581 	B_CPU_VIA_C7_ESTHER					= 0x136a,
582 	B_CPU_VIA_C7_ESTHER_2				= 0x136d,
583 	B_CPU_VIA_NANO_ISAIAH				= 0x136f,
584 
585 	/* Transmeta */
586 	B_CPU_TRANSMETA_x86					= 0x1600,
587 	B_CPU_TRANSMETA_CRUSOE				= 0x1654,
588 	B_CPU_TRANSMETA_EFFICEON			= 0x16f2,
589 	B_CPU_TRANSMETA_EFFICEON_2			= 0x16f3,
590 
591 	/* Rise */
592 	B_CPU_RISE_x86						= 0x1400,
593 	B_CPU_RISE_mP6						= 0x1450,
594 
595 	/* National Semiconductor */
596 	B_CPU_NATIONAL_x86					= 0x1500,
597 	B_CPU_NATIONAL_GEODE_GX1			= 0x1554,
598 	B_CPU_NATIONAL_GEODE_GX2,
599 
600 	/* For compatibility */
601 	B_CPU_AMD_29K						= 14,
602 	B_CPU_x86,
603 	B_CPU_MC6502,
604 	B_CPU_Z80,
605 	B_CPU_ALPHA,
606 	B_CPU_MIPS,
607 	B_CPU_HPPA,
608 	B_CPU_M68K,
609 	B_CPU_ARM,
610 	B_CPU_SH,
611 	B_CPU_SPARC
612 } cpu_type;
613 
614 #define B_CPU_x86_VENDOR_MASK	0xff00
615 
616 #ifdef __INTEL__
617 typedef union {
618 	struct {
619 		uint32	max_eax;
620 		char	vendor_id[12];
621 	} eax_0;
622 
623 	struct {
624 		uint32	stepping		: 4;
625 		uint32	model			: 4;
626 		uint32	family			: 4;
627 		uint32	type			: 2;
628 		uint32	reserved_0		: 2;
629 		uint32	extended_model	: 4;
630 		uint32	extended_family	: 8;
631 		uint32	reserved_1		: 4;
632 
633 		uint32	brand_index		: 8;
634 		uint32	clflush			: 8;
635 		uint32	logical_cpus	: 8;
636 		uint32	apic_id			: 8;
637 
638 		uint32	features;
639 		uint32	extended_features;
640 	} eax_1;
641 
642 	struct {
643 		uint8	call_num;
644 		uint8	cache_descriptors[15];
645 	} eax_2;
646 
647 	struct {
648 		uint32	reserved[2];
649 		uint32	serial_number_high;
650 		uint32	serial_number_low;
651 	} eax_3;
652 
653 	char		as_chars[16];
654 
655 	struct {
656 		uint32	eax;
657 		uint32	ebx;
658 		uint32	edx;
659 		uint32	ecx;
660 	} regs;
661 } cpuid_info;
662 
663 extern status_t		get_cpuid(cpuid_info *info, uint32 eaxRegister,
664 						uint32 cpuNum);
665 #endif
666 
667 
668 typedef enum platform_types {
669 	B_BEBOX_PLATFORM = 0,
670 	B_MAC_PLATFORM,
671 	B_AT_CLONE_PLATFORM,
672 	B_ENIAC_PLATFORM,
673 	B_APPLE_II_PLATFORM,
674 	B_CRAY_PLATFORM,
675 	B_LISA_PLATFORM,
676 	B_TI_994A_PLATFORM,
677 	B_TIMEX_SINCLAIR_PLATFORM,
678 	B_ORAC_1_PLATFORM,
679 	B_HAL_PLATFORM,
680 	B_BESM_6_PLATFORM,
681 	B_MK_61_PLATFORM,
682 	B_NINTENDO_64_PLATFORM,
683 	B_AMIGA_PLATFORM,
684 	B_ATARI_PLATFORM
685 } platform_type;
686 
687 typedef struct {
688 	bigtime_t	active_time;	/* usec of doing useful work since boot */
689 } cpu_info;
690 
691 
692 typedef int32 machine_id[2];	/* unique machine ID */
693 
694 typedef struct {
695 	machine_id		id;					/* unique machine ID */
696 	bigtime_t		boot_time;			/* time of boot (usecs since 1/1/1970) */
697 
698 	int32			cpu_count;			/* number of cpus */
699 	enum cpu_types	cpu_type;			/* type of cpu */
700 	int32			cpu_revision;		/* revision # of cpu */
701 	cpu_info		cpu_infos[B_MAX_CPU_COUNT];	/* info about individual cpus */
702 	int64			cpu_clock_speed;	/* processor clock speed (Hz) */
703 	int64			bus_clock_speed;	/* bus clock speed (Hz) */
704 	enum platform_types platform_type;	/* type of machine we're on */
705 
706 	int32			max_pages;			/* total # of accessible pages */
707 	int32			used_pages;			/* # of accessible pages in use */
708 	int32			page_faults;		/* # of page faults */
709 	int32			max_sems;
710 	int32			used_sems;
711 	int32			max_ports;
712 	int32			used_ports;
713 	int32			max_threads;
714 	int32			used_threads;
715 	int32			max_teams;
716 	int32			used_teams;
717 
718 	char			kernel_name[B_FILE_NAME_LENGTH];
719 	char			kernel_build_date[B_OS_NAME_LENGTH];
720 	char			kernel_build_time[B_OS_NAME_LENGTH];
721 	int64			kernel_version;
722 
723 	bigtime_t		_busy_wait_time;	/* reserved for whatever */
724 
725 	int32			cached_pages;
726 	uint32			abi;				/* the system API */
727 	int32			ignored_pages;		/* # of ignored/inaccessible pages */
728 	int32			pad;
729 } system_info;
730 
731 /* system private, use macro instead */
732 extern status_t		_get_system_info(system_info *info, size_t size);
733 
734 #define get_system_info(info) \
735 	_get_system_info((info), sizeof(*(info)))
736 
737 extern int32		is_computer_on(void);
738 extern double		is_computer_on_fire(void);
739 
740 
741 /* WARNING: Experimental API! */
742 
743 enum {
744 	B_OBJECT_TYPE_FD		= 0,
745 	B_OBJECT_TYPE_SEMAPHORE	= 1,
746 	B_OBJECT_TYPE_PORT		= 2,
747 	B_OBJECT_TYPE_THREAD	= 3
748 };
749 
750 enum {
751 	B_EVENT_READ				= 0x0001,	/* FD/port readable */
752 	B_EVENT_WRITE				= 0x0002,	/* FD/port writable */
753 	B_EVENT_ERROR				= 0x0004,	/* FD error */
754 	B_EVENT_PRIORITY_READ		= 0x0008,	/* FD priority readable */
755 	B_EVENT_PRIORITY_WRITE		= 0x0010,	/* FD priority writable */
756 	B_EVENT_HIGH_PRIORITY_READ	= 0x0020,	/* FD high priority readable */
757 	B_EVENT_HIGH_PRIORITY_WRITE	= 0x0040,	/* FD high priority writable */
758 	B_EVENT_DISCONNECTED		= 0x0080,	/* FD disconnected */
759 
760 	B_EVENT_ACQUIRE_SEMAPHORE	= 0x0001,	/* semaphore can be acquired */
761 
762 	B_EVENT_INVALID				= 0x1000	/* FD/port/sem/thread ID not or
763 											   no longer valid (e.g. has been
764 											   close/deleted) */
765 };
766 
767 typedef struct object_wait_info {
768 	int32		object;						/* ID of the object */
769 	uint16		type;						/* type of the object */
770 	uint16		events;						/* events mask */
771 } object_wait_info;
772 
773 /* wait_for_objects[_etc]() waits until at least one of the specified events or,
774    if given, the timeout occurred. When entering the function the
775    object_wait_info::events field specifies the events for each object the
776    caller is interested in. When the function returns the fields reflect the
777    events that actually occurred. The events B_EVENT_INVALID, B_EVENT_ERROR,
778    and B_EVENT_DISCONNECTED don't need to be specified. They will always be
779    reported, when they occur. */
780 
781 extern ssize_t		wait_for_objects(object_wait_info* infos, int numInfos);
782 extern ssize_t		wait_for_objects_etc(object_wait_info* infos, int numInfos,
783 						uint32 flags, bigtime_t timeout);
784 
785 
786 #ifdef __cplusplus
787 }
788 #endif
789 
790 #endif /* _OS_H */
791