1 #
2 # Config file for ktest.pl
3 #
4 # Place your customized version of this, in th
5 # ktest.pl is run from. By default, ktest.pl w
6 # called "ktest.conf", but you can name it any
7 # the name of your config file as the first ar
8 #
9 # Note, all paths must be absolute
10 #
11
12 # Options set in the beginning of the file are
13 # default options. These options can be overri
14 # options, with the following exceptions:
15 #
16 # LOG_FILE
17 # CLEAR_LOG
18 # POWEROFF_ON_SUCCESS
19 # REBOOT_ON_SUCCESS
20 #
21 # Test specific options are set after the labe
22 #
23 # TEST_START
24 #
25 # The options after a TEST_START label are spe
26 # Each TEST_START label will set up a new test
27 # perform a test more than once, you can add t
28 # to it followed by the number of times you wa
29 # to iterate. If the ITERATE is left off, the
30 # be performed once.
31 #
32 # TEST_START ITERATE 10
33 #
34 # You can skip a test by adding SKIP (before o
35 # and number)
36 #
37 # TEST_START SKIP
38 #
39 # TEST_START SKIP ITERATE 10
40 #
41 # TEST_START ITERATE 10 SKIP
42 #
43 # The SKIP label causes the options and the te
44 # This is useful to set up several different t
45 # only enabling the ones you want to use for a
46 #
47 # You can add default options anywhere in the
48 # with the DEFAULTS tag. This allows you to ha
49 # after the test options to keep the test opti
50 # of the file. You can even place the DEFAULTS
51 # test cases (but not in the middle of a singl
52 #
53 # TEST_START
54 # MIN_CONFIG = /home/test/config-test1
55 #
56 # DEFAULTS
57 # MIN_CONFIG = /home/test/config-default
58 #
59 # TEST_START ITERATE 10
60 #
61 # The above will run the first test with MIN_C
62 # /home/test/config-test-1. Then 10 tests will
63 # with MIN_CONFIG with /home/test/config-defau
64 #
65 # You can also disable defaults with the SKIP
66 #
67 # DEFAULTS SKIP
68 # MIN_CONFIG = /home/test/config-use-sometimes
69 #
70 # DEFAULTS
71 # MIN_CONFIG = /home/test/config-most-times
72 #
73 # The above will ignore the first MIN_CONFIG.
74 # use the first MIN_CONFIG, remove the SKIP fr
75 # DEFAULTS tag and add it to the second. Be ca
76 # may only be declared once per test or defaul
77 # the same option name under the same test or
78 # ktest will fail to execute, and no tests wil
79 #
80 # DEFAULTS OVERRIDE
81 #
82 # Options defined in the DEFAULTS section can
83 # even if they are defined in two different DE
84 # This is done to catch mistakes where an opti
85 # the previous option was forgotten about and
86 #
87 # The OVERRIDE keyword can be added to a secti
88 # section to override other DEFAULT sections v
89 # been defined previously. It will only overri
90 # have been defined before its use. Options de
91 # in a non override section will still error.
92 # can not be defined in the same section even
93 # is marked OVERRIDE.
94 #
95 #
96 #
97 # Both TEST_START and DEFAULTS sections can al
98 # The value after the IF must evaluate into a
99 # integer, and can use the config variables (e
100 #
101 # DEFAULTS IF ${IS_X86_32}
102 #
103 # The above will process the DEFAULTS section
104 # variable IS_X86_32 evaluates to a non zero p
105 # otherwise if it evaluates to zero, it will a
106 # as if the SKIP keyword was used.
107 #
108 # The ELSE keyword can be used directly after
109 # a IF statement.
110 #
111 # TEST_START IF ${RUN_NET_TESTS}
112 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
113 #
114 # ELSE
115 #
116 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
117 #
118 #
119 # The ELSE keyword can also contain an IF stat
120 # if then else sections. But all the sections
121 # DEFAULT or TEST_START, they can not be a mix
122 #
123 # TEST_START IF ${RUN_NET_TESTS}
124 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
125 #
126 # ELSE IF ${RUN_DISK_TESTS}
127 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
128 #
129 # ELSE IF ${RUN_CPU_TESTS}
130 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
131 #
132 # ELSE
133 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
134 #
135 # The if statement may also have comparisons t
136 # == and !=, strings may be used for both side
137 #
138 # BOX_TYPE := x86_32
139 #
140 # DEFAULTS IF ${BOX_TYPE} == x86_32
141 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
142 # ELSE
143 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-
144 #
145 # The DEFINED keyword can be used by the IF st
146 # It returns true if the given config variable
147 # or false otherwise.
148 #
149 #
150 # DEFAULTS IF DEFINED USE_CC
151 # CC := ${USE_CC}
152 # ELSE
153 # CC := gcc
154 #
155 #
156 # As well as NOT DEFINED.
157 #
158 # DEFAULTS IF NOT DEFINED MAKE_CMD
159 # MAKE_CMD := make ARCH=x86
160 #
161 #
162 # And/or ops (&&,||) may also be used to make
163 #
164 # TEST_START IF (DEFINED ALL_TESTS || ${MYTEST
165 #
166 # Notice the use of parentheses. Without any p
167 # processed the same as:
168 #
169 # TEST_START IF DEFINED ALL_TESTS || (${MYTEST
170 #
171 #
172 #
173 # INCLUDE file
174 #
175 # The INCLUDE keyword may be used in DEFAULT s
176 # read another config file and process that fi
177 # file can include other files, add new test c
178 # statements. Config variables will be passed
179 # to config variables will be seen by top leve
180 # a file is processed just like the contents o
181 # into the top level file, except, that includ
182 # TEST_START sections will have that section e
183 # the include file. That is, an included file
184 # by another DEFAULT keyword.
185 #
186 # Unlike other files referenced in this config
187 # to be absolute. If the file does not start w
188 # that the current config file was located in
189 # given name is found there, then the current
190 #
191 # INCLUDE myfile
192 # DEFAULT
193 #
194 # is the same as:
195 #
196 # INCLUDE myfile
197 #
198 # Note, if the include file does not contain a
199 # searched first by the location of the origin
200 # by the location that ktest.pl was executed i
201 #
202
203 #### Config variables ####
204 #
205 # This config file can also contain "config va
206 # These are assigned with ":=" instead of the
207 # assignment "=".
208 #
209 # The difference between ktest options and con
210 # is that config variables can be used multipl
211 # where each instance will override the previo
212 # And that they only live at time of processin
213 #
214 # The advantage to config variables are that t
215 # by any option or any other config variables
216 # that you may use over and over again in the
217 #
218 # For example:
219 #
220 # USER := root
221 # TARGET := mybox
222 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/
223 #
224 # TEST_START
225 # MIN_CONFIG = config1
226 # TEST = ${TEST_CASE}
227 #
228 # TEST_START
229 # MIN_CONFIG = config2
230 # TEST = ${TEST_CASE}
231 #
232 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/
233 #
234 # TEST_START
235 # MIN_CONFIG = config1
236 # TEST = ${TEST_CASE}
237 #
238 # TEST_START
239 # MIN_CONFIG = config2
240 # TEST = ${TEST_CASE}
241 #
242 # TEST_DIR := /home/me/test
243 #
244 # BUILD_DIR = ${TEST_DIR}/linux.git
245 # OUTPUT_DIR = ${TEST_DIR}/test
246 #
247 # Note, the config variables are evaluated imm
248 # updating TARGET after TEST_CASE has been ass
249 # to TEST_CASE.
250 #
251 # As shown in the example, to evaluate a confi
252 # use the ${X} convention. Simple $X will not
253 #
254 # If the config variable does not exist, the $
255 # be evaluated. Thus:
256 #
257 # MAKE_CMD = PATH=/mypath:${PATH} make
258 #
259 # If PATH is not a config variable, then the $
260 # the MAKE_CMD option will be evaluated by the
261 # the MAKE_CMD option is passed into shell pro
262 #
263 # Shell commands can also be inserted with the
264 # expression. Note, this is case sensitive, th
265 # will not work.
266 #
267 # HOSTNAME := ${shell hostname}
268 # DEFAULTS IF "${HOSTNAME}" == "frodo"
269 #
270
271 #### Using options in other options ####
272 #
273 # Options that are defined in the config file
274 # by other options. All options are evaluated
275 # use (except that config variables are evalua
276 # processing time).
277 #
278 # If an ktest option is used within another op
279 # typing it again in that option you can simpl
280 # just like you can config variables.
281 #
282 # MACHINE = mybox
283 #
284 # TEST = ssh root@${MACHINE} /path/to/test
285 #
286 # The option will be used per test case. Thus:
287 #
288 # TEST_TYPE = test
289 # TEST = ssh root@{MACHINE}
290 #
291 # TEST_START
292 # MACHINE = box1
293 #
294 # TEST_START
295 # MACHINE = box2
296 #
297 # For both test cases, MACHINE will be evaluat
298 # of the test case. The first test will run ss
299 # and the second will run ssh root@box2.
300
301 #### Mandatory Default Options ####
302
303 # These options must be in the default section
304 # may be overridden by test options.
305
306 # The machine hostname that you will test
307 #MACHINE = target
308
309 # The box is expected to have ssh on normal bo
310 # (most likely root, since you need privilege
311 #SSH_USER = root
312
313 # The directory that contains the Linux source
314 #BUILD_DIR = /home/test/linux.git
315
316 # The directory that the objects will be built
317 # (can not be same as BUILD_DIR)
318 #OUTPUT_DIR = /home/test/build/target
319
320 # The location of the compiled file to copy to
321 # (relative to OUTPUT_DIR)
322 #BUILD_TARGET = arch/x86/boot/bzImage
323
324 # The place to put your image on the test mach
325 #TARGET_IMAGE = /boot/vmlinuz-test
326
327 # A script or command to reboot the box
328 #
329 # Here is a digital loggers power switch examp
330 #POWER_CYCLE = wget --no-proxy -O /dev/null -q
331 #
332 # Here is an example to reboot a virtual box o
333 # with the name "Guest".
334 #POWER_CYCLE = virsh destroy Guest; sleep 5; v
335
336 # The script or command that reads the console
337 #
338 # If you use ttywatch server, something like
339 #CONSOLE = nc -d localhost 3001
340 #
341 # For a virtual machine with guest name "Guest
342 #CONSOLE = virsh console Guest
343
344 # Signal to send to kill console.
345 # ktest.pl will create a child process to moni
346 # When the console is finished, ktest will kil
347 # with this signal.
348 # (default INT)
349 #CLOSE_CONSOLE_SIGNAL = HUP
350
351 # Required version ending to differentiate the
352 # from other linux builds on the system.
353 #LOCALVERSION = -test
354
355 # For REBOOT_TYPE = grub2, you must specify wh
356 # file is. This is the file that is searched t
357 # option to boot to with GRUB_REBOOT
358 #GRUB_FILE = /boot/grub2/grub.cfg
359
360 # The tool for REBOOT_TYPE = grub2 or grub2bls
361 # to boot into (one shot mode).
362 # (default grub2_reboot)
363 #GRUB_REBOOT = grub2_reboot
364
365 # The grub title name for the test kernel to b
366 # (Only mandatory if REBOOT_TYPE = grub or gru
367 #
368 # Note, ktest.pl will not update the grub menu
369 # manually add an option for the test. ktest.p
370 # the grub menu.lst for this option to find wh
371 # reboot into.
372 #
373 # For example, if in the /boot/grub/menu.lst t
374 # title Test Kernel
375 # kernel vmlinuz-test
376 #
377 # For grub2, a search of top level "menuentry"
378 # submenu is searched. The menu is found by se
379 # contents of GRUB_MENU in the line that start
380 # You may want to include the quotes around th
381 # for: menuentry 'Test Kernel'
382 # do a: GRUB_MENU = 'Test Kernel'
383 # For customizing, add your entry in /etc/grub
384 #
385 # For grub2bls, a search of "title"s are done.
386 # by searching for the contents of GRUB_MENU i
387 # with "title".
388 #
389 #GRUB_MENU = Test Kernel
390
391 # For REBOOT_TYPE = syslinux, the name of the
392 # (on the target) to use to set up the next re
393 # test kernel.
394 # (default extlinux)
395 #SYSLINUX = syslinux
396
397 # For REBOOT_TYPE = syslinux, the path that is
398 # syslinux command where syslinux is installed
399 # (default /boot/extlinux)
400 #SYSLINUX_PATH = /boot/syslinux
401
402 # For REBOOT_TYPE = syslinux, the syslinux lab
403 # test kernel in the syslinux config file.
404 # (default undefined)
405 #SYSLINUX_LABEL = "test-kernel"
406
407 # A script to reboot the target into the test
408 # This and SWITCH_TO_TEST are about the same,
409 # SWITCH_TO_TEST is run even for REBOOT_TYPE =
410 # This may be left undefined.
411 # (default undefined)
412 #REBOOT_SCRIPT =
413
414 #### Optional Config Options (all have default
415
416 # Email options for receiving notifications. U
417 # the specified mailer prior to using this fea
418 #
419 # (default undefined)
420 #MAILTO =
421 #
422 # Supported mailers: sendmail, mail, mailx
423 # (default sendmail)
424 #MAILER = sendmail
425 #
426 # The executable to run
427 # (default: for sendmail "/usr/sbin/sendmail",
428 #MAIL_EXEC = /usr/sbin/sendmail
429 #
430 # The command used to send mail, which uses th
431 # can be modified. By default if the mailer is
432 # MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n
433 # For mail or mailx:
434 # MAIL_COMMAND = "$MAIL_PATH/$MAILER -s \'$SU
435 # ktest.pl will do the substitution for MAIL_P
436 # it sends the mail if "$FOO" format is use
437 # then the substitutions will occur at the
438 # But note, MAIL_PATH and MAILER require be
439 # ${MAIL_PATH} or ${MAILER} are used, but
440 #MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$M
441 #
442 # Errors are defined as those would terminate
443 # (default 1)
444 #EMAIL_ON_ERROR = 1
445 # (default 1)
446 #EMAIL_WHEN_FINISHED = 1
447 # (default 0)
448 #EMAIL_WHEN_STARTED = 1
449 #
450 # Users can cancel the test by Ctrl^C
451 # (default 0)
452 #EMAIL_WHEN_CANCELED = 1
453 #
454 # If a test ends with an error and EMAIL_ON_ER
455 # as a LOG_FILE is defined, then the log of th
456 # be included in the email that is sent.
457 # It is possible that the log may be very larg
458 # only the last amount of the log should be se
459 # much of the log is sent, set MAIL_MAX_SIZE.
460 # size in bytes of the last portion of the log
461 # test file. That is, if this is set to 100000
462 # last 100 thousand bytes of the log file will
463 # the email.
464 # (default undef)
465 #MAIL_MAX_SIZE = 1000000
466
467 # Start a test setup. If you leave this off, a
468 # will be default and the test will run once.
469 # This is a label and not really an option (it
470 # You can append ITERATE and a number after it
471 # test a number of times, or SKIP to ignore th
472 #
473 #TEST_START
474 #TEST_START ITERATE 5
475 #TEST_START SKIP
476
477 # Have the following options as default again.
478 # have already been defined by TEST_START. Opt
479 # just define all default options before the f
480 # and you do not need this option.
481 #
482 # This is a label and not really an option (it
483 # You can append SKIP to this label and the op
484 # section will be ignored.
485 #
486 # DEFAULTS
487 # DEFAULTS SKIP
488
489 # If you want to execute some command before t
490 # you can set this option. Note, it can be set
491 # or an option in the first test case. All oth
492 # ignore it. If both the default and first tes
493 # set, then the first test will take precedenc
494 #
495 # default (undefined)
496 #PRE_KTEST = ${SSH} ~/set_up_test
497
498 # If you want to execute some command after al
499 # completed, you can set this option. Note, it
500 # default or any test case can override it. If
501 # set this option, then the last test case tha
502 # precedence
503 #
504 # default (undefined)
505 #POST_KTEST = ${SSH} ~/dismantle_test
506
507 # If you want to remove the kernel entry in Bo
508 # environment, use kernel-install command.
509 # Here's the example:
510 #POST_KTEST = ssh root@Test "/usr/bin/kernel-i
511
512 # The default test type (default test)
513 # The test types may be:
514 # build - only build the kernel, do nothin
515 # install - build and install, but do nothin
516 # boot - build, install, and boot the ker
517 # test - build, boot and if TEST is set,
518 # (If TEST is not set, it defaults ba
519 # bisect - Perform a bisect on the kernel (s
520 # patchcheck - Do a test on a series of comm
521 #TEST_TYPE = test
522
523 # Test to run if there is a successful boot an
524 # Must exit with 0 on success and non zero on
525 # default (undefined)
526 #TEST = ssh user@machine /root/run_test
527
528 # The build type is any make config type or sp
529 # (default oldconfig)
530 # nobuild - skip the clean and build step
531 # useconfig:/path/to/config - use the given
532 # oldconfig on it.
533 # This option is ignored if TEST_TYPE is patch
534 #BUILD_TYPE = randconfig
535
536 # The make command (default make)
537 # If you are building a 32bit x86 on a 64 bit
538 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i
539
540 # Any build options for the make of the kernel
541 # (default "")
542 #BUILD_OPTIONS = -j20
543
544 # If you need to do some special handling befo
545 # you can add a script with this option.
546 # The environment variable KERNEL_VERSION will
547 # kernel version that is used.
548 #
549 # default (undefined)
550 #PRE_INSTALL = ssh user@target rm -rf '/lib/mo
551
552 # If you need an initrd, you can add a script
553 # it. The environment variable KERNEL_VERSION
554 # kernel version that is used. Remember to add
555 # to your grub menu.lst file.
556 #
557 # Here's a couple of examples to use:
558 #POST_INSTALL = ssh user@target /sbin/mkinitrd
559 #
560 # or on some systems:
561 #POST_INSTALL = ssh user@target /sbin/dracut -
562
563 # If you want to add the kernel entry in Boot
564 # environment, use kernel-install command.
565 # Here's the example:
566 #POST_INSTALL = ssh root@Test "/usr/bin/kernel
567
568 # If for some reason you just want to boot the
569 # want the test to install anything new. For e
570 # to boot test the same kernel over and over a
571 # the hassle of installing anything, you can s
572 # (default 0)
573 #NO_INSTALL = 1
574
575 # If there is a command that you want to run b
576 # case executes, then you can set this option
577 #
578 # default (undefined)
579 #PRE_TEST = ${SSH} reboot_to_special_kernel
580
581 # To kill the entire test if PRE_TEST is defin
582 # to 1.
583 # (default 0)
584 #PRE_TEST_DIE = 1
585
586 # If there is a command you want to run after
587 # completes, then you can set this option.
588 #
589 # default (undefined)
590 #POST_TEST = cd ${BUILD_DIR}; git reset --hard
591
592 # If there is a script that you require to run
593 # you can specify it with PRE_BUILD.
594 #
595 # One example may be if you must add a tempora
596 # fix a unrelated bug to perform a patchcheck
597 # patch before each build that is made. Use th
598 # to remove the patch.
599 #
600 # (default undef)
601 #PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /t
602
603 # To specify if the test should fail if the PR
604 # PRE_BUILD_DIE needs to be set to 1. Otherwis
605 # result is ignored.
606 # (default 0)
607 # PRE_BUILD_DIE = 1
608
609 # If there is a script that should run after t
610 # you can specify it with POST_BUILD.
611 #
612 # As the example in PRE_BUILD, POST_BUILD can
613 # made by the PRE_BUILD.
614 #
615 # (default undef)
616 #POST_BUILD = cd ${BUILD_DIR} && git reset --h
617
618 # To specify if the test should fail if the PO
619 # POST_BUILD_DIE needs to be set to 1. Otherwi
620 # result is ignored.
621 # (default 0)
622 #POST_BUILD_DIE = 1
623
624 # Way to reboot the box to the test kernel.
625 # Only valid options so far are "grub", "grub2
626 # (default grub)
627 # If you specify grub, it will assume grub ver
628 # and will search in /boot/grub/menu.lst for t
629 # and select that target to reboot to the kern
630 # your setup, then specify "script" and have a
631 # specified in REBOOT_SCRIPT to boot to the ta
632 #
633 # For REBOOT_TYPE = grub2, you must define bot
634 # GRUB_FILE.
635 #
636 # For REBOOT_TYPE = grub2bls, you must define
637 #
638 # For REBOOT_TYPE = syslinux, you must define
639 # perhaps modify SYSLINUX (default extlinux) a
640 # (default /boot/extlinux)
641 #
642 # The entry in /boot/grub/menu.lst must be ent
643 # The test will not modify that file.
644 #REBOOT_TYPE = grub
645
646 # If you are using a machine that doesn't boot
647 # perhaps gets its kernel from a remote server
648 # you can use this option to update the target
649 # test image.
650 #
651 # You could also do the same with POST_INSTALL
652 # between that option and this option is that
653 # after the install, where this one runs just
654 # (default undefined)
655 #SWITCH_TO_TEST = cp ${OUTPUT_DIR}/${BUILD_TAR
656
657 # If you are using a machine that doesn't boot
658 # perhaps gets its kernel from a remote server
659 # you can use this option to update the target
660 # the known good image to reboot safely back i
661 #
662 # This option holds a command that will execut
663 # to reboot to a good known image.
664 # (default undefined)
665 #SWITCH_TO_GOOD = ssh ${SSH_USER}/${MACHINE} c
666
667 # The min config that is needed to build for t
668 # A nice way to create this is with the follow
669 #
670 # $ ssh target
671 # $ lsmod > mymods
672 # $ scp mymods host:/tmp
673 # $ exit
674 # $ cd linux.git
675 # $ rm .config
676 # $ make LSMOD=mymods localyesconfig
677 # $ grep '^CONFIG' .config > /home/test/conf
678 #
679 # If you want even less configs:
680 #
681 # log in directly to target (do not ssh)
682 #
683 # $ su
684 # # lsmod | cut -d' ' -f1 | xargs rmmod
685 #
686 # repeat the above several times
687 #
688 # # lsmod > mymods
689 # # reboot
690 #
691 # May need to reboot to get your network back
692 # to the host, and then remove the previous .c
693 # localyesconfig again. The CONFIG_MIN generat
694 # not guarantee network activity to the box so
695 # test may fail.
696 #
697 # You might also want to set:
698 # CONFIG_CMDLINE="<your options here>"
699 # randconfig may set the above and override y
700 # line options.
701 # (default undefined)
702 #MIN_CONFIG = /home/test/config-min
703
704 # Sometimes there's options that just break th
705 # you do not care about. Here are a few:
706 # # CONFIG_STAGING is not set
707 # Staging drivers are horrible, and can break
708 # # CONFIG_SCSI_DEBUG is not set
709 # SCSI_DEBUG may change your root partition
710 # # CONFIG_KGDB_SERIAL_CONSOLE is not set
711 # KGDB may cause oops waiting for a connectio
712 # This option points to the file containing co
713 # to the MIN_CONFIG (or be the MIN_CONFIG if i
714 #
715 # Note, config options in MIN_CONFIG will over
716 #
717 # (default undefined)
718 #ADD_CONFIG = /home/test/config-broken
719
720 # The location on the host where to write temp
721 # (default /tmp/ktest/${MACHINE})
722 #TMP_DIR = /tmp/ktest/${MACHINE}
723
724 # Optional log file to write the status (recom
725 # Note, this is a DEFAULT section only option
726 # (default undefined)
727 #LOG_FILE = /home/test/logfiles/target.log
728
729 # Remove old logfile if it exists before start
730 # Note, this is a DEFAULT section only option
731 # (default 0)
732 #CLEAR_LOG = 0
733
734 # Line to define a successful boot up in conso
735 # This is what the line contains, not the enti
736 # the entire line to match, then use regular e
737 # (do not add any quotes around it)
738 #
739 # SUCCESS_LINE = ^MyBox Login:$
740 #
741 # (default "login:")
742 #SUCCESS_LINE = login:
743
744 # To speed up between reboots, defining a line
745 # default kernel produces that represents that
746 # kernel has successfully booted and can be us
747 # a new test kernel to it. Otherwise ktest.pl
748 # SLEEP_TIME to continue.
749 # (default undefined)
750 #REBOOT_SUCCESS_LINE = login:
751
752 # In case the console constantly fills the scr
753 # a specified time to stop the test after succ
754 # (in seconds)
755 # (default 10)
756 #STOP_AFTER_SUCCESS = 10
757
758 # In case the console constantly fills the scr
759 # a specified time to stop the test after fail
760 # (in seconds)
761 # (default 60)
762 #STOP_AFTER_FAILURE = 60
763
764 # In case the console constantly fills the scr
765 # a specified time to stop the test if it neve
766 # is recommended.
767 # Note: this is ignored if a success or failur
768 # (in seconds)
769 # (default 600, -1 is to never stop)
770 #STOP_TEST_AFTER = 600
771
772 # Stop testing if a build fails. If set, the s
773 # a failure is detected, otherwise it will sav
774 # dmesg and bootlog in a directory called
775 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhh
776 # if the STORE_FAILURES directory is set.
777 # (default 1)
778 # Note, even if this is set to zero, there are
779 # stop the tests.
780 #DIE_ON_FAILURE = 1
781
782 # Directory to store failure directories on fa
783 # set, DIE_ON_FAILURE=0 will not save off the
784 # bootlog. This option is ignored if DIE_ON_FA
785 # (default undefined)
786 #STORE_FAILURES = /home/test/failures
787
788 # Directory to store success directories on su
789 # set, the .config, dmesg and bootlog will not
790 # test succeeds.
791 # (default undefined)
792 #STORE_SUCCESSES = /home/test/successes
793
794 # Build without doing a make mrproper, or remo
795 # (default 0)
796 #BUILD_NOCLEAN = 0
797
798 # As the test reads the console, after it hits
799 # the time it waits for the monitor to settle
800 # can usually be lowered.
801 # (in seconds) (default 1)
802 #BOOTED_TIMEOUT = 1
803
804 # The timeout in seconds when we consider the
805 # the console stop producing output. Be sure t
806 # time here to get pass a reboot. Some machine
807 # any console output for a long time during a
808 # not want the test to fail just because the s
809 # the process of rebooting to the test kernel.
810 # (default 120)
811 #TIMEOUT = 120
812
813 # The timeout in seconds when to test if the b
814 # or not. Before issuing the reboot command, a
815 # is attempted to see if the target machine is
816 # If the target does not connect within this t
817 # is issued instead of a reboot.
818 # CONNECT_TIMEOUT = 25
819
820 # The timeout in seconds for how long to wait
821 # to timeout. If not defined, it will let it g
822 # (default undefined)
823 #RUN_TIMEOUT = 600
824
825 # In between tests, a reboot of the box may oc
826 # is the time to wait for the console after it
827 # output. Some machines may not produce a larg
828 # so this should accommodate it.
829 # The difference between this and TIMEOUT, is
830 # when rebooting to the test kernel. This slee
831 # after a test has completed and we are about
832 # another test. If a reboot to the reliable ke
833 # we wait SLEEP_TIME for the console to stop p
834 # before starting the next test.
835 #
836 # You can speed up reboot times even more by s
837 # (default 60)
838 #SLEEP_TIME = 60
839
840 # The time in between bisects to sleep (in sec
841 # (default 60)
842 #BISECT_SLEEP_TIME = 60
843
844 # The max wait time (in seconds) for waiting f
845 # If for some reason, the console is outputtin
846 # ever finishing, this will cause ktest to get
847 # option is the max time ktest will wait for t
848 # to settle down before continuing.
849 # (default 1800)
850 #MAX_MONITOR_WAIT
851
852 # The time in between patch checks to sleep (i
853 # (default 60)
854 #PATCHCHECK_SLEEP_TIME = 60
855
856 # Reboot the target box on error (default 0)
857 #REBOOT_ON_ERROR = 0
858
859 # Power off the target on error (ignored if RE
860 # Note, this is a DEFAULT section only option
861 # (default 0)
862 #POWEROFF_ON_ERROR = 0
863
864 # Power off the target after all tests have co
865 # Note, this is a DEFAULT section only option
866 # (default 0)
867 #POWEROFF_ON_SUCCESS = 0
868
869 # Reboot the target after all test completed s
870 # (ignored if POWEROFF_ON_SUCCESS is set)
871 #REBOOT_ON_SUCCESS = 1
872
873 # In case there are issues with rebooting, you
874 # to always powercycle after this amount of ti
875 # reboot.
876 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT d
877 # makes it powercycle immediately after reboot
878 # it if you do not want it.
879 # (default undefined)
880 #POWERCYCLE_AFTER_REBOOT = 5
881
882 # In case there's issues with halting, you can
883 # to always poweroff after this amount of time
884 # halt.
885 # Note, POWEROFF_AFTER_HALT = 0 does NOT disab
886 # makes it poweroff immediately after halting.
887 # it if you do not want it.
888 # (default undefined)
889 #POWEROFF_AFTER_HALT = 20
890
891 # A script or command to power off the box (de
892 # Needed for POWEROFF_ON_ERROR and SUCCESS
893 #
894 # Example for digital loggers power switch:
895 #POWER_OFF = wget --no-proxy -O /dev/null -q
896 #
897 # Example for a virtual guest call "Guest".
898 #POWER_OFF = virsh destroy Guest
899
900 # To have the build fail on "new" warnings, cr
901 # contains a list of all known warnings (they
902 # to the line with 'warning:', 'error:' or 'Er
903 # WARNINGS_FILE is set, then that file will be
904 # build detects a warning, it will examine thi
905 # warning does not exist in it, it will fail t
906 #
907 # Note, if this option is defined to a file th
908 # then any warning will fail the build.
909 # (see make_warnings_file below)
910 #
911 # (optional, default undefined)
912 #WARNINGS_FILE = ${OUTPUT_DIR}/warnings_file
913
914 # The way to execute a command on the target
915 # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND
916 # The variables SSH_USER, MACHINE and SSH_COMM
917 #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAN
918
919 # The way to copy a file to the target (instal
920 # (default scp $SRC_FILE $SSH_USER@$MACHINE:$D
921 # The variables SSH_USER, MACHINE are defined
922 # SRC_FILE and DST_FILE are ktest internal var
923 # should only have '$' and not the '${}' notat
924 # (default scp $SRC_FILE ${SSH_USER}@${MACHINE
925 #SCP_TO_TARGET = echo skip scp for $SRC_FILE $
926
927 # If install needs to be different than module
928 # option will override the SCP_TO_TARGET for i
929 # (default ${SCP_TO_TARGET} )
930 #SCP_TO_TARGET_INSTALL = scp $SRC_FILE tftp@tf
931
932 # The nice way to reboot the target
933 # (default ssh $SSH_USER@$MACHINE reboot)
934 # The variables SSH_USER and MACHINE are defin
935 #REBOOT = ssh $SSH_USER@$MACHINE reboot
936
937 # The return code of REBOOT
938 # (default 255)
939 #REBOOT_RETURN_CODE = 255
940
941 # The way triple faults are detected is by tes
942 # banner. If the kernel banner for the kernel
943 # found, and then later a kernel banner for an
944 # is found, it is considered that we encounter
945 # and there is no panic or callback, but simpl
946 # To disable this (because it did a false posi
947 # to 0.
948 # (default 1)
949 #DETECT_TRIPLE_FAULT = 0
950
951 # All options in the config file should be eit
952 # or could be used within a value of another o
953 # in the config file is not used, ktest will w
954 # if you want to continue.
955 #
956 # If you don't care if there are non-used opti
957 # option. Be careful though, a non-used option
958 # of an option name being typed incorrectly.
959 # (default 0)
960 #IGNORE_UNUSED = 1
961
962 # When testing a kernel that happens to have W
963 # traces, ktest.pl will detect these and fail
964 # due to warnings. By setting this option, kte
965 # call traces, and will not fail a test if the
966 # an oops. Use this option with care.
967 # (default 0)
968 #IGNORE_ERRORS = 1
969
970 #### Per test run options ####
971 # The following options are only allowed in TE
972 # They are ignored in the DEFAULTS sections.
973 #
974 # All of these are optional and undefined by d
975 # some of these options are required for TEST
976 # and bisect.
977 #
978 #
979 # CHECKOUT = branch
980 #
981 # If the BUILD_DIR is a git repository, then
982 # to checkout the given branch before running
983 # specify this for the first run, that branch
984 # all preceding tests until a new CHECKOUT is
985 #
986 #
987 # TEST_NAME = name
988 #
989 # If you want the test to have a name that is
990 # the test result banner at the end of the te
991 # option. This is useful to search for the RE
992 # not have to translate a test number to a te
993 #
994 # For TEST_TYPE = patchcheck
995 #
996 # This expects the BUILD_DIR to be a git repo
997 # will checkout the PATCHCHECK_START commit.
998 #
999 # The option BUILD_TYPE will be ignored.
1000 #
1001 # The MIN_CONFIG will be used for all builds
1002 # used for patchcheck is oldconfig.
1003 #
1004 # PATCHCHECK_START is required and is the fi
1005 # test (the SHA1 of the commit). You may al
1006 # that git checkout allows (branch name, ta
1007 #
1008 # PATCHCHECK_END is the last patch to check
1009 #
1010 # PATCHCHECK_CHERRY if set to non zero, then
1011 # performed against PATCHCHECK_START and
1012 #
1013 # git cherry ${PATCHCHECK_START} ${PATCH
1014 #
1015 # Then the changes found will be tested.
1016 #
1017 # Note, PATCHCHECK_CHERRY requires PATCH
1018 # (default 0)
1019 #
1020 # PATCHCHECK_TYPE is required and is the typ
1021 # build, boot, test.
1022 #
1023 # Note, the build test will look for warnin
1024 # in a file that a commit touches, the bu
1025 # IGNORE_WARNINGS is set for the given co
1026 #
1027 # IGNORE_WARNINGS can be used to disable th
1028 # on a particular commit (SHA1). You can
1029 # by adding a list of SHA1s that are spac
1030 #
1031 # If BUILD_NOCLEAN is set, then make mrprop
1032 # any of the builds, just like all other TE
1033 # what makes patchcheck different from the
1034 # BUILD_NOCLEAN is not set, only the first
1035 # make mrproper. This helps speed up the te
1036 #
1037 # Example:
1038 # TEST_START
1039 # TEST_TYPE = patchcheck
1040 # CHECKOUT = mybranch
1041 # PATCHCHECK_TYPE = boot
1042 # PATCHCHECK_START = 747e94ae3d1b4c9bf5380e
1043 # PATCHCHECK_END = HEAD~2
1044 # IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f
1045 #
1046 #
1047 #
1048 # For TEST_TYPE = bisect
1049 #
1050 # You can specify a git bisect if the BUILD_
1051 # The MIN_CONFIG will be used for all builds
1052 # used for bisecting is oldconfig.
1053 #
1054 # The option BUILD_TYPE will be ignored.
1055 #
1056 # BISECT_TYPE is the type of test to perform
1057 # build - bad fails to build
1058 # boot - bad builds but fails to boo
1059 # test - bad boots but fails a test
1060 #
1061 # BISECT_GOOD is the commit (SHA1) to label a
1062 # BISECT_BAD is the commit to label as bad (a
1063 #
1064 # The above three options are required for a
1065 #
1066 # BISECT_REPLAY = /path/to/replay/file (optio
1067 #
1068 # If an operation failed in the bisect that
1069 # fail. Then the test ends. The state of th
1070 # left off at where the failure occurred. Y
1071 # reason for the failure, and perhaps even
1072 # that would work to continue with. You can
1073 #
1074 # git bisect log > /path/to/replay/file
1075 #
1076 # The adding:
1077 #
1078 # BISECT_REPLAY= /path/to/replay/file
1079 #
1080 # And running the test again. The test will
1081 # git bisect start, git bisect good, and g
1082 # then it will run git bisect replay on th
1083 # continuing with the bisect.
1084 #
1085 # BISECT_START = commit (optional, default un
1086 #
1087 # As with BISECT_REPLAY, if the test failed
1088 # just happen to have a bad commit in the m
1089 # and you need to skip it. If BISECT_START
1090 # will checkout that commit after doing the
1091 # git bisect good, git bisect bad, and runn
1092 # if the BISECT_REPLAY is set.
1093 #
1094 # BISECT_SKIP = 1 (optional, default 0)
1095 #
1096 # If BISECT_TYPE is set to test but the bui
1097 # simply fail the test and end their. You c
1098 # and BISECT_START to resume after you foun
1099 # or you could set BISECT_SKIP to 1. If BIS
1100 # when something other than the BISECT_TYPE
1101 # run "git bisect skip" and try again.
1102 #
1103 # BISECT_FILES = <path> (optional, default un
1104 #
1105 # To just run the git bisect on a specific
1106 # For example:
1107 #
1108 # BISECT_FILES = arch/x86 kernel/time
1109 #
1110 # Will run the bisect with "git bisect star
1111 #
1112 # BISECT_REVERSE = 1 (optional, default 0)
1113 #
1114 # In those strange instances where it was b
1115 # and you are trying to find where it start
1116 # Set BISECT_GOOD to the commit that was la
1117 # Set BISECT_BAD to the commit that is know
1118 # With BISECT_REVERSE = 1, The test will co
1119 # good, and success as bad.
1120 #
1121 # BISECT_MANUAL = 1 (optional, default 0)
1122 #
1123 # In case there's a problem with automating
1124 # whatever reason. (Can't reboot, want to i
1125 # Doing a BISECT_MANUAL will have the test
1126 # tell it if the test passed or failed afte
1127 # This is basically the same as running git
1128 # but ktest will rebuild and install the ke
1129 #
1130 # BISECT_CHECK = 1 (optional, default 0)
1131 #
1132 # Just to be sure the good is good and bad
1133 # BISECT_CHECK to 1 will start the bisect b
1134 # out BISECT_BAD and makes sure it fails, t
1135 # out BISECT_GOOD and makes sure it succeed
1136 # the bisect (it works for BISECT_REVERSE t
1137 #
1138 # You can limit the test to just check BISE
1139 # BISECT_BAD with BISECT_CHECK = good or
1140 # BISECT_CHECK = bad, respectively.
1141 #
1142 # BISECT_TRIES = 5 (optional, default 1)
1143 #
1144 # For those cases that it takes several tri
1145 # the BISECT_TRIES is useful. It is the num
1146 # test is ran before it says the kernel is
1147 # will stop trying and mark the current SHA
1148 #
1149 # Note, as with all race bugs, there's no g
1150 # it succeeds, it is really a good bisect.
1151 # the bug is some what reliable.
1152 #
1153 # You can set BISECT_TRIES to zero, and all
1154 # good, unless you also set BISECT_MANUAL.
1155 #
1156 # BISECT_RET_GOOD = 0 (optional, default unde
1157 #
1158 # In case the specificed test returns somet
1159 # 0 for good, and non-zero for bad, you can
1160 # good by defining BISECT_RET_GOOD.
1161 #
1162 # BISECT_RET_BAD = 1 (optional, default undef
1163 #
1164 # In case the specificed test returns somet
1165 # 0 for good, and non-zero for bad, you can
1166 # bad by defining BISECT_RET_BAD.
1167 #
1168 # BISECT_RET_ABORT = 255 (optional, default u
1169 #
1170 # If you need to abort the bisect if the te
1171 # that was wrong, you can define BISECT_RET
1172 # code returned by the test in order to abo
1173 #
1174 # BISECT_RET_SKIP = 2 (optional, default unde
1175 #
1176 # If the test detects that the current comm
1177 # nor bad, but something else happened (ano
1178 # you can specify BISECT_RET_SKIP to an err
1179 # test returns when it should skip the curr
1180 #
1181 # BISECT_RET_DEFAULT = good (optional, defaul
1182 #
1183 # You can override the default of what to d
1184 # options are not hit. This may be one of,
1185 # "abort" or "skip" (without the quotes).
1186 #
1187 # Note, if you do not define any of the pre
1188 # and define BISECT_RET_DEFAULT, all bisect
1189 # what the BISECT_RET_DEFAULT has.
1190 #
1191 #
1192 # Example:
1193 # TEST_START
1194 # TEST_TYPE = bisect
1195 # BISECT_GOOD = v2.6.36
1196 # BISECT_BAD = b5153163ed580e00c67bdfecb02b
1197 # BISECT_TYPE = build
1198 # MIN_CONFIG = /home/test/config-bisect
1199 #
1200 #
1201 #
1202 # For TEST_TYPE = config_bisect
1203 #
1204 # In those cases that you have two different
1205 # work, the other does not, and you do not k
1206 # the problem.
1207 # The TEST_TYPE config_bisect will bisect th
1208 # what config causes the failure.
1209 #
1210 # The way it works is this:
1211 #
1212 # You can specify a good config with CONFIG
1213 # will use the MIN_CONFIG, and if that's no
1214 # the config that comes with "make defconfi
1215 #
1216 # It runs both the good and bad configs thr
1217 # make sure that they are set up for the ke
1218 #
1219 # It then reads the configs that are set, a
1220 # not set for both the good and bad configs
1221 # It will set half of the good configs with
1222 # "set" means to make the bad config match
1223 # in the good config that is off, will be t
1224 # config. That is considered a "set").
1225 #
1226 # It tests this new config and if it works,
1227 # config, otherwise it becomes the new bad
1228 # process until there's only one config lef
1229 # config.
1230 #
1231 # The "bad config" can also be a config tha
1232 # disabled because it depended on something
1233 #
1234 # During this process, it saves the current
1235 # ${TMP_DIR}/good_config and ${TMP_DIR}/bad
1236 # If you stop the test, you can copy them t
1237 # reuse them again.
1238 #
1239 # Although the MIN_CONFIG may be the config
1240 # MIN_CONFIG is ignored.
1241 #
1242 # The option BUILD_TYPE will be ignored.
1243 #
1244 # CONFIG_BISECT_TYPE is the type of test to
1245 # build - bad fails to build
1246 # boot - bad builds but fails to boo
1247 # test - bad boots but fails a test
1248 #
1249 # CONFIG_BISECT is the config that failed to
1250 #
1251 # If BISECT_MANUAL is set, it will pause bet
1252 # This is useful to use just ktest.pl just f
1253 # If you set it to build, it will run the bi
1254 # control what happens in between iterations
1255 # the test succeeded or not and continue the
1256 #
1257 # CONFIG_BISECT_GOOD (optional)
1258 # If you have a good config to start with, t
1259 # can specify it with CONFIG_BISECT_GOOD. Ot
1260 # the MIN_CONFIG is the base, if MIN_CONFIG
1261 # It will build a config with "make defconfi
1262 #
1263 # CONFIG_BISECT_CHECK (optional)
1264 # Set this to 1 if you want to confirm that
1265 # generates (the bad config with the min con
1266 # It may be that the min config fixes what b
1267 # and the test will not return a result.
1268 # Set it to "good" to test only the good con
1269 # to "bad" to only test the bad config.
1270 #
1271 # CONFIG_BISECT_EXEC (optional)
1272 # The config bisect is a separate program th
1273 # By default, it will look for:
1274 # `pwd`/config-bisect.pl # the location kt
1275 # If it does not find it there, it will look
1276 # `dirname <ktest.pl>`/config-bisect.pl #
1277 # If it does not find it there, it will look
1278 # ${BUILD_DIR}/tools/testing/ktest/config-
1279 # Setting CONFIG_BISECT_EXEC will override w
1280 #
1281 # Example:
1282 # TEST_START
1283 # TEST_TYPE = config_bisect
1284 # CONFIG_BISECT_TYPE = build
1285 # CONFIG_BISECT = /home/test/config-bad
1286 # MIN_CONFIG = /home/test/config-min
1287 # BISECT_MANUAL = 1
1288 #
1289 #
1290 #
1291 # For TEST_TYPE = make_min_config
1292 #
1293 # After doing a make localyesconfig, your ke
1294 # not be the most useful minimum configurati
1295 # config that you can use against other conf
1296 # someone else has a config that breaks on y
1297 # those configurations that are truly requir
1298 # will give you less of a chance that one of
1299 # will make the bug go away. This will give
1300 # be able to reproduce the reported bug matc
1301 #
1302 # Note, this does take some time, and may re
1303 # test over night, or perhaps over the weeke
1304 # you to interrupt it, and gives you the cur
1305 # that was found till that time.
1306 #
1307 # Note, this test automatically assumes a BU
1308 # and its test type acts like boot.
1309 # TODO: add a test version that makes the co
1310 # boot, like having network access.
1311 #
1312 # To save time, the test does not just grab
1313 # it. The Kconfig files are examined to dete
1314 # of the configs. If a config is chosen that
1315 # config, that config will be checked first.
1316 # parents first, we can eliminate whole grou
1317 # may have been enabled.
1318 #
1319 # For example, if a USB device config is cho
1320 # the CONFIG_USB will be tested before the d
1321 # found not to be needed, it, as well as all
1322 # it, will be disabled and removed from the
1323 #
1324 # OUTPUT_MIN_CONFIG is the path and filename
1325 # be created from the MIN_CONFIG. If you in
1326 # this file as your new min config, and use
1327 # This file does not need to exist on start
1328 # This file is not created until a config i
1329 # If this file exists, you will be prompted
1330 # as the min_config (overriding MIN_CONFIG)
1331 # is not defined.
1332 # (required field)
1333 #
1334 # START_MIN_CONFIG is the config to use to s
1335 # you can set this as the same OUTPUT_MIN_C
1336 # the OUTPUT_MIN_CONFIG file must exist.
1337 # (default MIN_CONFIG)
1338 #
1339 # IGNORE_CONFIG is used to specify a config
1340 # you already know must be set. Configs are
1341 # been tested and proved to be required. It
1342 # file if you intend on interrupting the te
1343 # it left off. New configs that it finds wi
1344 # and will not be tested again in later run
1345 # (optional)
1346 #
1347 # MIN_CONFIG_TYPE can be either 'boot' or 't
1348 # test if the created config can just boot
1349 # set to 'test', then the TEST option must
1350 # config will not only boot the target, but
1351 # config lets the test succeed. This is use
1352 # config that is generated allows network a
1353 # (optional)
1354 #
1355 # USE_OUTPUT_MIN_CONFIG set this to 1 if you
1356 # about using the OUTPUT_MIN_CONFIG as the
1357 # point. Set it to 0 if you want to always
1358 # If it is not defined, it will prompt you
1359 # to start with (MIN_CONFIG or OUTPUT_MIN_C
1360 #
1361 # Example:
1362 #
1363 # TEST_TYPE = make_min_config
1364 # OUTPUT_MIN_CONFIG = /path/to/config-new-mi
1365 # START_MIN_CONFIG = /path/to/config-min
1366 # IGNORE_CONFIG = /path/to/config-tested
1367 # MIN_CONFIG_TYPE = test
1368 # TEST = ssh ${USER}@${MACHINE} echo hi
1369 #
1370 #
1371 #
1372 #
1373 # For TEST_TYPE = make_warnings_file
1374 #
1375 # If you want the build to fail when a new wa
1376 # you set the WARNINGS_FILE to point to a fil
1377 #
1378 # The test "make_warnings_file" will let you
1379 # file before you run other tests, like patch
1380 #
1381 # What this test does is to run just a build,
1382 # specify BUILD_TYPE to tell the test what ty
1383 # A BUILD_TYPE of nobuild will fail this test
1384 #
1385 # The test will do the build and scan for all
1386 # it discovers will be saved in the WARNINGS_
1387 #
1388 # It is recommended (but not necessary) to ma
1389 # off, so that a full build is done (make mrp
1390 # That way, all warnings will be captured.
1391 #
1392 # Example:
1393 #
1394 # TEST_TYPE = make_warnings_file
1395 # WARNINGS_FILE = ${OUTPUT_DIR}
1396 # BUILD_TYPE = useconfig:oldconfig
1397 # CHECKOUT = v3.8
1398 # BUILD_NOCLEAN = 0
1399 #
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.