src/basic/util.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <alloca.h>
  25 #include <errno.h>
  26 #include <fcntl.h>
  27 #include <inttypes.h>
  28 #include <limits.h>
  29 #include <locale.h>
  30 #include <stdarg.h>
  31 #include <stdbool.h>
  32 #include <stddef.h>
  33 #include <stdint.h>
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <sys/inotify.h>
  38 #include <sys/socket.h>
  39 #include <sys/stat.h>
  40 #include <sys/statfs.h>
  41 #include <sys/types.h>
  42 #include <time.h>
  43 #include <unistd.h>
  44
  45 #include "formats-util.h"
  46 #include "macro.h"
  47 #include "missing.h"
  48 #include "time-util.h"
  49
  50 size_t page_size(void) _pure_;
  51 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  52
  53 static inline const char* yes_no(bool b) {
  54         return b ? "yes" : "no";
  55 }
  56
  57 static inline const char* true_false(bool b) {
  58         return b ? "true" : "false";
  59 }
  60
  61 static inline const char* one_zero(bool b) {
  62         return b ? "1" : "0";
  63 }
  64
  65 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
  66
  67 #if 0 /// UNNEEDED by elogind
  68 bool plymouth_running(void);
  69 #endif // 0
  70
  71 bool display_is_local(const char *display) _pure_;
  72 int socket_from_display(const char *display, char **path);
  73
  74 #if 0 /// UNNEEDED by elogind
  75 int block_get_whole_disk(dev_t d, dev_t *ret);
  76 #endif // 0
  77
  78 #define NULSTR_FOREACH(i, l)                                    \
  79         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
  80
  81 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
  82         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
  83
  84 extern int saved_argc;
  85 extern char **saved_argv;
  86
  87 #if 0 /// UNNEEDED by elogind
  88 bool kexec_loaded(void);
  89
  90 int prot_from_flags(int flags) _const_;
  91 #endif // 0
  92
  93 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
  94
  95 bool in_initrd(void);
  96
  97 #if 0 /// UNNEEDED by elogind
  98 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
  99                  int (*compar) (const void *, const void *, void *),
 100                  void *arg);
 101 #endif // 0
 102
 103 /**
 104  * Normal qsort requires base to be nonnull. Here were require
 105  * that only if nmemb > 0.
 106  */
 107 static inline void qsort_safe(void *base, size_t nmemb, size_t size, comparison_fn_t compar) {
 108         if (nmemb <= 1)
 109                 return;
 110
 111         assert(base);
 112         qsort(base, nmemb, size, compar);
 113 }
 114
 115 #if 0 /// UNNEEDED by elogind
 116 int on_ac_power(void);
 117 #endif // 0
 118
 119 #define memzero(x,l) (memset((x), 0, (l)))
 120 #define zero(x) (memzero(&(x), sizeof(x)))
 121
 122 static inline void *mempset(void *s, int c, size_t n) {
 123         memset(s, c, n);
 124         return (uint8_t*)s + n;
 125 }
 126
 127 static inline void _reset_errno_(int *saved_errno) {
 128         errno = *saved_errno;
 129 }
 130
 131 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 132
 133 #if 0 /// UNNEEDED by elogind
 134 static inline int negative_errno(void) {
 135         /* This helper should be used to shut up gcc if you know 'errno' is
 136          * negative. Instead of "return -errno;", use "return negative_errno();"
 137          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 138          * be 0 and thus the caller's error-handling might not be triggered. */
 139         assert_return(errno > 0, -EINVAL);
 140         return -errno;
 141 }
 142 #endif // 0
 143
 144 static inline unsigned u64log2(uint64_t n) {
 145 #if __SIZEOF_LONG_LONG__ == 8
 146         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 147 #else
 148 #error "Wut?"
 149 #endif
 150 }
 151
 152 static inline unsigned u32ctz(uint32_t n) {
 153 #if __SIZEOF_INT__ == 4
 154         return __builtin_ctz(n);
 155 #else
 156 #error "Wut?"
 157 #endif
 158 }
 159
 160 static inline unsigned log2i(int x) {
 161         assert(x > 0);
 162
 163         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 164 }
 165
 166 static inline unsigned log2u(unsigned x) {
 167         assert(x > 0);
 168
 169         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 170 }
 171
 172 static inline unsigned log2u_round_up(unsigned x) {
 173         assert(x > 0);
 174
 175         if (x == 1)
 176                 return 0;
 177
 178         return log2u(x - 1) + 1;
 179 }
 180
 181 #if 0 /// UNNEEDED by elogind
 182 bool id128_is_valid(const char *s) _pure_;
 183 #endif // 0
 184
 185 int container_get_leader(const char *machine, pid_t *pid);
 186
 187 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *userns_fd, int *root_fd);
 188 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int userns_fd, int root_fd);
 189
 190 uint64_t physical_memory(void);
 191
 192 #if 0 /// UNNEEDED by elogind
 193 int update_reboot_param_file(const char *param);
 194 #endif // 0
 195
 196 int version(void);