src/basic/path-util.h

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