xref: /dragonfly/usr.sbin/autofs/common.h (revision 5062ee70)
1 /*-
2  * Copyright (c) 2016 The DragonFly Project
3  * Copyright (c) 2014 The FreeBSD Foundation
4  * All rights reserved.
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  * $FreeBSD$
31  */
32 
33 #ifndef AUTOMOUNTD_H
34 #define	AUTOMOUNTD_H
35 
36 #include <sys/types.h>
37 #include <sys/queue.h>
38 #include <stdio.h>
39 #include <stdbool.h>
40 
41 #define	AUTO_MASTER_PATH	"/etc/auto_master"
42 #define	AUTO_MAP_PREFIX		"/etc"
43 #define	AUTO_SPECIAL_PREFIX	"/etc/autofs"
44 #define	AUTO_INCLUDE_PATH	AUTO_SPECIAL_PREFIX "/include"
45 
46 /*
47  * DragonFly has no _SAFE macros (see 085ff963).
48  */
49 #define	TAILQ_FOREACH_SAFE(var, head, field, tvar)			\
50 	for ((var) = TAILQ_FIRST((head));				\
51 	    (var) && ((tvar) = TAILQ_NEXT((var), field), 1);		\
52 	    (var) = (tvar))
53 
54 #define	TAILQ_FOREACH_REVERSE_SAFE(var, head, headname, field, tvar)	\
55 	for ((var) = TAILQ_LAST((head), headname);			\
56 	    (var) && ((tvar) = TAILQ_PREV((var), headname, field), 1);	\
57 	    (var) = (tvar))
58 
59 struct node {
60 	TAILQ_ENTRY(node)	n_next;
61 	TAILQ_HEAD(nodehead, node)	n_children;
62 	struct node		*n_parent;
63 	char			*n_key;
64 	char			*n_options;
65 	char			*n_location;
66 	char			*n_map;
67 	const char		*n_config_file;
68 	int			n_config_line;
69 };
70 
71 struct defined_value {
72 	TAILQ_ENTRY(defined_value)	d_next;
73 	char				*d_name;
74 	char				*d_value;
75 };
76 
77 void	log_init(int level);
78 void	log_set_peer_name(const char *name);
79 void	log_set_peer_addr(const char *addr);
80 void	log_err(int, const char *, ...)
81 	    __dead2 __printf0like(2, 3);
82 void	log_errx(int, const char *, ...)
83 	    __dead2 __printf0like(2, 3);
84 void	log_warn(const char *, ...) __printf0like(1, 2);
85 void	log_warnx(const char *, ...) __printflike(1, 2);
86 void	log_debugx(const char *, ...) __printf0like(1, 2);
87 
88 char	*checked_strdup(const char *);
89 char	*concat(const char *s1, char separator, const char *s2);
90 void	create_directory(const char *path);
91 
92 struct node	*node_new_root(void);
93 struct node	*node_new(struct node *parent, char *key, char *options,
94 		    char *location, const char *config_file, int config_line);
95 struct node	*node_new_map(struct node *parent, char *key, char *options,
96 		    char *map, const char *config_file, int config_line);
97 struct node	*node_find(struct node *root, const char *mountpoint);
98 bool		node_is_direct_map(const struct node *n);
99 bool		node_has_wildcards(const struct node *n);
100 char	*node_path(const struct node *n);
101 char	*node_options(const struct node *n);
102 void	node_expand_ampersand(struct node *root, const char *key);
103 void	node_expand_wildcard(struct node *root, const char *key);
104 int	node_expand_defined(struct node *root);
105 void	node_expand_indirect_maps(struct node *n);
106 void	node_print(const struct node *n, const char *cmdline_options);
107 void	parse_master(struct node *root, const char *path);
108 void	parse_map(struct node *parent, const char *map, const char *args,
109 	    bool *wildcards);
110 char	*defined_expand(const char *string);
111 void	defined_init(void);
112 void	defined_parse_and_add(char *def);
113 void	lesser_daemon(void);
114 
115 int	main_automount(int argc, char **argv);
116 void	main_automountd(int argc, char **argv) __dead2;
117 void	main_autounmountd(int argc, char **argv) __dead2;
118 
119 FILE	*auto_popen(const char *argv0, ...);
120 int	auto_pclose(FILE *iop);
121 
122 /*
123  * lex(1) stuff.
124  */
125 extern int lineno;
126 
127 #define	STR	1
128 #define	NEWLINE	2
129 
130 #endif /* !AUTOMOUNTD_H */
131