Add proper per-file copyright notices/licenses and top-level license.
[bluesky.git] / TBBT / trace_play / sfs_rc
1 ##############################################################################
2 #
3 #       @(#)sfs_rc      2.1     97/10/23
4 #
5 # Specify SFS parameters for sfs runs in this file.
6 #
7 # The following parameters are configurable within the SFS run and
8 # reporting rules.
9 #
10 # See below for details.
11 #
12 # Example shows a run of 100 to 1000 ops/sec
13 #
14 LOAD="100"
15 INCR_LOAD=100
16 NUM_RUNS=10
17 PROCS=4
18 CLIENTS="client1 client2"
19 MNT_POINTS="srvr:/a srvr:/b srvr:/c srvr:/d srvr:/e srvr:/f srvr:/g srvr:/h"
20 BIOD_MAX_WRITES=2
21 BIOD_MAX_READS=2
22 TCP="on"
23 NFS_VERSION="3"
24 SFS_USER="`id | tr '()' '  ' | awk '{print $2}' `"
25 SFS_DIR="`pwd`/bin"
26 WORK_DIR="`pwd`/result"
27 PRIME_MON_SCRIPT=""
28 PRIME_MON_ARGS=""
29 RSH="rsh"
30 #
31 # The following parameters are strictly defined within the SFS
32 # run and reporting rules and may not be changed.
33 #
34 RUNTIME=300
35 WARMUP_TIME=300
36 MIXFILE=""
37 ACCESS_PCNT=10
38 APPEND_PCNT=70
39 BLOCK_SIZE=8
40 BLOCK_FILE=""
41 DIR_COUNT=30
42 FILE_COUNT=
43 SYMLINK_COUNT=20
44 #
45 # The following parameters are useful for debugging or general system
46 # tuning.  They may not be used during during a reportable SFS run.
47 #
48 DEBUG=
49 DUMP=
50 POPULATE=
51 PRIME_SLEEP=0
52 PRIME_TIMEOUT=0
53 #
54 # The default SFS options are implied if no values are assigned to
55 # the variables. The variables and their meaning are as follows.
56 #
57 # The following parameters are configurable within the SFS run and
58 # reporting rules.
59 #
60 #  LOAD         - array of numbers specifying the NFS loads
61 #                 (NFS calls per second) to be generated by all clients
62 #                 combined. The number of consecutive runs equals the size
63 #                 of the array and the peak load equals the largest value
64 #                 in the array.
65 #  PROCS        - number of SFS sub-processes to generate NFS
66 #                 calls (DEFAULT PROCS = 4).
67 #  MNT_POINTS   - string containing the mount points of NFS-mounted
68 #                 filesystems on the client which will be used in the test.
69 #  BIOD_MAX_WRITES - maximum number of outstanding async (biod) writes
70 #                 (DEFAULT BIOD_MAX_WRITES = 2).
71 #  BIOD_MAX_READS - maximum number of outstanding async (biod) reads
72 #                 (DEFAULT BIOD_MAX_READS = 2).
73 #  TCP          - If set ("on") then use NFS/TCP behaviour rather
74 #  NFS_VERSION  - Set the version of the NFS protocol to use
75 #                 (DEFAULT [or unset] NFS_VERSION = 2)
76 #  NUM_RUNS     - number indicating the number of multi-client runs. NUM_RUNS
77 #                 should only be used if the size of the LOAD array <= 1;
78 #  INCR_LOAD    - number indicating the load increment factor in NFS call/sec.
79 #                 The first run generates LOAD calls/sec,
80 #                 subsequent runs are made with LOAD + (N * INCR_LOAD)
81 #                 calls/sec; where initial N = 0. INCR_LOAD should
82 #                 only be used if the size of the LOAD array <= 1.
83 #  CLIENTS      - string containing client's host names; include the Prime-
84 #                 Client's host name if you will be using the Prime-Client to
85 #                 generate NFS loads.
86 #  SFS_USER     - string containing the user account name that has appropriate
87 #                 permission to execute SFS on each of the clients. The
88 #                 user account name used on the Prime-Client should be added
89 #                 to the SFS_USER's .rhosts file on each of the clients.
90 #  SFS_DIR      - string containing the directory path where the SFS
91 #                 executables are stored; should be the same for all systems
92 #  WORK_DIR     - string containing directory path where the SFS output
93 #                 files are stored, this should be the same for all systems.
94 #  RSH          - OS dependent version of remote shell executable ON THE
95 #                 PRIME CLIENT
96 #  PRIME_MON_SCRIPT - string containing the name of a shell script used to
97 #                 control the start and stop of any external SFS
98 #                 processes like external performance monitors. The sample
99 #                 The sample shell script 'sfs_ext_mon' shows the
100 #                 expected semantics of the program.
101 #  PRIME_MON_ARGS - string containing optional arguments that are passed
102 #                 to the PRIME_MON_SCRIPT.
103 #
104 # The following parameters are strictly defined within the SFS
105 # run and reporting rules and may not be changed.
106 #
107 #  RUNTIME      - number of seconds to generate load
108 #                 (DEFAULT RUNTIME = 300).
109 #  WARMUP_TIME  - number of seconds to warmup
110 #                 (DEFAULT WARMUP_TIME = 300).
111 #  MIXFILE      - string containing the NFS call distribution filename;
112 #                 a copy of $MIXFILE must be placed in the $WORK_DIR
113 #                 directory on the Prime_Client. The Prime-Client will
114 #                 propagate a copy to all the other clients in the test.
115 #  ACCESS_PCNT  - percent of total file set available for use by i/o
116 #                 operations that will be accessed.
117 #                 (DEFAULT ACCESS_PCNT = 10).
118 #  APPEND_PCNT  - percent of writes that append rather than overwrite
119 #                 (DEFAULT APPEND_PCNT = 70).
120 #  BLOCK_SIZE   - number of KB in a block, up to 8 KB
121 #                 (DEFAULT BLOCK_SIZE = 8 ).
122 #  BLOCK_FILE   - string containing the block transfer sizes filename.
123 #                 A copy of $BLOCK_FILE must be placed in the $WORK_DIR
124 #                 directory on the Prime_Client. The Prime-Client will
125 #                 propagate a copy to all the other clients in the test.
126 #  DIR_COUNT    - number of files per directory to use for directory
127 #                 operations (DEFAULT DIR_COUNT = 30).
128 #  FILE_COUNT   - number of files to use for read and write
129 #                 operations. By default, number of files is
130 #                 calculated from the specified LOAD and ACCESS_PCNT.
131 #  SYMLINK_COUNT - number of symbolic links to use for symlink
132 #                 operations (DEFAULT SYMLINK_COUNT = 20).
133 #
134 # The following parameters are useful for debugging or general system
135 # tuning.  They may not be used during during a reportable SFS run.
136 #
137 #  DUMP         - If set, dump raw data points at end of run
138 #  POPULATE     - If set ("on") the only populate the file set and do
139 #                 run test.
140 #
141 #  PRIME_SLEEP  - number of seconds Prime-Client should sleep after starting
142 #                 and stopping the SFS external monitoring facility and
143 #                 before sending synchronization message to clients. This is a
144 #                 provision to allow sufficient time for starting and stopping
145 #                 other performance monitoring utilities that could be used
146 #                 during SFS execution.
147 #  PRIME_TIMEOUT - number of seconds Prime-Client should wait for a
148 #                 response from all the clients.  Zero indicates the
149 #                 default should be used.