src/basic/path-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010-2012 Lennart Poettering
   8 ***/
   9
  10 #include <alloca.h>
  11 #include <stdbool.h>
  12 #include <stddef.h>
  13
  14 #include "macro.h"
  15 #include "string-util.h"
  16 #include "time-util.h"
  17
  18 #define PATH_SPLIT_SBIN_BIN(x) x "sbin:" x "bin"
  19 #define PATH_SPLIT_SBIN_BIN_NULSTR(x) x "sbin\0" x "bin\0"
  20
  21 #define PATH_NORMAL_SBIN_BIN(x) x "bin"
  22 #define PATH_NORMAL_SBIN_BIN_NULSTR(x) x "bin\0"
  23
  24 #if HAVE_SPLIT_BIN
  25 #  define PATH_SBIN_BIN(x) PATH_SPLIT_SBIN_BIN(x)
  26 #  define PATH_SBIN_BIN_NULSTR(x) PATH_SPLIT_SBIN_BIN_NULSTR(x)
  27 #else
  28 #  define PATH_SBIN_BIN(x) PATH_NORMAL_SBIN_BIN(x)
  29 #  define PATH_SBIN_BIN_NULSTR(x) PATH_NORMAL_SBIN_BIN_NULSTR(x)
  30 #endif
  31
  32 #define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
  33 #define DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/usr/local/") PATH_SBIN_BIN_NULSTR("/usr/")
  34 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/")
  35 #define DEFAULT_PATH_SPLIT_USR_NULSTR DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/")
  36 #define DEFAULT_PATH_COMPAT PATH_SPLIT_SBIN_BIN("/usr/local/") ":" PATH_SPLIT_SBIN_BIN("/usr/") ":" PATH_SPLIT_SBIN_BIN("/")
  37
  38 #if HAVE_SPLIT_USR
  39 #  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
  40 #  define DEFAULT_PATH_NULSTR DEFAULT_PATH_SPLIT_USR_NULSTR
  41 #else
  42 #  define DEFAULT_PATH DEFAULT_PATH_NORMAL
  43 #  define DEFAULT_PATH_NULSTR DEFAULT_PATH_NORMAL_NULSTR
  44 #endif
  45
  46 bool is_path(const char *p) _pure_;
  47 #if 0 /// UNNEEDED by elogind
  48 int path_split_and_make_absolute(const char *p, char ***ret);
  49 #endif // 0
  50 bool path_is_absolute(const char *p) _pure_;
  51 #if 0 /// UNNEEDED by elogind
  52 char* path_make_absolute(const char *p, const char *prefix);
  53 #endif // 0
  54 int safe_getcwd(char **ret);
  55 int path_make_absolute_cwd(const char *p, char **ret);
  56 #if 0 /// UNNEEDED by elogind
  57 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  58 #endif // 0
  59 char* path_startswith(const char *path, const char *prefix) _pure_;
  60 int path_compare(const char *a, const char *b) _pure_;
  61 bool path_equal(const char *a, const char *b) _pure_;
  62 bool path_equal_or_files_same(const char *a, const char *b, int flags);
  63 char* path_join(const char *root, const char *path, const char *rest);
  64 char* path_simplify(char *path, bool kill_dots);
  65
  66 static inline bool path_equal_ptr(const char *a, const char *b) {
  67         return !!a == !!b && (!a || path_equal(a, b));
  68 }
  69
  70 /* Note: the search terminates on the first NULL item. */
  71 #define PATH_IN_SET(p, ...)                                     \
  72         ({                                                      \
  73                 char **s;                                       \
  74                 bool _found = false;                            \
  75                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  76                         if (path_equal(p, *s)) {                \
  77                                _found = true;                   \
  78                                break;                           \
  79                         }                                       \
  80                 _found;                                         \
  81         })
  82
  83 #if 0 /// UNNEEDED by elogind
  84 #define PATH_STARTSWITH_SET(p, ...)                             \
  85         ({                                                      \
  86                 char **s;                                       \
  87                 bool _found = false;                            \
  88                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  89                         if (path_startswith(p, *s)) {           \
  90                                _found = true;                   \
  91                                break;                           \
  92                         }                                       \
  93                 _found;                                         \
  94         })
  95
  96 int path_strv_make_absolute_cwd(char **l);
  97 #endif // 0
  98 char** path_strv_resolve(char **l, const char *root);
  99 char** path_strv_resolve_uniq(char **l, const char *root);
 100
 101 int find_binary(const char *name, char **filename);
 102
 103 #if 0 /// UNNEEDED by elogind
 104 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
 105
 106 int fsck_exists(const char *fstype);
 107 int mkfs_exists(const char *fstype);
 108 #endif // 0
 109
 110 /* Iterates through the path prefixes of the specified path, going up
 111  * the tree, to root. Also returns "" (and not "/"!) for the root
 112  * directory. Excludes the specified directory itself */
 113 #define PATH_FOREACH_PREFIX(prefix, path) \
 114         for (char *_slash = ({ path_simplify(strcpy(prefix, path), false); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 115
 116 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 117 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
 118         for (char *_slash = ({ path_simplify(strcpy(prefix, path), false); if (streq(prefix, "/")) prefix[0] = 0; strrchr(prefix, 0); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 119
 120 char *prefix_root(const char *root, const char *path);
 121
 122 /* Similar to prefix_root(), but returns an alloca() buffer, or
 123  * possibly a const pointer into the path parameter */
 124 #define prefix_roota(root, path)                                        \
 125         ({                                                              \
 126                 const char* _path = (path), *_root = (root), *_ret;     \
 127                 char *_p, *_n;                                          \
 128                 size_t _l;                                              \
 129                 while (_path[0] == '/' && _path[1] == '/')              \
 130                         _path ++;                                       \
 131                 if (empty_or_root(_root))                               \
 132                         _ret = _path;                                   \
 133                 else {                                                  \
 134                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 135                         _n = alloca(_l);                                \
 136                         _p = stpcpy(_n, _root);                         \
 137                         while (_p > _n && _p[-1] == '/')                \
 138                                 _p--;                                   \
 139                         if (_path[0] != '/')                            \
 140                                 *(_p++) = '/';                          \
 141                         strcpy(_p, _path);                              \
 142                         _ret = _n;                                      \
 143                 }                                                       \
 144                 _ret;                                                   \
 145         })
 146
 147 #if 0 /// UNNEEDED by elogind
 148 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 149 #endif // 0
 150
 151 char* dirname_malloc(const char *path);
 152 const char *last_path_component(const char *path);
 153
 154 bool filename_is_valid(const char *p) _pure_;
 155 bool path_is_normalized(const char *p) _pure_;
 156
 157 char *file_in_same_dir(const char *path, const char *filename);
 158
 159 bool hidden_or_backup_file(const char *filename) _pure_;
 160
 161 #if 0 /// UNNEEDED by elogind
 162 bool is_device_path(const char *path);
 163
 164 bool valid_device_node_path(const char *path);
 165 bool valid_device_allow_pattern(const char *path);
 166
 167 int systemd_installation_has_version(const char *root, unsigned minimal_version);
 168 #endif // 0
 169
 170 bool dot_or_dot_dot(const char *path);
 171
 172 static inline const char *skip_dev_prefix(const char *p) {
 173         const char *e;
 174
 175         /* Drop any /dev prefix if there is any */
 176
 177         e = path_startswith(p, "/dev/");
 178
 179         return e ?: p;
 180 }
 181
 182 bool empty_or_root(const char *root);
 183 static inline const char *empty_to_root(const char *path) {
 184         return isempty(path) ? "/" : path;
 185 }
 186
 187 enum {
 188         PATH_CHECK_FATAL    = 1 << 0,  /* If not set, then error message is appended with 'ignoring'. */
 189         PATH_CHECK_ABSOLUTE = 1 << 1,
 190         PATH_CHECK_RELATIVE = 1 << 2,
 191 };
 192
 193 int path_simplify_and_warn(char *path, unsigned flag, const char *unit, const char *filename, unsigned line, const char *lvalue);