os: New OS abstraction module.
[mesa.git] / src / gallium / auxiliary / os / os_misc.h
1 /**************************************************************************
2 *
3 * Copyright 2010 Vmware, Inc.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28
29 /*
30 * Miscellaneous OS services.
31 */
32
33
34 #ifndef _OS_MISC_H_
35 #define _OS_MISC_H_
36
37
38 #include "pipe/p_compiler.h"
39
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45
46 /*
47 * Trap into the debugger.
48 */
49 #if (defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64)) && defined(PIPE_CC_GCC)
50 # define os_break() __asm("int3")
51 #elif defined(PIPE_CC_MSVC)
52 # define os_break() __debugbreak()
53 #elif defined(PIPE_OS_UNIX)
54 # include <signal.h> /* for kill() */
55 # include <unistd.h> /* for getpid() */
56 # define os_break() kill(getpid(), SIGTRAP)
57 #elif defined(PIPE_OS_EMBEDDED)
58 void os_break(void);
59 #else
60 # define os_break() abort()
61 #endif
62
63
64 /*
65 * Abort the program.
66 */
67 #if defined(DEBUG) || defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY) || defined(PIPE_SUBSYSTEM_WINDOWS_MINIPORT)
68 # define os_abort() os_break()
69 #elif defined(PIPE_OS_EMBEDDED)
70 void os_abort(void);
71 #else
72 # define os_abort() abort()
73 #endif
74
75
76 /*
77 * Output a message. Message should preferably end in a newline.
78 */
79 void
80 os_log_message(const char *message);
81
82
83 /*
84 * Get an option. Should return NULL if specified option is not set.
85 */
86 const char *
87 os_get_option(const char *name);
88
89
90 #ifdef __cplusplus
91 }
92 #endif
93
94
95 #endif /* _OS_MISC_H_ */