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 #define DEFAULT_PATH_NORMAL "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin"
  32 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":/sbin:/bin"
  33
  34 #if HAVE_SPLIT_USR
  35 #  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
  36 #else
  37 #  define DEFAULT_PATH DEFAULT_PATH_NORMAL
  38 #endif
  39
  40 bool is_path(const char *p) _pure_;
  41 int path_split_and_make_absolute(const char *p, char ***ret);
  42 bool path_is_absolute(const char *p) _pure_;
  43 char* path_make_absolute(const char *p, const char *prefix);
  44 int safe_getcwd(char **ret);
  45 int path_make_absolute_cwd(const char *p, char **ret);
  46 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  47 char* path_kill_slashes(char *path);
  48 char* path_startswith(const char *path, const char *prefix) _pure_;
  49 int path_compare(const char *a, const char *b) _pure_;
  50 bool path_equal(const char *a, const char *b) _pure_;
  51 bool path_equal_or_files_same(const char *a, const char *b, int flags);
  52 char* path_join(const char *root, const char *path, const char *rest);
  53
  54 static inline bool path_equal_ptr(const char *a, const char *b) {
  55         return !!a == !!b && (!a || path_equal(a, b));
  56 }
  57
  58 /* Note: the search terminates on the first NULL item. */
  59 #define PATH_IN_SET(p, ...)                                     \
  60         ({                                                      \
  61                 char **s;                                       \
  62                 bool _found = false;                            \
  63                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  64                         if (path_equal(p, *s)) {                \
  65                                _found = true;                   \
  66                                break;                           \
  67                         }                                       \
  68                 _found;                                         \
  69         })
  70
  71 #define PATH_STARTSWITH_SET(p, ...)                             \
  72         ({                                                      \
  73                 char **s;                                       \
  74                 bool _found = false;                            \
  75                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  76                         if (path_startswith(p, *s)) {           \
  77                                _found = true;                   \
  78                                break;                           \
  79                         }                                       \
  80                 _found;                                         \
  81         })
  82
  83 int path_strv_make_absolute_cwd(char **l);
  84 char** path_strv_resolve(char **l, const char *root);
  85 char** path_strv_resolve_uniq(char **l, const char *root);
  86
  87 int find_binary(const char *name, char **filename);
  88
  89 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
  90
  91 int fsck_exists(const char *fstype);
  92 int mkfs_exists(const char *fstype);
  93
  94 /* Iterates through the path prefixes of the specified path, going up
  95  * the tree, to root. Also returns "" (and not "/"!) for the root
  96  * directory. Excludes the specified directory itself */
  97 #define PATH_FOREACH_PREFIX(prefix, path) \
  98         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
  99
 100 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 101 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
 102         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), '/'))
 103
 104 char *prefix_root(const char *root, const char *path);
 105
 106 /* Similar to prefix_root(), but returns an alloca() buffer, or
 107  * possibly a const pointer into the path parameter */
 108 #define prefix_roota(root, path)                                        \
 109         ({                                                              \
 110                 const char* _path = (path), *_root = (root), *_ret;     \
 111                 char *_p, *_n;                                          \
 112                 size_t _l;                                              \
 113                 while (_path[0] == '/' && _path[1] == '/')              \
 114                         _path ++;                                       \
 115                 if (isempty(_root) || path_equal(_root, "/"))           \
 116                         _ret = _path;                                   \
 117                 else {                                                  \
 118                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 119                         _n = alloca(_l);                                \
 120                         _p = stpcpy(_n, _root);                         \
 121                         while (_p > _n && _p[-1] == '/')                \
 122                                 _p--;                                   \
 123                         if (_path[0] != '/')                            \
 124                                 *(_p++) = '/';                          \
 125                         strcpy(_p, _path);                              \
 126                         _ret = _n;                                      \
 127                 }                                                       \
 128                 _ret;                                                   \
 129         })
 130
 131 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 132
 133 char* dirname_malloc(const char *path);
 134 const char *last_path_component(const char *path);
 135
 136 bool filename_is_valid(const char *p) _pure_;
 137 bool path_is_normalized(const char *p) _pure_;
 138
 139 char *file_in_same_dir(const char *path, const char *filename);
 140
 141 bool hidden_or_backup_file(const char *filename) _pure_;
 142
 143 bool is_device_path(const char *path);
 144 bool is_deviceallow_pattern(const char *path);
 145
 146 int systemd_installation_has_version(const char *root, unsigned minimal_version);
 147
 148 bool dot_or_dot_dot(const char *path);
 149
 150 static inline const char *skip_dev_prefix(const char *p) {
 151         const char *e;
 152
 153         /* Drop any /dev prefix if there is any */
 154
 155         e = path_startswith(p, "/dev/");
 156
 157         return e ?: p;
 158 }