1 /* 2 * Copyright (c) 1990 Jan-Simon Pendry 3 * Copyright (c) 1990 Imperial College of Science, Technology & Medicine 4 * Copyright (c) 1990 The Regents of the University of California. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Jan-Simon Pendry at Imperial College, London. 9 * 10 * %sccs.include.redist.c% 11 * 12 * @(#)am.h 5.3 (Berkeley) 05/12/91 13 * 14 * $Id: am.h,v 5.2.1.8 91/05/07 22:19:18 jsp Alpha $ 15 * 16 */ 17 18 #include "config.h" 19 20 /* 21 * Global declarations 22 */ 23 #include <sys/param.h> 24 #include <sys/socket.h> 25 #include <rpc/rpc.h> 26 #include "nfs_prot.h" 27 #ifdef MNTENT_HDR 28 #include MNTENT_HDR 29 #endif /* MNTENT_HDR */ 30 #include <assert.h> 31 32 #ifdef DEBUG_MEM 33 #include <malloc.h> 34 #endif /* DEBUG_MEM */ 35 36 #ifndef MAXHOSTNAMELEN 37 #define MAXHOSTNAMELEN 64 38 #endif /* MAXHOSTNAMELEN */ 39 40 #ifndef MNTTYPE_AUTO 41 #define MNTTYPE_AUTO "auto" 42 #endif /* MNTTYPE_AUTO */ 43 44 #ifndef FALSE 45 #define FALSE 0 46 #define TRUE 1 47 #endif /* FALSE */ 48 49 #ifndef ROOT_MAP 50 #define ROOT_MAP "\"root\"" 51 #endif /* ROOT_MAP */ 52 53 /* 54 * Flags from command line 55 */ 56 extern int print_pid; /* Print pid to stdout */ 57 extern int normalize_hosts; /* Normalize host names before use */ 58 extern int restart_existing_mounts; 59 #ifdef HAS_NIS_MAPS 60 extern char *domain; /* NIS domain to use */ 61 #endif /* HAS_NIS_MAPS */ 62 extern int am_timeo; /* Cache period */ 63 extern int afs_timeo; /* AFS timeout */ 64 extern int afs_retrans; /* AFS retrans */ 65 extern int am_timeo_w; /* Unmount timeout */ 66 extern char *mtab; /* Mount table */ 67 68 typedef enum { 69 Start, 70 Run, 71 Finishing, 72 Quit, 73 Done 74 } serv_state; 75 76 extern serv_state amd_state; /* Should we go now */ 77 extern int immediate_abort; /* Should close-down unmounts be retried */ 78 extern time_t do_mapc_reload; /* Flush & reload mount map cache */ 79 80 /* 81 * Useful constants 82 */ 83 extern char pid_fsname[]; /* kiska.southseas.nz:(pid%d) */ 84 extern char hostd[]; /* "kiska.southseas.nz" */ 85 extern char *hostdomain; /* "southseas.nz" */ 86 extern char *op_sys; /* "sos4" */ 87 extern char *arch; /* "sun4" */ 88 extern char *karch; /* "sun4c" */ 89 extern char *cluster; /* "r+d-kluster" */ 90 extern char *endian; /* "big" */ 91 extern char *auto_dir; /* "/a" */ 92 extern char copyright[]; /* Copyright info */ 93 extern char version[]; /* Version info */ 94 95 typedef struct am_ops am_ops; 96 typedef struct am_node am_node; 97 typedef struct am_opts am_opts; 98 typedef struct mntfs mntfs; 99 typedef struct fserver fserver; 100 typedef struct fsrvinfo fsrvinfo; 101 102 /* 103 * Debug defns. 104 */ 105 #ifdef DEBUG 106 #define DEBUG_MTAB "./mtab" 107 108 extern int debug_flags; /* Debug options */ 109 110 #define D_DAEMON 0x0001 /* Enter daemon mode */ 111 #define D_TRACE 0x0002 /* Do protocol trace */ 112 #define D_FULL 0x0004 /* Do full trace */ 113 #define D_MTAB 0x0008 /* Use local mtab */ 114 #define D_AMQ 0x0010 /* Register amq program */ 115 #define D_STR 0x0020 /* Debug string munging */ 116 #define D_MEM 0x0040 /* Trace memory allocations */ 117 118 /* 119 * Normally, don't enter daemon mode, and don't register amq 120 */ 121 #define D_TEST (~(D_DAEMON|D_MEM|D_STR)) 122 #endif /* DEBUG */ 123 124 /* 125 * Global variables. 126 */ 127 extern unsigned short nfs_port; /* Our NFS service port */ 128 extern struct in_addr myipaddr; /* (An) IP address of this host */ 129 130 extern int foreground; /* Foreground process */ 131 extern time_t next_softclock; /* Time to call softclock() */ 132 extern int task_notify_todo; /* Task notifier needs running */ 133 #ifdef HAS_TFS 134 extern int nfs_server_code_available; 135 #endif /* HAS_TFS */ 136 extern int last_used_map; /* Last map being used for mounts */ 137 extern AUTH *nfs_auth; /* Dummy uthorisation for remote servers */ 138 extern am_node **exported_ap; /* List of nodes */ 139 extern int first_free_map; /* First free node */ 140 extern am_node *root_node; /* Node for "root" */ 141 extern char *wire; /* Name of primary connected network */ 142 #define NEXP_AP (254) 143 #define NEXP_AP_MARGIN (128) 144 145 typedef int (*task_fun)P((voidp)); 146 typedef void (*cb_fun)P((int, int, voidp)); 147 typedef void (*fwd_fun)P((voidp, int, struct sockaddr_in *, 148 struct sockaddr_in *, voidp, int)); 149 150 /* 151 * String comparison macros 152 */ 153 #define STREQ(s1, s2) (strcmp((s1), (s2)) == 0) 154 #define FSTREQ(s1, s2) ((*(s1) == *(s2)) && STREQ((s1),(s2))) 155 156 /* 157 * Linked list 158 */ 159 typedef struct qelem qelem; 160 struct qelem { 161 qelem *q_forw; 162 qelem *q_back; 163 }; 164 #define FIRST(ty, q) ((ty *) ((q)->q_forw)) 165 #define LAST(ty, q) ((ty *) ((q)->q_back)) 166 #define NEXT(ty, q) ((ty *) (((qelem *) q)->q_forw)) 167 #define PREV(ty, q) ((ty *) (((qelem *) q)->q_back)) 168 #define HEAD(ty, q) ((ty *) q) 169 #define ITER(v, ty, q) \ 170 for ((v) = FIRST(ty,(q)); (v) != HEAD(ty,(q)); (v) = NEXT(ty,(v))) 171 172 /* 173 * List of mount table entries 174 */ 175 typedef struct mntlist mntlist; 176 struct mntlist { 177 struct mntlist *mnext; 178 struct mntent *mnt; 179 }; 180 181 /* 182 * Mount map 183 */ 184 typedef struct mnt_map mnt_map; 185 186 /* 187 * Global routines 188 */ 189 extern int atoi P((Const char *)); /* C */ 190 extern void am_mounted P((am_node*)); 191 extern void am_unmounted P((am_node*)); 192 extern int background(P_void); 193 extern int bind_resv_port P((int, unsigned short*)); 194 extern int compute_mount_flags P((struct mntent *)); 195 extern int softclock(P_void); 196 #ifdef DEBUG 197 extern int debug_option P((char*)); 198 #endif /* DEBUG */ 199 extern void deslashify P((char*)); 200 /*extern void domain_strip P((char*, char*));*/ 201 extern mntfs* dup_mntfs P((mntfs*)); 202 extern fserver* dup_srvr P((fserver*)); 203 extern int eval_fs_opts P((am_opts*, char*, char*, char*, char*, char*)); 204 extern char* expand_key P((char*)); 205 extern am_node* exported_ap_alloc(P_void); 206 extern am_node* find_ap P((char*)); 207 extern am_node* find_mf P((mntfs*)); 208 extern mntfs* find_mntfs P((am_ops*, am_opts*, char*, char*, char*, char*)); 209 extern void flush_mntfs(P_void); 210 extern void flush_nfs_fhandle_cache P((fserver*)); 211 extern void forcibly_timeout_mp P((am_node*)); 212 extern FREE_RETURN_TYPE free P((voidp)); /* C */ 213 extern void free_mntfs P((mntfs*)); 214 extern void free_opts P((am_opts*)); 215 extern void free_map P((am_node*)); 216 extern void free_mntlist P((mntlist*)); 217 extern void free_srvr P((fserver*)); 218 extern int fwd_init(P_void); 219 extern int fwd_packet P((int, voidp, int, struct sockaddr_in *, 220 struct sockaddr_in *, voidp, fwd_fun)); 221 extern void fwd_reply(P_void); 222 extern void get_args P((int, char*[])); 223 extern char *getwire P((void)); 224 #ifdef NEED_MNTOPT_PARSER 225 extern char *hasmntopt P((struct mntent*, char*)); 226 #endif /* NEED_MNTOPT_PARSER */ 227 extern int hasmntval P((struct mntent*, char*)); 228 extern void host_normalize P((char **)); 229 extern char *inet_dquad P((char*, unsigned long)); 230 extern void init_map P((am_node*, char*)); 231 extern void insert_am P((am_node*, am_node*)); 232 extern void ins_que P((qelem*, qelem*)); 233 extern int make_nfs_auth P((void)); 234 extern void make_root_node(P_void); 235 extern int make_rpc_packet P((char*, int, u_long, struct rpc_msg*, voidp, xdrproc_t, AUTH*)); 236 extern void map_flush_srvr P((fserver*)); 237 extern void mapc_add_kv P((mnt_map*, char*, char*)); 238 extern mnt_map* mapc_find P((char*, char*)); 239 extern void mapc_free P((mnt_map*)); 240 extern int mapc_keyiter P((mnt_map*, void (*)(char*,voidp), voidp)); 241 extern int mapc_search P((mnt_map*, char*, char**)); 242 extern void mapc_reload(P_void); 243 extern void mapc_showtypes P((FILE*)); 244 extern int mkdirs P((char*, int)); 245 extern void mk_fattr P((am_node*, enum ftype)); 246 extern void mnt_free P((struct mntent*)); 247 extern int mount_auto_node P((char*, voidp)); 248 extern int mount_automounter P((int)); 249 extern int mount_exported(P_void); 250 extern int mount_fs P((struct mntent*, int, caddr_t, int, MTYPE_TYPE)); 251 extern int mount_node P((am_node*)); 252 extern mntfs* new_mntfs(P_void); 253 extern void new_ttl P((am_node*)); 254 extern am_node* next_map P((int*)); 255 extern int nfs_srvr_port P((fserver*, u_short*, voidp)); 256 extern void normalize_slash P((char*)); 257 extern void ops_showfstypes P((FILE*)); 258 extern int pickup_rpc_reply P((voidp, int, voidp, xdrproc_t)); 259 extern mntlist* read_mtab P((char*)); 260 extern mntfs* realloc_mntfs P((mntfs*, am_ops*, am_opts*, char*, char*, char*, char*)); 261 extern void rem_que P((qelem*)); 262 extern void reschedule_timeout_mp(P_void); 263 extern void restart(P_void); 264 #ifdef UPDATE_MTAB 265 extern void rewrite_mtab P((mntlist *)); 266 #endif /* UPDATE_MTAB */ 267 extern void rmdirs P((char*)); 268 extern am_node* root_ap P((char*, int)); 269 extern int root_keyiter P((void (*)(char*,voidp), voidp)); 270 extern void root_newmap P((char*, char*, char*)); 271 extern void rpc_msg_init P((struct rpc_msg*, u_long, u_long, u_long)); 272 extern void run_task P((task_fun, voidp, cb_fun, voidp)); 273 extern void sched_task P((cb_fun, voidp, voidp)); 274 extern void show_rcs_info P((Const char*, char*)); 275 extern void sigchld P((int)); 276 extern void srvrlog P((fserver*, char*)); 277 extern char* str3cat P((char*, char*, char*, char*)); 278 extern char* strcat P((char*, Const char*)); /* C */ 279 extern int strcmp P((Const char*, Const char*)); /* C */ 280 extern char* strdup P((Const char*)); 281 extern int strlen P((Const char*)); /* C */ 282 extern char* strnsave P((Const char*, int)); 283 extern char* strrchr P((Const char*, int)); /* C */ 284 extern char* strealloc P((char*, char *)); 285 extern char** strsplit P((char*, int, int)); 286 extern int switch_option P((char*)); 287 extern int switch_to_logfile P((char*)); 288 extern void do_task_notify(P_void); 289 extern int timeout P((unsigned int, void (*fn)(), voidp)); 290 extern void timeout_mp(P_void); 291 extern void umount_exported(P_void); 292 extern int umount_fs P((char*)); 293 /*extern int unmount_node P((am_node*)); 294 extern int unmount_node_wrap P((voidp));*/ 295 extern void unregister_amq(P_void); 296 extern void untimeout P((int)); 297 extern int valid_key P((char*)); 298 extern void wakeup P((voidp)); 299 extern void wakeup_task P((int,int,voidp)); 300 extern void wakeup_srvr P((fserver*)); 301 extern void write_mntent P((struct mntent*)); 302 #ifdef UPDATE_MTAB 303 extern void unlock_mntlist P((void)); 304 #else 305 #define unlock_mntlist() 306 #endif /* UPDATE_MTAB */ 307 308 309 #define ALLOC(ty) ((struct ty *) xmalloc(sizeof(struct ty))) 310 311 /* 312 * Options 313 */ 314 struct am_opts { 315 char *fs_glob; /* Smashed copy of global options */ 316 char *fs_local; /* Expanded copy of local options */ 317 char *fs_mtab; /* Mount table entry */ 318 /* Other options ... */ 319 char *opt_dev; 320 char *opt_delay; 321 char *opt_dir; 322 char *opt_fs; 323 char *opt_group; 324 char *opt_mount; 325 char *opt_opts; 326 char *opt_pref; 327 char *opt_cache; 328 char *opt_rfs; 329 char *opt_rhost; 330 char *opt_sublink; 331 char *opt_type; 332 char *opt_unmount; 333 char *opt_user; 334 }; 335 336 /* 337 * File Handle 338 * 339 * This is interpreted by indexing the exported array 340 * by fhh_id. 341 * 342 * The whole structure is mapped onto a standard fhandle_t 343 * when transmitted. 344 */ 345 struct am_fh { 346 int fhh_pid; /* process id */ 347 int fhh_id; /* map id */ 348 int fhh_gen; /* generation number */ 349 }; 350 351 extern am_node *fh_to_mp P((nfs_fh*)); 352 extern am_node *fh_to_mp3 P((nfs_fh*,int*,int)); 353 extern void mp_to_fh P((am_node*, nfs_fh*)); 354 #define fh_to_mp2(fhp, rp) fh_to_mp3(fhp, rp, VLOOK_CREATE) 355 extern int auto_fmount P((am_node *mp)); 356 extern int auto_fumount P((am_node *mp)); 357 358 #define MAX_READDIR_ENTRIES 16 359 360 typedef char* (*vfs_match)P((am_opts*)); 361 typedef int (*vfs_init)P((mntfs*)); 362 typedef int (*vmount_fs)P((am_node*)); 363 typedef int (*vfmount_fs)P((mntfs*)); 364 typedef int (*vumount_fs)P((am_node*)); 365 typedef int (*vfumount_fs)P((mntfs*)); 366 typedef am_node*(*vlookuppn)P((am_node*, char*, int*, int)); 367 typedef int (*vreaddir)P((am_node*, nfscookie, dirlist*, entry*, int)); 368 typedef am_node*(*vreadlink)P((am_node*, int*)); 369 typedef void (*vmounted)P((mntfs*)); 370 typedef void (*vumounted)P((am_node*)); 371 typedef fserver*(*vffserver)P((mntfs*)); 372 373 struct am_ops { 374 char *fs_type; 375 vfs_match fs_match; 376 vfs_init fs_init; 377 vmount_fs mount_fs; 378 vfmount_fs fmount_fs; 379 vumount_fs umount_fs; 380 vfumount_fs fumount_fs; 381 vlookuppn lookuppn; 382 vreaddir readdir; 383 vreadlink readlink; 384 vmounted mounted; 385 vumounted umounted; 386 vffserver ffserver; 387 int fs_flags; 388 }; 389 extern am_node *efs_lookuppn P((am_node*, char*, int*, int)); 390 extern int efs_readdir P((am_node*, nfscookie, dirlist*, entry*, int)); 391 392 #define VLOOK_CREATE 0x1 393 #define VLOOK_DELETE 0x2 394 395 #define FS_DIRECTORY 0x0001 /* This looks like a dir, not a link */ 396 #define FS_MBACKGROUND 0x0002 /* Should background this mount */ 397 #define FS_NOTIMEOUT 0x0004 /* Don't bother with timeouts */ 398 #define FS_MKMNT 0x0008 /* Need to make the mount point */ 399 #define FS_UBACKGROUND 0x0010 /* Unmount in background */ 400 #define FS_BACKGROUND (FS_MBACKGROUND|FS_UBACKGROUND) 401 #define FS_DISCARD 0x0020 /* Discard immediately on last reference */ 402 #define FS_AMQINFO 0x0040 /* Amq is interested in this fs type */ 403 404 #ifdef SUNOS4_COMPAT 405 extern am_ops *sunos4_match P((am_opts*, char*, char*, char*, char*, char*)); 406 #endif /* SUNOS4_COMPAT */ 407 extern am_ops *ops_match P((am_opts*, char*, char*, char*, char*, char*)); 408 #include "fstype.h" 409 410 /* 411 * Per-mountpoint statistics 412 */ 413 struct am_stats { 414 time_t s_mtime; /* Mount time */ 415 u_short s_uid; /* Uid of mounter */ 416 int s_getattr; /* Count of getattrs */ 417 int s_lookup; /* Count of lookups */ 418 int s_readdir; /* Count of readdirs */ 419 int s_readlink; /* Count of readlinks */ 420 int s_statfs; /* Count of statfs */ 421 }; 422 typedef struct am_stats am_stats; 423 424 /* 425 * System statistics 426 */ 427 struct amd_stats { 428 int d_drops; /* Dropped requests */ 429 int d_stale; /* Stale NFS handles */ 430 int d_mok; /* Succesful mounts */ 431 int d_merr; /* Failed mounts */ 432 int d_uerr; /* Failed unmounts */ 433 }; 434 extern struct amd_stats amd_stats; 435 436 /* 437 * List of fileservers 438 */ 439 struct fserver { 440 qelem fs_q; /* List of fileservers */ 441 int fs_refc; /* Number of references to this node */ 442 char *fs_host; /* Normalized hostname of server */ 443 struct sockaddr_in *fs_ip; /* Network address of server */ 444 int fs_cid; /* Callout id */ 445 int fs_pinger; /* Ping (keepalive) interval */ 446 int fs_flags; /* Flags */ 447 char *fs_type; /* File server type */ 448 voidp fs_private; /* Private data */ 449 void (*fs_prfree)(); /* Free private data */ 450 }; 451 #define FSF_VALID 0x0001 /* Valid information available */ 452 #define FSF_DOWN 0x0002 /* This fileserver is thought to be down */ 453 #define FSF_ERROR 0x0004 /* Permanent error has occured */ 454 #define FSF_WANT 0x0008 /* Want a wakeup call */ 455 #define FSF_PINGING 0x0010 /* Already doing pings */ 456 #define FSRV_ISDOWN(fs) (((fs)->fs_flags & (FSF_DOWN|FSF_VALID)) == (FSF_DOWN|FSF_VALID)) 457 #define FSRV_ISUP(fs) (((fs)->fs_flags & (FSF_DOWN|FSF_VALID)) == (FSF_VALID)) 458 459 /* 460 * List of mounted filesystems 461 */ 462 struct mntfs { 463 qelem mf_q; /* List of mounted filesystems */ 464 am_ops *mf_ops; /* Operations on this mountpoint */ 465 am_opts *mf_fo; /* File opts */ 466 char *mf_mount; /* "/a/kiska/home/kiska" */ 467 char *mf_info; /* Mount info */ 468 char *mf_auto; /* Automount opts */ 469 char *mf_mopts; /* FS mount opts */ 470 fserver *mf_server; /* File server */ 471 int mf_flags; /* Flags */ 472 int mf_error; /* Error code from background mount */ 473 int mf_refc; /* Number of references to this node */ 474 int mf_cid; /* Callout id */ 475 void (*mf_prfree)(); /* Free private space */ 476 voidp mf_private; /* Private - per-fs data */ 477 }; 478 479 #define MFF_MOUNTED 0x0001 /* Node is mounted */ 480 #define MFF_MOUNTING 0x0002 /* Mount is in progress */ 481 #define MFF_UNMOUNTING 0x0004 /* Unmount is in progress */ 482 #define MFF_RESTART 0x0008 /* Restarted node */ 483 #define MFF_MKMNT 0x0010 /* Delete this node's am_mount */ 484 #define MFF_ERROR 0x0020 /* This node failed to mount */ 485 #define MFF_LOGDOWN 0x0040 /* Logged that this mount is down */ 486 #define MFF_RSTKEEP 0x0080 /* Don't timeout this filesystem - restarted */ 487 #define MFF_WANTTIMO 0x0100 /* Need a timeout call when not busy */ 488 489 /* 490 * Map of auto-mount points. 491 */ 492 struct am_node { 493 int am_mapno; /* Map number */ 494 mntfs *am_mnt; /* Mounted filesystem */ 495 char *am_name; /* "kiska" 496 Name of this node */ 497 char *am_path; /* "/home/kiska" 498 Path of this node's mount point */ 499 char *am_link; /* "/a/kiska/home/kiska/this/that" 500 Link to sub-directory */ 501 am_node *am_parent, /* Parent of this node */ 502 *am_ysib, /* Younger sibling of this node */ 503 *am_osib, /* Older sibling of this node */ 504 *am_child; /* First child of this node */ 505 struct attrstat am_attr; /* File attributes */ 506 #define am_fattr am_attr.attrstat_u.attributes 507 int am_flags; /* Boolean flags */ 508 int am_error; /* Specific mount error */ 509 time_t am_ttl; /* Time to live */ 510 int am_timeo_w; /* Wait interval */ 511 int am_timeo; /* Timeout interval */ 512 unsigned int am_gen; /* Generation number */ 513 char *am_pref; /* Mount info prefix */ 514 am_stats am_stats; /* Statistics gathering */ 515 }; 516 517 #define AMF_NOTIMEOUT 0x0001 /* This node never times out */ 518 #define AMF_ROOT 0x0002 /* This is a root node */ 519 520 #define ONE_HOUR (60 * 60) /* One hour in seconds */ 521 522 /* 523 * The following values can be tuned... 524 */ 525 #define ALLOWED_MOUNT_TIME 40 /* 40s for a mount */ 526 #define AM_TTL (5 * 60) /* Default cache period */ 527 #define AM_TTL_W (2 * 60) /* Default unmount interval */ 528 #define AM_PINGER 30 /* NFS ping interval for live systems */ 529 #define AFS_TIMEO 8 /* Default afs timeout - .8s */ 530 #define AFS_RETRANS ((ALLOWED_MOUNT_TIME*10+5*afs_timeo)/afs_timeo * 2) 531 /* Default afs retrans - 1/10th seconds */ 532 533 #define RPC_XID_PORTMAP 0 534 #define RPC_XID_MOUNTD 1 535 #define RPC_XID_NFSPING 2 536 #define RPC_XID_MASK (0x0f) /* 16 id's for now */ 537 #define MK_RPC_XID(type_id, uniq) ((type_id) | ((uniq) << 4)) 538