xref: /freebsd/usr.sbin/autofs/common.h (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2014 The FreeBSD Foundation
5  *
6  * This software was developed by Edward Tomasz Napierala under sponsorship
7  * from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef AUTOMOUNTD_H
32 #define	AUTOMOUNTD_H
33 
34 #include <sys/queue.h>
35 #include <stdbool.h>
36 
37 #define	AUTO_MASTER_PATH	"/etc/auto_master"
38 #define	AUTO_MAP_PREFIX		"/etc"
39 #define	AUTO_SPECIAL_PREFIX	"/etc/autofs"
40 #define	AUTO_INCLUDE_PATH	AUTO_SPECIAL_PREFIX "/include"
41 
42 struct node {
43 	TAILQ_ENTRY(node)	n_next;
44 	TAILQ_HEAD(nodehead, node)	n_children;
45 	struct node		*n_parent;
46 	char			*n_key;
47 	char			*n_options;
48 	char			*n_location;
49 	char			*n_map;
50 	const char		*n_config_file;
51 	int			n_config_line;
52 };
53 
54 struct defined_value {
55 	TAILQ_ENTRY(defined_value)	d_next;
56 	char				*d_name;
57 	char				*d_value;
58 };
59 
60 void	log_init(int level);
61 void	log_set_peer_name(const char *name);
62 void	log_set_peer_addr(const char *addr);
63 void	log_err(int, const char *, ...)
64 	    __dead2 __printf0like(2, 3);
65 void	log_errx(int, const char *, ...)
66 	    __dead2 __printf0like(2, 3);
67 void	log_warn(const char *, ...) __printf0like(1, 2);
68 void	log_warnx(const char *, ...) __printflike(1, 2);
69 void	log_debugx(const char *, ...) __printf0like(1, 2);
70 
71 char	*checked_strdup(const char *);
72 char	*concat(const char *s1, char separator, const char *s2);
73 void	create_directory(const char *path);
74 
75 struct node	*node_new_root(void);
76 struct node	*node_new(struct node *parent, char *key, char *options,
77 		    char *location, const char *config_file, int config_line);
78 struct node	*node_new_map(struct node *parent, char *key, char *options,
79 		    char *map, const char *config_file, int config_line);
80 struct node	*node_find(struct node *root, const char *mountpoint);
81 bool		node_is_direct_map(const struct node *n);
82 bool		node_has_wildcards(const struct node *n);
83 char	*node_path(const struct node *n);
84 char	*node_options(const struct node *n);
85 void	node_expand_ampersand(struct node *root, const char *key);
86 void	node_expand_wildcard(struct node *root, const char *key);
87 int	node_expand_defined(struct node *root);
88 void	node_expand_indirect_maps(struct node *n);
89 void	node_print(const struct node *n, const char *cmdline_options);
90 void	parse_master(struct node *root, const char *path);
91 void	parse_map(struct node *parent, const char *map, const char *args,
92 	    bool *wildcards);
93 char	*defined_expand(const char *string);
94 void	defined_init(void);
95 void	defined_parse_and_add(char *def);
96 void	lesser_daemon(void);
97 void	rpc_umntall(void);
98 
99 int	main_automount(int argc, char **argv);
100 int	main_automountd(int argc, char **argv);
101 int	main_autounmountd(int argc, char **argv);
102 
103 FILE	*auto_popen(const char *argv0, ...);
104 int	auto_pclose(FILE *iop);
105 
106 /*
107  * lex(1) stuff.
108  */
109 extern int lineno;
110 
111 #define	STR	1
112 #define	NEWLINE	2
113 
114 #endif /* !AUTOMOUNTD_H */
115