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 #else
  34 #  define PATH_SBIN_BIN(x) x "bin"
  35 #endif
  36
  37 #define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
  38 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/")
  39
  40 #if HAVE_SPLIT_USR
  41 #  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
  42 #else
  43 #  define DEFAULT_PATH DEFAULT_PATH_NORMAL
  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 (isempty(_root) || path_equal(_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 }