1 #ifndef UTIL_H 2 #define UTIL_H 3 4 #include <stdarg.h> 5 #include <stdbool.h> 6 #include <getopt.h> 7 8 /* 9 * Copyright 2011 The Chromium Authors, All Rights Reserved. 10 * Copyright 2008 Jon Loeliger, Freescale Semiconductor, Inc. 11 * 12 * This program is free software; you can redistribute it and/or 13 * modify it under the terms of the GNU General Public License as 14 * published by the Free Software Foundation; either version 2 of the 15 * License, or (at your option) any later version. 16 * 17 * This program is distributed in the hope that it will be useful, 18 * but WITHOUT ANY WARRANTY; without even the implied warranty of 19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20 * General Public License for more details. 21 * 22 * You should have received a copy of the GNU General Public License 23 * along with this program; if not, write to the Free Software 24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 25 * USA 26 */ 27 28 #ifdef __GNUC__ 29 #define PRINTF(i, j) __attribute__((format (printf, i, j))) 30 #define NORETURN __attribute__((noreturn)) 31 #else 32 #define PRINTF(i, j) 33 #define NORETURN 34 #endif 35 36 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 37 38 #define stringify(s) stringify_(s) 39 #define stringify_(s) #s 40 41 static inline void NORETURN PRINTF(1, 2) die(const char *str, ...) 42 { 43 va_list ap; 44 45 va_start(ap, str); 46 fprintf(stderr, "FATAL ERROR: "); 47 vfprintf(stderr, str, ap); 48 va_end(ap); 49 exit(1); 50 } 51 52 static inline void *xmalloc(size_t len) 53 { 54 void *new = malloc(len); 55 56 if (!new) 57 die("malloc() failed\n"); 58 59 return new; 60 } 61 62 static inline void *xrealloc(void *p, size_t len) 63 { 64 void *new = realloc(p, len); 65 66 if (!new) 67 die("realloc() failed (len=%zd)\n", len); 68 69 return new; 70 } 71 72 extern char *xstrdup(const char *s); 73 74 extern int PRINTF(2, 3) xasprintf(char **strp, const char *fmt, ...); 75 extern int PRINTF(2, 3) xasprintf_append(char **strp, const char *fmt, ...); 76 extern int xavsprintf_append(char **strp, const char *fmt, va_list ap); 77 extern char *join_path(const char *path, const char *name); 78 79 /** 80 * Check a property of a given length to see if it is all printable and 81 * has a valid terminator. The property can contain either a single string, 82 * or multiple strings each of non-zero length. 83 * 84 * @param data The string to check 85 * @param len The string length including terminator 86 * @return 1 if a valid printable string, 0 if not 87 */ 88 bool util_is_printable_string(const void *data, int len); 89 90 /* 91 * Parse an escaped character starting at index i in string s. The resulting 92 * character will be returned and the index i will be updated to point at the 93 * character directly after the end of the encoding, this may be the '\0' 94 * terminator of the string. 95 */ 96 char get_escape_char(const char *s, int *i); 97 98 /** 99 * Read a device tree file into a buffer. This will report any errors on 100 * stderr. 101 * 102 * @param filename The filename to read, or - for stdin 103 * @param len If non-NULL, the amount of data we managed to read 104 * @return Pointer to allocated buffer containing fdt, or NULL on error 105 */ 106 char *utilfdt_read(const char *filename, size_t *len); 107 108 /** 109 * Read a device tree file into a buffer. Does not report errors, but only 110 * returns them. The value returned can be passed to strerror() to obtain 111 * an error message for the user. 112 * 113 * @param filename The filename to read, or - for stdin 114 * @param buffp Returns pointer to buffer containing fdt 115 * @param len If non-NULL, the amount of data we managed to read 116 * @return 0 if ok, else an errno value representing the error 117 */ 118 int utilfdt_read_err(const char *filename, char **buffp, size_t *len); 119 120 /** 121 * Write a device tree buffer to a file. This will report any errors on 122 * stderr. 123 * 124 * @param filename The filename to write, or - for stdout 125 * @param blob Poiner to buffer containing fdt 126 * @return 0 if ok, -1 on error 127 */ 128 int utilfdt_write(const char *filename, const void *blob); 129 130 /** 131 * Write a device tree buffer to a file. Does not report errors, but only 132 * returns them. The value returned can be passed to strerror() to obtain 133 * an error message for the user. 134 * 135 * @param filename The filename to write, or - for stdout 136 * @param blob Poiner to buffer containing fdt 137 * @return 0 if ok, else an errno value representing the error 138 */ 139 int utilfdt_write_err(const char *filename, const void *blob); 140 141 /** 142 * Decode a data type string. The purpose of this string 143 * 144 * The string consists of an optional character followed by the type: 145 * Modifier characters: 146 * hh or b 1 byte 147 * h 2 byte 148 * l 4 byte, default 149 * 150 * Type character: 151 * s string 152 * i signed integer 153 * u unsigned integer 154 * x hex 155 * 156 * TODO: Implement ll modifier (8 bytes) 157 * TODO: Implement o type (octal) 158 * 159 * @param fmt Format string to process 160 * @param type Returns type found(s/d/u/x), or 0 if none 161 * @param size Returns size found(1,2,4,8) or 4 if none 162 * @return 0 if ok, -1 on error (no type given, or other invalid format) 163 */ 164 int utilfdt_decode_type(const char *fmt, int *type, int *size); 165 166 /* 167 * This is a usage message fragment for the -t option. It is the format 168 * supported by utilfdt_decode_type. 169 */ 170 171 #define USAGE_TYPE_MSG \ 172 "<type>\ts=string, i=int, u=unsigned, x=hex\n" \ 173 "\tOptional modifier prefix:\n" \ 174 "\t\thh or b=byte, h=2 byte, l=4 byte (default)"; 175 176 /** 177 * Print property data in a readable format to stdout 178 * 179 * Properties that look like strings will be printed as strings. Otherwise 180 * the data will be displayed either as cells (if len is a multiple of 4 181 * bytes) or bytes. 182 * 183 * If len is 0 then this function does nothing. 184 * 185 * @param data Pointers to property data 186 * @param len Length of property data 187 */ 188 void utilfdt_print_data(const char *data, int len); 189 190 /** 191 * Show source version and exit 192 */ 193 void NORETURN util_version(void); 194 195 /** 196 * Show usage and exit 197 * 198 * This helps standardize the output of various utils. You most likely want 199 * to use the usage() helper below rather than call this. 200 * 201 * @param errmsg If non-NULL, an error message to display 202 * @param synopsis The initial example usage text (and possible examples) 203 * @param short_opts The string of short options 204 * @param long_opts The structure of long options 205 * @param opts_help An array of help strings (should align with long_opts) 206 */ 207 void NORETURN util_usage(const char *errmsg, const char *synopsis, 208 const char *short_opts, 209 struct option const long_opts[], 210 const char * const opts_help[]); 211 212 /** 213 * Show usage and exit 214 * 215 * If you name all your usage variables with usage_xxx, then you can call this 216 * help macro rather than expanding all arguments yourself. 217 * 218 * @param errmsg If non-NULL, an error message to display 219 */ 220 #define usage(errmsg) \ 221 util_usage(errmsg, usage_synopsis, usage_short_opts, \ 222 usage_long_opts, usage_opts_help) 223 224 /** 225 * Call getopt_long() with standard options 226 * 227 * Since all util code runs getopt in the same way, provide a helper. 228 */ 229 #define util_getopt_long() getopt_long(argc, argv, usage_short_opts, \ 230 usage_long_opts, NULL) 231 232 /* Helper for aligning long_opts array */ 233 #define a_argument required_argument 234 235 /* Helper for usage_short_opts string constant */ 236 #define USAGE_COMMON_SHORT_OPTS "hV" 237 238 /* Helper for usage_long_opts option array */ 239 #define USAGE_COMMON_LONG_OPTS \ 240 {"help", no_argument, NULL, 'h'}, \ 241 {"version", no_argument, NULL, 'V'}, \ 242 {NULL, no_argument, NULL, 0x0} 243 244 /* Helper for usage_opts_help array */ 245 #define USAGE_COMMON_OPTS_HELP \ 246 "Print this help and exit", \ 247 "Print version and exit", \ 248 NULL 249 250 /* Helper for getopt case statements */ 251 #define case_USAGE_COMMON_FLAGS \ 252 case 'h': usage(NULL); \ 253 case 'V': util_version(); \ 254 case '?': usage("unknown option"); 255 256 #endif /* UTIL_H */ 257