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 #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 <errno.h>
  55 #include <limits.h>
  56 #include <sys/param.h>
  57 #include <sys/types.h>
  58 #include <dirent.h>
  59 #include <sys/time.h>
  60 #include <time.h>
  61 #include <signal.h>
  62 #include <fnmatch.h>
  63 #include <assert.h>
  64 #include <regex.h>
  65 #include <utime.h>
  66 #include <sys/wait.h>
  67 #include <sys/poll.h>
  68 #include <sys/socket.h>
  69 #include <sys/ioctl.h>
  70 #include <inttypes.h>
  71 #include <linux/kernel.h>
  72 #include <linux/magic.h>
  73 #include <linux/types.h>
  74 #include <sys/ttydefaults.h>
  75 #include <api/fs/debugfs.h>
  76 #include <termios.h>
  77 #include <linux/bitops.h>
  78
  79 extern const char *graph_line;
  80 extern const char *graph_dotted_line;
  81 extern char buildid_dir[];
  82 extern char tracing_events_path[];
  83 extern void perf_debugfs_set_path(const char *mountpoint);
  84 const char *perf_debugfs_mount(const char *mountpoint);
  85 const char *find_tracing_dir(void);
  86 char *get_tracing_file(const char *name);
  87 void put_tracing_file(char *file);
  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
 152 extern int prefixcmp(const char *str, const char *prefix);
 153 extern void set_buildid_dir(void);
 154 extern void disable_buildid_cache(void);
 155
 156 static inline const char *skip_prefix(const char *str, const char *prefix)
 157 {
 158         size_t len = strlen(prefix);
 159         return strncmp(str, prefix, len) ? NULL : str + len;
 160 }
 161
 162 #ifdef __GLIBC_PREREQ
 163 #if __GLIBC_PREREQ(2, 1)
 164 #define HAVE_STRCHRNUL
 165 #endif
 166 #endif
 167
 168 #ifndef HAVE_STRCHRNUL
 169 #define strchrnul gitstrchrnul
 170 static inline char *gitstrchrnul(const char *s, int c)
 171 {
 172         while (*s && *s != c)
 173                 s++;
 174         return (char *)s;
 175 }
 176 #endif
 177
 178 /*
 179  * Wrappers:
 180  */
 181 extern char *xstrdup(const char *str);
 182 extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
 183
 184
 185 static inline void *zalloc(size_t size)
 186 {
 187         return calloc(1, size);
 188 }
 189
 190 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
 191
 192 static inline int has_extension(const char *filename, const char *ext)
 193 {
 194         size_t len = strlen(filename);
 195         size_t extlen = strlen(ext);
 196
 197         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 198 }
 199
 200 /* Sane ctype - no locale, and works with signed chars */
 201 #undef isascii
 202 #undef isspace
 203 #undef isdigit
 204 #undef isxdigit
 205 #undef isalpha
 206 #undef isprint
 207 #undef isalnum
 208 #undef islower
 209 #undef isupper
 210 #undef tolower
 211 #undef toupper
 212
 213 #ifndef NSEC_PER_MSEC
 214 #define NSEC_PER_MSEC   1000000L
 215 #endif
 216
 217 int parse_nsec_time(const char *str, u64 *ptime);
 218
 219 extern unsigned char sane_ctype[256];
 220 #define GIT_SPACE               0x01
 221 #define GIT_DIGIT               0x02
 222 #define GIT_ALPHA               0x04
 223 #define GIT_GLOB_SPECIAL        0x08
 224 #define GIT_REGEX_SPECIAL       0x10
 225 #define GIT_PRINT_EXTRA         0x20
 226 #define GIT_PRINT               0x3E
 227 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 228 #define isascii(x) (((x) & ~0x7f) == 0)
 229 #define isspace(x) sane_istest(x,GIT_SPACE)
 230 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 231 #define isxdigit(x)     \
 232         (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
 233 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 234 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 235 #define isprint(x) sane_istest(x,GIT_PRINT)
 236 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
 237 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
 238 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 239 #define toupper(x) sane_case((unsigned char)(x), 0)
 240
 241 static inline int sane_case(int x, int high)
 242 {
 243         if (sane_istest(x, GIT_ALPHA))
 244                 x = (x & ~0x20) | high;
 245         return x;
 246 }
 247
 248 int mkdir_p(char *path, mode_t mode);
 249 int copyfile(const char *from, const char *to);
 250 int copyfile_mode(const char *from, const char *to, mode_t mode);
 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 int strtailcmp(const char *s1, const char *s2);
 258 char *strxfrchar(char *s, char from, char to);
 259 unsigned long convert_unit(unsigned long value, char *unit);
 260 ssize_t readn(int fd, void *buf, size_t n);
 261 ssize_t writen(int fd, void *buf, size_t n);
 262
 263 struct perf_event_attr;
 264
 265 void event_attr_init(struct perf_event_attr *attr);
 266
 267 #define _STR(x) #x
 268 #define STR(x) _STR(x)
 269
 270 /*
 271  *  Determine whether some value is a power of two, where zero is
 272  * *not* considered a power of two.
 273  */
 274
 275 static inline __attribute__((const))
 276 bool is_power_of_2(unsigned long n)
 277 {
 278         return (n != 0 && ((n & (n - 1)) == 0));
 279 }
 280
 281 static inline unsigned next_pow2(unsigned x)
 282 {
 283         if (!x)
 284                 return 1;
 285         return 1ULL << (32 - __builtin_clz(x - 1));
 286 }
 287
 288 static inline unsigned long next_pow2_l(unsigned long x)
 289 {
 290 #if BITS_PER_LONG == 64
 291         if (x <= (1UL << 31))
 292                 return next_pow2(x);
 293         return (unsigned long)next_pow2(x >> 32) << 32;
 294 #else
 295         return next_pow2(x);
 296 #endif
 297 }
 298
 299 size_t hex_width(u64 v);
 300 int hex2u64(const char *ptr, u64 *val);
 301
 302 char *ltrim(char *s);
 303 char *rtrim(char *s);
 304
 305 void dump_stack(void);
 306
 307 extern unsigned int page_size;
 308 extern int cacheline_size;
 309
 310 void get_term_dimensions(struct winsize *ws);
 311
 312 struct parse_tag {
 313         char tag;
 314         int mult;
 315 };
 316
 317 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
 318
 319 #define SRCLINE_UNKNOWN  ((char *) "??:0")
 320
 321 static inline int path__join(char *bf, size_t size,
 322                              const char *path1, const char *path2)
 323 {
 324         return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
 325 }
 326
 327 static inline int path__join3(char *bf, size_t size,
 328                               const char *path1, const char *path2,
 329                               const char *path3)
 330 {
 331         return scnprintf(bf, size, "%s%s%s%s%s",
 332                          path1, path1[0] ? "/" : "",
 333                          path2, path2[0] ? "/" : "", path3);
 334 }
 335
 336 struct dso;
 337
 338 char *get_srcline(struct dso *dso, unsigned long addr);
 339 void free_srcline(char *srcline);
 340
 341 int filename__read_int(const char *filename, int *value);
 342 int filename__read_str(const char *filename, char **buf, size_t *sizep);
 343 int perf_event_paranoid(void);
 344
 345 void mem_bswap_64(void *src, int byte_size);
 346 void mem_bswap_32(void *src, int byte_size);
 347
 348 const char *get_filename_for_perf_kvm(void);
 349 bool find_process(const char *name);
 350 #endif /* GIT_COMPAT_UTIL_H */