2 * Copyright 2000, International Business Machines Corporation and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
11 * afs_init.c - initialize AFS client.
16 #include <afsconfig.h>
17 #include "afs/param.h"
23 #include "afs/sysincludes.h" /* Standard vendor system headers */
24 #include "afsincludes.h" /* Afs-based standard headers */
25 #include "afs/afs_stats.h" /* afs statistics */
27 /* Exported variables */
28 struct osi_dev cacheDev; /*Cache device */
29 afs_int32 cacheInfoModTime; /*Last time cache info modified */
30 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
31 struct mount *afs_cacheVfsp = 0;
32 #elif defined(AFS_LINUX20_ENV)
33 struct super_block *afs_cacheSBp = 0;
35 struct vfs *afs_cacheVfsp = 0;
37 afs_rwlock_t afs_puttofileLock; /* not used */
38 char *afs_sysname = 0; /* So that superuser may change the
39 * local value of @sys */
40 char *afs_sysnamelist[MAXNUMSYSNAMES]; /* For support of a list of sysname */
41 int afs_sysnamecount = 0;
42 struct volume *Initialafs_freeVolList;
43 int afs_memvolumes = 0;
44 #if defined(AFS_XBSD_ENV)
45 static struct vnode *volumeVnode;
49 * Initialization order is important. Must first call afs_CacheInit,
50 * then cache file and volume file initialization routines. Next, the
51 * individual cache entry initialization routines are called.
61 * astatSize : The number of stat cache (vnode) entries to
63 * afiles : The number of disk files to allocate to the cache
64 * ablocks : The max number of 1 Kbyte blocks that all of
65 * the files in the cache may occupy.
66 * aDentries : Number of dcache entries to allocate.
67 * aVolumes : Number of volume cache entries to allocate.
68 * achunk : Power of 2 to make the chunks.
69 * aflags : Flags passed in.
70 * inodes : max inodes to pin down in inode[]
71 * users : what should size of per-user access cache be?
74 * This routine should only be called at initialization time, since
75 * it reclaims no resources and doesn't sufficiently synchronize
76 * with other processes.
79 struct cm_initparams cm_initParams;
80 static int afs_cacheinit_flag = 0;
82 afs_CacheInit(afs_int32 astatSize, afs_int32 afiles, afs_int32 ablocks,
83 afs_int32 aDentries, afs_int32 aVolumes, afs_int32 achunk,
84 afs_int32 aflags, afs_int32 ninodes, afs_int32 nusers)
87 register struct volume *tv;
89 AFS_STATCNT(afs_CacheInit);
91 * Jot down the epoch time, namely when this incarnation of the
92 * Cache Manager started.
94 afs_stats_cmperf.epoch = pag_epoch = osi_Time();
96 afs_stats_cmperf.sysName_ID = SYS_NAME_ID;
98 afs_stats_cmperf.sysName_ID = SYS_NAME_ID_UNDEFINED;
99 #endif /* SYS_NAME_ID */
101 printf("Starting AFS cache scan...");
102 if (afs_cacheinit_flag)
104 afs_cacheinit_flag = 1;
105 cacheInfoModTime = 0;
110 LOCK_INIT(&afs_ftf, "afs_ftf");
111 RWLOCK_INIT(&afs_xaxs, "afs_xaxs");
115 #if defined(AFS_AIX32_ENV) || defined(AFS_HPUX_ENV)
120 * We want to also reserve space for the gnode struct which is associated
121 * with each vnode (vcache) one; we want to use the pinned pool for them
122 * since they're referenced at interrupt level.
124 if (afs_stats_cmperf.SmallBlocksAlloced + astatSize < 3600)
125 preallocs = astatSize;
127 preallocs = 3600 - afs_stats_cmperf.SmallBlocksAlloced;
131 osi_AllocMoreSSpace(preallocs);
135 * create volume list structure
139 else if (aVolumes > 3000)
142 tv = (struct volume *)afs_osi_Alloc(aVolumes * sizeof(struct volume));
143 for (i = 0; i < aVolumes - 1; i++)
144 tv[i].next = &tv[i + 1];
145 tv[aVolumes - 1].next = NULL;
146 afs_freeVolList = Initialafs_freeVolList = tv;
147 afs_memvolumes = aVolumes;
149 afs_cacheFiles = afiles;
150 afs_cacheStats = astatSize;
151 afs_vcacheInit(astatSize);
152 afs_dcacheInit(afiles, ablocks, aDentries, achunk, aflags);
153 #ifdef AFS_64BIT_CLIENT
154 #ifdef AFS_VM_RDWR_ENV
155 afs_vmMappingEnd = AFS_CHUNKBASE(0x7fffffff);
156 #endif /* AFS_VM_RDWR_ENV */
157 #endif /* AFS_64BIT_CLIENT */
159 #if defined(AFS_AIX_ENV) && !defined(AFS_AIX51_ENV)
161 static void afs_procsize_init(void);
167 /* Save the initialization parameters for later pioctl queries. */
168 cm_initParams.cmi_version = CMI_VERSION;
169 cm_initParams.cmi_nChunkFiles = afiles;
170 cm_initParams.cmi_nStatCaches = astatSize;
171 cm_initParams.cmi_nDataCaches = aDentries;
172 cm_initParams.cmi_nVolumeCaches = aVolumes;
173 cm_initParams.cmi_firstChunkSize = AFS_FIRSTCSIZE;
174 cm_initParams.cmi_otherChunkSize = AFS_OTHERCSIZE;
175 cm_initParams.cmi_cacheSize = afs_cacheBlocks;
176 cm_initParams.cmi_setTime = afs_setTime;
177 cm_initParams.cmi_memCache = (aflags & AFSCALL_INIT_MEMCACHE) ? 1 : 0;
185 * afs_ComputeCacheParams
188 * Set some cache parameters.
195 afs_ComputeCacheParms(void)
197 register afs_int32 i;
198 afs_int32 afs_maxCacheDirty;
201 * Don't allow more than 2/3 of the files in the cache to be dirty.
203 afs_maxCacheDirty = (2 * afs_cacheFiles) / 3;
206 * Also, don't allow more than 2/3 of the total space get filled
207 * with dirty chunks. Compute the total number of chunks required
208 * to fill the cache, make sure we don't set out limit above 2/3 of
209 * that. If the cache size is greater than 1G, avoid overflow at
210 * the expense of precision on the chunk size.
212 if (afs_cacheBlocks & 0xffe00000) {
213 i = afs_cacheBlocks / (AFS_FIRSTCSIZE >> 10);
215 i = (afs_cacheBlocks << 10) / AFS_FIRSTCSIZE;
218 if (afs_maxCacheDirty > i)
219 afs_maxCacheDirty = i;
220 if (afs_maxCacheDirty < 1)
221 afs_maxCacheDirty = 1;
222 afs_stats_cmperf.cacheMaxDirtyChunks = afs_maxCacheDirty;
223 } /*afs_ComputeCacheParms */
229 * Look up inode given a file name.
230 * Optionally return the vnode too.
231 * If the vnode is not returned, we rele it.
234 LookupInodeByPath(char *filename, ino_t * inode, struct vnode **fvpp)
238 #ifdef AFS_LINUX22_ENV
240 code = gop_lookupname(filename, AFS_UIOSYS, 0, &dp);
243 *inode = dp->d_inode->i_ino;
246 struct vnode *filevp;
247 code = gop_lookupname(filename, AFS_UIOSYS, 0, &filevp);
250 *inode = afs_vnodeToInumber(filevp);
256 #endif /* AFS_LINUX22_ENV */
262 afs_InitCellInfo(char *afile)
267 code = LookupInodeByPath(afile, &inode, NULL);
268 return afs_cellname_init(inode, code);
275 * Set up the volume info storage file.
278 * afile : the file to be declared to be the volume info storage
279 * file for AFS. It must be already truncated to 0 length.
282 * This function is called only during initialization.
284 * WARNING: Data will be written to this file over time by AFS.
288 afs_InitVolumeInfo(char *afile)
291 struct osi_file *tfile;
293 AFS_STATCNT(afs_InitVolumeInfo);
294 #if defined(AFS_XBSD_ENV)
296 * On Open/Free/NetBSD, we can get into big trouble if we don't hold the volume file
297 * vnode. SetupVolume holds afs_xvolume lock exclusive.
298 * SetupVolume->GetVolSlot->UFSGetVolSlot->{GetVolCache or WriteVolCache}
299 * ->osi_UFSOpen->VFS_VGET()->ffs_vget->getnewvnode->vgone on some vnode.
300 * If it's AFS, then ->vclean->afs_nbsd_reclaim->FlushVCache->QueueVCB->
301 * GetVolume->FindVolume-> waits on afs_xvolume lock !
303 * In general, anything that's called with afs_xvolume locked must not
304 * end up calling getnewvnode(). The only cases I've found so far
305 * are things which try to get the volumeInode, and since we keep
308 code = LookupInodeByPath(afile, &volumeInode, &volumeVnode);
310 code = LookupInodeByPath(afile, &volumeInode, NULL);
314 tfile = afs_CFileOpen(volumeInode);
315 afs_CFileTruncate(tfile, 0);
316 afs_CFileClose(tfile);
324 * Set up the given file as the AFS cache info file.
327 * afile : Name of the file assumed to be the cache info file
328 * for the Cache Manager; it will be used as such.
329 * Side Effects: This sets afs_fragsize, which is used in the cache usage
330 * calculations such as in afs_adjustsize()
333 * This function is called only during initialization. The given
334 * file should NOT be truncated to 0 lenght; its contents descrebe
335 * what data is really in the cache.
337 * WARNING: data will be written to this file over time by AFS.
339 * NOTE: Starting to use separate osi_InitCacheInfo() routines to clean up
344 afs_InitCacheInfo(register char *afile)
346 register afs_int32 code;
347 struct osi_stat tstat;
348 register struct osi_file *tfile;
349 struct afs_fheader theader;
350 #ifndef AFS_LINUX22_ENV
351 struct vnode *filevp;
355 AFS_STATCNT(afs_InitCacheInfo);
356 if (cacheDiskType != AFS_FCACHE_TYPE_UFS)
357 osi_Panic("afs_InitCacheInfo --- called for non-ufs cache!");
358 #ifdef AFS_LINUX22_ENV
359 code = osi_InitCacheInfo(afile);
363 code = gop_lookupname(afile, AFS_UIOSYS, 0, &filevp);
367 #if defined(AFS_SUN56_ENV)
369 #elif defined(AFS_HPUX102_ENV)
371 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV) ||defined(AFS_HPUX100_ENV)
373 #elif defined(AFS_DUX40_ENV)
379 #if defined(AFS_SGI_ENV)
381 VFS_STATVFS(filevp->v_vfsp, &st, NULL, code);
384 if (!VFS_STATFS(filevp->v_vfsp, &st, NULL))
385 #endif /* AFS_SGI65_ENV */
386 #elif defined(AFS_SUN5_ENV) || defined(AFS_HPUX100_ENV)
387 if (!VFS_STATVFS(filevp->v_vfsp, &st))
388 #elif defined(AFS_OSF_ENV)
390 VFS_STATFS(filevp->v_vfsp, code);
392 st = filevp->v_vfsp->m_stat;
394 #elif defined(AFS_AIX41_ENV)
395 if (!VFS_STATFS(filevp->v_vfsp, &st, &afs_osi_cred))
396 #elif defined(AFS_LINUX20_ENV)
401 VFS_STATFS(filevp->v_vfsp, &st);
404 #elif defined(AFS_DARWIN_ENV)
405 if (!VFS_STATFS(filevp->v_mount, &st, current_proc()))
406 #elif defined(AFS_FBSD50_ENV)
407 if (!VFS_STATFS(filevp->v_mount, &st, curthread))
408 #elif defined(AFS_XBSD_ENV)
409 if (!VFS_STATFS(filevp->v_mount, &st, curproc))
411 if (!VFS_STATFS(filevp->v_vfsp, &st))
413 #if defined(AFS_SUN5_ENV) || defined(AFS_HPUX100_ENV)
414 afs_fsfragsize = st.f_frsize - 1;
416 afs_fsfragsize = st.f_bsize - 1;
419 #if defined(AFS_LINUX20_ENV)
420 cacheInode = filevp->i_ino;
421 afs_cacheSBp = filevp->i_sb;
422 #elif defined(AFS_XBSD_ENV)
423 cacheInode = VTOI(filevp)->i_number;
424 cacheDev.mp = filevp->v_mount;
425 cacheDev.held_vnode = filevp;
426 vref(filevp); /* Make sure mount point stays busy. XXX */
427 #if !defined(AFS_OBSD_ENV)
428 afs_cacheVfsp = filevp->v_vfsp;
431 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
432 afs_InitDualFSCacheOps(filevp);
434 cacheInode = afs_vnodeToInumber(filevp);
435 cacheDev.dev = afs_vnodeToDev(filevp);
436 afs_cacheVfsp = filevp->v_vfsp;
437 #endif /* AFS_LINUX20_ENV */
439 #endif /* AFS_LINUX22_ENV */
440 tfile = osi_UFSOpen(cacheInode);
441 afs_osi_Stat(tfile, &tstat);
442 cacheInfoModTime = tstat.mtime;
443 code = afs_osi_Read(tfile, -1, &theader, sizeof(theader));
445 if (code == sizeof(theader)) {
446 /* read the header correctly */
447 if (theader.magic == AFS_FHMAGIC
448 && theader.firstCSize == AFS_FIRSTCSIZE
449 && theader.otherCSize == AFS_OTHERCSIZE
450 && theader.version == AFS_CI_VERSION)
454 /* write out a good file label */
455 theader.magic = AFS_FHMAGIC;
456 theader.firstCSize = AFS_FIRSTCSIZE;
457 theader.otherCSize = AFS_OTHERCSIZE;
458 theader.version = AFS_CI_VERSION;
459 afs_osi_Write(tfile, 0, &theader, sizeof(theader));
461 * Truncate the rest of the file, since it may be arbitrarily
464 osi_UFSTruncate(tfile, sizeof(struct afs_fheader));
466 /* Leave the file open now, since reopening the file makes public pool
467 * vnode systems (like OSF/Alpha) much harder to handle, That's because
468 * they can do a vnode recycle operation any time we open a file, which
469 * we'd do on any afs_GetDSlot call, etc.
471 afs_cacheInodep = (struct osi_file *)tfile;
475 int afs_resourceinit_flag = 0;
477 afs_ResourceInit(int preallocs)
479 register afs_int32 i;
480 static struct rx_securityClass *secobj;
482 AFS_STATCNT(afs_ResourceInit);
483 RWLOCK_INIT(&afs_xuser, "afs_xuser");
484 RWLOCK_INIT(&afs_xvolume, "afs_xvolume");
485 RWLOCK_INIT(&afs_xserver, "afs_xserver");
486 RWLOCK_INIT(&afs_xsrvAddr, "afs_xsrvAddr");
487 RWLOCK_INIT(&afs_icl_lock, "afs_icl_lock");
488 RWLOCK_INIT(&afs_xinterface, "afs_xinterface");
489 LOCK_INIT(&afs_puttofileLock, "afs_puttofileLock");
491 #ifndef AFS_AIX32_ENV
492 LOCK_INIT(&osi_fsplock, "osi_fsplock");
494 LOCK_INIT(&osi_flplock, "osi_flplock");
496 RWLOCK_INIT(&afs_xconn, "afs_xconn");
499 afs_InitCBQueue(1); /* initialize callback queues */
501 if (afs_resourceinit_flag == 0) {
502 afs_resourceinit_flag = 1;
503 for (i = 0; i < NFENTRIES; i++)
505 for (i = 0; i < MAXNUMSYSNAMES; i++)
506 afs_sysnamelist[i] = afs_osi_Alloc(MAXSYSNAME);
507 afs_sysname = afs_sysnamelist[0];
508 strcpy(afs_sysname, SYS_NAME);
509 afs_sysnamecount = 1;
510 #if defined(AFS_AIX32_ENV) || defined(AFS_HPUX_ENV)
513 if ((preallocs > 256) && (preallocs < 3600))
514 afs_preallocs = preallocs;
515 osi_AllocMoreSSpace(afs_preallocs);
516 osi_AllocMoreMSpace(100);
521 secobj = rxnull_NewServerSecurityObject();
523 rx_NewService(0, 1, "afs", &secobj, 1, RXAFSCB_ExecuteRequest);
525 rx_NewService(0, RX_STATS_SERVICE_ID, "rpcstats", &secobj, 1,
526 RXSTATS_ExecuteRequest);
528 afs_osi_Wakeup(&afs_server); /* wakeup anyone waiting for it */
531 } /*afs_ResourceInit */
533 #if defined(AFS_AIX_ENV) && !defined(AFS_AIX51_ENV)
536 * AIX dynamic sizeof(struct proc)
538 * AIX keeps its proc structures in an array. The size of struct proc
539 * varies from release to release of the OS. In order to maintain
540 * binary compatibility with releases later than what we build on, we
541 * need to determine the size of struct proc at run time.
543 * We need this in order to walk the proc[] array to do PAG garbage
546 * We also need this in order to support 'klog -setpag', since the
547 * kernel code needs to locate the proc structure for the parent process
548 * of the current process.
550 * To compute sizeof(struct proc), we need the addresses of two proc
551 * structures and their corresponding pids. Given the pids, we can use
552 * the PROCMASK() macro to compute their corresponding indices in the
553 * proc[] array. By dividing the distance between the pointers by the
554 * number of proc structures, we can compute the size of a single proc
557 * We know the base address of the proc table from v.vb_proc:
559 * <sys/sysconfig.h> declares sysconfig() and SYS_GETPARMS;
560 * (we don't use this, but I note it here for completeness)
562 * <sys/var.h> declares struct var and external variable v;
566 * v.ve_proc &proc[x] (current highwater mark for
567 * proc[] array usage)
569 * The first proc pointer is v.vb_proc, which is the proc structure for
570 * process 0. Process 0's pointer to its first child is the other proc
571 * pointer. If process 0 has no children, we simply give up and do not
572 * support features that require knowing the size of struct proc.
576 afs_procsize_init(void)
578 struct proc *p0; /* pointer to process 0 */
579 struct proc *pN; /* pointer to process 0's first child */
587 p0 = (struct proc *)v.vb_proc;
589 afs_gcpags = AFS_GCPAGS_EPROC0;
593 pN = (struct proc *)0;
604 afs_gcpags = AFS_GCPAGS_EPROCN;
608 if (pN->p_pid == p0->p_pid) {
609 afs_gcpags = AFS_GCPAGS_EEQPID;
613 pN_index = PROCMASK(pN->p_pid);
614 pN_offset = ((char *)pN - (char *)p0);
615 procsize = pN_offset / pN_index;
618 * check that the computation was exact
621 if (pN_index * procsize != pN_offset) {
622 afs_gcpags = AFS_GCPAGS_EINEXACT;
627 * check that the proc table size is a multiple of procsize.
630 if ((((char *)v.ve_proc - (char *)v.vb_proc) % procsize) != 0) {
631 afs_gcpags = AFS_GCPAGS_EPROCEND;
637 afs_gcpags_procsize = procsize;
645 * Clean up and shut down the AFS cache.
651 * Nothing interesting.
656 AFS_STATCNT(shutdown_cache);
657 afs_WriteThroughDSlots();
658 if (afs_cold_shutdown) {
659 afs_cacheinit_flag = 0;
664 afs_cacheFiles = afs_cacheBlocks = 0;
665 pag_epoch = maxIHint = nihints = usedihint = 0;
667 #if defined(AFS_XBSD_ENV)
668 vrele(volumeVnode); /* let it go, finally. */
670 if (cacheDev.held_vnode) {
671 vrele(cacheDev.held_vnode);
672 cacheDev.held_vnode = NULL;
675 cacheInode = volumeInode = (ino_t) 0;
677 cacheInfoModTime = 0;
679 afs_fsfragsize = 1023;
680 memset((char *)&afs_stats_cmperf, 0, sizeof(afs_stats_cmperf));
681 memset((char *)&cacheDev, 0, sizeof(struct osi_dev));
684 } /*shutdown_cache */
688 shutdown_vnodeops(void)
690 #if !defined(AFS_SGI_ENV) && !defined(AFS_SUN5_ENV)
691 struct buf *afs_bread_freebp = 0;
695 AFS_STATCNT(shutdown_vnodeops);
696 if (afs_cold_shutdown) {
697 #ifndef AFS_SUN5_ENV /* XXX */
700 #ifndef AFS_LINUX20_ENV
703 #if !defined(AFS_SGI_ENV) && !defined(AFS_SUN5_ENV)
704 afs_bread_freebp = 0;
715 register struct srvAddr *sa;
717 AFS_STATCNT(shutdown_AFS);
718 if (afs_cold_shutdown) {
719 afs_resourceinit_flag = 0;
721 * Free Volumes table allocations
725 for (i = 0; i < NVOLS; i++) {
726 for (tv = afs_volumes[i]; tv; tv = tv->next) {
728 afs_osi_Free(tv->name, strlen(tv->name) + 1);
737 * Free FreeVolList allocations
739 afs_osi_Free(Initialafs_freeVolList,
740 afs_memvolumes * sizeof(struct volume));
741 afs_freeVolList = Initialafs_freeVolList = 0;
743 /* XXX HACK fort MEM systems XXX
745 * For -memcache cache managers when we run out of free in memory volumes
746 * we simply malloc more; we won't be able to free those additional volumes.
752 * Free Users table allocation
755 struct unixuser *tu, *ntu;
756 for (i = 0; i < NUSERS; i++) {
757 for (tu = afs_users[i]; tu; tu = ntu) {
760 afs_osi_Free(tu->stp, tu->stLen);
762 EXP_RELE(tu->exporter);
763 afs_osi_Free(tu, sizeof(struct unixuser));
770 * Free Servers table allocation
773 struct server *ts, *nts;
774 struct conn *tc, *ntc;
775 register struct afs_cbr *tcbrp, *tbrp;
777 for (i = 0; i < NSERVERS; i++) {
778 for (ts = afs_servers[i]; ts; ts = nts) {
780 for (sa = ts->addr; sa; sa = sa->next_sa) {
783 * Free all server's connection structs
789 rx_DestroyConnection(tc->id);
791 afs_osi_Free(tc, sizeof(struct conn));
796 for (tcbrp = ts->cbrs; tcbrp; tcbrp = tbrp) {
798 * Free all server's callback structs
803 afs_osi_Free(ts, sizeof(struct server));
808 for (i = 0; i < NFENTRIES; i++)
810 /* Reinitialize local globals to defaults */
811 for (i = 0; i < MAXNUMSYSNAMES; i++)
812 afs_osi_Free(afs_sysnamelist[i], MAXSYSNAME);
814 afs_sysnamecount = 0;
816 afs_setTimeHost = NULL;
818 afs_waitForever = afs_waitForeverCount = 0;
820 afs_server = (struct rx_service *)0;
821 RWLOCK_INIT(&afs_xconn, "afs_xconn");
822 memset((char *)&afs_rootFid, 0, sizeof(struct VenusFid));
823 RWLOCK_INIT(&afs_xuser, "afs_xuser");
824 RWLOCK_INIT(&afs_xvolume, "afs_xvolume");
825 RWLOCK_INIT(&afs_xserver, "afs_xserver");
826 LOCK_INIT(&afs_puttofileLock, "afs_puttofileLock");