a7429de2032ded709cd327237cc4516a75a8fe63
[openafs.git] / doc / man-pages / pod8 / fileserver.pod
1 =head1 NAME
2
3 fileserver - Initializes the File Server component of the fs process
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fileserver> S<<< [B<-auditlog> <I<path to log file>>] >>>
11     S<<< [B<-d> <I<debug level>>] >>>
12     S<<< [B<-p> <I<number of processes>>] >>>
13     S<<< [B<-spare> <I<number of spare blocks>>] >>>
14     S<<< [B<-pctspare> <I<percentage spare>>] >>>
15     S<<< [B<-b> <I<buffers>>] >>>
16     S<<< [B<-l> <I<large vnodes>>] >>>
17     S<<< [B<-s> <I<small vnodes>>] >>>
18     S<<< [B<-vc> <I<volume cachesize>>] >>>
19     S<<< [B<-w> <I<call back wait interval>>] >>>
20     S<<< [B<-cb> <I<number of call backs>>] >>>
21     S<<< [B<-banner>] >>>
22     S<<< [B<-novbc>] >>>
23     S<<< [B<-implicit> <I<admin mode bits: rlidwka>>] >>>
24     S<<< [B<-readonly>] >>>
25     S<<< [B<-hr> <I<number of hours between refreshing the host cps>>] >>>
26     S<<< [B<-busyat> <I<< redirect clients when queue > n >>>] >>>
27     S<<< [B<-nobusy>] >>>
28     S<<< [B<-rxpck> <I<number of rx extra packets>>] >>>
29     S<<< [B<-rxdbg>] >>>
30     S<<< [B<-rxdbge>] >>>
31     S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
32     S<<< [B<-nojumbo> >>>
33     S<<< [B<-jumbo> >>>
34     S<<< [B<-rxbind> >>>
35     S<<< [B<-allow-dotted-principals>] >>>
36     S<<< [B<-L>] >>>
37     S<<< [B<-S>] >>>
38     S<<< [B<-k> <I<stack size>>] >>>
39     S<<< [B<-realm> <I<Kerberos realm name>>] >>>
40     S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
41     S<<< [B<-sendsize> <I<size of send buffer in bytes>>] >>>
42     S<<< [B<-abortthreshold> <I<abort threshold>>] >>>
43     S<<< [B<-enable_peer_stats>] >>>
44     S<<< [B<-enable_process_stats>] >>>
45     S<<< [B<-syslog> [<I< loglevel >>]] >>>
46     S<<< [B<-mrafslogs>] >>>
47     S<<< [B<-saneacls>] >>>
48     S<<< [B<-help>] >>>
49     S<<< [B<-fs-state-dont-save>] >>>
50     S<<< [B<-fs-state-dont-restore>] >>>
51     S<<< [B<-fs-state-verify>] (none | save | restore | both)] >>>
52     S<<< [B<-vhashsize> <I<log(2) of number of volume hash buckets>>] >>>
53     S<<< [B<-vlrudisable>] >>>
54     S<<< [B<-vlruthresh> <I<minutes before eligibility for soft detach>>] >>>
55     S<<< [B<-vlruinterval> <I<seconds between VLRU scans>>] >>>
56     S<<< [B<-vlrumax> <I<max volumes to soft detach in one VLRU scan>>] >>>
57     S<<< [B<-vattachpar> <I<number of volume attach threads>>] >>>
58     S<<< [B<-m> <I<min percentage spare in partition>>] >>>
59     S<<< [B<-lock>] >>>
60
61 =for html
62 </div>
63
64 =head1 DESCRIPTION
65
66 The B<fileserver> command initializes the File Server component of the
67 C<fs> process. In the conventional configuration, its binary file is
68 located in the F</usr/afs/bin> directory on a file server machine.
69
70 The B<fileserver> command is not normally issued at the command shell
71 prompt, but rather placed into a database server machine's
72 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
73 ever issued at the command shell prompt, the issuer must be logged onto a
74 file server machine as the local superuser C<root>.
75
76 The File Server creates the F</usr/afs/logs/FileLog> log file as it
77 initializes, if the file does not already exist. It does not write a
78 detailed trace by default, but the B<-d> option may be used to
79 increase the amount of detail. Use the B<bos getlog> command to
80 display the contents of the log file.
81
82 The command's arguments enable the administrator to control many aspects
83 of the File Server's performance, as detailed in L<OPTIONS>.  By default
84 the B<fileserver> command sets values for many arguments that are suitable
85 for a medium-sized file server machine. To set values suitable for a small
86 or large file server machine, use the B<-S> or B<-L> flag
87 respectively. The following list describes the parameters and
88 corresponding argument for which the B<fileserver> command sets default
89 values, and the table below summarizes the setting for each of the three
90 machine sizes.
91
92 =over 4
93
94 =item *
95
96 The maximum number of lightweight processes (LWPs) or pthreads 
97 the File Server uses to handle requests for data; corresponds to the 
98 B<-p> argument. The File Server always uses a minimum of 32 KB of 
99 memory for these processes.
100
101 =item *
102
103 The maximum number of directory blocks the File Server caches in memory;
104 corresponds to the B<-b> argument. Each cached directory block (buffer)
105 consumes 2,092 bytes of memory.
106
107 =item *
108
109 The maximum number of large vnodes the File Server caches in memory for
110 tracking directory elements; corresponds to the B<-l> argument. Each large
111 vnode consumes 292 bytes of memory.
112
113 =item *
114
115 The maximum number of small vnodes the File Server caches in memory for
116 tracking file elements; corresponds to the B<-s> argument.  Each small
117 vnode consumes 100 bytes of memory.
118
119 =item *
120
121 The maximum volume cache size, which determines how many volumes the File
122 Server can cache in memory before having to retrieve data from disk;
123 corresponds to the B<-vc> argument.
124
125 =item *
126
127 The maximum number of callback structures the File Server caches in
128 memory; corresponds to the B<-cb> argument. Each callback structure
129 consumes 16 bytes of memory.
130
131 =item *
132
133 The maximum number of Rx packets the File Server uses; corresponds to the
134 B<-rxpck> argument. Each packet consumes 1544 bytes of memory.
135
136 =back
137
138 The default values are:
139
140   Parameter (Argument)               Small (-S)     Medium   Large (-L)
141   ---------------------------------------------------------------------
142   Number of LWPs (-p)                        6           9           12
143   Number of cached dir blocks (-b)          70          90          120
144   Number of cached large vnodes (-l)       200         400          600
145   Number of cached small vnodes (-s)       200         400          600
146   Maximum volume cache size (-vc)          200         400          600
147   Number of callbacks (-cb)             20,000      60,000       64,000
148   Number of Rx packets (-rxpck)            100         150          200
149
150 To override any of the values, provide the indicated argument (which can
151 be combined with the B<-S> or B<-L> flag).
152
153 The amount of memory required for the File Server varies. The approximate
154 default memory usage is 751 KB when the B<-S> flag is used (small
155 configuration), 1.1 MB when all defaults are used (medium configuration),
156 and 1.4 MB when the B<-L> flag is used (large configuration). If
157 additional memory is available, increasing the value of the B<-cb> and
158 B<-vc> arguments can improve File Server performance most directly.
159
160 By default, the File Server allows a volume to exceed its quota by 1 MB
161 when an application is writing data to an existing file in a volume that
162 is full. The File Server still does not allow users to create new files in
163 a full volume. To change the default, use one of the following arguments:
164
165 =over 4
166
167 =item *
168
169 Set the B<-spare> argument to the number of extra kilobytes that the File
170 Server allows as overage. A value of C<0> allows no overage.
171
172 =item *
173
174 Set the B<-pctspare> argument to the percentage of the volume's quota the
175 File Server allows as overage.
176
177 =back
178
179 By default, the File Server implicitly grants the C<a> (administer) and
180 C<l> (lookup) permissions to system:administrators on the access control
181 list (ACL) of every directory in the volumes stored on its file server
182 machine. In other words, the group's members can exercise those two
183 permissions even when an entry for the group does not appear on an ACL. To
184 change the set of default permissions, use the B<-implicit> argument.
185
186 The File Server maintains a I<host current protection subgroup> (I<host
187 CPS>) for each client machine from which it has received a data access
188 request. Like the CPS for a user, a host CPS lists all of the Protection
189 Database groups to which the machine belongs, and the File Server compares
190 the host CPS to a directory's ACL to determine in what manner users on the
191 machine are authorized to access the directory's contents. When the B<pts
192 adduser> or B<pts removeuser> command is used to change the groups to
193 which a machine belongs, the File Server must recompute the machine's host
194 CPS in order to notice the change. By default, the File Server contacts
195 the Protection Server every two hours to recompute host CPSs, implying
196 that it can take that long for changed group memberships to become
197 effective. To change this frequency, use the B<-hr> argument.
198
199 The File Server stores volumes in partitions. A partition is a
200 filesystem or directory on the server machine that is named C</vicepX>
201 or C</vicepXX> where XX is "a" through "z" or "aa" though "zz". The
202 File Server expects that the /vicepXX directories are each on a
203 dedicated filesystem. The File Server will only use a /vicepXX if it's
204 a mountpoint for another filesystem, unless the file
205 C</vicepXX/AlwaysAttach> exists. The data in the partition is a
206 special format that can only be access using OpenAFS commands or an
207 OpenAFS client.
208
209 The File Server generates the following message when a partition is nearly
210 full:
211
212    No space left on device
213
214 This command does not use the syntax conventions of the AFS command
215 suites. Provide the command name and all option names in full.
216
217 =head1 CAUTIONS
218
219 Do not use the B<-k> and B<-w> arguments, which are intended for use
220 by the OpenAFS developers only. Changing them from their default
221 values can result in unpredictable File Server behavior.  In any case,
222 on many operating systems the File Server uses native threads rather
223 than the LWP threads, so using the B<-k> argument to set the number of
224 LWP threads has no effect.
225
226 Do not specify both the B<-spare> and B<-pctspare> arguments. Doing so
227 causes the File Server to exit, leaving an error message in the
228 F</usr/afs/logs/FileLog> file.
229
230 Options that are available only on some system types, such as the B<-m>
231 and B<-lock> options, appear in the output generated by the B<-help>
232 option only on the relevant system type.
233
234 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes)
235 and the maximum size of a /vicepX partition on a fileserver is 2^64 
236 kilobytes.  (The maximum partition size in releases 1.5.34 and earlier
237 is 2^31 kilobytes.)
238
239 The maximum number of directory entries is 64,000 if all of the entries
240 have names that are 15 octets or less in length. A name that is 15 octets
241 long requires the use of only one block in the directory. Additional
242 sequential blocks are required to store entries with names that are longer
243 than 15 octets. Each additional block provides an additional length of 32
244 octets for the name of the entry. Note that if file names use an encoding
245 like UTF-8, a single character may be encoded into multiple octets.
246
247 In real world use, the maximum number of objects in an AFS directory
248 is usually between 16,000 and 25,000, depending on the average name
249 length.
250
251 =head1 OPTIONS
252
253 =over 4
254
255 =item B<-auditlog> <I<log path>>
256
257 Set and enable auditing.
258
259 =item B<-d> <I<debug level>>
260
261 Sets the detail level for the debugging trace written to the
262 F</usr/afs/logs/FileLog> file. Provide one of the following values, each
263 of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
264 and C<125>. The default value of C<0> produces only a few messages.
265
266 =item B<-p> <I<number of processes>>
267
268 Sets the number of threads (or LWPs) to run. Provide a positive integer. 
269 The File Server creates and uses five threads for special purposes, 
270 in addition to the number specified (but if this argument specifies 
271 the maximum possible number, the File Server automatically uses five 
272 of the threads for its own purposes).
273
274 The maximum number of threads can differ in each release of AFS.  Consult
275 the I<IBM AFS Release Notes> for the current release.
276
277 =item B<-spare> <I<number of spare blocks>>
278
279 Specifies the number of additional kilobytes an application can store in a
280 volume after the quota is exceeded. Provide a positive integer; a value of
281 C<0> prevents the volume from ever exceeding its quota. Do not combine
282 this argument with the B<-pctspare> argument.
283
284 =item B<-pctspare> <I<percentage spare>>
285
286 Specifies the amount by which the File Server allows a volume to exceed
287 its quota, as a percentage of the quota. Provide an integer between C<0>
288 and C<99>. A value of C<0> prevents the volume from ever exceeding its
289 quota. Do not combine this argument with the B<-spare> argument.
290
291 =item B<-b> <I<buffers>>
292
293 Sets the number of directory buffers. Provide a positive integer.
294
295 =item B<-l> <I<large vnodes>>
296
297 Sets the number of large vnodes available in memory for caching directory
298 elements. Provide a positive integer.
299
300 =item B<-s> <I<small nodes>>
301
302 Sets the number of small vnodes available in memory for caching file
303 elements. Provide a positive integer.
304
305 =item B<-vc> <I<volume cachesize>>
306
307 Sets the number of volumes the File Server can cache in memory.  Provide a
308 positive integer.
309
310 =item B<-w> <I<call back wait interval>>
311
312 Sets the interval at which the daemon spawned by the File Server performs
313 its maintenance tasks. Do not use this argument; changing the default
314 value can cause unpredictable behavior.
315
316 =item B<-cb> <I<number of callbacks>>
317
318 Sets the number of callbacks the File Server can track. Provide a positive
319 integer.
320
321 =item B<-banner>
322
323 Prints the following banner to F</dev/console> about every 10 minutes.
324
325    File Server is running at I<time>.
326
327 =item B<-novbc>
328
329 Prevents the File Server from breaking the callbacks that Cache Managers
330 hold on a volume that the File Server is reattaching after the volume was
331 offline (as a result of the B<vos restore> command, for example). Use of
332 this flag is strongly discouraged.
333
334 =item B<-implicit> <I<admin mode bits>>
335
336 Defines the set of permissions granted by default to the
337 system:administrators group on the ACL of every directory in a volume
338 stored on the file server machine. Provide one or more of the standard
339 permission letters (C<rlidwka>) and auxiliary permission letters
340 (C<ABCDEFGH>), or one of the shorthand notations for groups of permissions
341 (C<all>, C<none>, C<read>, and C<write>). To review the meaning of the
342 permissions, see the B<fs setacl> reference page.
343
344 =item B<-readonly>
345
346 Don't allow writes to this fileserver.
347
348 =item B<-hr> <I<number of hours between refreshing the host cps>>
349
350 Specifies how often the File Server refreshes its knowledge of the
351 machines that belong to protection groups (refreshes the host CPSs for
352 machines). The File Server must update this information to enable users
353 from machines recently added to protection groups to access data for which
354 those machines now have the necessary ACL permissions.
355
356 =item B<-busyat> <I<< redirect clients when queue > n >>>
357
358 Defines the number of incoming RPCs that can be waiting for a response
359 from the File Server before the File Server returns the error code
360 C<VBUSY> to the Cache Manager that sent the latest RPC. In response, the
361 Cache Manager retransmits the RPC after a delay. This argument prevents
362 the accumulation of so many waiting RPCs that the File Server can never
363 process them all. Provide a positive integer.  The default value is
364 C<600>.
365
366 =item B<-rxpck> <I<number of rx extra packets>>
367
368 Controls the number of Rx packets the File Server uses to store data for
369 incoming RPCs that it is currently handling, that are waiting for a
370 response, and for replies that are not yet complete. Provide a positive
371 integer.
372
373 =item B<-rxdbg>
374
375 Writes a trace of the File Server's operations on Rx packets to the file
376 F</usr/afs/logs/rx_dbg>.
377
378 =item B<-rxdbge>
379
380 Writes a trace of the File Server's operations on Rx events (such as
381 retransmissions) to the file F</usr/afs/logs/rx_dbg>.
382
383 =item B<-rxmaxmtu> <I<bytes>>
384
385 Defines the maximum size of an MTU.  The value must be between the
386 minimum and maximum packet data sizes for Rx.
387
388 =item B<-jumbo>
389
390 Allows the server to send and receive jumbograms. A jumbogram is
391 a large-size packet composed of 2 to 4 normal Rx data packets that share
392 the same header. The fileserver does not use jumbograms by default, as some
393 routers are not capable of properly breaking the jumbogram into smaller
394 packets and reassembling them.
395
396 =item B<-nojumbo>
397
398 Deprecated; jumbograms are disabled by default.
399
400 =item B<-rxbind>
401
402 Force the fileserver to only bind to one IP address.
403
404 =item B<-allow-dotted-principal>
405
406 By default, the RXKAD security layer will disallow access by Kerberos
407 principals with a dot in the first component of their name. This is to avoid
408 the confusion where principals user/admin and user.admin are both mapped to the
409 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
410 between principal names may disable this check by starting the server
411 with this option.
412
413 =item B<-L>
414
415 Sets values for many arguments in a manner suitable for a large file
416 server machine. Combine this flag with any option except the B<-S> flag;
417 omit both flags to set values suitable for a medium-sized file server
418 machine.
419
420 =item B<-S>
421
422 Sets values for many arguments in a manner suitable for a small file
423 server machine. Combine this flag with any option except the B<-L> flag;
424 omit both flags to set values suitable for a medium-sized file server
425 machine.
426
427 =item B<-k> <I<stack size>>
428
429 Sets the LWP stack size in units of 1 kilobyte. Do not use this argument,
430 and in particular do not specify a value less than the default of C<24>.
431
432 =item B<-realm> <I<Kerberos realm name>>
433
434 Defines the Kerberos realm name for the File Server to use. If this
435 argument is not provided, it uses the realm name corresponding to the cell
436 listed in the local F</usr/afs/etc/ThisCell> file.
437
438 =item B<-udpsize> <I<size of socket buffer in bytes>>
439
440 Sets the size of the UDP buffer, which is 64 KB by default. Provide a
441 positive integer, preferably larger than the default.
442
443 =item B<-sendsize> <I<size of send buffer in bytes>>
444
445 Sets the size of the send buffer, which is 16384 bytes by default.
446
447 =item B<-abortthreshold> <I<abort threshold>>
448
449 Sets the abort threshold, which is triggered when an AFS client sends
450 a number of FetchStatus requests in a row and all of them fail due to
451 access control or some other error. When the abort threshold is
452 reached, the file server starts to slow down the responses to the
453 problem client in order to reduce the load on the file server.
454
455 The throttling behaviour can cause issues especially for some versions
456 of the Windows OpenAFS client. When using Windows Explorer to navigate
457 the AFS directory tree, directories with only "look" access for the
458 current user may load more slowly because of the throttling. This is
459 because the Windows OpenAFS client sends FetchStatus calls one at a
460 time instead of in bulk like the Unix Open AFS client.
461
462 Setting the threshold to 0 disables the throttling behavior. This
463 option is available in OpenAFS versions 1.4.1 and later.
464
465 =item B<-enable_peer_stats>
466
467 Activates the collection of Rx statistics and allocates memory for their
468 storage. For each connection with a specific UDP port on another machine,
469 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
470 so on) sent or received. To display or otherwise access the records, use
471 the Rx Monitoring API.
472
473 =item B<-enable_process_stats>
474
475 Activates the collection of Rx statistics and allocates memory for their
476 storage. A separate record is kept for each type of RPC (FetchFile,
477 GetStatus, and so on) sent or received, aggregated over all connections to
478 other machines. To display or otherwise access the records, use the Rx
479 Monitoring API.
480
481 =item B<-syslog [<loglevel>]
482
483 Use syslog instead of the normal logging location for the fileserver
484 process.  If provided, log messages are at <loglevel> instead of the
485 default LOG_USER.
486
487 =item B<-mrafslogs>
488
489 Use MR-AFS (Multi-Resident) style logging.  This option is deprecated.
490
491 =item B<-saneacls>
492
493 Offer the SANEACLS capability for the fileserver.  This option is
494 currently unimplemented.
495
496 =item B<-help>
497
498 Prints the online help for this command. All other valid options are
499 ignored.
500
501 =item B<-fs-state-dont-save>
502
503 When present, fileserver state will not be saved during shutdown.  Default
504 is to save state.
505
506 This option is only supported by the demand-attach file server.
507
508 =item B<-fs-state-dont-restore>
509
510 When present, fileserver state will not be restored during startup.
511 Default is to restore state on startup.
512
513 This option is only supported by the demand-attach file server.
514
515 =item B<-fs-state-verify> (none | save | restore | both)
516
517 This argument controls the behavior of the state verification mechanism.
518 A value of C<none> turns off all verification.  A value of C<save> only
519 performs the verification steps prior to saving state to disk.  A value
520 of C<restore> only performs the verification steps after restoring state
521 from disk.  A value of C<both> performs all verifications steps both
522 prior to save and following a restore.
523
524 The default is C<both>.
525
526 This option is only supported by the demand-attach file server.
527
528 =item B<-vhashsize <I<size>>
529
530 The log(2) number of of volume hash buckets.  Default is 8 (i.e., by
531 default, there are 2^8 = 256 volume hash buckets).
532
533 This option is only supported by the demand-attach file server.
534
535 =item B<-vlruthresh <I<minutes>>
536
537 The number of minutes of inactivity before a volume is eligible for soft
538 detachment.  Default is 120 minutes.
539
540 This option is only supported by the demand-attach file server.
541
542 =item B<-vlruinterval <I<seconds>>
543
544 The number of seconds between VLRU candidate queue scan.  The default is
545 120 seconds.
546
547 This option is only supported by the demand-attach file server.
548
549 =item B<-vlrumax <I<positive integer>>
550
551 The maximum number of volumes which can be soft detached in a single pass
552 of the scanner.  Default is 8 volumes.
553
554 This option is only supported by the demand-attach file server.
555
556 =item B<-vattachpar> <I<number of volume attach threads>>
557
558 The number of threads assigned to attach and detach volumes.  The default
559 is 1.  Warning: many of the I/O parallism features of Demand-Attach
560 Fileserver are turned off when the number of volume attach threads is only
561 1.
562
563 This option is only meaningful for a file server built with pthreads
564 support.
565
566 =item B<-m> <I<min percentage spare in partition>>
567
568 Specifies the percentage of each AFS server partition that the AIX version
569 of the File Server creates as a reserve. Specify an integer value between
570 C<0> and C<30>; the default is 8%. A value of C<0> means that the
571 partition can become completely full, which can have serious negative
572 consequences.  This option is not supported on platforms other than AIX.
573
574 =item B<-lock>
575
576 Prevents any portion of the fileserver binary from being paged (swapped)
577 out of memory on a file server machine running the IRIX operating system.
578 This option is not supported on platforms other than IRIX.
579
580 =back
581
582 =head1 EXAMPLES
583
584 The following B<bos create> command creates an fs process on the file
585 server machine C<fs2.abc.com> that uses the large configuration size, and
586 allows volumes to exceed their quota by 10%. Type the command on a single
587 line:
588
589    % bos create -server fs2.abc.com -instance fs -type fs \
590                 -cmd "/usr/afs/bin/fileserver -pctspare 10 \
591                 -L" /usr/afs/bin/volserver /usr/afs/bin/salvager
592
593
594 =head1 TROUBLESHOOTING
595
596 Sending process signals to the File Server Process can change its
597 behavior in the following ways:
598
599   Process          Signal       OS     Result
600   ---------------------------------------------------------------------
601
602   File Server      XCPU        Unix    Prints a list of client IP
603                                        Addresses.
604
605   File Server      USR2      Windows   Prints a list of client IP
606                                        Addresses.
607
608   File Server      POLL        HPUX    Prints a list of client IP
609                                        Addresses.
610
611   Any server       TSTP        Any     Increases Debug level by a power
612                                        of 5 -- 1,5,25,125, etc.
613                                        This has the same effect as the
614                                        -d XXX command-line option.
615
616   Any Server       HUP         Any     Resets Debug level to 0
617
618   File Server      TERM        Any     Run minor instrumentation over
619                                        the list of descriptors.
620
621   Other Servers    TERM        Any     Causes the process to quit.
622
623   File Server      QUIT        Any     Causes the File Server to Quit.
624                                        Bos Server knows this.
625
626 The basic metric of whether an AFS file server is doing well is the number
627 of connections waiting for a thread,
628 which can be found by running the following command:
629
630    % rxdebug <server> | grep waiting_for | wc -l
631
632 Each line returned by C<rxdebug> that contains the text "waiting_for"
633 represents a connection that's waiting for a file server thread.
634
635 If the blocked connection count is ever above 0, the server is having
636 problems replying to clients in a timely fashion.  If it gets above 10,
637 roughly, there will be noticable slowness by the user.  The total number of
638 connections is a mostly irrelevant number that goes essentially
639 monotonically for as long as the server has been running and then goes back
640 down to zero when it's restarted.
641
642 The most common cause of blocked connections rising on a server is some
643 process somewhere performing an abnormal number of accesses to that server
644 and its volumes.  If multiple servers have a blocked connection count, the
645 most likely explanation is that there is a volume replicated between those
646 servers that is absorbing an abnormally high access rate.
647
648 To get an access count on all the volumes on a server, run:
649
650    % vos listvol <server> -long
651
652 and save the output in a file.  The results will look like a bunch of B<vos
653 examine> output for each volume on the server.  Look for lines like:
654
655    40065 accesses in the past day (i.e., vnode references)
656
657 and look for volumes with an abnormally high number of accesses.  Anything
658 over 10,000 is fairly high, but some volumes like root.cell and other
659 volumes close to the root of the cell will have that many hits routinely.
660 Anything over 100,000 is generally abnormally high.  The count resets about
661 once a day.
662
663 Another approach that can be used to narrow the possibilities for a
664 replicated volume, when multiple servers are having trouble, is to find all
665 replicated volumes for that server.  Run:
666
667    % vos listvldb -server <server>
668
669 where <server> is one of the servers having problems to refresh the VLDB
670 cache, and then run:
671
672    % vos listvldb -server <server> -part <partition>
673
674 to get a list of all volumes on that server and partition, including every
675 other server with replicas.
676
677 Once the volume causing the problem has been identified, the best way to
678 deal with the problem is to move that volume to another server with a low
679 load or to stop any runaway programs that are accessing that volume
680 unnecessarily.  Often the volume will be enough information to tell what's
681 going on.
682
683 If you still need additional information about who's hitting that server,
684 sometimes you can guess at that information from the failed callbacks in the
685 F<FileLog> log in F</var/log/afs> on the server, or from the output of:
686
687    % /usr/afsws/etc/rxdebug <server> -rxstats
688
689 but the best way is to turn on debugging output from the file server.
690 (Warning: This generates a lot of output into FileLog on the AFS server.)
691 To do this, log on to the AFS server, find the PID of the fileserver
692 process, and do:
693
694     kill -TSTP <pid>
695
696 where <pid> is the PID of the file server process.  This will raise the
697 debugging level so that you'll start seeing what people are actually doing
698 on the server.  You can do this up to three more times to get even more
699 output if needed.  To reset the debugging level back to normal, use (The
700 following command will NOT terminate the file server):
701
702     kill -HUP <pid>
703
704 The debugging setting on the File Server should be reset back to normal when
705 debugging is no longer needed.  Otherwise, the AFS server may well fill its
706 disks with debugging output.
707
708 The lines of the debugging output that are most useful for debugging load
709 problems are:
710
711     SAFS_FetchStatus,  Fid = 2003828163.77154.82248, Host 171.64.15.76
712     SRXAFS_FetchData, Fid = 2003828163.77154.82248
713
714 (The example above is partly truncated to highlight the interesting
715 information).  The Fid identifies the volume and inode within the volume;
716 the volume is the first long number.  So, for example, this was:
717
718    % vos examine 2003828163
719    pubsw.matlab61                   2003828163 RW    1040060 K  On-line
720        afssvr5.Stanford.EDU /vicepa 
721        RWrite 2003828163 ROnly 2003828164 Backup 2003828165 
722        MaxQuota    3000000 K 
723        Creation    Mon Aug  6 16:40:55 2001
724        Last Update Tue Jul 30 19:00:25 2002
725        86181 accesses in the past day (i.e., vnode references)
726
727        RWrite: 2003828163    ROnly: 2003828164    Backup: 2003828165
728        number of sites -> 3
729           server afssvr5.Stanford.EDU partition /vicepa RW Site 
730           server afssvr11.Stanford.EDU partition /vicepd RO Site 
731           server afssvr5.Stanford.EDU partition /vicepa RO Site 
732
733 and from the Host information one can tell what system is accessing that
734 volume.
735
736 Note that the output of L<vos_examine(1)> also includes the access count, so
737 once the problem has been identified, vos examine can be used to see if the
738 access count is still increasing.  Also remember that you can run vos
739 examine on the read-only replica (e.g., pubsw.matlab61.readonly) to see the
740 access counts on the read-only replica on all of the servers that it's
741 located on.
742
743 =head1 PRIVILEGE REQUIRED
744
745 The issuer must be logged in as the superuser C<root> on a file server
746 machine to issue the command at a command shell prompt.  It is conventional
747 instead to create and start the process by issuing the B<bos create>
748 command.
749
750 =head1 SEE ALSO
751
752 L<BosConfig(5)>,
753 L<FileLog(5)>,
754 L<bos_create(8)>,
755 L<bos_getlog(8)>,
756 L<fs_setacl(1)>,
757 L<salvager(8)>,
758 L<volserver(8)>,
759 L<vos_examine(1)>
760
761 =head1 COPYRIGHT
762
763 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
764
765 This documentation is covered by the IBM Public License Version 1.0.  It was
766 converted from HTML to POD by software written by Chas Williams and Russ
767 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.