contrib/amd/amd/amd.h

   1 /*
   2  * Copyright (c) 1997-2004 Erez Zadok
   3  * Copyright (c) 1990 Jan-Simon Pendry
   4  * Copyright (c) 1990 Imperial College of Science, Technology & Medicine
   5  * Copyright (c) 1990 The Regents of the University of California.
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Jan-Simon Pendry at Imperial College, London.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgment:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      %W% (Berkeley) %G%
  40  *
  41  * $Id: amd.h,v 1.8.2.8 2004/01/21 04:04:58 ib42 Exp $
  42  *
  43  */
  44
  45 #ifndef _AMD_H
  46 #define _AMD_H
  47
  48
  49 /*
  50  * MACROS:
  51  */
  52
  53 /* options for amd.conf */
  54 #define CFM_BROWSABLE_DIRS              0x0001
  55 #define CFM_MOUNT_TYPE_AUTOFS           0x0002
  56 #define CFM_SELECTORS_IN_DEFAULTS       0x0004
  57 #define CFM_NORMALIZE_HOSTNAMES         0x0008
  58 #define CFM_PROCESS_LOCK                0x0010
  59 #define CFM_PRINT_PID                   0x0020
  60 #define CFM_RESTART_EXISTING_MOUNTS     0x0040
  61 #define CFM_SHOW_STATFS_ENTRIES         0x0080
  62 #define CFM_FULLY_QUALIFIED_HOSTS       0x0100
  63 #define CFM_BROWSABLE_DIRS_FULL         0x0200 /* allow '/' in readdir() */
  64 #define CFM_UNMOUNT_ON_EXIT             0x0400 /* when amd finishing */
  65 #define CFM_NFS_INSECURE_PORT           0x0800
  66
  67 /* some systems (SunOS 4.x) neglect to define the mount null message */
  68 #ifndef MOUNTPROC_NULL
  69 # define MOUNTPROC_NULL ((u_long)(0))
  70 #endif /* not MOUNTPROC_NULL */
  71
  72 /* Hash table size */
  73 #define NKVHASH (1 << 2)        /* Power of two */
  74
  75 /* interval between forced retries of a mount */
  76 #define RETRY_INTERVAL  2
  77
  78 #define ereturn(x) { *error_return = x; return 0; }
  79
  80
  81 /*
  82  * TYPEDEFS:
  83  */
  84
  85 typedef struct cf_map cf_map_t;
  86 typedef struct kv kv;
  87 /*
  88  * Cache map operations
  89  */
  90 typedef void add_fn(mnt_map *, char *, char *);
  91 typedef int init_fn(mnt_map *, char *, time_t *);
  92 typedef int mtime_fn(mnt_map *, char *, time_t *);
  93 typedef int isup_fn(mnt_map *, char *);
  94 typedef int reload_fn(mnt_map *, char *, add_fn *);
  95 typedef int search_fn(mnt_map *, char *, char *, char **, time_t *);
  96
  97
  98
  99 /*
 100  * STRUCTURES:
 101  */
 102
 103 /* global amd options that are manipulated by conf.c */
 104 struct amu_global_options {
 105   char *arch;                   /* name of current architecture */
 106   char *auto_dir;               /* automounter temp dir */
 107   char *cluster;                /* cluster name */
 108   char *karch;                  /* kernel architecture */
 109   char *logfile;                /* amd log file */
 110   char *op_sys;                 /* operating system name ${os} */
 111   char *op_sys_ver;             /* OS version ${osver} */
 112   char *op_sys_full;            /* full OS name ${full_os} */
 113   char *op_sys_vendor;          /* name of OS vendor ${vendor} */
 114   char *pid_file;               /* PID file */
 115   char *sub_domain;             /* local domain */
 116   char *map_options;            /* global map options */
 117   char *map_type;               /* global map type */
 118   char *search_path;            /* search path for maps */
 119   char *mount_type;             /* mount type for map */
 120   u_int flags;                  /* various CFM_* flags */
 121   int amfs_auto_retrans;        /* NFS retransmit counter */
 122   int amfs_auto_timeo;          /* NFS retry interval */
 123   int am_timeo;                 /* cache duration */
 124   int am_timeo_w;               /* dismount interval */
 125   int portmap_program;          /* amd RPC program number */
 126 #ifdef HAVE_MAP_HESIOD
 127   char *hesiod_base;            /* Hesiod rhs */
 128 #endif /* HAVE_MAP_HESIOD */
 129 #ifdef HAVE_MAP_LDAP
 130   char *ldap_base;              /* LDAP base */
 131   char *ldap_hostports;         /* LDAP host ports */
 132   long ldap_cache_seconds;      /* LDAP internal cache - keep seconds */
 133   long ldap_cache_maxmem;       /* LDAP internal cache - max memory (bytes) */
 134 #endif /* HAVE_MAP_LDAP */
 135 #ifdef HAVE_MAP_NIS
 136   char *nis_domain;             /* YP domain name */
 137 #endif /* HAVE_MAP_NIS */
 138   char *nfs_proto;              /* NFS protocol (NULL, udp, tcp) */
 139   int nfs_vers;                 /* NFS version (0, 2, 3, 4) */
 140 };
 141
 142 /* if you add anything here, update conf.c:reset_cf_map() */
 143 struct cf_map {
 144   char *cfm_dir;                /* /home, /u, /src */
 145   char *cfm_name;               /* amd.home, /etc/amd.home ... */
 146   char *cfm_type;               /* file, hesiod, ndbm, nis ... */
 147   char *cfm_opts;               /* -cache:=all, etc. */
 148   char *cfm_search_path;        /* /etc/local:/etc/amdmaps:/misc/yp */
 149   char *cfm_tag;                /* optional map tag for amd -T */
 150   u_int cfm_flags;              /* browsable_dirs? mount_type? */
 151 };
 152
 153 /*
 154  * Key-value pair
 155  */
 156 struct kv {
 157   kv *next;
 158   char *key;
 159 #ifdef HAVE_REGEXEC
 160   regex_t re;                   /* store the regexp from regcomp() */
 161 #endif /* HAVE_REGEXEC */
 162   char *val;
 163 };
 164
 165 struct mnt_map {
 166   qelem hdr;
 167   int refc;                     /* Reference count */
 168   short flags;                  /* Allocation flags */
 169   short alloc;                  /* Allocation mode */
 170   time_t modify;                /* Modify time of map */
 171   u_int reloads;                /* Number of times map was reloaded */
 172   char *map_name;               /* Name of this map */
 173   char *wildcard;               /* Wildcard value */
 174   reload_fn *reload;            /* Function to be used for reloads */
 175   isup_fn *isup;                /* Is service up or not? (1=up, 0=down) */
 176   search_fn *search;            /* Function to be used for searching */
 177   mtime_fn *mtime;              /* Modify time function */
 178   kv *kvhash[NKVHASH];          /* Cached data */
 179   /* options available via amd conf file */
 180   char *cf_map_type;            /* file, hesiod, ndbm, nis, etc. */
 181   char *cf_search_path;         /* /etc/local:/etc/amdmaps:/misc/yp */
 182   void *map_data;               /* Map data black box */
 183 };
 184
 185 /*
 186  * Mounting a file system may take a significant period of time.  The
 187  * problem is that if this is done in the main process thread then the
 188  * entire automounter could be blocked, possibly hanging lots of processes
 189  * on the system.  Instead we use a continuation scheme to allow mounts to
 190  * be attempted in a sub-process.  When the sub-process exits we pick up the
 191  * exit status (by convention a UN*X error number) and continue in a
 192  * notifier.  The notifier gets handed a data structure and can then
 193  * determine whether the mount was successful or not.  If not, it updates
 194  * the data structure and tries again until there are no more ways to try
 195  * the mount, or some other permanent error occurs.  In the mean time no RPC
 196  * reply is sent, even after the mount is successful.  We rely on the RPC
 197  * retry mechanism to resend the lookup request which can then be handled.
 198  */
 199 struct continuation {
 200   char **ivec;                  /* Current mount info */
 201   am_node *mp;                  /* Node we are trying to mount */
 202   char *key;                    /* Map key */
 203   char *info;                   /* Info string */
 204   char **xivec;                 /* Saved strsplit vector */
 205   char *auto_opts;              /* Automount options */
 206   am_opts fs_opts;              /* Filesystem options */
 207   char *def_opts;               /* Default automount options */
 208   int retry;                    /* Try again? */
 209   int tried;                    /* Have we tried any yet? */
 210   time_t start;                 /* Time we started this mount */
 211   int callout;                  /* Callout identifier */
 212 };
 213
 214
 215 /*
 216  * EXTERNALS:
 217  */
 218
 219 /* Amq server global functions */
 220 extern amq_mount_info_list *amqproc_getmntfs_1_svc(voidp argp, struct svc_req *rqstp);
 221 extern amq_mount_stats *amqproc_stats_1_svc(voidp argp, struct svc_req *rqstp);
 222 extern amq_mount_tree_list *amqproc_export_1_svc(voidp argp, struct svc_req *rqstp);
 223 extern amq_mount_tree_p *amqproc_mnttree_1_svc(voidp argp, struct svc_req *rqstp);
 224 extern amq_string *amqproc_getvers_1_svc(voidp argp, struct svc_req *rqstp);
 225 extern int *amqproc_getpid_1_svc(voidp argp, struct svc_req *rqstp);
 226 extern int *amqproc_mount_1_svc(voidp argp, struct svc_req *rqstp);
 227 extern int *amqproc_setopt_1_svc(voidp argp, struct svc_req *rqstp);
 228 extern voidp amqproc_null_1_svc(voidp argp, struct svc_req *rqstp);
 229 extern voidp amqproc_umnt_1_svc(voidp argp, struct svc_req *rqstp);
 230
 231 /* other external definitions */
 232 extern am_nfs_fh *root_fh(char *dir);
 233 extern am_node *find_ap(char *);
 234 extern am_node *find_ap2(char *, am_node *);
 235 extern bool_t xdr_amq_mount_info_qelem(XDR *xdrs, qelem *qhead);
 236 extern fserver *find_nfs_srvr(mntfs *mf);
 237 extern int auto_fmount(am_node *mp);
 238 extern int auto_fumount(am_node *mp);
 239 extern int mount_nfs_fh(am_nfs_handle_t *fhp, char *dir, char *fs_name, char *opts, mntfs *mf);
 240 extern int process_last_regular_map(void);
 241 extern int set_conf_kv(const char *section, const char *k, const char *v);
 242 extern int try_mount(voidp mvp);
 243 extern int yyparse (void);
 244 extern nfsentry *make_entry_chain(am_node *mp, const nfsentry *current_chain, int fully_browsable);
 245 extern void amfs_auto_cont(int rc, int term, voidp closure);
 246 extern void amfs_auto_mkcacheref(mntfs *mf);
 247 extern void amfs_auto_retry(int rc, int term, voidp closure);
 248 extern void assign_error_mntfs(am_node *mp);
 249 extern void flush_srvr_nfs_cache(void);
 250 extern void free_continuation(struct continuation *cp);
 251 extern void mf_mounted(mntfs *mf);
 252 extern void quick_reply(am_node *mp, int error);
 253 extern void root_newmap(const char *, const char *, const char *, const cf_map_t *);
 254
 255 /* amd global variables */
 256 extern FILE *yyin;
 257 extern SVCXPRT *nfs_program_2_transp; /* For quick_reply() */
 258 extern char *conf_tag;
 259 extern char *opt_gid;
 260 extern char *opt_uid;
 261 extern int NumChild;
 262 extern int fwd_sock;
 263 extern int select_intr_valid;
 264 extern int usage;
 265 extern int use_conf_file;       /* use amd configuration file */
 266 extern jmp_buf select_intr;
 267 extern qelem mfhead;
 268 extern struct am_opts fs_static; /* copy of the options to play with */
 269 extern struct amu_global_options gopt; /* where global options are stored */
 270
 271 #ifdef HAVE_SIGACTION
 272 extern sigset_t masked_sigs;
 273 #endif /* HAVE_SIGACTION */
 274
 275 #if defined(HAVE_AMU_FS_LINK) || defined(HAVE_AMU_FS_LINKX)
 276 extern char *amfs_link_match(am_opts *fo);
 277 extern int amfs_link_fumount(mntfs *mf);
 278 #endif /* defined(HAVE_AMU_FS_LINK) || defined(HAVE_AMU_FS_LINKX) */
 279
 280 #ifdef HAVE_AMU_FS_NFSL
 281 extern char *nfs_match(am_opts *fo);
 282 #endif /* HAVE_AMU_FS_NFSL */
 283
 284 #if defined(HAVE_FS_NFS3) && !defined(HAVE_XDR_MOUNTRES3)
 285 extern bool_t xdr_mountres3(XDR *xdrs, mountres3 *objp);
 286 #endif /* defined(HAVE_FS_NFS3) && !defined(HAVE_XDR_MOUNTRES3) */
 287
 288 /* Unix file system (irix) */
 289 #ifdef HAVE_FS_XFS
 290 extern am_ops xfs_ops;          /* Un*x file system */
 291 #endif /* HAVE_FS_XFS */
 292
 293 /* Unix file system (irix) */
 294 #ifdef HAVE_FS_EFS
 295 extern am_ops efs_ops;          /* Un*x file system */
 296 #endif /* HAVE_FS_EFS */
 297
 298 #endif /* not _AMD_H */