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 <fcntl.h>
  26 #include <inttypes.h>
  27 #include <limits.h>
  28 #include <locale.h>
  29 #include <stdarg.h>
  30 #include <stdbool.h>
  31 #include <stddef.h>
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <sys/inotify.h>
  35 #include <sys/socket.h>
  36 #include <sys/stat.h>
  37 #include <sys/statfs.h>
  38 #include <sys/types.h>
  39 #include <time.h>
  40 #include <unistd.h>
  41
  42 #include "formats-util.h"
  43 #include "macro.h"
  44 #include "missing.h"
  45 #include "time-util.h"
  46
  47 size_t page_size(void) _pure_;
  48 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  49
  50 static inline const char* yes_no(bool b) {
  51         return b ? "yes" : "no";
  52 }
  53
  54 static inline const char* true_false(bool b) {
  55         return b ? "true" : "false";
  56 }
  57
  58 static inline const char* one_zero(bool b) {
  59         return b ? "1" : "0";
  60 }
  61
  62 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
  63
  64 bool plymouth_running(void);
  65
  66 bool display_is_local(const char *display) _pure_;
  67 int socket_from_display(const char *display, char **path);
  68
  69 int block_get_whole_disk(dev_t d, dev_t *ret);
  70
  71 #define NULSTR_FOREACH(i, l)                                    \
  72         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
  73
  74 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
  75         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
  76
  77 extern int saved_argc;
  78 extern char **saved_argv;
  79
  80 bool kexec_loaded(void);
  81
  82 int prot_from_flags(int flags) _const_;
  83
  84 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
  85
  86 bool in_initrd(void);
  87
  88 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
  89                  int (*compar) (const void *, const void *, void *),
  90                  void *arg);
  91
  92 /**
  93  * Normal qsort requires base to be nonnull. Here were require
  94  * that only if nmemb > 0.
  95  */
  96 static inline void qsort_safe(void *base, size_t nmemb, size_t size, comparison_fn_t compar) {
  97         if (nmemb <= 1)
  98                 return;
  99
 100         assert(base);
 101         qsort(base, nmemb, size, compar);
 102 }
 103
 104 int on_ac_power(void);
 105
 106 #define memzero(x,l) (memset((x), 0, (l)))
 107 #define zero(x) (memzero(&(x), sizeof(x)))
 108
 109 static inline void *mempset(void *s, int c, size_t n) {
 110         memset(s, c, n);
 111         return (uint8_t*)s + n;
 112 }
 113
 114 static inline void _reset_errno_(int *saved_errno) {
 115         errno = *saved_errno;
 116 }
 117
 118 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 119
 120 static inline int negative_errno(void) {
 121         /* This helper should be used to shut up gcc if you know 'errno' is
 122          * negative. Instead of "return -errno;", use "return negative_errno();"
 123          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 124          * be 0 and thus the caller's error-handling might not be triggered. */
 125         assert_return(errno > 0, -EINVAL);
 126         return -errno;
 127 }
 128
 129 static inline unsigned u64log2(uint64_t n) {
 130 #if __SIZEOF_LONG_LONG__ == 8
 131         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 132 #else
 133 #error "Wut?"
 134 #endif
 135 }
 136
 137 static inline unsigned u32ctz(uint32_t n) {
 138 #if __SIZEOF_INT__ == 4
 139         return __builtin_ctz(n);
 140 #else
 141 #error "Wut?"
 142 #endif
 143 }
 144
 145 static inline unsigned log2i(int x) {
 146         assert(x > 0);
 147
 148         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 149 }
 150
 151 static inline unsigned log2u(unsigned x) {
 152         assert(x > 0);
 153
 154         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 155 }
 156
 157 static inline unsigned log2u_round_up(unsigned x) {
 158         assert(x > 0);
 159
 160         if (x == 1)
 161                 return 0;
 162
 163         return log2u(x - 1) + 1;
 164 }
 165
 166 bool id128_is_valid(const char *s) _pure_;
 167
 168 int container_get_leader(const char *machine, pid_t *pid);
 169
 170 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *userns_fd, int *root_fd);
 171 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int userns_fd, int root_fd);
 172
 173 uint64_t physical_memory(void);
 174
 175 int update_reboot_param_file(const char *param);
 176
 177 int version(void);