usr.sbin/autofs/common.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  * $FreeBSD$
  31  */
  32
  33 #ifndef AUTOMOUNTD_H
  34 #define AUTOMOUNTD_H
  35
  36 #include <sys/queue.h>
  37 #include <stdbool.h>
  38
  39 #define AUTO_MASTER_PATH        "/etc/auto_master"
  40 #define AUTO_MAP_PREFIX         "/etc"
  41 #define AUTO_SPECIAL_PREFIX     "/etc/autofs"
  42 #define AUTO_INCLUDE_PATH       AUTO_SPECIAL_PREFIX "/include"
  43
  44 struct node {
  45         TAILQ_ENTRY(node)       n_next;
  46         TAILQ_HEAD(nodehead, node)      n_children;
  47         struct node             *n_parent;
  48         char                    *n_key;
  49         char                    *n_options;
  50         char                    *n_location;
  51         char                    *n_map;
  52         const char              *n_config_file;
  53         int                     n_config_line;
  54 };
  55
  56 struct defined_value {
  57         TAILQ_ENTRY(defined_value)      d_next;
  58         char                            *d_name;
  59         char                            *d_value;
  60 };
  61
  62 void    log_init(int level);
  63 void    log_set_peer_name(const char *name);
  64 void    log_set_peer_addr(const char *addr);
  65 void    log_err(int, const char *, ...)
  66             __dead2 __printf0like(2, 3);
  67 void    log_errx(int, const char *, ...)
  68             __dead2 __printf0like(2, 3);
  69 void    log_warn(const char *, ...) __printf0like(1, 2);
  70 void    log_warnx(const char *, ...) __printflike(1, 2);
  71 void    log_debugx(const char *, ...) __printf0like(1, 2);
  72
  73 char    *checked_strdup(const char *);
  74 char    *concat(const char *s1, char separator, const char *s2);
  75 void    create_directory(const char *path);
  76
  77 struct node     *node_new_root(void);
  78 struct node     *node_new(struct node *parent, char *key, char *options,
  79                     char *location, const char *config_file, int config_line);
  80 struct node     *node_new_map(struct node *parent, char *key, char *options,
  81                     char *map, const char *config_file, int config_line);
  82 struct node     *node_find(struct node *root, const char *mountpoint);
  83 bool            node_is_direct_map(const struct node *n);
  84 bool            node_has_wildcards(const struct node *n);
  85 char    *node_path(const struct node *n);
  86 char    *node_options(const struct node *n);
  87 void    node_expand_ampersand(struct node *root, const char *key);
  88 void    node_expand_wildcard(struct node *root, const char *key);
  89 int     node_expand_defined(struct node *root);
  90 void    node_expand_indirect_maps(struct node *n);
  91 void    node_print(const struct node *n, const char *cmdline_options);
  92 void    parse_master(struct node *root, const char *path);
  93 void    parse_map(struct node *parent, const char *map, const char *args,
  94             bool *wildcards);
  95 char    *defined_expand(const char *string);
  96 void    defined_init(void);
  97 void    defined_parse_and_add(char *def);
  98 void    lesser_daemon(void);
  99
 100 int     main_automount(int argc, char **argv);
 101 int     main_automountd(int argc, char **argv);
 102 int     main_autounmountd(int argc, char **argv);
 103
 104 FILE    *auto_popen(const char *argv0, ...);
 105 int     auto_pclose(FILE *iop);
 106
 107 /*
 108  * lex(1) stuff.
 109  */
 110 extern int lineno;
 111
 112 #define STR     1
 113 #define NEWLINE 2
 114
 115 #endif /* !AUTOMOUNTD_H */