|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-2988AB7C-F8BB-5917-BB22-A57C0CC56C73" xml:lang="en"><title> Configuring |
|
13 the base_perf_f32_env.ini File</title><shortdesc> Describes the common configuration items for each test case that |
|
14 can be configured in the <filepath>base_perf_f32_env.ini</filepath> file. </shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
15 <p><note> Changing this configuration file has an impact on the entire test |
|
16 suite as each test uses the contents of this file for its specific test scenario.</note> </p> |
|
17 <p>The configurable items in the <filepath>base_perf_f32_env.ini</filepath> file |
|
18 are listed in the following table: </p> |
|
19 <table id="GUID-07452553-4920-527F-BA4D-713189B04D04"> |
|
20 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
21 <tbody> |
|
22 <row> |
|
23 <entry><p> <b>Field name</b> </p> </entry> |
|
24 <entry><p> <b>Description</b> </p> </entry> |
|
25 </row> |
|
26 <row> |
|
27 <entry><p>csvFileName </p> </entry> |
|
28 <entry><p>Defines the default name of the <filepath>.CSV</filepath> file and |
|
29 its location. The data within this parameter can be in one of the following |
|
30 formats: </p> <p> <filepath> <Drive Letter>: \<name of file>.csv</filepath> </p> <p>- |
|
31 OR - </p> <p> <filepath><Drive Letter>: \<location>\<name of |
|
32 file>.csv</filepath> </p> <p>The <filepath>.CSV</filepath> file |
|
33 contains readable test results. By default, this file is named <filepath>f32-perfResults.csv</filepath> and |
|
34 is stored in the <filepath>C:</filepath> drive. </p> <p><note> This value |
|
35 is used by all test cases.</note> </p> </entry> |
|
36 </row> |
|
37 <row> |
|
38 <entry><p>threadname </p> </entry> |
|
39 <entry><p>Defines the default name of the thread handle to be created, for |
|
40 all test cases. </p> </entry> |
|
41 </row> |
|
42 <row> |
|
43 <entry><p>stacksize </p> </entry> |
|
44 <entry><p>Defines a default integer that specifies the stack size allocated |
|
45 to the thread handle. The default is set to <b>0x2000</b>. </p> <p>This value |
|
46 is used by all test cases. </p> </entry> |
|
47 </row> |
|
48 <row> |
|
49 <entry><p>minheapsize </p> </entry> |
|
50 <entry><p>Defines a default integer value that specifies the minimum heap |
|
51 size allocated to the thread handle. By default, this is set to <b>256 KB</b> or <b>0x100</b>. </p> <p><note> This |
|
52 value is used by all test cases. </note></p> </entry> |
|
53 </row> |
|
54 <row> |
|
55 <entry><p>maxheapsize </p> </entry> |
|
56 <entry><p>Defines a default value that specifies the maximum heap size allocated |
|
57 to the thread handle. By default, this is set to <b>1 MB</b> or <b>0x100</b>. </p> <note><p> This |
|
58 value is used by all test cases. </p></note> </entry> |
|
59 </row> |
|
60 <row> |
|
61 <entry><p>ownertype </p> </entry> |
|
62 <entry><p>Defines a default <codeph>TOwnerType</codeph> enumeration value |
|
63 that defines the ownership of this thread handle. By default, this is set |
|
64 to <codeph>EOwnerProcess</codeph>. </p> <note><p> This value is used by all |
|
65 test cases. </p></note> </entry> |
|
66 </row> |
|
67 <row> |
|
68 <entry><p>threadpriority </p> </entry> |
|
69 <entry><p>Defines a default <codeph>TThreadPriority</codeph> enumeration value |
|
70 that defines the priority of the thread handle. By default, this is set to <codeph>EPriorityLess</codeph>. </p> <note><p> This |
|
71 value is used by all test cases. </p></note> </entry> |
|
72 </row> |
|
73 <row> |
|
74 <entry><p>driveName </p> </entry> |
|
75 <entry><p>Default writable drive. This drive is used for creating a temporary |
|
76 test directory structure for test cases. </p> <p>This value must be the character |
|
77 of the drive, followed by a semicolon. The default value is <filepath>E:</filepath>. |
|
78 The data within this parameter must be in the following format: </p> <p> <filepath><Drive |
|
79 Letter>:</filepath> </p> <p><note> Modifying this value impacts the location |
|
80 where the test cases create its test directory structure, and also the location |
|
81 on which the tests performs their operations. </note></p> </entry> |
|
82 </row> |
|
83 <row> |
|
84 <entry><p>formatDrive </p> </entry> |
|
85 <entry><p>Defines a boolean value that indicates whether a drive is to be |
|
86 formatted during a test. This must be a boolean value. By default, it is set |
|
87 to <codeph>EFalse</codeph>. </p> <p><note> This value is used by all test |
|
88 cases. </note></p> </entry> |
|
89 </row> |
|
90 <row> |
|
91 <entry><p>baseDirName </p> </entry> |
|
92 <entry><p>Defines the name of the parent test directory used to store the |
|
93 test directory. The data within this parameter must be in the following format: </p> <p> <filepath>{Default, |
|
94 driveName}\< name of base directory>\</filepath> </p> <note><p> This value |
|
95 is used by all test cases. Therefore, altering this value affects all test |
|
96 cases. </p> </note></entry> |
|
97 </row> |
|
98 <row> |
|
99 <entry><p>subDirName </p> </entry> |
|
100 <entry><p>Defines the name of the actual test directory that is used for storing |
|
101 test files. Each sub-directory created has the same name. For example, if |
|
102 the name of the test directory is <filepath>dir</filepath>, the first directory |
|
103 that will be created is <filepath>dir</filepath>, the second sub-directory |
|
104 created is also called <b>dir</b>, and so on. </p> <p>Ensure that this name |
|
105 does not contain a dot character (‘.’). </p> <note><p> This value is used |
|
106 by all test cases. Therefore, altering this value affects all test cases. </p></note> </entry> |
|
107 </row> |
|
108 <row> |
|
109 <entry><p>fileBaseName </p> </entry> |
|
110 <entry><p>Defines the name of the test file that is used for each test case. |
|
111 Each file will be appended with an incrementing number. For example, if the |
|
112 file base name is <filepath>file.txt</filepath> then the name of the first |
|
113 file that will be created is <filepath>file1.txt</filepath>. Ensure that the |
|
114 name of the file does contain a dot character (‘.’). You can use one of the |
|
115 following formats: </p> <p> <filepath><name of file>.<extension name></filepath> </p> <p>- |
|
116 OR - </p> <p> <filepath> <name of file></filepath> </p> <note><p> This |
|
117 value is used by all test cases. Therefore, altering this value affects all |
|
118 test cases. </p></note> </entry> |
|
119 </row> |
|
120 <row> |
|
121 <entry><p>fileData </p> </entry> |
|
122 <entry><p>Defines the content of each file created. </p> <note><p> This value |
|
123 is used by all test cases. </p></note> </entry> |
|
124 </row> |
|
125 <row> |
|
126 <entry><p>dirTreeDepth </p> </entry> |
|
127 <entry><p>Defines an integer number that represents the default number of |
|
128 directories to be created in the base directory. </p> <p>This value is used |
|
129 by all test cases. Therefore, altering this value affects all test cases, |
|
130 and the test directory structure that each test case creates and uses. </p> <note><p> Based |
|
131 on the actual size of the directory structure that is created, use an MMC |
|
132 card of an appropriate size. </p></note> </entry> |
|
133 </row> |
|
134 <row> |
|
135 <entry><p>numOfFiles </p> </entry> |
|
136 <entry><p>Defines an integer number that represents the default number of |
|
137 files to create in each directory. </p> <p>This value is used by all test |
|
138 cases. Therefore, altering this value affects all test cases, and the test |
|
139 directory structure that each test case creates and uses. </p> <note><p> Based |
|
140 on the actual size of the directory structure that is created, use an MMC |
|
141 card of an appropriate size. </p></note> </entry> |
|
142 </row> |
|
143 <row> |
|
144 <entry><p>fileSize </p> </entry> |
|
145 <entry><p>Defines an integer number that represents the default file size |
|
146 (in bytes) of each file to create. By default, this is set to <b>128 Kb</b> or <b>1024 |
|
147 x128 bytes</b>. </p> <note><p> Modifying this value affects all tests within |
|
148 this suite, as all test cases use this file size while creating files for |
|
149 its test directory structure. Also note that the block sizes you are using |
|
150 while manipulating the file size as RFile write API tests are also affected. |
|
151 For example, if you are using a <codeph>blockSize</codeph> of 65536 bytes |
|
152 for <codeph>XLBytes</codeph>, ensure that the file size set is equal to or |
|
153 greater than 131072 bytes. As you cannot write 65536 bytes to a file that |
|
154 has a set size of less than (blockSize + blockSize). </p></note> </entry> |
|
155 </row> |
|
156 <row> |
|
157 <entry><p>XSBytes </p> </entry> |
|
158 <entry><p>Defines an integer number that represents a <codeph>blockSize</codeph> (in |
|
159 bytes) that can either be read into a file or written to a file. Modifying |
|
160 this value affects all RFile read test cases and all RFile write test cases. </p> <p> <b> XSBytes</b> represents |
|
161 an extra small number of bytes. By default, this value is 16 bytes. </p> </entry> |
|
162 </row> |
|
163 <row> |
|
164 <entry><p>SBytes </p> </entry> |
|
165 <entry><p>Defines an integer number that represents a blockSize in bytes that |
|
166 can either be read into a file or written to a file. Modifying this value |
|
167 affects all RFile read test cases and all RFile write test cases. </p> <p> <b> SBytes</b> represents |
|
168 a small number of bytes. By default, this value is 512 bytes. </p> </entry> |
|
169 </row> |
|
170 <row> |
|
171 <entry><p>MBytes </p> </entry> |
|
172 <entry><p>Defines an integer number that represents a blockSize in bytes that |
|
173 can either be read into a file or written to a file. Modifying this value |
|
174 affects all RFile read test cases and all RFile write test cases. </p> <p> <b> MBytes</b> represents |
|
175 a medium number of bytes. By default, this value is 512 bytes. </p> </entry> |
|
176 </row> |
|
177 <row> |
|
178 <entry><p>LBytes </p> </entry> |
|
179 <entry><p>Defines an integer number that represents a blockSize in bytes that |
|
180 can either be read into a file or written to a file. Modifying this value |
|
181 affects all RFile read test cases and all RFile write test cases. </p> <p> <b>LBytes</b> represents |
|
182 a large number of bytes. By default, this value is 32768 bytes. </p> </entry> |
|
183 </row> |
|
184 <row> |
|
185 <entry><p>XLBytes </p> </entry> |
|
186 <entry><p>Defines an integer number that represents a blockSize in bytes that |
|
187 can either be read into a file or written to a file. Modifying this value |
|
188 affects all RFile read test cases and all RFile write test cases. </p> <p> <b> XLBytes</b> represents |
|
189 an extra large number of bytes. By default, this value is 65536 bytes. </p> </entry> |
|
190 </row> |
|
191 </tbody> |
|
192 </tgroup> |
|
193 </table></conbody></concept> |