60811faf5a4658877fb8fcd502d35762da4ab6b2
[mesa.git] / src / util / 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 #include <stdint.h>
38 #include <stdbool.h>
39
40 #include "detect_os.h"
41
42
43 #if DETECT_OS_UNIX
44 # include <signal.h> /* for kill() */
45 # include <unistd.h> /* getpid() */
46 #endif
47
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53
54 /*
55 * Trap into the debugger.
56 */
57 #if (defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64)) && defined(PIPE_CC_GCC)
58 # define os_break() __asm("int3")
59 #elif defined(PIPE_CC_MSVC)
60 # define os_break() __debugbreak()
61 #elif DETECT_OS_UNIX
62 # define os_break() kill(getpid(), SIGTRAP)
63 #else
64 # define os_break() abort()
65 #endif
66
67
68 /*
69 * Abort the program.
70 */
71 #if defined(DEBUG)
72 # define os_abort() do { os_break(); abort(); } while(0)
73 #else
74 # define os_abort() abort()
75 #endif
76
77
78 /*
79 * Output a message. Message should preferably end in a newline.
80 */
81 void
82 os_log_message(const char *message);
83
84
85 /*
86 * Get an option. Should return NULL if specified option is not set.
87 */
88 const char *
89 os_get_option(const char *name);
90
91
92 /*
93 * Get the total amount of physical memory available on the system.
94 */
95 bool
96 os_get_total_physical_memory(uint64_t *size);
97
98 /*
99 * Amount of physical memory available to a process
100 */
101 bool
102 os_get_available_system_memory(uint64_t *size);
103
104
105 #ifdef __cplusplus
106 }
107 #endif
108
109
110 #endif /* _OS_MISC_H_ */