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   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <alloca.h>
  24 #include <stdbool.h>
  25 #include <stddef.h>
  26
  27 #include "macro.h"
  28 #include "string-util.h"
  29 #include "time-util.h"
  30
  31 #if HAVE_SPLIT_BIN
  32 #  define PATH_SBIN_BIN(x) x "sbin:" x "bin"
  33 #  define PATH0_SBIN_BIN(x) x "sbin\0" x "bin"
  34 #else
  35 #  define PATH0_SBIN_BIN(x) x "bin"
  36 #  define PATH_SBIN_BIN(x) x "bin"
  37 #endif
  38
  39 #define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
  40 #define DEFAULT_PATH0_NORMAL PATH0_SBIN_BIN("/usr/local/") "\0" PATH0_SBIN_BIN("/usr/")
  41 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/")
  42 #define DEFAULT_PATH0_SPLIT_USR DEFAULT_PATH0_NORMAL "\0" PATH0_SBIN_BIN("/")
  43
  44 #if HAVE_SPLIT_USR
  45 #  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
  46 #  define DEFAULT_PATH_NULSTR DEFAULT_PATH0_SPLIT_USR
  47 #else
  48 #  define DEFAULT_PATH DEFAULT_PATH_NORMAL
  49 #  define DEFAULT_PATH_NULSTR DEFAULT_PATH0_NORMAL
  50 #endif
  51
  52 bool is_path(const char *p) _pure_;
  53 int path_split_and_make_absolute(const char *p, char ***ret);
  54 bool path_is_absolute(const char *p) _pure_;
  55 char* path_make_absolute(const char *p, const char *prefix);
  56 int safe_getcwd(char **ret);
  57 int path_make_absolute_cwd(const char *p, char **ret);
  58 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  59 char* path_kill_slashes(char *path);
  60 char* path_startswith(const char *path, const char *prefix) _pure_;
  61 int path_compare(const char *a, const char *b) _pure_;
  62 bool path_equal(const char *a, const char *b) _pure_;
  63 bool path_equal_or_files_same(const char *a, const char *b, int flags);
  64 char* path_join(const char *root, const char *path, const char *rest);
  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 #define PATH_STARTSWITH_SET(p, ...)                             \
  84         ({                                                      \
  85                 char **s;                                       \
  86                 bool _found = false;                            \
  87                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  88                         if (path_startswith(p, *s)) {           \
  89                                _found = true;                   \
  90                                break;                           \
  91                         }                                       \
  92                 _found;                                         \
  93         })
  94
  95 int path_strv_make_absolute_cwd(char **l);
  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 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
 102
 103 int fsck_exists(const char *fstype);
 104 int mkfs_exists(const char *fstype);
 105
 106 /* Iterates through the path prefixes of the specified path, going up
 107  * the tree, to root. Also returns "" (and not "/"!) for the root
 108  * directory. Excludes the specified directory itself */
 109 #define PATH_FOREACH_PREFIX(prefix, path) \
 110         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 111
 112 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 113 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
 114         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), '/'))
 115
 116 char *prefix_root(const char *root, const char *path);
 117
 118 /* Similar to prefix_root(), but returns an alloca() buffer, or
 119  * possibly a const pointer into the path parameter */
 120 #define prefix_roota(root, path)                                        \
 121         ({                                                              \
 122                 const char* _path = (path), *_root = (root), *_ret;     \
 123                 char *_p, *_n;                                          \
 124                 size_t _l;                                              \
 125                 while (_path[0] == '/' && _path[1] == '/')              \
 126                         _path ++;                                       \
 127                 if (isempty(_root) || path_equal(_root, "/"))           \
 128                         _ret = _path;                                   \
 129                 else {                                                  \
 130                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 131                         _n = alloca(_l);                                \
 132                         _p = stpcpy(_n, _root);                         \
 133                         while (_p > _n && _p[-1] == '/')                \
 134                                 _p--;                                   \
 135                         if (_path[0] != '/')                            \
 136                                 *(_p++) = '/';                          \
 137                         strcpy(_p, _path);                              \
 138                         _ret = _n;                                      \
 139                 }                                                       \
 140                 _ret;                                                   \
 141         })
 142
 143 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 144
 145 char* dirname_malloc(const char *path);
 146 const char *last_path_component(const char *path);
 147
 148 bool filename_is_valid(const char *p) _pure_;
 149 bool path_is_normalized(const char *p) _pure_;
 150
 151 char *file_in_same_dir(const char *path, const char *filename);
 152
 153 bool hidden_or_backup_file(const char *filename) _pure_;
 154
 155 bool is_device_path(const char *path);
 156 bool is_deviceallow_pattern(const char *path);
 157
 158 int systemd_installation_has_version(const char *root, unsigned minimal_version);
 159
 160 bool dot_or_dot_dot(const char *path);
 161
 162 static inline const char *skip_dev_prefix(const char *p) {
 163         const char *e;
 164
 165         /* Drop any /dev prefix if there is any */
 166
 167         e = path_startswith(p, "/dev/");
 168
 169         return e ?: p;
 170 }