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