Add proper per-file copyright notices/licenses and top-level license.
[bluesky.git] / results / knfsd-async / sfs_native
1 ##############################################################################
2 #
3 #       @(#)sfs_nfs_rc  $Revision: 1.13 $
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 an NFS V3 run of 100 to 1000 ops/sec
13 #
14 LOAD="4100"
15 INCR_LOAD=100
16 NUM_RUNS=20
17 PROCS=4
18 CLIENTS="c09-44.sysnet.ucsd.edu"
19 MNT_POINTS="c09-45.sysnet.ucsd.edu:/export c09-45.sysnet.ucsd.edu:/export c09-45.sysnet.ucsd.edu:/export c09-45.sysnet.ucsd.edu:/export"
20 BIOD_MAX_WRITES=2
21 BIOD_MAX_READS=2
22 IPV6_ENABLE="off"
23 FS_PROTOCOL="nfs"
24 SFS_DIR="bin"
25 SUFFIX=""
26 WORK_DIR="result"
27 PRIME_MON_SCRIPT=""
28 PRIME_MON_ARGS=""
29 INIT_TIMEOUT=8000
30 # Leaving BLOCK_SIZE un-set is the default. This will permit auto-negotiation.
31 # If you over-ride this and set it to a particular value, you must
32 # add the value that you used to the Other Notes section of the 
33 # submission/disclosure.
34 BLOCK_SIZE=
35 # SFS_NFS_USER_ID only needed if running NFS load on Windows client 
36 # It's value should match the UID, of the user's account, on the NFS server.
37 SFS_NFS_USER_ID=500
38 # SFS_NFS_GROUP_ID only needed if running NFS load on Windows client 
39 # It's value should match the GID, of the user's account, on the NFS server.
40 SFS_NFS_GROUP_ID=500
41 #
42 # The following parameters are strictly defined within the SFS
43 # run and reporting rules and may not be changed.
44 #
45 RUNTIME=300
46 WARMUP_TIME=300
47 MIXFILE=""
48 ACCESS_PCNT=30
49 APPEND_PCNT=70
50 BLOCK_FILE=""
51 DIR_COUNT=30
52 FILE_COUNT=20000
53 SYMLINK_COUNT=20
54 TCP="on"
55 #
56 # The following parameters are useful for debugging or general system
57 # tuning.  They may not be used during during a reportable SFS run.
58 #
59 DEBUG=""
60 DUMP=
61 POPULATE=
62 LAT_GRAPH=
63 PRIME_SLEEP=0
64 PRIME_TIMEOUT=0
65 #
66 # The default SFS options are implied if no values are assigned to
67 # the variables. The variables and their meaning are as follows.
68 #
69 # The following parameters are configurable within the SFS run and
70 # reporting rules.
71 #
72 #  LOAD         - array of numbers specifying the NFS loads
73 #                 (NFS calls per second) to be generated by all clients
74 #                 combined. The number of consecutive runs equals the size
75 #                 of the array and the peak load equals the largest value
76 #                 in the array. (DEFAULT = 60)
77 #  PROCS        - number of SFS sub-processes to generate NFS
78 #                 calls (DEFAULT PROCS = 4).
79 #  MNT_POINTS   - string containing the mount points of NFS-mounted
80 #                 filesystems on the client which will be used in the test or
81 #                 it can be set to the name of a file containing a list of
82 #                 mount points. The file should be located in WORK_DIR. The
83 #                 file should have the following format:
84 #                       client1 svr:/mnt1 ... svr:/mntM
85 #                       ...
86 #                       clientN svr:/mntL ... svr:/mntL+M
87 #
88 #  BIOD_MAX_WRITES - maximum number of outstanding async (biod) writes
89 #                 (DEFAULT BIOD_MAX_WRITES = 2).
90 #  BIOD_MAX_READS - maximum number of outstanding async (biod) reads
91 #                 (DEFAULT BIOD_MAX_READS = 2).
92 #  IPV6_ENABLE  - If set ("on") then use IP V6 otherwise use IP V4.
93 #                 (DEFAULT IPV6_ENABLE = "off").
94 #  FS_PROTOCOL  - File server protocol used "cifs" or "nfs"
95 #                 (DEFAULT FS_PROTOCOL = "nfs")
96 #  NUM_RUNS     - number indicating the number of multi-client runs. NUM_RUNS
97 #                 should only be used if the size of the LOAD array <= 1;
98 #  INCR_LOAD    - number indicating the load increment factor in NFS call/sec.
99 #                 The first run generates LOAD calls/sec,
100 #                 subsequent runs are made with LOAD + (N * INCR_LOAD)
101 #                 calls/sec; where initial N = 0. INCR_LOAD should
102 #                 only be used if the size of the LOAD array <= 1.
103 #  CLIENTS      - string containing client's host names; include the Prime-
104 #                 Client's host name if you will be using the Prime-Client to
105 #                 generate NFS loads.
106 #  SFS_NFS_USER_ID - ID number to use as the User ID (UID) on the NFS server.
107 #  SFS_NFS_GROUP_ID - ID number to use as the Group ID (GID) on the NFS server.
108 #                 for NFS requests to the server.
109 #  SFS_DIR      - string containing the directory path where the SFS
110 #                 executables are stored; should be the same for all systems
111 #                 This location is used first, if the binaries are not found
112 #                 there then it looks in the "binaries" directory.
113 #                 (DEFAULT SFS_DIR = "bin")
114 #  SUFFIX       - Suffix for the log files.
115 #  WORK_DIR     - string containing directory path where the SFS output
116 #                 files are stored, this should be the same for all systems.
117 #  PRIME_MON_SCRIPT - string containing the name of a script used to
118 #                 control the start and stop of any external SFS processes
119 #                 like external performance monitors. The sample script
120 #                 'sfs_ext_mon' shows the expected semantics of the program.
121 #                 This variable must refer to an executable on a Windows
122 #                 client.
123 #  PRIME_MON_ARGS - string containing optional arguments that are passed
124 #                 to the PRIME_MON_SCRIPT.
125 #
126 # The following parameters are strictly defined within the SFS
127 # run and reporting rules and may not be changed.
128 #
129 #  RUNTIME      - number of seconds to generate load
130 #                 (DEFAULT RUNTIME = 300).
131 #  TCP          - If set ("on") then use NFS/TCP behaviour rather than UDP.
132 #  WARMUP_TIME  - number of seconds to warmup
133 #                 (DEFAULT WARMUP_TIME = 300).
134 #  MIXFILE      - string containing the NFS call distribution filename;
135 #                 a copy of $MIXFILE must be placed in the $WORK_DIR
136 #                 directory on the Prime_Client. The Prime-Client will
137 #                 propagate a copy to all the other clients in the test.
138 #  ACCESS_PCNT  - percent of total file set available for use by i/o
139 #                 operations that will be accessed.
140 #                 (DEFAULT ACCESS_PCNT = 20).
141 #  APPEND_PCNT  - percent of writes that append rather than overwrite
142 #                 (DEFAULT APPEND_PCNT = 70).
143 #  BLOCK_SIZE   - number of KB in a block, up to 4 Meg.
144 #                 (Value is automatically negoitated with the server)
145 #  BLOCK_FILE   - string containing the block transfer sizes filename.
146 #                 A copy of $BLOCK_FILE must be placed in the $WORK_DIR
147 #                 directory on the Prime_Client. The Prime-Client will
148 #                 propagate a copy to all the other clients in the test.
149 #  DIR_COUNT    - number of files per directory to use for directory
150 #                 operations (DEFAULT DIR_COUNT = 30).
151 #  FILE_COUNT   - number of files to use for read and write
152 #                 operations. By default, number of files is
153 #                 calculated from the specified LOAD and ACCESS_PCNT.
154 #  SYMLINK_COUNT - number of symbolic links to use for symlink
155 #                 operations (DEFAULT SYMLINK_COUNT = 20).
156 #
157 # The following parameters are useful for debugging or general system
158 # tuning.  They may not be used during during a reportable SFS run.
159 #
160 #  DUMP         - If set to a non-zero value, dump raw data points at end of
161 #                 run. (DEFAULT DUMP = 0 ).
162 #  LAT_GRAPH    - Debug option that enable per op latency graph data. 
163 #                 May invalidate the results due to overhead of logging.
164 #                 If set ("on") will enable logging. Default is ""
165 #  POPULATE     - If set ("on") then only populate the file set but do not
166 #                 run the test.
167 #  PRIME_SLEEP  - number of seconds Prime-Client should sleep after starting
168 #                 and stopping the SFS external monitoring facility and
169 #                 before sending synchronization message to clients. This is a
170 #                 provision to allow sufficient time for starting and stopping
171 #                 other performance monitoring utilities that could be used
172 #                 during SFS execution.
173 #  PRIME_TIMEOUT - number of seconds Prime-Client should wait for a
174 #                 response from all the clients.  Zero indicates the
175 #                 default should be used.
176 #  INIT_TIMEOUT - number of seconds Prime-Client should wait for a
177 #                 response from all the clients during the INIT phase.
178 #                 May be changed if needed and will not invalidate the
179 #                 run.