1 /* Declarations for common convenience functions. 2 Copyright (C) 2006-2011 Red Hat, Inc. 3 This file is part of Red Hat elfutils. 4 5 Red Hat elfutils is free software; you can redistribute it and/or modify 6 it under the terms of the GNU General Public License as published by the 7 Free Software Foundation; version 2 of the License. 8 9 Red Hat elfutils is distributed in the hope that it will be useful, but 10 WITHOUT ANY WARRANTY; without even the implied warranty of 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 General Public License for more details. 13 14 You should have received a copy of the GNU General Public License along 15 with Red Hat elfutils; if not, write to the Free Software Foundation, 16 Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA. 17 18 In addition, as a special exception, Red Hat, Inc. gives You the 19 additional right to link the code of Red Hat elfutils with code licensed 20 under an Open Source Initiative certified open source license 21 (http://www.opensource.org/licenses/index.php) and to distribute linked 22 combinations including the two. Non-GPL Code permitted under this 23 exception must only link to the code of Red Hat elfutils through those 24 well defined interfaces identified in the file named EXCEPTION found in 25 the source code files (the "Approved Interfaces"). The files of Non-GPL 26 Code may instantiate templates or use macros or inline functions from 27 the Approved Interfaces without causing the resulting work to be covered 28 by the GNU General Public License. Only Red Hat, Inc. may make changes 29 or additions to the list of Approved Interfaces. Red Hat's grant of 30 this exception is conditioned upon your not adding any new exceptions. 31 If you wish to add a new Approved Interface or exception, please contact 32 Red Hat. You must obey the GNU General Public License in all respects 33 for all of the Red Hat elfutils code and other code used in conjunction 34 with Red Hat elfutils except the Non-GPL Code covered by this exception. 35 If you modify this file, you may extend this exception to your version 36 of the file, but you are not obligated to do so. If you do not wish to 37 provide this exception without modification, you must delete this 38 exception statement from your version and license this file solely under 39 the GPL without exception. 40 41 Red Hat elfutils is an included package of the Open Invention Network. 42 An included package of the Open Invention Network is a package for which 43 Open Invention Network licensees cross-license their patents. No patent 44 license is granted, either expressly or impliedly, by designation as an 45 included package. Should you wish to participate in the Open Invention 46 Network licensing program, please visit www.openinventionnetwork.com 47 <http://www.openinventionnetwork.com>. */ 48 49 #ifndef LIB_SYSTEM_H 50 #define LIB_SYSTEM_H 1 51 52 #include <argp.h> 53 #include <stddef.h> 54 #include <stdint.h> 55 #include <endian.h> 56 #include <byteswap.h> 57 58 #if __BYTE_ORDER == __LITTLE_ENDIAN 59 # define LE32(n) (n) 60 # define BE32(n) bswap_32 (n) 61 #elif __BYTE_ORDER == __BIG_ENDIAN 62 # define BE32(n) (n) 63 # define LE32(n) bswap_32 (n) 64 #else 65 # error "Unknown byte order" 66 #endif 67 68 extern void *xmalloc (size_t) __attribute__ ((__malloc__)); 69 extern void *xcalloc (size_t, size_t) __attribute__ ((__malloc__)); 70 extern void *xrealloc (void *, size_t) __attribute__ ((__malloc__)); 71 72 extern char *xstrdup (const char *) __attribute__ ((__malloc__)); 73 extern char *xstrndup (const char *, size_t) __attribute__ ((__malloc__)); 74 75 76 extern uint32_t crc32 (uint32_t crc, unsigned char *buf, size_t len); 77 extern int crc32_file (int fd, uint32_t *resp); 78 79 /* A special gettext function we use if the strings are too short. */ 80 #define sgettext(Str) \ 81 ({ const char *__res = strrchr (gettext (Str), '|'); \ 82 __res ? __res + 1 : Str; }) 83 84 #define gettext_noop(Str) Str 85 86 87 #define pwrite_retry(fd, buf, len, off) \ 88 TEMP_FAILURE_RETRY (pwrite (fd, buf, len, off)) 89 #define write_retry(fd, buf, n) \ 90 TEMP_FAILURE_RETRY (write (fd, buf, n)) 91 #define pread_retry(fd, buf, len, off) \ 92 TEMP_FAILURE_RETRY (pread (fd, buf, len, off)) 93 94 95 /* We need define two variables, argp_program_version_hook and 96 argp_program_bug_address, in all programs. argp.h declares these 97 variables as non-const (which is correct in general). But we can 98 do better, it is not going to change. So we want to move them into 99 the .rodata section. Define macros to do the trick. */ 100 #define ARGP_PROGRAM_VERSION_HOOK_DEF \ 101 void (*const apvh) (FILE *, struct argp_state *) \ 102 __asm ("argp_program_version_hook") 103 #define ARGP_PROGRAM_BUG_ADDRESS_DEF \ 104 const char *const apba__ __asm ("argp_program_bug_address") 105 106 107 /* The demangler from libstdc++. */ 108 extern char *__cxa_demangle (const char *mangled_name, char *output_buffer, 109 size_t *length, int *status); 110 111 112 113 /* Color handling. */ 114 115 /* Command line parser. */ 116 extern const struct argp color_argp; 117 118 /* Coloring mode. */ 119 enum color_enum 120 { 121 color_never = 0, 122 color_always, 123 color_auto 124 } __attribute__ ((packed)); 125 extern enum color_enum color_mode; 126 127 /* Colors to use for the various components. */ 128 extern char *color_address; 129 extern char *color_bytes; 130 extern char *color_mnemonic; 131 extern char *color_operand1; 132 extern char *color_operand2; 133 extern char *color_operand3; 134 extern char *color_label; 135 extern char *color_undef; 136 extern char *color_undef_tls; 137 extern char *color_undef_weak; 138 extern char *color_symbol; 139 extern char *color_tls; 140 extern char *color_weak; 141 142 extern const char color_off[]; 143 144 #endif /* system.h */ 145