src/basic/util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <alloca.h>
   5 #include <errno.h>
   6 #include <fcntl.h>
   7 #include <inttypes.h>
   8 #include <limits.h>
   9 #include <locale.h>
  10 #include <stdarg.h>
  11 #include <stdbool.h>
  12 #include <stddef.h>
  13 #include <stdint.h>
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <string.h>
  17 #include <sys/inotify.h>
  18 #include <sys/socket.h>
  19 #include <sys/stat.h>
  20 #include <sys/statfs.h>
  21 #include <sys/sysmacros.h>
  22 #include <sys/types.h>
  23 #include <time.h>
  24 #include <unistd.h>
  25
  26 #include "format-util.h"
  27 #include "macro.h"
  28 #include "missing.h"
  29 #include "time-util.h"
  30
  31 size_t page_size(void) _pure_;
  32 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  33
  34 static inline const char* yes_no(bool b) {
  35         return b ? "yes" : "no";
  36 }
  37
  38 static inline const char* true_false(bool b) {
  39         return b ? "true" : "false";
  40 }
  41
  42 static inline const char* one_zero(bool b) {
  43         return b ? "1" : "0";
  44 }
  45
  46 static inline const char* enable_disable(bool b) {
  47         return b ? "enable" : "disable";
  48 }
  49
  50 bool plymouth_running(void);
  51
  52 bool display_is_local(const char *display) _pure_;
  53 int socket_from_display(const char *display, char **path);
  54
  55 #define NULSTR_FOREACH(i, l)                                    \
  56         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
  57
  58 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
  59         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
  60
  61 extern int saved_argc;
  62 extern char **saved_argv;
  63
  64 bool kexec_loaded(void);
  65
  66 int prot_from_flags(int flags) _const_;
  67
  68 bool in_initrd(void);
  69 void in_initrd_force(bool value);
  70
  71 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
  72                  int (*compar) (const void *, const void *, void *),
  73                  void *arg);
  74
  75 /**
  76  * Normal bsearch requires base to be nonnull. Here were require
  77  * that only if nmemb > 0.
  78  */
  79 static inline void* bsearch_safe(const void *key, const void *base,
  80                                  size_t nmemb, size_t size, comparison_fn_t compar) {
  81         if (nmemb <= 0)
  82                 return NULL;
  83
  84         assert(base);
  85         return bsearch(key, base, nmemb, size, compar);
  86 }
  87
  88 /**
  89  * Normal qsort requires base to be nonnull. Here were require
  90  * that only if nmemb > 0.
  91  */
  92 static inline void qsort_safe(void *base, size_t nmemb, size_t size, comparison_fn_t compar) {
  93         if (nmemb <= 1)
  94                 return;
  95
  96         assert(base);
  97         qsort(base, nmemb, size, compar);
  98 }
  99
 100 /* A wrapper around the above, but that adds typesafety: the element size is automatically derived from the type and so
 101  * is the prototype for the comparison function */
 102 #define typesafe_qsort(p, n, func)                                      \
 103         ({                                                              \
 104                 int (*_func_)(const typeof(p[0])*, const typeof(p[0])*) = func; \
 105                 qsort_safe((p), (n), sizeof((p)[0]), (__compar_fn_t) _func_); \
 106         })
 107
 108 static inline void qsort_r_safe(void *base, size_t nmemb, size_t size, int (*compar)(const void*, const void*, void*), void *userdata) {
 109         if (nmemb <= 1)
 110                 return;
 111
 112         assert(base);
 113         qsort_r(base, nmemb, size, compar, userdata);
 114 }
 115
 116 /**
 117  * Normal memcpy requires src to be nonnull. We do nothing if n is 0.
 118  */
 119 static inline void memcpy_safe(void *dst, const void *src, size_t n) {
 120         if (n == 0)
 121                 return;
 122         assert(src);
 123         memcpy(dst, src, n);
 124 }
 125
 126 int on_ac_power(void);
 127
 128 #define memzero(x,l) (memset((x), 0, (l)))
 129 #define zero(x) (memzero(&(x), sizeof(x)))
 130
 131 static inline void *mempset(void *s, int c, size_t n) {
 132         memset(s, c, n);
 133         return (uint8_t*)s + n;
 134 }
 135
 136 static inline void _reset_errno_(int *saved_errno) {
 137         errno = *saved_errno;
 138 }
 139
 140 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 141
 142 static inline int negative_errno(void) {
 143         /* This helper should be used to shut up gcc if you know 'errno' is
 144          * negative. Instead of "return -errno;", use "return negative_errno();"
 145          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 146          * be 0 and thus the caller's error-handling might not be triggered. */
 147         assert_return(errno > 0, -EINVAL);
 148         return -errno;
 149 }
 150
 151 static inline unsigned u64log2(uint64_t n) {
 152 #if __SIZEOF_LONG_LONG__ == 8
 153         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 154 #else
 155 #error "Wut?"
 156 #endif
 157 }
 158
 159 static inline unsigned u32ctz(uint32_t n) {
 160 #if __SIZEOF_INT__ == 4
 161         return __builtin_ctz(n);
 162 #else
 163 #error "Wut?"
 164 #endif
 165 }
 166
 167 static inline unsigned log2i(int x) {
 168         assert(x > 0);
 169
 170         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 171 }
 172
 173 static inline unsigned log2u(unsigned x) {
 174         assert(x > 0);
 175
 176         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 177 }
 178
 179 static inline unsigned log2u_round_up(unsigned x) {
 180         assert(x > 0);
 181
 182         if (x == 1)
 183                 return 0;
 184
 185         return log2u(x - 1) + 1;
 186 }
 187
 188 int container_get_leader(const char *machine, pid_t *pid);
 189
 190 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *userns_fd, int *root_fd);
 191 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int userns_fd, int root_fd);
 192
 193 uint64_t physical_memory(void);
 194 uint64_t physical_memory_scale(uint64_t v, uint64_t max);
 195
 196 uint64_t system_tasks_max(void);
 197 uint64_t system_tasks_max_scale(uint64_t v, uint64_t max);
 198
 199 int version(void);
 200
 201 int str_verscmp(const char *s1, const char *s2);
 202
 203 void disable_coredumps(void);