contrib/amd/amd/amd.h

   1 /*
   2  * Copyright (c) 1997-2006 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  *
  40  * File: am-utils/amd/amd.h
  41  *
  42  */
  43
  44 #ifndef _AMD_H
  45 #define _AMD_H
  46
  47
  48 /*
  49  * MACROS:
  50  */
  51
  52 /*
  53  * Define a default debug mtab path for systems
  54  * that support mtab on file.
  55  */
  56 #ifdef MOUNT_TABLE_ON_FILE
  57 # define DEBUG_MNTTAB_FILE               "/tmp/mnttab"
  58 #endif /* MOUNT_TABLE_ON_FILE */
  59
  60 /* options for amd.conf */
  61 #define CFM_BROWSABLE_DIRS              0x00000001
  62 #define CFM_MOUNT_TYPE_AUTOFS           0x00000002 /* use kernel autofs support */
  63 #define CFM_SELECTORS_IN_DEFAULTS       0x00000004
  64 #define CFM_NORMALIZE_HOSTNAMES         0x00000008
  65 #define CFM_PROCESS_LOCK                0x00000010
  66 #define CFM_PRINT_PID                   0x00000020
  67 #define CFM_RESTART_EXISTING_MOUNTS     0x00000040
  68 #define CFM_SHOW_STATFS_ENTRIES         0x00000080
  69 #define CFM_FULLY_QUALIFIED_HOSTS       0x00000100
  70 #define CFM_BROWSABLE_DIRS_FULL         0x00000200 /* allow '/' in readdir() */
  71 #define CFM_UNMOUNT_ON_EXIT             0x00000400 /* when amd finishing */
  72 #define CFM_USE_TCPWRAPPERS             0x00000800
  73 #define CFM_AUTOFS_USE_LOFS             0x00001000
  74 #define CFM_NFS_INSECURE_PORT           0x00002000
  75 #define CFM_DOMAIN_STRIP                0x00004000
  76 #define CFM_NORMALIZE_SLASHES           0x00008000 /* normalize slashes? */
  77 #define CFM_FORCED_UNMOUNTS             0x00010000 /* forced unmounts? */
  78 #define CFM_TRUNCATE_LOG                0x00020000 /* truncate log file? */
  79 #if 0
  80 /* XXX: reserved to sync up with am-utils-6.2 */
  81 #define CFM_SUN_MAP_SYNTAX              0x00040000 /* Sun map syntax? */
  82 #endif
  83 #define CFM_NFS_ANY_INTERFACE           0x00080000 /* all interfaces are acceptable */
  84
  85 /* defaults global flags: plock, tcpwrappers, and autofs/lofs */
  86 #define CFM_DEFAULT_FLAGS       (CFM_PROCESS_LOCK|CFM_USE_TCPWRAPPERS|CFM_AUTOFS_USE_LOFS|CFM_DOMAIN_STRIP|CFM_NORMALIZE_SLASHES)
  87
  88 /*
  89  * macro definitions for automounter vfs/vnode operations.
  90  */
  91 #define VLOOK_CREATE    0x1
  92 #define VLOOK_DELETE    0x2
  93 #define VLOOK_LOOKUP    0x3
  94
  95 /*
  96  * macro definitions for automounter vfs capabilities
  97  */
  98 #define FS_DIRECTORY    0x0001  /* This looks like a dir, not a link */
  99 #define FS_MBACKGROUND  0x0002  /* Should background this mount */
 100 #define FS_NOTIMEOUT    0x0004  /* Don't bother with timeouts */
 101 #define FS_MKMNT        0x0008  /* Need to make the mount point */
 102 #define FS_UBACKGROUND  0x0010  /* Unmount in background */
 103 #define FS_BACKGROUND   (FS_MBACKGROUND|FS_UBACKGROUND)
 104 #define FS_DISCARD      0x0020  /* Discard immediately on last reference */
 105 #define FS_AMQINFO      0x0040  /* Amq is interested in this fs type */
 106 #define FS_AUTOFS       0x0080  /* This filesystem can be an autofs f/s */
 107 #define FS_DIRECT       0x0100  /* Direct mount */
 108 #define FS_ON_AUTOFS    0x0200  /* This filesystem can be mounted directly
 109                                    onto an autofs mountpoint */
 110
 111 /*
 112  * macros for struct am_node (map of auto-mount points).
 113  */
 114 #define AMF_NOTIMEOUT   0x0001  /* This node never times out */
 115 #define AMF_ROOT        0x0002  /* This is a root node */
 116 #define AMF_AUTOFS      0x0004  /* This node is part of an autofs filesystem */
 117 #define AMF_REMOUNT     0x0008  /* This node needs to be remounted */
 118 #define AMF_SOFTLOOKUP  0x0010  /* This node returns EIO if server is down */
 119
 120 /*
 121  * macros for struct mntfs (list of mounted filesystems)
 122  */
 123 #define MFF_MOUNTED     0x0001  /* Node is mounted */
 124 #define MFF_MOUNTING    0x0002  /* Mount is in progress */
 125 #define MFF_UNMOUNTING  0x0004  /* Unmount is in progress */
 126 #define MFF_RESTART     0x0008  /* Restarted node */
 127 #define MFF_MKMNT       0x0010  /* Delete this node's am_mount */
 128 #define MFF_ERROR       0x0020  /* This node failed to mount */
 129 #define MFF_LOGDOWN     0x0040  /* Logged that this mount is down */
 130 #define MFF_RSTKEEP     0x0080  /* Don't timeout this filesystem - restarted */
 131 #define MFF_WANTTIMO    0x0100  /* Need a timeout call when not busy */
 132 #define MFF_NFSLINK     0x0200  /* nfsl type, and deemed a link */
 133 #define MFF_IS_AUTOFS   0x0400  /* this filesystem is of type autofs */
 134 #define MFF_NFS_SCALEDOWN 0x0800 /* the mount failed, retry with v2/UDP */
 135 #define MFF_ON_AUTOFS   0x1000  /* autofs has a lofs/link to this f/s */
 136 #define MFF_WEBNFS      0x2000  /* use public filehandle */
 137
 138 /*
 139  * macros for struct fserver.
 140  */
 141 #define FSF_VALID       0x0001  /* Valid information available */
 142 #define FSF_DOWN        0x0002  /* This fileserver is thought to be down */
 143 #define FSF_ERROR       0x0004  /* Permanent error has occurred */
 144 #define FSF_WANT        0x0008  /* Want a wakeup call */
 145 #define FSF_PINGING     0x0010  /* Already doing pings */
 146 #define FSF_WEBNFS      0x0020  /* Don't try to contact portmapper */
 147 #define FSF_PING_UNINIT 0x0040  /* ping values have not been initilized */
 148 #define FSF_FORCE_UNMOUNT 0x0080 /* force umount of this fserver */
 149 #define FSRV_ERROR(fs)  ((fs) && (((fs)->fs_flags & FSF_ERROR) == FSF_ERROR))
 150 #define FSRV_ISDOWN(fs) ((fs) && (((fs)->fs_flags & (FSF_DOWN|FSF_VALID)) == (FSF_DOWN|FSF_VALID)))
 151 #define FSRV_ISUP(fs)   (!(fs) || (((fs)->fs_flags & (FSF_DOWN|FSF_VALID)) == (FSF_VALID)))
 152
 153 /* some systems (SunOS 4.x) neglect to define the mount null message */
 154 #ifndef MOUNTPROC_NULL
 155 # define MOUNTPROC_NULL ((u_long)(0))
 156 #endif /* not MOUNTPROC_NULL */
 157
 158 /*
 159  * Error to return if remote host is not available.
 160  * Try, in order, "host down", "host unreachable", "invalid argument".
 161  */
 162 #ifdef EHOSTDOWN
 163 # define AM_ERRNO_HOST_DOWN     EHOSTDOWN
 164 #else /* not EHOSTDOWN */
 165 # ifdef EHOSTUNREACH
 166 #  define AM_ERRNO_HOST_DOWN    EHOSTUNREACH
 167 # else /* not EHOSTUNREACH */
 168 #  define AM_ERRNO_HOST_DOWN    EINVAL
 169 # endif /* not EHOSTUNREACH */
 170 #endif /* not EHOSTDOWN */
 171
 172 /* Hash table size */
 173 #define NKVHASH (1 << 2)        /* Power of two */
 174
 175 /* Max entries to return in one call */
 176 #define MAX_READDIR_ENTRIES     16
 177
 178 /*
 179  * default amfs_auto retrans - 1/10th seconds
 180  */
 181 #define AMFS_AUTO_RETRANS(x)    ((ALLOWED_MOUNT_TIME*10+5*gopt.amfs_auto_timeo[(x)])/gopt.amfs_auto_timeo[(x)] * 2)
 182
 183 /*
 184  * The following values can be tuned...
 185  */
 186 #define AM_TTL                  (300) /* Default cache period (5 min) */
 187 #define AM_TTL_W                (120) /* Default unmount interval (2 min) */
 188 #define AM_PINGER               30 /* NFS ping interval for live systems */
 189 #define AMFS_AUTO_TIMEO         8 /* Default amfs_auto timeout - .8s */
 190 #define AMFS_EXEC_MAP_TIMEOUT   10 /* default 10sec exec map timeout */
 191
 192 /* interval between forced retries of a mount */
 193 #define RETRY_INTERVAL  2
 194
 195 #ifndef ROOT_MAP
 196 # define ROOT_MAP "\"root\""
 197 #endif /* not ROOT_MAP */
 198
 199 #define ereturn(x) do { *error_return = x; return 0; } while (0)
 200
 201 #define NEVER (time_t) 0
 202
 203 #if defined(HAVE_TCPD_H) && defined(HAVE_LIBWRAP)
 204 # define AMD_SERVICE_NAME "amd" /* for tcpwrappers */
 205 #endif /* defined(HAVE_TCPD_H) && defined(HAVE_LIBWRAP) */
 206
 207 /*
 208  * TYPEDEFS:
 209  */
 210
 211 typedef struct cf_map cf_map_t;
 212 typedef struct kv kv;
 213 typedef struct am_node am_node;
 214 typedef struct mntfs mntfs;
 215 typedef struct am_opts am_opts;
 216 typedef struct am_ops am_ops;
 217 typedef struct am_stats am_stats;
 218 typedef struct fserver fserver;
 219
 220 typedef voidp wchan_t;
 221 typedef voidp opaque_t;
 222
 223 /*
 224  * Cache map operations
 225  */
 226 typedef void add_fn(mnt_map *, char *, char *);
 227 typedef int init_fn(mnt_map *, char *, time_t *);
 228 typedef int mtime_fn(mnt_map *, char *, time_t *);
 229 typedef int isup_fn(mnt_map *, char *);
 230 typedef int reload_fn(mnt_map *, char *, add_fn *);
 231 typedef int search_fn(mnt_map *, char *, char *, char **, time_t *);
 232 typedef int task_fun(opaque_t);
 233 typedef void cb_fun(int, int, opaque_t);
 234 typedef void fwd_fun(voidp, int, struct sockaddr_in *,
 235                      struct sockaddr_in *, opaque_t, int);
 236 typedef int key_fun(char *, opaque_t);
 237 typedef void callout_fun(opaque_t);
 238
 239 /*
 240  * automounter vfs/vnode operations.
 241  */
 242 typedef char *(*vfs_match) (am_opts *);
 243 typedef int (*vfs_init) (mntfs *);
 244 typedef int (*vmount_fs) (am_node *, mntfs *);
 245 typedef int (*vumount_fs) (am_node *, mntfs *);
 246 typedef am_node *(*vlookup_child) (am_node *, char *, int *, int);
 247 typedef am_node *(*vmount_child) (am_node *, int *);
 248 typedef int (*vreaddir) (am_node *, nfscookie, nfsdirlist *, nfsentry *, u_int);
 249 typedef am_node *(*vreadlink) (am_node *, int *);
 250 typedef void (*vmounted) (mntfs *);
 251 typedef void (*vumounted) (mntfs *);
 252 typedef fserver *(*vffserver) (mntfs *);
 253 typedef wchan_t (*vget_wchan) (mntfs *);
 254
 255
 256
 257 /*
 258  * STRUCTURES:
 259  */
 260
 261 /* global amd options that are manipulated by conf.c */
 262 struct amu_global_options {
 263   char *arch;                   /* name of current architecture */
 264   char *auto_dir;               /* automounter temp dir */
 265   int auto_attrcache;           /* attribute cache timeout for auto dirs */
 266   char *cluster;                /* cluster name */
 267   char *karch;                  /* kernel architecture */
 268   char *logfile;                /* amd log file */
 269   char *op_sys;                 /* operating system name ${os} */
 270   char *op_sys_ver;             /* OS version ${osver} */
 271   char *op_sys_full;            /* full OS name ${full_os} */
 272   char *op_sys_vendor;          /* name of OS vendor ${vendor} */
 273   char *pid_file;               /* PID file */
 274   char *sub_domain;             /* local domain */
 275   char *localhost_address;      /* localhost address (NULL means use 127.0.0.1) */
 276   char *map_defaults;           /* global map /default options */
 277   char *map_options;            /* global map options */
 278   int map_reload_interval;      /* map reload interval */
 279   char *map_type;               /* global map type */
 280   char *search_path;            /* search path for maps */
 281   char *mount_type;             /* mount type for map */
 282   char *debug_mtab_file;        /* path for the mtab file during debug mode */
 283   u_int flags;                  /* various CFM_* flags */
 284
 285 #define AMU_TYPE_NONE -1        /* for amfs_auto_{timeo,retrans,toplvl} */
 286 #define AMU_TYPE_UDP 0          /* for amfs_auto_{timeo,retrans,toplvl} */
 287 #define AMU_TYPE_TCP 1          /* for amfs_auto_{timeo,retrans,toplvl} */
 288   /*
 289    * Note: toplvl is only UDP, but we want to separate it from regular
 290    * NFS mounts which Amd makes, because the toplvl mount is a localhost
 291    * mount for which different timeo/retrans parameters may be desired.
 292    */
 293 #define AMU_TYPE_TOPLVL 2       /* for amfs_auto_{timeo,retrans,toplvl} */
 294 #define AMU_TYPE_MAX 3          /* for amfs_auto_{timeo,retrans,toplvl} */
 295   int amfs_auto_retrans[AMU_TYPE_MAX]; /* NFS retransmit counter */
 296   int amfs_auto_timeo[AMU_TYPE_MAX]; /* NFS retry interval */
 297
 298   int am_timeo;                 /* cache duration */
 299   int am_timeo_w;               /* dismount interval */
 300   u_long portmap_program;       /* amd RPC program number */
 301   u_short preferred_amq_port;   /* preferred amq service RPC port number (0 means "any") */
 302 #ifdef HAVE_MAP_HESIOD
 303   char *hesiod_base;            /* Hesiod rhs */
 304 #endif /* HAVE_MAP_HESIOD */
 305 #ifdef HAVE_MAP_LDAP
 306   char *ldap_base;              /* LDAP base */
 307   char *ldap_hostports;         /* LDAP host ports */
 308   long ldap_cache_seconds;      /* LDAP internal cache - keep seconds */
 309   long ldap_cache_maxmem;       /* LDAP internal cache - max memory (bytes) */
 310   long ldap_proto_version;      /* LDAP protocol version */
 311 #endif /* HAVE_MAP_LDAP */
 312 #ifdef HAVE_MAP_NIS
 313   char *nis_domain;             /* YP domain name */
 314 #endif /* HAVE_MAP_NIS */
 315   char *nfs_proto;              /* NFS protocol (NULL, udp, tcp) */
 316   int nfs_vers;                 /* NFS version (0, 2, 3, 4) */
 317   u_int exec_map_timeout;       /* timeout (seconds) for executable maps */
 318 };
 319
 320 /* if you add anything here, update conf.c:reset_cf_map() */
 321 struct cf_map {
 322   char *cfm_dir;                /* /home, /u, /src */
 323   char *cfm_name;               /* amd.home, /etc/amd.home ... */
 324   char *cfm_type;               /* file, hesiod, ndbm, nis ... */
 325   char *cfm_defaults;           /* map /defaults options in amd.conf */
 326   char *cfm_opts;               /* -cache:=all, etc. */
 327   char *cfm_search_path;        /* /etc/local:/etc/amdmaps:/misc/yp */
 328   char *cfm_tag;                /* optional map tag for amd -T */
 329   u_int cfm_flags;              /* browsable_dirs? mount_type? */
 330   struct cf_map *cfm_next;      /* pointer to next in list (if any) */
 331 };
 332
 333 /*
 334  * Key-value pair
 335  */
 336 struct kv {
 337   kv *next;
 338   char *key;
 339 #ifdef HAVE_REGEXEC
 340   regex_t re;                   /* store the regexp from regcomp() */
 341 #endif /* HAVE_REGEXEC */
 342   char *val;
 343 };
 344
 345 struct mnt_map {
 346   qelem hdr;
 347   int refc;                     /* Reference count */
 348   short flags;                  /* Allocation flags */
 349   short alloc;                  /* Allocation mode */
 350   time_t modify;                /* Modify time of map */
 351   u_int reloads;                /* Number of times map was reloaded */
 352   char *map_name;               /* Name of this map */
 353   char *wildcard;               /* Wildcard value */
 354   reload_fn *reload;            /* Function to be used for reloads */
 355   isup_fn *isup;                /* Is service up or not? (1=up, 0=down) */
 356   search_fn *search;            /* Function to be used for searching */
 357   mtime_fn *mtime;              /* Modify time function */
 358   kv *kvhash[NKVHASH];          /* Cached data */
 359   cf_map_t *cfm;                /* pointer to per-map amd.conf opts, if any */
 360   void *map_data;               /* Map data black box */
 361 };
 362
 363 /*
 364  * Options
 365  */
 366 struct am_opts {
 367   char *fs_glob;                /* Smashed copy of global options */
 368   char *fs_local;               /* Expanded copy of local options */
 369   char *fs_mtab;                /* Mount table entry */
 370   /* Other options ... */
 371   char *opt_dev;
 372   char *opt_delay;
 373   char *opt_dir;
 374   char *opt_fs;
 375   char *opt_group;
 376   char *opt_mount;
 377   char *opt_opts;
 378   char *opt_remopts;
 379   char *opt_pref;
 380   char *opt_cache;
 381   char *opt_rfs;
 382   char *opt_rhost;
 383   char *opt_sublink;
 384   char *opt_type;
 385   char *opt_mount_type;         /* "nfs" or "autofs" */
 386   char *opt_unmount;
 387   char *opt_umount;             /* an "alias" for opt_unmount (type:=program) */
 388   char *opt_user;
 389   char *opt_maptype;            /* map type: file, nis, hesiod, etc. */
 390   char *opt_cachedir;           /* cache directory */
 391   char *opt_addopts;            /* options to add to opt_opts */
 392 };
 393
 394 struct am_ops {
 395   char          *fs_type;       /* type of filesystems e.g. "nfsx" */
 396   vfs_match     fs_match;       /* fxn: match */
 397   vfs_init      fs_init;        /* fxn: initialization */
 398   vmount_fs     mount_fs;       /* fxn: mount my own vnode */
 399   vumount_fs    umount_fs;      /* fxn: unmount my own vnode */
 400   vlookup_child lookup_child;   /* fxn: lookup path-name */
 401   vmount_child  mount_child;    /* fxn: mount path-name */
 402   vreaddir      readdir;        /* fxn: read directory */
 403   vreadlink     readlink;       /* fxn: read link */
 404   vmounted      mounted;        /* fxn: after-mount extra actions */
 405   vumounted     umounted;       /* fxn: after-umount extra actions */
 406   vffserver     ffserver;       /* fxn: find a file server */
 407   vget_wchan    get_wchan;      /* fxn: get the waiting channel */
 408   int           nfs_fs_flags;   /* filesystem flags FS_* for nfs mounts */
 409 #ifdef HAVE_FS_AUTOFS
 410   int           autofs_fs_flags;/* filesystem flags FS_* for autofs mounts */
 411 #endif /* HAVE_FS_AUTOFS */
 412 };
 413
 414 /*
 415  * List of mounted filesystems
 416  */
 417 struct mntfs {
 418   qelem mf_q;                   /* List of mounted filesystems */
 419   am_ops *mf_ops;               /* Operations on this mountpoint */
 420   am_opts *mf_fo;               /* File opts */
 421   char *mf_mount;               /* "/a/kiska/home/kiska" */
 422   char *mf_info;                /* Mount info */
 423   char *mf_auto;                /* Automount opts */
 424   char *mf_mopts;               /* FS mount opts */
 425   char *mf_remopts;             /* Remote FS mount opts */
 426   char *mf_loopdev;             /* loop device name for /dev/loop mounts */
 427   fserver *mf_server;           /* File server */
 428   int mf_fsflags;               /* Flags FS_* copied from mf_ops->*_fs_flags */
 429   int mf_flags;                 /* Flags MFF_* */
 430   int mf_error;                 /* Error code from background mount */
 431   int mf_refc;                  /* Number of references to this node */
 432   int mf_cid;                   /* Callout id */
 433   void (*mf_prfree) (opaque_t); /* Free private space */
 434   opaque_t mf_private;          /* Private - per-fs data */
 435 };
 436
 437 /*
 438  * List of fileservers
 439  */
 440 struct fserver {
 441   qelem fs_q;                   /* List of fileservers */
 442   int fs_refc;                  /* Number of references to this server */
 443   char *fs_host;                /* Normalized hostname of server */
 444   struct sockaddr_in *fs_ip;    /* Network address of server */
 445   int fs_cid;                   /* Callout id */
 446   int fs_pinger;                /* Ping (keepalive) interval */
 447   int fs_flags;                 /* Flags */
 448   char *fs_type;                /* File server type */
 449   u_long fs_version;            /* NFS version of server (2, 3, etc.)*/
 450   char *fs_proto;               /* NFS protocol of server (tcp, udp, etc.) */
 451   opaque_t fs_private;          /* Private data */
 452   void (*fs_prfree) (opaque_t); /* Free private data */
 453 };
 454
 455 /*
 456  * Per-mountpoint statistics
 457  */
 458 struct am_stats {
 459   time_t s_mtime;               /* Mount time */
 460   u_short s_uid;                /* Uid of mounter */
 461   int s_getattr;                /* Count of getattrs */
 462   int s_lookup;                 /* Count of lookups */
 463   int s_readdir;                /* Count of readdirs */
 464   int s_readlink;               /* Count of readlinks */
 465   int s_statfs;                 /* Count of statfs */
 466 };
 467
 468 /*
 469  * System statistics
 470  */
 471 struct amd_stats {
 472   int d_drops;                  /* Dropped requests */
 473   int d_stale;                  /* Stale NFS handles */
 474   int d_mok;                    /* Successful mounts */
 475   int d_merr;                   /* Failed mounts */
 476   int d_uerr;                   /* Failed unmounts */
 477 };
 478 extern struct amd_stats amd_stats;
 479
 480 /*
 481  * Map of auto-mount points.
 482  */
 483 struct am_node {
 484   int am_mapno;         /* Map number */
 485   mntfs *am_mnt;        /* Mounted filesystem */
 486   mntfs **am_mfarray;   /* Filesystem sources to try to mount */
 487   char *am_name;        /* "kiska": name of this node */
 488   char *am_path;        /* "/home/kiska": path of this node's mount point */
 489   char *am_link;        /* "/a/kiska/home/kiska/this/that": link to sub-dir */
 490   am_node *am_parent;   /* Parent of this node */
 491   am_node *am_ysib;     /* Younger sibling of this node */
 492   am_node *am_osib;     /* Older sibling of this node */
 493   am_node *am_child;    /* First child of this node */
 494   nfsattrstat am_attr;  /* File attributes */
 495 #define am_fattr        am_attr.ns_u.ns_attr_u
 496   int am_flags;         /* Boolean flags AMF_* */
 497   int am_error;         /* Specific mount error */
 498   time_t am_ttl;        /* Time to live */
 499   int am_timeo_w;       /* Dismount wait interval */
 500   int am_timeo;         /* Cache timeout interval */
 501   u_int am_gen;         /* Generation number */
 502   char *am_pref;        /* Mount info prefix */
 503   am_stats am_stats;    /* Statistics gathering */
 504   SVCXPRT *am_transp;   /* Info for quick reply */
 505   dev_t am_dev;         /* Device number */
 506   dev_t am_rdev;        /* Remote/real device number */
 507 #ifdef HAVE_FS_AUTOFS
 508   autofs_fh_t *am_autofs_fh;
 509   time_t am_autofs_ttl; /* Time to expire autofs nodes */
 510 #endif /* HAVE_FS_AUTOFS */
 511 };
 512
 513 /*
 514  * EXTERNALS:
 515  */
 516
 517 /*
 518  * Amq server global functions
 519  */
 520 extern amq_mount_info_list *amqproc_getmntfs_1_svc(voidp argp, struct svc_req *rqstp);
 521 extern amq_mount_stats *amqproc_stats_1_svc(voidp argp, struct svc_req *rqstp);
 522 extern amq_mount_tree_list *amqproc_export_1_svc(voidp argp, struct svc_req *rqstp);
 523 extern amq_mount_tree_p *amqproc_mnttree_1_svc(voidp argp, struct svc_req *rqstp);
 524 extern amq_string *amqproc_getvers_1_svc(voidp argp, struct svc_req *rqstp);
 525 extern amq_string *amqproc_pawd_1_svc(voidp argp, struct svc_req *rqstp);
 526 extern int *amqproc_getpid_1_svc(voidp argp, struct svc_req *rqstp);
 527 extern int *amqproc_mount_1_svc(voidp argp, struct svc_req *rqstp);
 528 extern int *amqproc_setopt_1_svc(voidp argp, struct svc_req *rqstp);
 529 extern voidp amqproc_null_1_svc(voidp argp, struct svc_req *rqstp);
 530 extern voidp amqproc_umnt_1_svc(voidp argp, struct svc_req *rqstp);
 531
 532 /* other external definitions */
 533 extern am_nfs_fh *get_root_nfs_fh(char *dir);
 534 extern am_node *find_ap(char *);
 535 extern am_node *get_ap_child(am_node *, char *);
 536 extern bool_t xdr_amq_mount_info_qelem(XDR *xdrs, qelem *qhead);
 537 extern fserver *find_nfs_srvr(mntfs *mf);
 538 extern int mount_nfs_fh(am_nfs_handle_t *fhp, char *mntdir, char *fs_name, mntfs *mf);
 539 extern int process_all_regular_maps(void);
 540 extern cf_map_t *find_cf_map(const char *name);
 541 extern int set_conf_kv(const char *section, const char *k, const char *v);
 542 extern int mount_node(opaque_t arg);
 543 extern int unmount_mp(am_node *mp);
 544 extern int yyparse (void);
 545
 546 extern void amfs_mkcacheref(mntfs *mf);
 547 extern int amfs_mount(am_node *mp, mntfs *mf, char *opts);
 548 extern void assign_error_mntfs(am_node *mp);
 549 extern am_node *next_nonerror_node(am_node *xp);
 550 extern void flush_srvr_nfs_cache(fserver *fs);
 551 extern void am_mounted(am_node *);
 552 extern void mf_mounted(mntfs *mf, bool_t call_free_opts);
 553 extern void am_unmounted(am_node *);
 554 extern am_node *get_exported_ap(int index);
 555 extern am_node *get_first_exported_ap(int *index);
 556 extern am_node *get_next_exported_ap(int *index);
 557 extern am_node *path_to_exported_ap(char *path);
 558 extern am_node *exported_ap_alloc(void);
 559 extern am_node *find_mf(mntfs *);
 560 extern am_node *next_map(int *);
 561 extern am_ops *ops_match(am_opts *, char *, char *, char *, char *, char *);
 562 extern am_ops *ops_search(char *);
 563 extern fserver *dup_srvr(fserver *);
 564 extern void srvrlog(fserver *, char *);
 565 extern int get_mountd_port(fserver *, u_short *, wchan_t);
 566 extern void flush_nfs_fhandle_cache(fserver *);
 567
 568 extern mntfs *dup_mntfs(mntfs *);
 569 extern mntfs *find_mntfs(am_ops *, am_opts *, char *, char *, char *, char *, char *);
 570 extern mntfs *locate_mntfs(am_ops *, am_opts *, char *, char *, char *, char *, char *);
 571 extern mntfs *new_mntfs(void);
 572 extern mntfs *realloc_mntfs(mntfs *, am_ops *, am_opts *, char *, char *, char *, char *, char *);
 573 extern void flush_mntfs(void);
 574 extern void free_mntfs(voidp);
 575
 576
 577 extern void amq_program_1(struct svc_req *rqstp, SVCXPRT *transp);
 578 extern int  background(void);
 579 extern void deslashify(char *);
 580 extern void do_task_notify(void);
 581 extern int  eval_fs_opts(am_opts *, char *, char *, char *, char *, char *);
 582 extern void forcibly_timeout_mp(am_node *);
 583 extern void free_map(am_node *);
 584 extern void free_opts(am_opts *);
 585 extern void free_srvr(fserver *);
 586 extern int  fwd_init(void);
 587 extern int  fwd_packet(int, char *, int, struct sockaddr_in *, struct sockaddr_in *, opaque_t, fwd_fun *);
 588 extern void fwd_reply(void);
 589 extern void get_args(int argc, char *argv[]);
 590 extern wchan_t get_mntfs_wchan(mntfs *mf);
 591 extern void host_normalize(char **);
 592 extern void init_map(am_node *, char *);
 593 extern void ins_que(qelem *, qelem *);
 594 extern void insert_am(am_node *, am_node *);
 595 extern int  make_nfs_auth(void);
 596 extern void make_root_node(void);
 597 extern void map_flush_srvr(fserver *);
 598 extern void mapc_add_kv(mnt_map *, char *, char *);
 599 extern mnt_map *mapc_find(char *, char *, const char *);
 600 extern void mapc_free(opaque_t);
 601 extern int  mapc_keyiter(mnt_map *, key_fun, opaque_t);
 602 extern void mapc_reload(void);
 603 extern int  mapc_search(mnt_map *, char *, char **);
 604 extern void mapc_showtypes(char *buf, size_t l);
 605 extern int  mapc_type_exists(const char *type);
 606 extern void mk_fattr(nfsfattr *, nfsftype);
 607 extern int  mount_auto_node(char *, opaque_t);
 608 extern int  mount_automounter(int);
 609 extern int  mount_exported(void);
 610 extern void mp_to_fh(am_node *, am_nfs_fh *);
 611 extern void new_ttl(am_node *);
 612 extern void nfs_quick_reply(am_node *mp, int error);
 613 extern void normalize_slash(char *);
 614 extern void ops_showamfstypes(char *buf, size_t l);
 615 extern void ops_showfstypes(char *outbuf, size_t l);
 616 extern void rem_que(qelem *);
 617 extern void reschedule_timeout_mp(void);
 618 extern void restart(void);
 619 extern void restart_automounter_nodes(void);
 620 extern int  root_keyiter(key_fun *, opaque_t);
 621 extern void root_newmap(const char *, const char *, const char *, const cf_map_t *);
 622 extern void run_task(task_fun *, opaque_t, cb_fun *, opaque_t);
 623 extern void sched_task(cb_fun *, opaque_t, wchan_t);
 624 extern int  softclock(void);
 625 extern int  timeout(u_int, void (*fn)(opaque_t), opaque_t);
 626 extern void timeout_mp(opaque_t);
 627 extern void untimeout(int);
 628 extern void umount_exported(void);
 629 extern int  valid_key(char *);
 630 extern void wakeup(wchan_t);
 631 extern void wakeup_srvr(fserver *);
 632 extern void wakeup_task(int, int, wchan_t);
 633 #define SIZEOF_PID_FSNAME       (16 + MAXHOSTNAMELEN)
 634 extern char pid_fsname[SIZEOF_PID_FSNAME]; /* "kiska.southseas.nz:(pid%d)" */
 635 #define SIZEOF_HOSTD (2 * MAXHOSTNAMELEN + 1)
 636 extern char hostd[SIZEOF_HOSTD]; /* Host+domain */
 637 #define SIZEOF_OPTS 256         /* used for char opts[] and preopts[] */
 638
 639 /*
 640  * Global variables.
 641  */
 642 extern FILE *yyin;
 643 extern SVCXPRT *current_transp; /* For nfs_quick_reply() */
 644 extern char *conf_tag;
 645 #define SIZEOF_UID_STR  12
 646 #define SIZEOF_GID_STR  12
 647 extern char *opt_gid, gid_str[SIZEOF_GID_STR];
 648 extern char *opt_uid, uid_str[SIZEOF_UID_STR];
 649 extern int NumChildren;
 650 extern int fwd_sock;
 651 extern int select_intr_valid;
 652 extern int immediate_abort;     /* Should close-down unmounts be retried */
 653 extern int usage;
 654 extern int use_conf_file;       /* use amd configuration file */
 655 extern int task_notify_todo;    /* Task notifier needs running */
 656 extern jmp_buf select_intr;
 657 extern qelem mfhead;
 658 extern struct amu_global_options gopt; /* where global options are stored */
 659 extern time_t do_mapc_reload;   /* Flush & reload mount map cache */
 660 extern time_t next_softclock;   /* Time to call softclock() */
 661
 662 #ifdef HAVE_SIGACTION
 663 extern sigset_t masked_sigs;
 664 #endif /* HAVE_SIGACTION */
 665
 666 #if defined(HAVE_AMU_FS_LINK) || defined(HAVE_AMU_FS_LINKX)
 667 extern char *amfs_link_match(am_opts *fo);
 668 #endif /* defined(HAVE_AMU_FS_LINK) || defined(HAVE_AMU_FS_LINKX) */
 669
 670 #ifdef HAVE_FS_AUTOFS
 671 extern int amd_use_autofs;
 672
 673 extern int autofs_get_fh(am_node *mp);
 674 extern void autofs_release_fh(am_node *mp);
 675 extern void autofs_get_mp(am_node *mp);
 676 extern void autofs_release_mp(am_node *mp);
 677 extern void autofs_add_fdset(fd_set *readfds);
 678 extern int autofs_handle_fdset(fd_set *readfds, int nsel);
 679 extern void autofs_mounted(am_node *mp);
 680 extern void autofs_mount_succeeded(am_node *mp);
 681 extern void autofs_mount_failed(am_node *mp);
 682 extern int autofs_umount_succeeded(am_node *mp);
 683 extern int autofs_umount_failed(am_node *mp);
 684 extern int autofs_mount_fs(am_node *mp, mntfs *mf);
 685 extern int autofs_umount_fs(am_node *mp, mntfs *mf);
 686 extern void autofs_get_opts(char *opts, size_t l, autofs_fh_t *fh);
 687 extern int autofs_compute_mount_flags(mntent_t *);
 688 extern void autofs_timeout_mp(am_node *);
 689 extern int create_autofs_service(void);
 690 extern int destroy_autofs_service(void);
 691 #endif /* HAVE_FS_AUTOFS */
 692
 693 /**************************************************************************/
 694 /*** Generic file-system types, implemented as part of the native O/S.  ***/
 695 /**************************************************************************/
 696
 697 /*
 698  * Loopback File System
 699  * Many systems can't support this, and in any case most of the
 700  * functionality is available with Symlink FS.
 701  */
 702 #ifdef HAVE_FS_LOFS
 703 extern am_ops lofs_ops;
 704 extern int mount_lofs(char *mntdir, char *fs_name, char *opts, int on_autofs);
 705 #endif /* HAVE_FS_LOFS */
 706
 707 /*
 708  * CD-ROM File System (CD-ROM)
 709  * (HSFS: High Sierra F/S on some machines)
 710  * Many systems can't support this, and in any case most of the
 711  * functionality is available with program FS.
 712  */
 713 #ifdef HAVE_FS_CDFS
 714 extern am_ops cdfs_ops;
 715 #endif /* HAVE_FS_CDFS */
 716
 717 /*
 718  * PC File System (MS-DOS)
 719  * Many systems can't support this, and in any case most of the
 720  * functionality is available with program FS.
 721  */
 722 #ifdef HAVE_FS_PCFS
 723 extern am_ops pcfs_ops;
 724 #endif /* HAVE_FS_PCFS */
 725
 726 /*
 727  * Caching File System (Solaris)
 728  */
 729 #ifdef HAVE_FS_CACHEFS
 730 extern am_ops cachefs_ops;
 731 #endif /* HAVE_FS_CACHEFS */
 732
 733 /*
 734  * Network File System
 735  * Good, slow, NFS V.2.
 736  */
 737 #ifdef HAVE_FS_NFS
 738 extern am_ops nfs_ops;          /* NFS */
 739 extern fserver *find_nfs_srvr (mntfs *);
 740 extern qelem nfs_srvr_list;
 741 #endif /* HAVE_FS_NFS */
 742
 743 /*
 744  * Un*x File System
 745  * Normal local disk file system.
 746  */
 747 #ifdef HAVE_FS_UFS
 748 extern am_ops ufs_ops;          /* Un*x file system */
 749 #endif /* HAVE_FS_UFS */
 750
 751 /* Unix file system (irix) */
 752 #ifdef HAVE_FS_XFS
 753 extern am_ops xfs_ops;          /* Un*x file system */
 754 #endif /* HAVE_FS_XFS */
 755
 756 /* Unix file system (irix) */
 757 #ifdef HAVE_FS_EFS
 758 extern am_ops efs_ops;          /* Un*x file system */
 759 #endif /* HAVE_FS_EFS */
 760
 761 /**************************************************************************/
 762 /*** Automounter file-system types, implemented by amd.                 ***/
 763 /**************************************************************************/
 764
 765 /*
 766  * Root AMD File System
 767  */
 768 extern am_ops amfs_root_ops;    /* Root file system */
 769
 770 /*
 771  * Generic amfs helper methods
 772  */
 773 extern am_node *amfs_generic_lookup_child(am_node *mp, char *fname, int *error_return, int op);
 774 extern am_node *amfs_generic_mount_child(am_node *ap, int *error_return);
 775 extern int amfs_generic_readdir(am_node *mp, nfscookie cookie, nfsdirlist *dp, nfsentry *ep, u_int count);
 776 extern int amfs_generic_umount(am_node *mp, mntfs *mf);
 777 extern void amfs_generic_mounted(mntfs *mf);
 778 extern char *amfs_generic_match(am_opts *fo);
 779 extern fserver *amfs_generic_find_srvr(mntfs *);
 780
 781 /*
 782  * Automount File System
 783  */
 784 #ifdef HAVE_AMU_FS_AUTO
 785 extern am_ops amfs_auto_ops;    /* Automount file system (this!) */
 786 #endif /* HAVE_AMU_FS_AUTO */
 787
 788 /*
 789  * Toplvl Automount File System
 790  */
 791 #ifdef HAVE_AMU_FS_TOPLVL
 792 extern am_ops amfs_toplvl_ops;  /* Toplvl Automount file system */
 793 extern int amfs_toplvl_mount(am_node *mp, mntfs *mf);
 794 extern int amfs_toplvl_umount(am_node *mp, mntfs *mf);
 795 #endif /* HAVE_AMU_FS_TOPLVL */
 796
 797 /*
 798  * Direct Automount File System
 799  */
 800 #ifdef HAVE_AMU_FS_DIRECT
 801 extern am_ops amfs_direct_ops;  /* Direct Automount file system (this too) */
 802 #endif /* HAVE_AMU_FS_DIRECT */
 803
 804 /*
 805  * Error File System
 806  */
 807 #ifdef HAVE_AMU_FS_ERROR
 808 extern am_ops amfs_error_ops;   /* Error file system */
 809 extern am_node *amfs_error_lookup_child(am_node *mp, char *fname, int *error_return, int op);
 810 extern am_node *amfs_error_mount_child(am_node *ap, int *error_return);
 811 extern int amfs_error_readdir(am_node *mp, nfscookie cookie, nfsdirlist *dp, nfsentry *ep, u_int count);
 812 #endif /* HAVE_AMU_FS_ERROR */
 813
 814 /*
 815  * NFS mounts with local existence check.
 816  */
 817 #ifdef HAVE_AMU_FS_NFSL
 818 extern am_ops amfs_nfsl_ops;    /* NFSL */
 819 #endif /* HAVE_AMU_FS_NFSL */
 820
 821 /*
 822  * Multi-nfs mounts.
 823  */
 824 #ifdef HAVE_AMU_FS_NFSX
 825 extern am_ops amfs_nfsx_ops;    /* NFSX */
 826 #endif /* HAVE_AMU_FS_NFSX */
 827
 828 /*
 829  * NFS host - a whole tree.
 830  */
 831 #ifdef HAVE_AMU_FS_HOST
 832 extern am_ops amfs_host_ops;    /* NFS host */
 833 #endif /* HAVE_AMU_FS_HOST */
 834
 835 /*
 836  * Program File System
 837  * This is useful for things like RVD.
 838  */
 839 #ifdef HAVE_AMU_FS_PROGRAM
 840 extern am_ops amfs_program_ops; /* Program File System */
 841 #endif /* HAVE_AMU_FS_PROGRAM */
 842
 843 /*
 844  * Symbolic-link file system.
 845  * A "filesystem" which is just a symbol link.
 846  */
 847 #ifdef HAVE_AMU_FS_LINK
 848 extern am_ops amfs_link_ops;    /* Symlink FS */
 849 #endif /* HAVE_AMU_FS_LINK */
 850
 851 /*
 852  * Symbolic-link file system, which also checks that the target of
 853  * the symlink exists.
 854  * A "filesystem" which is just a symbol link.
 855  */
 856 #ifdef HAVE_AMU_FS_LINKX
 857 extern am_ops amfs_linkx_ops;   /* Symlink FS with existence check */
 858 #endif /* HAVE_AMU_FS_LINKX */
 859
 860 /*
 861  * Union file system
 862  */
 863 #ifdef HAVE_AMU_FS_UNION
 864 extern am_ops amfs_union_ops;   /* Union FS */
 865 #endif /* HAVE_AMU_FS_UNION */
 866
 867 #endif /* not _AMD_H */