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