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 const char *spaces;
  86 extern const char *dots;
  87 extern char buildid_dir[];
  88
  89 /* On most systems <limits.h> would have given us this, but
  90  * not on some systems (e.g. GNU/Hurd).
  91  */
  92 #ifndef PATH_MAX
  93 #define PATH_MAX 4096
  94 #endif
  95
  96 #ifndef PRIuMAX
  97 #define PRIuMAX "llu"
  98 #endif
  99
 100 #ifndef PRIu32
 101 #define PRIu32 "u"
 102 #endif
 103
 104 #ifndef PRIx32
 105 #define PRIx32 "x"
 106 #endif
 107
 108 #ifndef PATH_SEP
 109 #define PATH_SEP ':'
 110 #endif
 111
 112 #ifndef STRIP_EXTENSION
 113 #define STRIP_EXTENSION ""
 114 #endif
 115
 116 #ifndef has_dos_drive_prefix
 117 #define has_dos_drive_prefix(path) 0
 118 #endif
 119
 120 #ifndef is_dir_sep
 121 #define is_dir_sep(c) ((c) == '/')
 122 #endif
 123
 124 #ifdef __GNUC__
 125 #define NORETURN __attribute__((__noreturn__))
 126 #else
 127 #define NORETURN
 128 #ifndef __attribute__
 129 #define __attribute__(x)
 130 #endif
 131 #endif
 132
 133 #define PERF_GTK_DSO  "libperf-gtk.so"
 134
 135 /* General helper functions */
 136 extern void usage(const char *err) NORETURN;
 137 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 138 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 139 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 140
 141 #include "../../../include/linux/stringify.h"
 142
 143 #define DIE_IF(cnd)     \
 144         do { if (cnd)   \
 145                 die(" at (" __FILE__ ":" __stringify(__LINE__) "): "    \
 146                     __stringify(cnd) "\n");                             \
 147         } while (0)
 148
 149
 150 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 151 extern void set_warning_routine(void (*routine)(const char *err, va_list params));
 152
 153 extern int prefixcmp(const char *str, const char *prefix);
 154 extern void set_buildid_dir(const char *dir);
 155
 156 #ifdef __GLIBC_PREREQ
 157 #if __GLIBC_PREREQ(2, 1)
 158 #define HAVE_STRCHRNUL
 159 #endif
 160 #endif
 161
 162 #ifndef HAVE_STRCHRNUL
 163 #define strchrnul gitstrchrnul
 164 static inline char *gitstrchrnul(const char *s, int c)
 165 {
 166         while (*s && *s != c)
 167                 s++;
 168         return (char *)s;
 169 }
 170 #endif
 171
 172 /*
 173  * Wrappers:
 174  */
 175 extern char *xstrdup(const char *str);
 176 extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
 177
 178
 179 static inline void *zalloc(size_t size)
 180 {
 181         return calloc(1, size);
 182 }
 183
 184 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
 185
 186 /* Sane ctype - no locale, and works with signed chars */
 187 #undef isascii
 188 #undef isspace
 189 #undef isdigit
 190 #undef isxdigit
 191 #undef isalpha
 192 #undef isprint
 193 #undef isalnum
 194 #undef islower
 195 #undef isupper
 196 #undef tolower
 197 #undef toupper
 198
 199 #ifndef NSEC_PER_MSEC
 200 #define NSEC_PER_MSEC   1000000L
 201 #endif
 202
 203 int parse_nsec_time(const char *str, u64 *ptime);
 204
 205 extern unsigned char sane_ctype[256];
 206 #define GIT_SPACE               0x01
 207 #define GIT_DIGIT               0x02
 208 #define GIT_ALPHA               0x04
 209 #define GIT_GLOB_SPECIAL        0x08
 210 #define GIT_REGEX_SPECIAL       0x10
 211 #define GIT_PRINT_EXTRA         0x20
 212 #define GIT_PRINT               0x3E
 213 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 214 #define isascii(x) (((x) & ~0x7f) == 0)
 215 #define isspace(x) sane_istest(x,GIT_SPACE)
 216 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 217 #define isxdigit(x)     \
 218         (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
 219 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 220 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 221 #define isprint(x) sane_istest(x,GIT_PRINT)
 222 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
 223 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
 224 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 225 #define toupper(x) sane_case((unsigned char)(x), 0)
 226
 227 static inline int sane_case(int x, int high)
 228 {
 229         if (sane_istest(x, GIT_ALPHA))
 230                 x = (x & ~0x20) | high;
 231         return x;
 232 }
 233
 234 int mkdir_p(char *path, mode_t mode);
 235 int rm_rf(char *path);
 236 int copyfile(const char *from, const char *to);
 237 int copyfile_mode(const char *from, const char *to, mode_t mode);
 238 int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
 239
 240 s64 perf_atoll(const char *str);
 241 char **argv_split(const char *str, int *argcp);
 242 void argv_free(char **argv);
 243 bool strglobmatch(const char *str, const char *pat);
 244 bool strlazymatch(const char *str, const char *pat);
 245 static inline bool strisglob(const char *str)
 246 {
 247         return strpbrk(str, "*?[") != NULL;
 248 }
 249 int strtailcmp(const char *s1, const char *s2);
 250 char *strxfrchar(char *s, char from, char to);
 251 unsigned long convert_unit(unsigned long value, char *unit);
 252 ssize_t readn(int fd, void *buf, size_t n);
 253 ssize_t writen(int fd, void *buf, size_t n);
 254
 255 struct perf_event_attr;
 256
 257 void event_attr_init(struct perf_event_attr *attr);
 258
 259 #define _STR(x) #x
 260 #define STR(x) _STR(x)
 261
 262 size_t hex_width(u64 v);
 263 int hex2u64(const char *ptr, u64 *val);
 264
 265 char *ltrim(char *s);
 266 char *rtrim(char *s);
 267
 268 void dump_stack(void);
 269 void sighandler_dump_stack(int sig);
 270
 271 extern unsigned int page_size;
 272 extern int cacheline_size;
 273
 274 struct parse_tag {
 275         char tag;
 276         int mult;
 277 };
 278
 279 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
 280
 281 #define SRCLINE_UNKNOWN  ((char *) "??:0")
 282
 283 static inline int path__join(char *bf, size_t size,
 284                              const char *path1, const char *path2)
 285 {
 286         return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
 287 }
 288
 289 static inline int path__join3(char *bf, size_t size,
 290                               const char *path1, const char *path2,
 291                               const char *path3)
 292 {
 293         return scnprintf(bf, size, "%s%s%s%s%s",
 294                          path1, path1[0] ? "/" : "",
 295                          path2, path2[0] ? "/" : "", path3);
 296 }
 297
 298 struct dso;
 299 struct symbol;
 300
 301 extern bool srcline_full_filename;
 302 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
 303                   bool show_sym);
 304 char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
 305                   bool show_sym, bool unwind_inlines);
 306 void free_srcline(char *srcline);
 307
 308 int perf_event_paranoid(void);
 309
 310 void mem_bswap_64(void *src, int byte_size);
 311 void mem_bswap_32(void *src, int byte_size);
 312
 313 const char *get_filename_for_perf_kvm(void);
 314 bool find_process(const char *name);
 315
 316 #ifdef HAVE_ZLIB_SUPPORT
 317 int gzip_decompress_to_file(const char *input, int output_fd);
 318 #endif
 319
 320 #ifdef HAVE_LZMA_SUPPORT
 321 int lzma_decompress_to_file(const char *input, int output_fd);
 322 #endif
 323
 324 char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
 325
 326 static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
 327 {
 328         return asprintf_expr_inout_ints(var, true, nints, ints);
 329 }
 330
 331 static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
 332 {
 333         return asprintf_expr_inout_ints(var, false, nints, ints);
 334 }
 335
 336 int get_stack_size(const char *str, unsigned long *_size);
 337
 338 int fetch_kernel_version(unsigned int *puint,
 339                          char *str, size_t str_sz);
 340 #define KVER_VERSION(x)         (((x) >> 16) & 0xff)
 341 #define KVER_PATCHLEVEL(x)      (((x) >> 8) & 0xff)
 342 #define KVER_SUBLEVEL(x)        ((x) & 0xff)
 343 #define KVER_FMT        "%d.%d.%d"
 344 #define KVER_PARAM(x)   KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
 345
 346 const char *perf_tip(const char *dirpath);
 347 bool is_regular_file(const char *file);
 348 int fetch_current_timestamp(char *buf, size_t sz);
 349
 350 enum binary_printer_ops {
 351         BINARY_PRINT_DATA_BEGIN,
 352         BINARY_PRINT_LINE_BEGIN,
 353         BINARY_PRINT_ADDR,
 354         BINARY_PRINT_NUM_DATA,
 355         BINARY_PRINT_NUM_PAD,
 356         BINARY_PRINT_SEP,
 357         BINARY_PRINT_CHAR_DATA,
 358         BINARY_PRINT_CHAR_PAD,
 359         BINARY_PRINT_LINE_END,
 360         BINARY_PRINT_DATA_END,
 361 };
 362
 363 typedef void (*print_binary_t)(enum binary_printer_ops,
 364                                unsigned int val,
 365                                void *extra);
 366
 367 void print_binary(unsigned char *data, size_t len,
 368                   size_t bytes_per_line, print_binary_t printer,
 369                   void *extra);
 370 #endif /* GIT_COMPAT_UTIL_H */