src/basic/path-util.h

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