[thirdparty/systemd.git] / src / basic / path-util.h

/* SPDX-License-Identifier: LGPL-2.1+ */
#pragma once

/***
  This file is part of systemd.

  Copyright 2010-2012 Lennart Poettering
***/

#include <alloca.h>
#include <stdbool.h>
#include <stddef.h>

#include "macro.h"
#include "string-util.h"
#include "time-util.h"

#if HAVE_SPLIT_BIN
#  define PATH_SBIN_BIN(x) x "sbin:" x "bin"
#  define PATH0_SBIN_BIN(x) x "sbin\0" x "bin"
#else
#  define PATH0_SBIN_BIN(x) x "bin"
#  define PATH_SBIN_BIN(x) x "bin"
#endif

#define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
#define DEFAULT_PATH0_NORMAL PATH0_SBIN_BIN("/usr/local/") "\0" PATH0_SBIN_BIN("/usr/")
#define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/")
#define DEFAULT_PATH0_SPLIT_USR DEFAULT_PATH0_NORMAL "\0" PATH0_SBIN_BIN("/")

#if HAVE_SPLIT_USR
#  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
#  define DEFAULT_PATH_NULSTR DEFAULT_PATH0_SPLIT_USR
#else
#  define DEFAULT_PATH DEFAULT_PATH_NORMAL
#  define DEFAULT_PATH_NULSTR DEFAULT_PATH0_NORMAL
#endif

bool is_path(const char *p) _pure_;
int path_split_and_make_absolute(const char *p, char ***ret);
bool path_is_absolute(const char *p) _pure_;
char* path_make_absolute(const char *p, const char *prefix);
int safe_getcwd(char **ret);
int path_make_absolute_cwd(const char *p, char **ret);
int path_make_relative(const char *from_dir, const char *to_path, char **_r);
char* path_kill_slashes(char *path);
char* path_startswith(const char *path, const char *prefix) _pure_;
int path_compare(const char *a, const char *b) _pure_;
bool path_equal(const char *a, const char *b) _pure_;
bool path_equal_or_files_same(const char *a, const char *b, int flags);
char* path_join(const char *root, const char *path, const char *rest);

static inline bool path_equal_ptr(const char *a, const char *b) {
        return !!a == !!b && (!a || path_equal(a, b));
}

/* Note: the search terminates on the first NULL item. */
#define PATH_IN_SET(p, ...)                                     \
        ({                                                      \
                char **s;                                       \
                bool _found = false;                            \
                STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
                        if (path_equal(p, *s)) {                \
                               _found = true;                   \
                               break;                           \
                        }                                       \
                _found;                                         \
        })

#define PATH_STARTSWITH_SET(p, ...)                             \
        ({                                                      \
                char **s;                                       \
                bool _found = false;                            \
                STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
                        if (path_startswith(p, *s)) {           \
                               _found = true;                   \
                               break;                           \
                        }                                       \
                _found;                                         \
        })

int path_strv_make_absolute_cwd(char **l);
char** path_strv_resolve(char **l, const char *root);
char** path_strv_resolve_uniq(char **l, const char *root);

int find_binary(const char *name, char **filename);

bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);

int fsck_exists(const char *fstype);
int mkfs_exists(const char *fstype);

/* Iterates through the path prefixes of the specified path, going up
 * the tree, to root. Also returns "" (and not "/"!) for the root
 * directory. Excludes the specified directory itself */
#define PATH_FOREACH_PREFIX(prefix, path) \
        for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))

/* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
#define PATH_FOREACH_PREFIX_MORE(prefix, path) \
        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), '/'))

char *prefix_root(const char *root, const char *path);

/* Similar to prefix_root(), but returns an alloca() buffer, or
 * possibly a const pointer into the path parameter */
#define prefix_roota(root, path)                                        \
        ({                                                              \
                const char* _path = (path), *_root = (root), *_ret;     \
                char *_p, *_n;                                          \
                size_t _l;                                              \
                while (_path[0] == '/' && _path[1] == '/')              \
                        _path ++;                                       \
                if (isempty(_root) || path_equal(_root, "/"))           \
                        _ret = _path;                                   \
                else {                                                  \
                        _l = strlen(_root) + 1 + strlen(_path) + 1;     \
                        _n = alloca(_l);                                \
                        _p = stpcpy(_n, _root);                         \
                        while (_p > _n && _p[-1] == '/')                \
                                _p--;                                   \
                        if (_path[0] != '/')                            \
                                *(_p++) = '/';                          \
                        strcpy(_p, _path);                              \
                        _ret = _n;                                      \
                }                                                       \
                _ret;                                                   \
        })

int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);

char* dirname_malloc(const char *path);
const char *last_path_component(const char *path);

bool filename_is_valid(const char *p) _pure_;
bool path_is_normalized(const char *p) _pure_;

char *file_in_same_dir(const char *path, const char *filename);

bool hidden_or_backup_file(const char *filename) _pure_;

bool is_device_path(const char *path);
bool is_deviceallow_pattern(const char *path);

int systemd_installation_has_version(const char *root, unsigned minimal_version);

bool dot_or_dot_dot(const char *path);

static inline const char *skip_dev_prefix(const char *p) {
        const char *e;

        /* Drop any /dev prefix if there is any */

        e = path_startswith(p, "/dev/");

        return e ?: p;
}
Commit	Line	Data
53e1b683	1	/* SPDX-License-Identifier: LGPL-2.1+ */
76877b46	2	#pragma once
9eb977db KS	3
	4	/***
	5	This file is part of systemd.
	6
	7	Copyright 2010-2012 Lennart Poettering
9eb977db KS	8	***/
9eb977db KS	9
11c3a366	10	#include <alloca.h>
44a6b1b6	11	#include <stdbool.h>
11c3a366	12	#include <stddef.h>
9eb977db	13
44a6b1b6	14	#include "macro.h"
a6f72863	15	#include "string-util.h"
8e184852	16	#include "time-util.h"
44a6b1b6	17
671f0f8d ZJS	18	#if HAVE_SPLIT_BIN
671f0f8d ZJS	19	# define PATH_SBIN_BIN(x) x "sbin:" x "bin"
5008da1e	20	# define PATH0_SBIN_BIN(x) x "sbin\0" x "bin"
671f0f8d	21	#else
5008da1e	22	# define PATH0_SBIN_BIN(x) x "bin"
671f0f8d ZJS	23	# define PATH_SBIN_BIN(x) x "bin"
	24	#endif
	25
	26	#define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
5008da1e	27	#define DEFAULT_PATH0_NORMAL PATH0_SBIN_BIN("/usr/local/") "\0" PATH0_SBIN_BIN("/usr/")
671f0f8d	28	#define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/")
5008da1e	29	#define DEFAULT_PATH0_SPLIT_USR DEFAULT_PATH0_NORMAL "\0" PATH0_SBIN_BIN("/")
e10a55fd	30
349cc4a5	31	#if HAVE_SPLIT_USR
e10a55fd	32	# define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
5008da1e	33	# define DEFAULT_PATH_NULSTR DEFAULT_PATH0_SPLIT_USR
c9d954b2	34	#else
e10a55fd	35	# define DEFAULT_PATH DEFAULT_PATH_NORMAL
5008da1e	36	# define DEFAULT_PATH_NULSTR DEFAULT_PATH0_NORMAL
c9d954b2 ZJS	37	#endif
c9d954b2 ZJS	38
44a6b1b6	39	bool is_path(const char *p) _pure_;
0f474365	40	int path_split_and_make_absolute(const char p, char **ret);
44a6b1b6 ZJS	41	bool path_is_absolute(const char *p) _pure_;
44a6b1b6 ZJS	42	char* path_make_absolute(const char p, const char prefix);
a2556d25	43	int safe_getcwd(char **ret);
0f474365	44	int path_make_absolute_cwd(const char p, char *ret);
7cb9c51c	45	int path_make_relative(const char from_dir, const char to_path, char **_r);
44a6b1b6 ZJS	46	char* path_kill_slashes(char *path);
44a6b1b6 ZJS	47	char* path_startswith(const char path, const char prefix) _pure_;
2230852b	48	int path_compare(const char a, const char b) _pure_;
44a6b1b6	49	bool path_equal(const char a, const char b) _pure_;
e3f791a2	50	bool path_equal_or_files_same(const char a, const char b, int flags);
0c6ea3a4	51	char* path_join(const char root, const char path, const char *rest);
44a6b1b6	52
24737c29 ZJS	53	static inline bool path_equal_ptr(const char a, const char b) {
	54	return !!a == !!b && (!a \|\| path_equal(a, b));
	55	}
	56
3ae5990c ZJS	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
ad2706db LP	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
0f474365	82	int path_strv_make_absolute_cwd(char **l);
e1873695 LP	83	char path_strv_resolve(char l, const char *root);
e1873695 LP	84	char path_strv_resolve_uniq(char l, const char *root);
9eb977db	85
85eca92e	86	int find_binary(const char name, char *filename);
fecffe5d	87
2ad8416d	88	bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
8e184852	89
eb66db55	90	int fsck_exists(const char *fstype);
5bcd08db	91	int mkfs_exists(const char *fstype);
eb66db55	92
e203f7c3 LP	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 */
fecffe5d	96	#define PATH_FOREACH_PREFIX(prefix, path) \
4a690c47	97	for (char _slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((_slash = 0), true); _slash = strrchr((prefix), '/'))
e203f7c3 LP	98
	99	/* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
	100	#define PATH_FOREACH_PREFIX_MORE(prefix, path) \
4a690c47	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), '/'))
1d13f648 LP	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	})
0f03c2a4 LP	129
0f03c2a4 LP	130	int parse_path_argument_and_warn(const char path, bool suppress_root, char *arg);
5f311f8c LP	131
5f311f8c LP	132	char* dirname_malloc(const char *path);
b12d25a8	133	const char last_path_component(const char path);
bb15fafe LP	134
bb15fafe LP	135	bool filename_is_valid(const char *p) _pure_;
99be45a4	136	bool path_is_normalized(const char *p) _pure_;
a0956174 LP	137
	138	char file_in_same_dir(const char path, const char *filename);
	139
55cdd057	140	bool hidden_or_backup_file(const char *filename) _pure_;
a0956174 LP	141
a0956174 LP	142	bool is_device_path(const char *path);
3ccb8862	143	bool is_deviceallow_pattern(const char *path);
5a46d55f ZJS	144
5a46d55f ZJS	145	int systemd_installation_has_version(const char *root, unsigned minimal_version);
49bfc877 LP	146
49bfc877 LP	147	bool dot_or_dot_dot(const char *path);
a119ec7c LP	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	}