1BLTK(1)                      Battery life tool kit                     BLTK(1)
2
3
4

NAME

6       bltk  -  tool kit is used to measure battery life and performance under
7       different workloads on Linux.
8

SYNOPSIS

10       bltk [-hVvaNAcCBXswiIRPOYZyQzxul] [-t sec] [-r results_dir] [-m  {0,1}]
11       [-U  path]  [-g setup] [-J pid] [-T time] [-F file] [-W app] [-L title]
12       [-K comment] [-e app] [-E app] [-p percent] [-d percent]  [-o  {0,1,2}]
13       [-q file] [-b percent] [-f command] [-k num]
14

DESCRIPTION

16       The BLTK can be used with various workloads to simulate different types
17       of laptop usage.  The following workloads are currently implemented:
18
19              Idle workload
20                     collect statistics only (mostly used to  measure  battery
21                     life)
22
23              Reader workload
24                     simulates  text reading on laptop (mostly used to measure
25                     battery life)
26
27              Playback workload
28                     simulates laptop entertaining  usage  (produces  constant
29                     average load on the system)
30
31              Office Activity workload
32                     simulates  laptop  usage  for different office activities
33                     (based on OpenOffice.org office suit)
34
35       When started, test collects platform/OS initial info  and  if  it's  OK
36       prompts  user  to  unplug  AC  adapter. After cable unplugged, workload
37       started. During the workload execution test  harness  collects  various
38       system  information  (e.g.  CPU load, battery drain, display state, CPU
39       frequency, etc...). After battery  completely  discharged  user  should
40       plug  the  AC  cable  back  and  boot  the system.  When it is done the
41       results are available.
42
43       There are several tools for  result  evaluation.  They  allow  creating
44       report  file  for  test  run, to gather results into a table for system
45       comparison, and to draw graphs for different purposes.
46
47       Results - after the battery  dies  and  the  system  booted  back,  the
48       results are available. They are stored in 'bltk/<wokload_name>.results'
49       directory (or in the directory, specified  in  -r  option).  If  target
50       directory already exist the tool will add numeric extension to its name
51       (.001, .002 e.t.c.) The results consist of  the  following  files  (see
52       below for detailed description):
53
54       cmd    In this file 'bltk' command with arguments are stored
55
56       infoi<N>.log (info1.log, info2.log, ...)
57              Here   initial   system   info  is  stored.  Another  two  files
58              (info1.log, info2.log) contains system info after AC adapter was
59              unplugged, and on 5% battery capacity remained. They are used to
60              check whether any changes occurred during test execution.
61
62       stat.log
63              Statistics generated  by  bltk  harness  are  stored  here.  One
64              statistic line generated per 1 minute (or per number of seconds,
65              specified in -t option).
66
67       system<N>
68              When -k 1 is used, the system information is stored  under  this
69              directory.  The  numbers  at  the end of directory name have the
70              following meanings:
71
72              0      initial system info
73
74              1      system info after AC adapter was unplugged
75
76              2      system info on 5% battery capacity remained
77
78       version
79              this file contains version information
80
81       workload
82              the file contains info about workload
83
84       work_out.log
85
86       err.log
87              There are stored any error messages
88
89       warning.log
90              Contains warnings
91
92       work.log
93              Strings generated by USR1, USR2 signals  from  workload.  String
94              format is the same as in the 'stat.log' file.
95
96       fail   when test fails
97
98       score
99
100       Report
101
102       Report.table
103

OPTIONS

105       -h, --help
106              Help; display a help message and then exits.
107
108       -V, --version
109              Version; display version number and then exits.
110
111       -v, --verbose
112              Verbose
113
114       -a, --ac-ignore
115              ignore ac adapter state check (on/off)
116
117       -N, --time-stat-ignore
118              disable time statistics
119
120       -A, --ac-stat-ignore
121              disable ac adapter statistics
122
123       -c, --cpu-stat-ignore
124              disable cpu load statistics
125
126       -C, --cpu-add-stat-ignore
127              disable cpu additional statistics
128
129       -B, --bat-stat-ignore
130              disable battery statistics
131
132       -X, --disp-stat-ignore
133              Disable display state statistics
134
135       -H, --hd-stat-ignore
136              disable hard drive state statistics
137
138       -t seconds, --report-time seconds
139              frequency of report line generation in seconds
140
141       -r results_dir, --results results_dir
142              name of results directory
143
144       -s, --stat-ignore
145              disable all statistics
146
147       -w, --work-stat-ignore
148              disable workload statistics
149
150       -m {0,1}, --stat-memory {0,1}
151              dump  statistics  directly on disk or keep in memory, if statisā€
152              tics are kept in memory, it will be  dumped    on  disk  at  low
153              battery capacity, or at the test end
154
155              0      disk
156
157              1      memory (by default)
158
159       -i, --idle-test
160              idle test
161
162       -I, --idle
163              idle workload
164
165       -R, --reader
166              reader workload
167
168       -P, --player
169              playback workload
170
171       -O, --office
172              office productivity workload
173
174       -U path, --user path
175              user-specified workload (path to executable)
176
177       -g routine, --user-init routine"
178              setup routines for user-specified workload
179
180       -Y, --discharging
181              battery discharge mode
182
183       -Z, --charging
184              battery charge mode
185
186       -J pid, --jobs pid
187              make jobs number
188
189       -T seconds, --time seconds
190              workload time
191
192       -F, --file
193              workload file
194
195       -W, --prog
196              workload  program       name of player (player workload, default
197              'mplayer')      name of web-browser  (reader  workload,  default
198              'firefox')
199
200       -L, --title
201              title of web-browser document
202
203       -M, --manufacturer
204              enable time and cpu load statistics only
205
206       -S, --show
207              demo/debug mode, one iteration only
208
209       -n, --show-num
210              demo/debug mode, 'show-num' iteration
211
212       -j, --show-cnt
213              demo/debug mode, 'show-cnt' sub iteration
214
215       -T seconds, --show-time seconds
216              demo/debug mode, debug time
217
218       -K comment, --comment comment
219              user comment for report
220
221       -e application, --init-prog application
222              run program before test starting
223
224       -E application, --init-prog-su application
225              run program as root before test starting
226
227       -y, --yes
228              auto 'yes' answer to all questions
229
230       -Q, --debug
231              debug workload (see cpu-load and disp-load below)
232
233       -p percent, --cpu-load percent
234              debug workload, the time cpu loaded in percent
235
236       -d percent, --disp-load percent
237              Debug workload, the time display on in percent
238
239       -o {0,1,2}, --output {0,1,2}
240              direct workload output:
241
242              0      file
243
244              1      file and console
245
246              2      /dev/null, other - console
247
248       -z, --debug-vars
249              debug option
250
251       -q file, --debug-vars-file file
252              debug option - debug variables file
253
254       -x, --dpms
255              debug option - try to use display power management
256
257       -u, --spy
258              debug option - try to find out unexpected system activity
259
260       -l, --simul-laptop
261              debug option, laptop simulation
262
263       -b percent, --bat-sync percent
264              debug option, battery critical capacity, default 5%
265
266       -f command, --user-field command
267              the  output  of user-specified command being added to statistics
268              Example:      -f "cat /proc/acpi/thermal_zone/TZ01/temperature |
269              awk '{print }'"
270
271       -k num, --stat-system num
272              debug option, save system files, default 0
273

EXAMPLES

275       bltk -I or --idle
276              idle workload running
277
278       bltk -R or --reader
279              reader workload running
280
281       bltk -O or --office
282              office workload running
283
284       bltk -P or --player
285              player workload running
286
287       bltk -i or --idle-test -T 60 -t 1
288              idle test running for 60 seconds, stats interval 1 second
289

SEE ALSO

291       bltk.conf(5), bltk_report(1)
292

AUTHOR

294       Konstantin Karasyov   <konstantin.a.karasyov@intel.com>
295       Vladimir Lebedev      <vladimir.p.lebedev@intel.com>
296
297
298
299BLTK                             15 July 2008                          BLTK(1)
Impressum