/* $NetBSD: amd.h,v 1.1.1.6 2003/03/09 01:13:04 christos Exp $ */ /* * Copyright (c) 1997-2003 Erez Zadok * Copyright (c) 1990 Jan-Simon Pendry * Copyright (c) 1990 Imperial College of Science, Technology & Medicine * Copyright (c) 1990 The Regents of the University of California. * All rights reserved. * * This code is derived from software contributed to Berkeley by * Jan-Simon Pendry at Imperial College, London. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgment: * This product includes software developed by the University of * California, Berkeley and its contributors. * 4. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * * Id: amd.h,v 1.29 2002/12/27 22:43:46 ezk Exp * */ #ifndef _AMD_H #define _AMD_H /* * MACROS: */ /* options for amd.conf */ #define CFM_BROWSABLE_DIRS 0x0001 #define CFM_MOUNT_TYPE_AUTOFS 0x0002 /* use kernel autofs support */ #define CFM_SELECTORS_IN_DEFAULTS 0x0004 #define CFM_NORMALIZE_HOSTNAMES 0x0008 #define CFM_PROCESS_LOCK 0x0010 #define CFM_PRINT_PID 0x0020 #define CFM_RESTART_EXISTING_MOUNTS 0x0040 #define CFM_SHOW_STATFS_ENTRIES 0x0080 #define CFM_FULLY_QUALIFIED_HOSTS 0x0100 #define CFM_BROWSABLE_DIRS_FULL 0x0200 /* allow '/' in readdir() */ #define CFM_UNMOUNT_ON_EXIT 0x0400 /* when amd finishing */ /* some systems (SunOS 4.x) neglect to define the mount null message */ #ifndef MOUNTPROC_NULL # define MOUNTPROC_NULL ((u_long)(0)) #endif /* not MOUNTPROC_NULL */ /* Hash table size */ #define NKVHASH (1 << 2) /* Power of two */ /* interval between forced retries of a mount */ #define RETRY_INTERVAL 2 #define ereturn(x) do { *error_return = x; return 0; } while (0) #define NEVER (time_t) 0 /* * TYPEDEFS: */ typedef struct cf_map cf_map_t; typedef struct kv kv; /* * Cache map operations */ typedef void add_fn(mnt_map *, char *, char *); typedef int init_fn(mnt_map *, char *, time_t *); typedef int mtime_fn(mnt_map *, char *, time_t *); typedef int isup_fn(mnt_map *, char *); typedef int reload_fn(mnt_map *, char *, add_fn *); typedef int search_fn(mnt_map *, char *, char *, char **, time_t *); /* * STRUCTURES: */ /* global amd options that are manipulated by conf.c */ struct amu_global_options { char *arch; /* name of current architecture */ char *auto_dir; /* automounter temp dir */ char *cluster; /* cluster name */ char *karch; /* kernel architecture */ char *logfile; /* amd log file */ char *op_sys; /* operating system name ${os} */ char *op_sys_ver; /* OS version ${osver} */ char *op_sys_full; /* full OS name ${full_os} */ char *op_sys_vendor; /* name of OS vendor ${vendor} */ char *pid_file; /* PID file */ char *sub_domain; /* local domain */ char *map_options; /* global map options */ int map_reload_interval; /* map reload interval */ char *map_type; /* global map type */ char *search_path; /* search path for maps */ char *mount_type; /* mount type for map */ u_int flags; /* various CFM_* flags */ int amfs_auto_retrans; /* NFS retransmit counter */ int amfs_auto_timeo; /* NFS retry interval */ int am_timeo; /* cache duration */ int am_timeo_w; /* dismount interval */ int portmap_program; /* amd RPC program number */ #ifdef HAVE_MAP_HESIOD char *hesiod_base; /* Hesiod rhs */ #endif /* HAVE_MAP_HESIOD */ #ifdef HAVE_MAP_LDAP char *ldap_base; /* LDAP base */ char *ldap_hostports; /* LDAP host ports */ long ldap_cache_seconds; /* LDAP internal cache - keep seconds */ long ldap_cache_maxmem; /* LDAP internal cache - max memory (bytes) */ long ldap_proto_version; /* LDAP protocol version */ #endif /* HAVE_MAP_LDAP */ #ifdef HAVE_MAP_NIS char *nis_domain; /* YP domain name */ #endif /* HAVE_MAP_NIS */ char *nfs_proto; /* NFS protocol (NULL, udp, tcp) */ int nfs_vers; /* NFS version (0, 2, 3, 4) */ }; /* if you add anything here, update conf.c:reset_cf_map() */ struct cf_map { char *cfm_dir; /* /home, /u, /src */ char *cfm_name; /* amd.home, /etc/amd.home ... */ char *cfm_type; /* file, hesiod, ndbm, nis ... */ char *cfm_opts; /* -cache:=all, etc. */ char *cfm_search_path; /* /etc/local:/etc/amdmaps:/misc/yp */ char *cfm_tag; /* optional map tag for amd -T */ u_int cfm_flags; /* browsable_dirs? mount_type? */ }; /* * Key-value pair */ struct kv { kv *next; char *key; #ifdef HAVE_REGEXEC regex_t re; /* store the regexp from regcomp() */ #endif /* HAVE_REGEXEC */ char *val; }; struct mnt_map { qelem hdr; int refc; /* Reference count */ short flags; /* Allocation flags */ short alloc; /* Allocation mode */ time_t modify; /* Modify time of map */ u_int reloads; /* Number of times map was reloaded */ char *map_name; /* Name of this map */ char *wildcard; /* Wildcard value */ reload_fn *reload; /* Function to be used for reloads */ isup_fn *isup; /* Is service up or not? (1=up, 0=down) */ search_fn *search; /* Function to be used for searching */ mtime_fn *mtime; /* Modify time function */ kv *kvhash[NKVHASH]; /* Cached data */ /* options available via amd conf file */ char *cf_map_type; /* file, hesiod, ndbm, nis, etc. */ char *cf_search_path; /* /etc/local:/etc/amdmaps:/misc/yp */ void *map_data; /* Map data black box */ }; /* * Mounting a file system may take a significant period of time. The * problem is that if this is done in the main process thread then the * entire automounter could be blocked, possibly hanging lots of processes * on the system. Instead we use a continuation scheme to allow mounts to * be attempted in a sub-process. When the sub-process exits we pick up the * exit status (by convention a UN*X error number) and continue in a * notifier. The notifier gets handed a data structure and can then * determine whether the mount was successful or not. If not, it updates * the data structure and tries again until there are no more ways to try * the mount, or some other permanent error occurs. In the mean time no RPC * reply is sent, even after the mount is successful. We rely on the RPC * retry mechanism to resend the lookup request which can then be handled. */ struct continuation { am_node *mp; /* Node we are trying to mount */ int retry; /* Try again? */ time_t start; /* Time we started this mount */ int callout; /* Callout identifier */ mntfs **mf; /* Current mntfs */ }; /* * EXTERNALS: */ /* Amq server global functions */ extern amq_mount_info_list *amqproc_getmntfs_1_svc(voidp argp, struct svc_req *rqstp); extern amq_mount_stats *amqproc_stats_1_svc(voidp argp, struct svc_req *rqstp); extern amq_mount_tree_list *amqproc_export_1_svc(voidp argp, struct svc_req *rqstp); extern amq_mount_tree_p *amqproc_mnttree_1_svc(voidp argp, struct svc_req *rqstp); extern amq_string *amqproc_getvers_1_svc(voidp argp, struct svc_req *rqstp); extern int *amqproc_getpid_1_svc(voidp argp, struct svc_req *rqstp); extern int *amqproc_mount_1_svc(voidp argp, struct svc_req *rqstp); extern int *amqproc_setopt_1_svc(voidp argp, struct svc_req *rqstp); extern voidp amqproc_null_1_svc(voidp argp, struct svc_req *rqstp); extern voidp amqproc_umnt_1_svc(voidp argp, struct svc_req *rqstp); /* other external definitions */ extern am_nfs_fh *get_root_nfs_fh(char *dir); extern am_node *find_ap(char *); extern am_node *get_ap_child(am_node *, char *); extern bool_t xdr_amq_mount_info_qelem(XDR *xdrs, qelem *qhead); extern fserver *find_nfs_srvr(mntfs *mf); extern int auto_fmount(am_node *mp); extern int auto_fumount(am_node *mp); extern int mount_nfs_fh(am_nfs_handle_t *fhp, char *mntdir, char *real_mntdir, char *fs_name, char *opts, int on_autofs, mntfs *mf); extern int process_last_regular_map(void); extern int set_conf_kv(const char *section, const char *k, const char *v); extern int try_mount(voidp mvp); extern int unmount_mp(am_node *mp); extern int yyparse (void); extern nfsentry *make_entry_chain(am_node *mp, const nfsentry *current_chain, int fully_browsable); extern void amfs_auto_cont(int rc, int term, voidp closure); extern void amfs_auto_mkcacheref(mntfs *mf); extern void amfs_auto_retry(int rc, int term, voidp closure); extern void amfs_auto_mounted(mntfs *mf); extern int mount_amfs_toplvl(mntfs *mf, char *opts); extern void assign_error_mntfs(am_node *mp); extern void flush_srvr_nfs_cache(void); extern void free_continuation(struct continuation *cp); extern void mf_mounted(mntfs *mf); extern void nfs_quick_reply(am_node *mp, int error); extern void root_newmap(const char *, const char *, const char *, const cf_map_t *); /* amd global variables */ extern FILE *yyin; extern SVCXPRT *current_transp; /* For nfs_quick_reply() */ extern char *conf_tag; extern char *opt_gid; extern char *opt_uid; extern int NumChild; extern int fwd_sock; extern int select_intr_valid; extern int usage; extern int use_conf_file; /* use amd configuration file */ extern jmp_buf select_intr; extern qelem mfhead; extern struct am_opts fs_static; /* copy of the options to play with */ extern struct amu_global_options gopt; /* where global options are stored */ #ifdef HAVE_SIGACTION extern sigset_t masked_sigs; #endif /* HAVE_SIGACTION */ #if defined(HAVE_AMU_FS_LINK) || defined(HAVE_AMU_FS_LINKX) extern char *amfs_link_match(am_opts *fo); extern int amfs_link_mount(am_node *mp, mntfs *mf); extern int amfs_link_umount(am_node *mp, mntfs *mf); #endif /* defined(HAVE_AMU_FS_LINK) || defined(HAVE_AMU_FS_LINKX) */ #ifdef HAVE_AMU_FS_NFSL extern char *nfs_match(am_opts *fo); #endif /* HAVE_AMU_FS_NFSL */ #if defined(HAVE_FS_NFS3) && !defined(HAVE_XDR_MOUNTRES3) extern bool_t xdr_mountres3(XDR *xdrs, mountres3 *objp); #endif /* defined(HAVE_FS_NFS3) && !defined(HAVE_XDR_MOUNTRES3) */ #ifdef HAVE_FS_AUTOFS extern int amd_use_autofs; extern autofs_fh_t *autofs_get_fh(am_node *mp); extern void autofs_release_fh(autofs_fh_t *fh); extern void autofs_add_fdset(fd_set *readfds); extern int autofs_handle_fdset(fd_set *readfds, int nsel); extern void autofs_mounted(am_node *mp); extern void autofs_mount_succeeded(am_node *mp); extern void autofs_mount_failed(am_node *mp); extern int autofs_umount_succeeded(am_node *mp); extern int autofs_umount_failed(am_node *mp); extern void autofs_get_opts(char *opts, autofs_fh_t *fh); extern int autofs_link_mount(am_node *mp); extern int autofs_link_umount(am_node *mp); extern int autofs_compute_mount_flags(mntent_t *); extern void autofs_timeout_mp(am_node *); extern int create_autofs_service(void); extern int destroy_autofs_service(void); #endif /* HAVE_FS_AUTOFS */ /* Unix file system (irix) */ #ifdef HAVE_FS_XFS extern am_ops xfs_ops; /* Un*x file system */ #endif /* HAVE_FS_XFS */ /* Unix file system (irix) */ #ifdef HAVE_FS_EFS extern am_ops efs_ops; /* Un*x file system */ #endif /* HAVE_FS_EFS */ #endif /* not _AMD_H */