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 int path_split_and_make_absolute(const char *p, char ***ret);
  48 bool path_is_absolute(const char *p) _pure_;
  49 char* path_make_absolute(const char *p, const char *prefix);
  50 int safe_getcwd(char **ret);
  51 int path_make_absolute_cwd(const char *p, char **ret);
  52 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  53 char* path_kill_slashes(char *path);
  54 char* path_startswith(const char *path, const char *prefix) _pure_;
  55 int path_compare(const char *a, const char *b) _pure_;
  56 bool path_equal(const char *a, const char *b) _pure_;
  57 bool path_equal_or_files_same(const char *a, const char *b, int flags);
  58 char* path_join(const char *root, const char *path, const char *rest);
  59
  60 static inline bool path_equal_ptr(const char *a, const char *b) {
  61         return !!a == !!b && (!a || path_equal(a, b));
  62 }
  63
  64 /* Note: the search terminates on the first NULL item. */
  65 #define PATH_IN_SET(p, ...)                                     \
  66         ({                                                      \
  67                 char **s;                                       \
  68                 bool _found = false;                            \
  69                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  70                         if (path_equal(p, *s)) {                \
  71                                _found = true;                   \
  72                                break;                           \
  73                         }                                       \
  74                 _found;                                         \
  75         })
  76
  77 #define PATH_STARTSWITH_SET(p, ...)                             \
  78         ({                                                      \
  79                 char **s;                                       \
  80                 bool _found = false;                            \
  81                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  82                         if (path_startswith(p, *s)) {           \
  83                                _found = true;                   \
  84                                break;                           \
  85                         }                                       \
  86                 _found;                                         \
  87         })
  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 = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 105
 106 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 107 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
 108         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); if (streq(prefix, "/")) prefix[0] = 0; strrchr(prefix, 0); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 109
 110 char *prefix_root(const char *root, const char *path);
 111
 112 /* Similar to prefix_root(), but returns an alloca() buffer, or
 113  * possibly a const pointer into the path parameter */
 114 #define prefix_roota(root, path)                                        \
 115         ({                                                              \
 116                 const char* _path = (path), *_root = (root), *_ret;     \
 117                 char *_p, *_n;                                          \
 118                 size_t _l;                                              \
 119                 while (_path[0] == '/' && _path[1] == '/')              \
 120                         _path ++;                                       \
 121                 if (empty_or_root(_root))                               \
 122                         _ret = _path;                                   \
 123                 else {                                                  \
 124                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 125                         _n = alloca(_l);                                \
 126                         _p = stpcpy(_n, _root);                         \
 127                         while (_p > _n && _p[-1] == '/')                \
 128                                 _p--;                                   \
 129                         if (_path[0] != '/')                            \
 130                                 *(_p++) = '/';                          \
 131                         strcpy(_p, _path);                              \
 132                         _ret = _n;                                      \
 133                 }                                                       \
 134                 _ret;                                                   \
 135         })
 136
 137 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 138
 139 char* dirname_malloc(const char *path);
 140 const char *last_path_component(const char *path);
 141
 142 bool filename_is_valid(const char *p) _pure_;
 143 bool path_is_normalized(const char *p) _pure_;
 144
 145 char *file_in_same_dir(const char *path, const char *filename);
 146
 147 bool hidden_or_backup_file(const char *filename) _pure_;
 148
 149 bool is_device_path(const char *path);
 150 bool is_deviceallow_pattern(const char *path);
 151
 152 int systemd_installation_has_version(const char *root, unsigned minimal_version);
 153
 154 bool dot_or_dot_dot(const char *path);
 155
 156 static inline const char *skip_dev_prefix(const char *p) {
 157         const char *e;
 158
 159         /* Drop any /dev prefix if there is any */
 160
 161         e = path_startswith(p, "/dev/");
 162
 163         return e ?: p;
 164 }
 165
 166 bool empty_or_root(const char *root);
 167 static inline const char *empty_to_root(const char *path) {
 168         return isempty(path) ? "/" : path;
 169 }