Home | History | Annotate | Download | only in os 
      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 #if defined(PIPE_OS_UNIX)
     42 #  include <signal.h> /* for kill() */
     43 #  include <unistd.h> /* getpid() */
     44 #endif
     45 
     46 
     47 #ifdef  __cplusplus
     48 extern "C" {
     49 #endif
     50 
     51 
     52 /*
     53  * Trap into the debugger.
     54  */
     55 #if (defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64)) && defined(PIPE_CC_GCC)
     56 #  define os_break() __asm("int3")
     57 #elif defined(PIPE_CC_MSVC)
     58 #  define os_break()  __debugbreak()
     59 #elif defined(PIPE_OS_UNIX)
     60 #  define os_break() kill(getpid(), SIGTRAP)
     61 #else
     62 #  define os_break() abort()
     63 #endif
     64 
     65 
     66 /*
     67  * Abort the program.
     68  */
     69 #if defined(DEBUG)
     70 #  define os_abort() do { os_break(); abort(); } while(0)
     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 /*
     91  * Get the total amount of physical memory available on the system.
     92  */
     93 bool
     94 os_get_total_physical_memory(uint64_t *size);
     95 
     96 
     97 #ifdef	__cplusplus
     98 }
     99 #endif
    100 
    101 
    102 #endif /* _OS_MISC_H_ */
    103