1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include <alloca.h>
5 #include <stdbool.h>
6 #include <stddef.h>
7
8 #include "macro.h"
9 #include "string-util.h"
10 #include "strv.h"
11 #include "time-util.h"
12
13 #define PATH_SPLIT_SBIN_BIN(x) x "sbin:" x "bin"
14 #define PATH_SPLIT_SBIN_BIN_NULSTR(x) x "sbin\0" x "bin\0"
15
16 #define PATH_NORMAL_SBIN_BIN(x) x "bin"
17 #define PATH_NORMAL_SBIN_BIN_NULSTR(x) x "bin\0"
18
19 #if HAVE_SPLIT_BIN
20 # define PATH_SBIN_BIN(x) PATH_SPLIT_SBIN_BIN(x)
21 # define PATH_SBIN_BIN_NULSTR(x) PATH_SPLIT_SBIN_BIN_NULSTR(x)
22 #else
23 # define PATH_SBIN_BIN(x) PATH_NORMAL_SBIN_BIN(x)
24 # define PATH_SBIN_BIN_NULSTR(x) PATH_NORMAL_SBIN_BIN_NULSTR(x)
25 #endif
26
27 #define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
28 #define DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/usr/local/") PATH_SBIN_BIN_NULSTR("/usr/")
29 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/")
30 #define DEFAULT_PATH_SPLIT_USR_NULSTR DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/")
31 #define DEFAULT_PATH_COMPAT PATH_SPLIT_SBIN_BIN("/usr/local/") ":" PATH_SPLIT_SBIN_BIN("/usr/") ":" PATH_SPLIT_SBIN_BIN("/")
32
33 #if HAVE_SPLIT_USR
34 # define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
35 # define DEFAULT_PATH_NULSTR DEFAULT_PATH_SPLIT_USR_NULSTR
36 #else
37 # define DEFAULT_PATH DEFAULT_PATH_NORMAL
38 # define DEFAULT_PATH_NULSTR DEFAULT_PATH_NORMAL_NULSTR
39 #endif
40
41 #ifndef DEFAULT_USER_PATH
42 # define DEFAULT_USER_PATH DEFAULT_PATH
43 #endif
44
is_path(const char * p)45 static inline bool is_path(const char *p) {
46 assert(p);
47 return strchr(p, '/');
48 }
49
path_is_absolute(const char * p)50 static inline bool path_is_absolute(const char *p) {
51 assert(p);
52 return p[0] == '/';
53 }
54
55 int path_split_and_make_absolute(const char *p, char ***ret);
56 char* path_make_absolute(const char *p, const char *prefix);
57 int safe_getcwd(char **ret);
58 int path_make_absolute_cwd(const char *p, char **ret);
59 int path_make_relative(const char *from, const char *to, char **ret);
60 char *path_startswith_full(const char *path, const char *prefix, bool accept_dot_dot) _pure_;
path_startswith(const char * path,const char * prefix)61 static inline char* path_startswith(const char *path, const char *prefix) {
62 return path_startswith_full(path, prefix, true);
63 }
64 int path_compare(const char *a, const char *b) _pure_;
65
path_equal(const char * a,const char * b)66 static inline bool path_equal(const char *a, const char *b) {
67 return path_compare(a, b) == 0;
68 }
69
70 bool path_equal_or_files_same(const char *a, const char *b, int flags);
71 /* Compares only the last portion of the input paths, ie: the filenames */
72 bool path_equal_filename(const char *a, const char *b);
73
74 char* path_extend_internal(char **x, ...);
75 #define path_extend(x, ...) path_extend_internal(x, __VA_ARGS__, POINTER_MAX)
76 #define path_join(...) path_extend_internal(NULL, __VA_ARGS__, POINTER_MAX)
77
78 char* path_simplify(char *path);
79
path_equal_ptr(const char * a,const char * b)80 static inline bool path_equal_ptr(const char *a, const char *b) {
81 return !!a == !!b && (!a || path_equal(a, b));
82 }
83
84 /* Note: the search terminates on the first NULL item. */
85 #define PATH_IN_SET(p, ...) path_strv_contains(STRV_MAKE(__VA_ARGS__), p)
86
87 char* path_startswith_strv(const char *p, char **set);
88 #define PATH_STARTSWITH_SET(p, ...) path_startswith_strv(p, STRV_MAKE(__VA_ARGS__))
89
90 int path_strv_make_absolute_cwd(char **l);
91 char** path_strv_resolve(char **l, const char *root);
92 char** path_strv_resolve_uniq(char **l, const char *root);
93
94 int find_executable_full(const char *name, const char *root, char **exec_search_path, bool use_path_envvar, char **ret_filename, int *ret_fd);
find_executable(const char * name,char ** ret_filename)95 static inline int find_executable(const char *name, char **ret_filename) {
96 return find_executable_full(name, /* root= */ NULL, NULL, true, ret_filename, NULL);
97 }
98
99 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
100
101 int fsck_exists(const char *fstype);
102
103 /* Iterates through the path prefixes of the specified path, going up
104 * the tree, to root. Also returns "" (and not "/"!) for the root
105 * directory. Excludes the specified directory itself */
106 #define PATH_FOREACH_PREFIX(prefix, path) \
107 for (char *_slash = ({ \
108 path_simplify(strcpy(prefix, path)); \
109 streq(prefix, "/") ? NULL : strrchr(prefix, '/'); \
110 }); \
111 _slash && ((*_slash = 0), true); \
112 _slash = strrchr((prefix), '/'))
113
114 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
115 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
116 for (char *_slash = ({ \
117 path_simplify(strcpy(prefix, path)); \
118 if (streq(prefix, "/")) \
119 prefix[0] = 0; \
120 strrchr(prefix, 0); \
121 }); \
122 _slash && ((*_slash = 0), true); \
123 _slash = strrchr((prefix), '/'))
124
125 /* Similar to path_join(), but only works for two components, and only the first one may be NULL and returns
126 * an alloca() buffer, or possibly a const pointer into the path parameter. */
127 #define prefix_roota(root, path) \
128 ({ \
129 const char* _path = (path), *_root = (root), *_ret; \
130 char *_p, *_n; \
131 size_t _l; \
132 while (_path[0] == '/' && _path[1] == '/') \
133 _path ++; \
134 if (isempty(_root)) \
135 _ret = _path; \
136 else { \
137 _l = strlen(_root) + 1 + strlen(_path) + 1; \
138 _n = newa(char, _l); \
139 _p = stpcpy(_n, _root); \
140 while (_p > _n && _p[-1] == '/') \
141 _p--; \
142 if (_path[0] != '/') \
143 *(_p++) = '/'; \
144 strcpy(_p, _path); \
145 _ret = _n; \
146 } \
147 _ret; \
148 })
149
150 char* dirname_malloc(const char *path);
151 int path_find_first_component(const char **p, bool accept_dot_dot, const char **ret);
152 int path_find_last_component(const char *path, bool accept_dot_dot, const char **next, const char **ret);
153 const char *last_path_component(const char *path);
154 int path_extract_filename(const char *path, char **ret);
155 int path_extract_directory(const char *path, char **ret);
156
157 bool filename_is_valid(const char *p) _pure_;
158 bool path_is_valid_full(const char *p, bool accept_dot_dot) _pure_;
path_is_valid(const char * p)159 static inline bool path_is_valid(const char *p) {
160 return path_is_valid_full(p, true);
161 }
path_is_safe(const char * p)162 static inline bool path_is_safe(const char *p) {
163 return path_is_valid_full(p, false);
164 }
165 bool path_is_normalized(const char *p) _pure_;
166
167 char *file_in_same_dir(const char *path, const char *filename);
168
169 bool hidden_or_backup_file(const char *filename) _pure_;
170
171 bool is_device_path(const char *path);
172
173 bool valid_device_node_path(const char *path);
174 bool valid_device_allow_pattern(const char *path);
175
176 bool dot_or_dot_dot(const char *path);
177
skip_dev_prefix(const char * p)178 static inline const char *skip_dev_prefix(const char *p) {
179 const char *e;
180
181 /* Drop any /dev prefix if there is any */
182
183 e = path_startswith(p, "/dev/");
184
185 return e ?: p;
186 }
187
188 bool empty_or_root(const char *path);
empty_to_root(const char * path)189 static inline const char *empty_to_root(const char *path) {
190 return isempty(path) ? "/" : path;
191 }
192
193 bool path_strv_contains(char **l, const char *path);
194 bool prefixed_path_strv_contains(char **l, const char *path);
195