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_SBIN_BIN_NULSTR(x) x "sbin\0" x "bin\0"
  15
  16 #define PATH_NORMAL_SBIN_BIN(x) x "bin"
  17 #define PATH_NORMAL_SBIN_BIN_NULSTR(x) x "bin\0"
  18
  19 #if HAVE_SPLIT_BIN
  20 #  define PATH_SBIN_BIN(x) PATH_SPLIT_SBIN_BIN(x)
  21 #  define PATH_SBIN_BIN_NULSTR(x) PATH_SPLIT_SBIN_BIN_NULSTR(x)
  22 #else
  23 #  define PATH_SBIN_BIN(x) PATH_NORMAL_SBIN_BIN(x)
  24 #  define PATH_SBIN_BIN_NULSTR(x) PATH_NORMAL_SBIN_BIN_NULSTR(x)
  25 #endif
  26
  27 #define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
  28 #define DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/usr/local/") PATH_SBIN_BIN_NULSTR("/usr/")
  29 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/")
  30 #define DEFAULT_PATH_SPLIT_USR_NULSTR DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/")
  31 #define DEFAULT_PATH_COMPAT PATH_SPLIT_SBIN_BIN("/usr/local/") ":" PATH_SPLIT_SBIN_BIN("/usr/") ":" PATH_SPLIT_SBIN_BIN("/")
  32
  33 #if HAVE_SPLIT_USR
  34 #  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
  35 #  define DEFAULT_PATH_NULSTR DEFAULT_PATH_SPLIT_USR_NULSTR
  36 #else
  37 #  define DEFAULT_PATH DEFAULT_PATH_NORMAL
  38 #  define DEFAULT_PATH_NULSTR DEFAULT_PATH_NORMAL_NULSTR
  39 #endif
  40
  41 #ifndef DEFAULT_USER_PATH
  42 #  define DEFAULT_USER_PATH DEFAULT_PATH
  43 #endif
  44
  45 bool is_path(const char *p) _pure_;
  46 int path_split_and_make_absolute(const char *p, char ***ret);
  47 bool path_is_absolute(const char *p) _pure_;
  48 char* path_make_absolute(const char *p, const char *prefix);
  49 int safe_getcwd(char **ret);
  50 int path_make_absolute_cwd(const char *p, char **ret);
  51 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  52 char* path_startswith(const char *path, const char *prefix) _pure_;
  53 int path_compare(const char *a, const char *b) _pure_;
  54 bool path_equal(const char *a, const char *b) _pure_;
  55 bool path_equal_or_files_same(const char *a, const char *b, int flags);
  56 char* path_join_internal(const char *first, ...);
  57 #define path_join(x, ...) path_join_internal(x, __VA_ARGS__, (const char*) -1)
  58
  59 char* path_simplify(char *path, bool kill_dots);
  60
  61 enum {
  62         PATH_CHECK_FATAL    = 1 << 0,  /* If not set, then error message is appended with 'ignoring'. */
  63         PATH_CHECK_ABSOLUTE = 1 << 1,
  64         PATH_CHECK_RELATIVE = 1 << 2,
  65 };
  66
  67 int path_simplify_and_warn(char *path, unsigned flag, const char *unit, const char *filename, unsigned line, const char *lvalue);
  68
  69 static inline bool path_equal_ptr(const char *a, const char *b) {
  70         return !!a == !!b && (!a || path_equal(a, b));
  71 }
  72
  73 /* Note: the search terminates on the first NULL item. */
  74 #define PATH_IN_SET(p, ...)                                     \
  75         ({                                                      \
  76                 char **_s;                                      \
  77                 bool _found = false;                            \
  78                 STRV_FOREACH(_s, STRV_MAKE(__VA_ARGS__))        \
  79                         if (path_equal(p, *_s)) {               \
  80                                _found = true;                   \
  81                                break;                           \
  82                         }                                       \
  83                 _found;                                         \
  84         })
  85
  86 char* path_startswith_strv(const char *p, char **set);
  87 #define PATH_STARTSWITH_SET(p, ...) path_startswith_strv(p, STRV_MAKE(__VA_ARGS__))
  88
  89 int path_strv_make_absolute_cwd(char **l);
  90 char** path_strv_resolve(char **l, const char *root);
  91 char** path_strv_resolve_uniq(char **l, const char *root);
  92
  93 int find_binary(const char *name, char **filename);
  94
  95 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
  96
  97 int fsck_exists(const char *fstype);
  98 int mkfs_exists(const char *fstype);
  99
 100 /* Iterates through the path prefixes of the specified path, going up
 101  * the tree, to root. Also returns "" (and not "/"!) for the root
 102  * directory. Excludes the specified directory itself */
 103 #define PATH_FOREACH_PREFIX(prefix, path)                               \
 104         for (char *_slash = ({                                          \
 105                                 path_simplify(strcpy(prefix, path), false); \
 106                                 streq(prefix, "/") ? NULL : strrchr(prefix, '/'); \
 107                         });                                             \
 108              _slash && ((*_slash = 0), true);                           \
 109              _slash = strrchr((prefix), '/'))
 110
 111 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 112 #define PATH_FOREACH_PREFIX_MORE(prefix, path)                          \
 113         for (char *_slash = ({                                          \
 114                                 path_simplify(strcpy(prefix, path), false); \
 115                                 if (streq(prefix, "/"))                 \
 116                                         prefix[0] = 0;                  \
 117                                 strrchr(prefix, 0);                     \
 118                         });                                             \
 119              _slash && ((*_slash = 0), true);                           \
 120              _slash = strrchr((prefix), '/'))
 121
 122 /* Similar to path_join(), but only works for two components, and only the first one may be NULL and returns
 123  * an alloca() buffer, or 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 (isempty(_root))                                     \
 132                         _ret = _path;                                   \
 133                 else {                                                  \
 134                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 135                         _n = newa(char, _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 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 148
 149 char* dirname_malloc(const char *path);
 150 const char *last_path_component(const char *path);
 151 int path_extract_filename(const char *p, char **ret);
 152
 153 bool filename_is_valid(const char *p) _pure_;
 154 bool path_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 bool is_device_path(const char *path);
 162
 163 bool valid_device_node_path(const char *path);
 164 bool valid_device_allow_pattern(const char *path);
 165
 166 int systemd_installation_has_version(const char *root, unsigned minimal_version);
 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 }