tools/perf/util/util.h

   1 #ifndef GIT_COMPAT_UTIL_H
   2 #define GIT_COMPAT_UTIL_H
   3
   4 #ifndef FLEX_ARRAY
   5 /*
   6  * See if our compiler is known to support flexible array members.
   7  */
   8 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
   9 # define FLEX_ARRAY /* empty */
  10 #elif defined(__GNUC__)
  11 # if (__GNUC__ >= 3)
  12 #  define FLEX_ARRAY /* empty */
  13 # else
  14 #  define FLEX_ARRAY 0 /* older GNU extension */
  15 # endif
  16 #endif
  17
  18 /*
  19  * Otherwise, default to safer but a bit wasteful traditional style
  20  */
  21 #ifndef FLEX_ARRAY
  22 # define FLEX_ARRAY 1
  23 #endif
  24 #endif
  25
  26 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
  27
  28 #ifdef __GNUC__
  29 #define TYPEOF(x) (__typeof__(x))
  30 #else
  31 #define TYPEOF(x)
  32 #endif
  33
  34 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
  35 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
  36
  37 /* Approximation of the length of the decimal representation of this type. */
  38 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  39
  40 #define _ALL_SOURCE 1
  41 #define _BSD_SOURCE 1
  42 /* glibc 2.20 deprecates _BSD_SOURCE in favour of _DEFAULT_SOURCE */
  43 #define _DEFAULT_SOURCE 1
  44 #define HAS_BOOL
  45
  46 #include <unistd.h>
  47 #include <stdio.h>
  48 #include <sys/stat.h>
  49 #include <sys/statfs.h>
  50 #include <fcntl.h>
  51 #include <stdbool.h>
  52 #include <stddef.h>
  53 #include <stdlib.h>
  54 #include <stdarg.h>
  55 #include <string.h>
  56 #include <term.h>
  57 #include <errno.h>
  58 #include <limits.h>
  59 #include <sys/param.h>
  60 #include <sys/types.h>
  61 #include <dirent.h>
  62 #include <sys/time.h>
  63 #include <time.h>
  64 #include <signal.h>
  65 #include <fnmatch.h>
  66 #include <assert.h>
  67 #include <regex.h>
  68 #include <utime.h>
  69 #include <sys/wait.h>
  70 #include <poll.h>
  71 #include <sys/socket.h>
  72 #include <sys/ioctl.h>
  73 #include <inttypes.h>
  74 #include <linux/kernel.h>
  75 #include <linux/magic.h>
  76 #include <linux/types.h>
  77 #include <sys/ttydefaults.h>
  78 #include <api/fs/tracing_path.h>
  79 #include <termios.h>
  80 #include <linux/bitops.h>
  81 #include <termios.h>
  82
  83 extern const char *graph_line;
  84 extern const char *graph_dotted_line;
  85 extern char buildid_dir[];
  86
  87 /* On most systems <limits.h> would have given us this, but
  88  * not on some systems (e.g. GNU/Hurd).
  89  */
  90 #ifndef PATH_MAX
  91 #define PATH_MAX 4096
  92 #endif
  93
  94 #ifndef PRIuMAX
  95 #define PRIuMAX "llu"
  96 #endif
  97
  98 #ifndef PRIu32
  99 #define PRIu32 "u"
 100 #endif
 101
 102 #ifndef PRIx32
 103 #define PRIx32 "x"
 104 #endif
 105
 106 #ifndef PATH_SEP
 107 #define PATH_SEP ':'
 108 #endif
 109
 110 #ifndef STRIP_EXTENSION
 111 #define STRIP_EXTENSION ""
 112 #endif
 113
 114 #ifndef has_dos_drive_prefix
 115 #define has_dos_drive_prefix(path) 0
 116 #endif
 117
 118 #ifndef is_dir_sep
 119 #define is_dir_sep(c) ((c) == '/')
 120 #endif
 121
 122 #ifdef __GNUC__
 123 #define NORETURN __attribute__((__noreturn__))
 124 #else
 125 #define NORETURN
 126 #ifndef __attribute__
 127 #define __attribute__(x)
 128 #endif
 129 #endif
 130
 131 #define PERF_GTK_DSO  "libperf-gtk.so"
 132
 133 /* General helper functions */
 134 extern void usage(const char *err) NORETURN;
 135 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 136 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 137 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 138
 139 #include "../../../include/linux/stringify.h"
 140
 141 #define DIE_IF(cnd)     \
 142         do { if (cnd)   \
 143                 die(" at (" __FILE__ ":" __stringify(__LINE__) "): "    \
 144                     __stringify(cnd) "\n");                             \
 145         } while (0)
 146
 147
 148 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 149 extern void set_warning_routine(void (*routine)(const char *err, va_list params));
 150
 151 extern int prefixcmp(const char *str, const char *prefix);
 152 extern void set_buildid_dir(const char *dir);
 153
 154 static inline const char *skip_prefix(const char *str, const char *prefix)
 155 {
 156         size_t len = strlen(prefix);
 157         return strncmp(str, prefix, len) ? NULL : str + len;
 158 }
 159
 160 #ifdef __GLIBC_PREREQ
 161 #if __GLIBC_PREREQ(2, 1)
 162 #define HAVE_STRCHRNUL
 163 #endif
 164 #endif
 165
 166 #ifndef HAVE_STRCHRNUL
 167 #define strchrnul gitstrchrnul
 168 static inline char *gitstrchrnul(const char *s, int c)
 169 {
 170         while (*s && *s != c)
 171                 s++;
 172         return (char *)s;
 173 }
 174 #endif
 175
 176 /*
 177  * Wrappers:
 178  */
 179 extern char *xstrdup(const char *str);
 180 extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
 181
 182
 183 static inline void *zalloc(size_t size)
 184 {
 185         return calloc(1, size);
 186 }
 187
 188 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
 189
 190 static inline int has_extension(const char *filename, const char *ext)
 191 {
 192         size_t len = strlen(filename);
 193         size_t extlen = strlen(ext);
 194
 195         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 196 }
 197
 198 /* Sane ctype - no locale, and works with signed chars */
 199 #undef isascii
 200 #undef isspace
 201 #undef isdigit
 202 #undef isxdigit
 203 #undef isalpha
 204 #undef isprint
 205 #undef isalnum
 206 #undef islower
 207 #undef isupper
 208 #undef tolower
 209 #undef toupper
 210
 211 #ifndef NSEC_PER_MSEC
 212 #define NSEC_PER_MSEC   1000000L
 213 #endif
 214
 215 int parse_nsec_time(const char *str, u64 *ptime);
 216
 217 extern unsigned char sane_ctype[256];
 218 #define GIT_SPACE               0x01
 219 #define GIT_DIGIT               0x02
 220 #define GIT_ALPHA               0x04
 221 #define GIT_GLOB_SPECIAL        0x08
 222 #define GIT_REGEX_SPECIAL       0x10
 223 #define GIT_PRINT_EXTRA         0x20
 224 #define GIT_PRINT               0x3E
 225 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 226 #define isascii(x) (((x) & ~0x7f) == 0)
 227 #define isspace(x) sane_istest(x,GIT_SPACE)
 228 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 229 #define isxdigit(x)     \
 230         (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
 231 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 232 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 233 #define isprint(x) sane_istest(x,GIT_PRINT)
 234 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
 235 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
 236 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 237 #define toupper(x) sane_case((unsigned char)(x), 0)
 238
 239 static inline int sane_case(int x, int high)
 240 {
 241         if (sane_istest(x, GIT_ALPHA))
 242                 x = (x & ~0x20) | high;
 243         return x;
 244 }
 245
 246 int mkdir_p(char *path, mode_t mode);
 247 int rm_rf(char *path);
 248 int copyfile(const char *from, const char *to);
 249 int copyfile_mode(const char *from, const char *to, mode_t mode);
 250 int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
 251
 252 s64 perf_atoll(const char *str);
 253 char **argv_split(const char *str, int *argcp);
 254 void argv_free(char **argv);
 255 bool strglobmatch(const char *str, const char *pat);
 256 bool strlazymatch(const char *str, const char *pat);
 257 static inline bool strisglob(const char *str)
 258 {
 259         return strpbrk(str, "*?[") != NULL;
 260 }
 261 int strtailcmp(const char *s1, const char *s2);
 262 char *strxfrchar(char *s, char from, char to);
 263 unsigned long convert_unit(unsigned long value, char *unit);
 264 ssize_t readn(int fd, void *buf, size_t n);
 265 ssize_t writen(int fd, void *buf, size_t n);
 266
 267 struct perf_event_attr;
 268
 269 void event_attr_init(struct perf_event_attr *attr);
 270
 271 #define _STR(x) #x
 272 #define STR(x) _STR(x)
 273
 274 size_t hex_width(u64 v);
 275 int hex2u64(const char *ptr, u64 *val);
 276
 277 char *ltrim(char *s);
 278 char *rtrim(char *s);
 279
 280 void dump_stack(void);
 281 void sighandler_dump_stack(int sig);
 282
 283 extern unsigned int page_size;
 284 extern int cacheline_size;
 285
 286 struct parse_tag {
 287         char tag;
 288         int mult;
 289 };
 290
 291 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
 292
 293 #define SRCLINE_UNKNOWN  ((char *) "??:0")
 294
 295 static inline int path__join(char *bf, size_t size,
 296                              const char *path1, const char *path2)
 297 {
 298         return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
 299 }
 300
 301 static inline int path__join3(char *bf, size_t size,
 302                               const char *path1, const char *path2,
 303                               const char *path3)
 304 {
 305         return scnprintf(bf, size, "%s%s%s%s%s",
 306                          path1, path1[0] ? "/" : "",
 307                          path2, path2[0] ? "/" : "", path3);
 308 }
 309
 310 struct dso;
 311 struct symbol;
 312
 313 extern bool srcline_full_filename;
 314 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
 315                   bool show_sym);
 316 char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
 317                   bool show_sym, bool unwind_inlines);
 318 void free_srcline(char *srcline);
 319
 320 int filename__read_str(const char *filename, char **buf, size_t *sizep);
 321 int perf_event_paranoid(void);
 322
 323 void mem_bswap_64(void *src, int byte_size);
 324 void mem_bswap_32(void *src, int byte_size);
 325
 326 const char *get_filename_for_perf_kvm(void);
 327 bool find_process(const char *name);
 328
 329 #ifdef HAVE_ZLIB_SUPPORT
 330 int gzip_decompress_to_file(const char *input, int output_fd);
 331 #endif
 332
 333 #ifdef HAVE_LZMA_SUPPORT
 334 int lzma_decompress_to_file(const char *input, int output_fd);
 335 #endif
 336
 337 char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
 338
 339 static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
 340 {
 341         return asprintf_expr_inout_ints(var, true, nints, ints);
 342 }
 343
 344 static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
 345 {
 346         return asprintf_expr_inout_ints(var, false, nints, ints);
 347 }
 348
 349 int get_stack_size(const char *str, unsigned long *_size);
 350
 351 int fetch_kernel_version(unsigned int *puint,
 352                          char *str, size_t str_sz);
 353 #define KVER_VERSION(x)         (((x) >> 16) & 0xff)
 354 #define KVER_PATCHLEVEL(x)      (((x) >> 8) & 0xff)
 355 #define KVER_SUBLEVEL(x)        ((x) & 0xff)
 356 #define KVER_FMT        "%d.%d.%d"
 357 #define KVER_PARAM(x)   KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
 358
 359 #endif /* GIT_COMPAT_UTIL_H */