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