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