tests/regression/tools/filtering/test_valid_filter

   1 #!/bin/bash
   2 #
   3 # Copyright (C) - 2012 Christian Babeux <christian.babeux@efficios.com>
   4 #
   5 # This program is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License, version 2 only, as
   7 # published by the Free Software Foundation.
   8 #
   9 # This program is distributed in the hope that it will be useful, but WITHOUT
  10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12 # more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along with
  15 # this program; if not, write to the Free Software Foundation, Inc., 51
  16 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 TEST_DESC="Filtering - Valid filters"
  19
  20 CURDIR=$(dirname $0)/
  21 TESTDIR=$CURDIR/../../..
  22 LTTNG_BIN="lttng"
  23 STATS_BIN="$TESTDIR/utils/babelstats.pl"
  24 SESSION_NAME="valid_filter"
  25 NR_ITER=100
  26 NUM_GLOBAL_TESTS=2
  27 NUM_UST_TESTS=288
  28 NUM_KERNEL_TESTS=288
  29 NUM_TESTS=$(($NUM_UST_TESTS+$NUM_KERNEL_TESTS+$NUM_GLOBAL_TESTS))
  30
  31 source $TESTDIR/utils/utils.sh
  32
  33 function enable_lttng_event_filter()
  34 {
  35         domain="$1"
  36         sess_name="$2"
  37         event_name="$3"
  38         filter="$4"
  39
  40         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event $event_name \
  41                         -s $sess_name $domain --filter "$filter" 2>&1 >/dev/null
  42         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-context \
  43                         -s $sess_name $domain -t procname 2>&1 >/dev/null
  44
  45         ok $? "Enable lttng event with filtering"
  46 }
  47
  48 function run_ust
  49 {
  50         ./$CURDIR/$BIN_NAME $NR_ITER >/dev/null 2>&1
  51 }
  52
  53 function run_kernel
  54 {
  55         # Trigger the event for 100 iterations
  56         echo -n "100" > /proc/lttng-test-filter-event
  57 }
  58
  59 function test_valid_filter
  60 {
  61         domain_name="$1"
  62         domain="$2"
  63         event_name="$3"
  64         filter="$4"
  65         validator="$5"
  66
  67         diag "Test valid $domain_name filter: $filter"
  68
  69         trace_path=$(mktemp -d)
  70
  71         # Create session
  72         create_lttng_session_ok $SESSION_NAME $trace_path
  73
  74         # Enable filter
  75         enable_lttng_event_filter $domain $SESSION_NAME $event_name $filter
  76
  77         # Trace apps
  78         start_lttng_tracing_ok $SESSION_NAME
  79         run_$domain_name
  80         stop_lttng_tracing_ok $SESSION_NAME
  81
  82         # Destroy session
  83         destroy_lttng_session_ok $SESSION_NAME
  84
  85         stats=`babeltrace $trace_path | $STATS_BIN --tracepoint $event_name`
  86
  87         rm -rf $trace_path
  88
  89         $validator "$stats"
  90
  91         ok $? "Validate trace filter output"
  92
  93         rm -rf $trace_path
  94 }
  95
  96 function validate_min_max
  97 {
  98         stats="$1"
  99         field=$2
 100         expected_min=$3
 101         expected_max=$4
 102
 103         echo $stats | grep -q "$field $expected_min $expected_max"
 104
 105         return $?
 106 }
 107
 108 function validator_intfield
 109 {
 110         stats="$1"
 111         status=0
 112
 113         validate_min_max "$stats" "intfield" "1" "99"
 114         status=$(($status|$?))
 115
 116         validate_min_max "$stats" "intfield2" "0x1" "0x63"
 117         status=$(($status|$?))
 118
 119         validate_min_max "$stats" "longfield" "1" "99"
 120         status=$(($status|$?))
 121
 122         validate_min_max "$stats" "netintfield" "1" "99"
 123         status=$(($status|$?))
 124
 125         validate_min_max "$stats" "netintfieldhex" "0x1" "0x63"
 126         status=$(($status|$?))
 127
 128         if [ $KERNEL_CHECK -eq 0 ]; then
 129                 validate_min_max "$stats" "floatfield" "2222" "2222"
 130                 status=$(($status|$?))
 131
 132                 validate_min_max "$stats" "doublefield" "2" "2"
 133                 status=$(($status|$?))
 134         fi
 135
 136         return $status
 137 }
 138
 139 function validator_intfield_gt
 140 {
 141         stats="$1"
 142         status=0
 143
 144         validate_min_max "$stats" "intfield" "2" "99"
 145         status=$(($status|$?))
 146
 147         return $status
 148 }
 149
 150 function validator_has_no_event
 151 {
 152         stats="$1"
 153         status=0
 154
 155         validate_min_max "$stats" "intfield" "0" "99"
 156         status=$(($status|$?))
 157
 158         if [ $status -eq 0 ]; then
 159                 return 1
 160         else
 161                 return 0
 162         fi
 163 }
 164
 165 function validator_has_events
 166 {
 167         stats="$1"
 168         status=0
 169
 170         validate_min_max "$stats" "intfield" "0" "99"
 171         status=$(($status|$?))
 172
 173         return $status
 174 }
 175
 176 function validator_intfield_ge
 177 {
 178         stats="$1"
 179         status=0
 180
 181         validate_min_max "$stats" "intfield" "1" "99"
 182         status=$(($status|$?))
 183
 184         return $status
 185 }
 186
 187 function validator_intfield_lt
 188 {
 189         stats="$1"
 190         status=0
 191
 192         validate_min_max "$stats" "intfield" "0" "1"
 193         status=$(($status|$?))
 194
 195         return $status
 196 }
 197
 198 function validator_intfield_le
 199 {
 200         stats="$1"
 201         status=0
 202
 203         validate_min_max "$stats" "intfield" "0" "2"
 204         status=$(($status|$?))
 205
 206         return $status
 207 }
 208
 209 function validator_intfield_eq
 210 {
 211         stats="$1"
 212         status=0
 213
 214         validate_min_max "$stats" "intfield" "1" "1"
 215         status=$(($status|$?))
 216
 217         return $status
 218 }
 219
 220 function validator_intfield_ne
 221 {
 222         stats="$1"
 223         status=0
 224
 225         validate_min_max "$stats" "intfield" "0" "98"
 226         status=$(($status|$?))
 227
 228         return $status
 229 }
 230
 231 function validator_intfield_not
 232 {
 233         stats="$1"
 234         status=0
 235
 236         validate_min_max "$stats" "intfield" "0" "0"
 237         status=$(($status|$?))
 238
 239         return $status
 240 }
 241
 242 function validator_intfield_gt_and_longfield_gt
 243 {
 244         stats="$1"
 245         status=0
 246
 247         validate_min_max "$stats" "intfield" "43" "99"
 248         status=$(($status|$?))
 249         validate_min_max "$stats" "longfield" "43" "99"
 250         status=$(($status|$?))
 251
 252         return $status
 253 }
 254
 255 function validator_intfield_ge_and_longfield_le
 256 {
 257         stats="$1"
 258         status=0
 259
 260         validate_min_max "$stats" "intfield" "42" "42"
 261         status=$(($status|$?))
 262         validate_min_max "$stats" "longfield" "42" "42"
 263         status=$(($status|$?))
 264
 265         return $status
 266 }
 267
 268 function validator_intfield_lt_or_longfield_gt
 269 {
 270         stats="$1"
 271         status=0
 272
 273         validate_min_max "$stats" "intfield" "0" "99"
 274         status=$(($status|$?))
 275         validate_min_max "$stats" "longfield" "0" "99"
 276         status=$(($status|$?))
 277
 278         return $status
 279 }
 280
 281 function validator_mixed_str_or_int_and_int
 282 {
 283         stats="$1"
 284         status=0
 285
 286         validate_min_max "$stats" "intfield" "34" "99"
 287         status=$(($status|$?))
 288
 289         validate_min_max "$stats" "stringfield" "\"test\"" "\"test\""
 290         status=$(($status|$?))
 291
 292         return $status
 293 }
 294
 295 function validator_mixed_int_double
 296 {
 297         stats="$1"
 298         status=0
 299
 300         validate_min_max "$stats" "intfield" "0" "42"
 301         status=$(($status|$?))
 302
 303         return $status
 304 }
 305
 306 function validator_true_statement
 307 {
 308         stats="$1"
 309         status=0
 310
 311         validate_min_max "$stats" "intfield" "0" "99"
 312         status=$(($status|$?))
 313
 314         validate_min_max "$stats" "intfield2" "0x0" "0x63"
 315         status=$(($status|$?))
 316
 317         validate_min_max "$stats" "longfield" "0" "99"
 318         status=$(($status|$?))
 319
 320         validate_min_max "$stats" "netintfield" "0" "99"
 321         status=$(($status|$?))
 322
 323         validate_min_max "$stats" "netintfieldhex" "0x0" "0x63"
 324         status=$(($status|$?))
 325
 326         if [ $KERNEL_CHECK -eq 0 ]; then
 327                 validate_min_max "$stats" "floatfield" "2222" "2222"
 328                 status=$(($status|$?))
 329
 330                 validate_min_max "$stats" "doublefield" "2" "2"
 331                 status=$(($status|$?))
 332         fi
 333
 334         validate_min_max "$stats" "stringfield" "\"test\"" "\"test\""
 335         status=$(($status|$?))
 336
 337         validate_min_max "$stats" "stringfield2" ""\*"" ""\*""
 338         status=$(($status|$?))
 339
 340         return $status
 341 }
 342
 343 plan_tests $NUM_TESTS
 344
 345 print_test_banner "$TEST_DESC"
 346
 347 IFS=$'\n'
 348
 349 issue_356_filter="intfield > 0 && intfield > 1 && "
 350 issue_356_filter+="intfield > 2 && intfield > 3 && "
 351 issue_356_filter+="intfield > 4 && intfield > 5 && "
 352 issue_356_filter+="intfield > 6 && intfield > 7 && "
 353 issue_356_filter+="intfield > 8 || intfield > 0"
 354
 355 start_lttng_sessiond
 356
 357 ### UST TESTS
 358
 359 BIN_NAME="gen-ust-events"
 360
 361 # One to one mapping between filters and validators
 362
 363 UST_FILTERS=("intfield"                                                 #1
 364          "intfield > 1"                                                 #2
 365          "intfield >= 1"                                                #3
 366          "intfield < 2"                                                 #4
 367          "intfield <= 2"                                                #5
 368          "intfield == 1"                                                #6
 369          "intfield != 99"                                               #7
 370          "!intfield"                                                    #8
 371          "-intfield"                                                    #9
 372          "--intfield"                                                   #10
 373          "+intfield"                                                    #11
 374          "++intfield"                                                   #12
 375          "intfield > 1 && longfield > 42"                               #13
 376          "intfield >= 42 && longfield <= 42"                            #14
 377          "intfield < 1 || longfield > 98"                               #15
 378          "(stringfield == \"test\" || intfield != 10) && intfield > 33" #16
 379          "intfield < 42.4242424242"                                     #17
 380          "\"test\" == \"test\""                                         #18 #Issue #342
 381          "stringfield == \"test\""                                      #19
 382          "stringfield == \"t*\""                                        #20
 383          "stringfield == \"*\""                                         #21
 384          $issue_356_filter                                              #22 #Issue #356
 385          "intfield < 0xDEADBEEF"                                        #23
 386          "intfield < 0x2"                                               #24
 387          "intfield < 02"                                                #25
 388          "stringfield2 == \"\\\*\""                                     #26
 389          "1.0 || intfield || 1.0"                                       #27
 390          "1 < intfield"                                                 #28
 391          "\$ctx.vtid == 0"                                              #29
 392          "\$ctx.vtid != 0"                                              #30
 393          "0 == \$ctx.vtid"                                              #31
 394          "0 != \$ctx.vtid"                                              #32
 395          "\$ctx.vpid == 0"                                              #33
 396          "\$ctx.vpid != 0"                                              #34
 397          "0 == \$ctx.vpid"                                              #35
 398          "0 != \$ctx.vpid"                                              #36
 399          "\$ctx.procname != \"$BIN_NAME\""                              #37
 400          "\$ctx.procname == \"$BIN_NAME\""                              #38
 401          "\"$BIN_NAME\" != \$ctx.procname"                              #39
 402          "\"$BIN_NAME\" == \$ctx.procname"                              #40
 403          "\$ctx.procname != \"$BIN_NAME*\""                             #41
 404          "\$ctx.procname == \"$BIN_NAME*\""                             #42
 405          "\"$BIN_NAME*\" != \$ctx.procname"                             #43
 406          "\"$BIN_NAME*\" == \$ctx.procname"                             #44
 407          "\$ctx.procname != \"*\""                                      #45
 408          "\$ctx.procname == \"*\""                                      #46
 409          "\"*\" != \$ctx.procname"                                      #47
 410          "\"*\" == \$ctx.procname"                                      #48
 411 )
 412
 413 UST_FILTER_COUNT=${#UST_FILTERS[@]}
 414
 415 if [ ! -x "$CURDIR/$BIN_NAME" ]; then
 416         BAIL_OUT "No UST nevents binary detected."
 417 fi
 418
 419 UST_VALIDATOR=("validator_intfield"                 #1
 420            "validator_intfield_gt"                  #2
 421            "validator_intfield_ge"                  #3
 422            "validator_intfield_lt"                  #4
 423            "validator_intfield_le"                  #5
 424            "validator_intfield_eq"                  #6
 425            "validator_intfield_ne"                  #7
 426            "validator_intfield_not"                 #8
 427            "validator_intfield"                     #9
 428            "validator_intfield"                     #10
 429            "validator_intfield"                     #11
 430            "validator_intfield"                     #12
 431            "validator_intfield_gt_and_longfield_gt" #13
 432            "validator_intfield_ge_and_longfield_le" #14
 433            "validator_intfield_lt_or_longfield_gt"  #15
 434            "validator_mixed_str_or_int_and_int"     #16
 435            "validator_mixed_int_double"             #17
 436            "validator_true_statement"               #18
 437            "validator_true_statement"               #19
 438            "validator_true_statement"               #20
 439            "validator_true_statement"               #21
 440            "validator_intfield"                     #22
 441            "validator_true_statement"               #23
 442            "validator_intfield_lt"                  #24
 443            "validator_intfield_lt"                  #25
 444            "validator_true_statement"               #26
 445            "validator_true_statement"               #27
 446            "validator_intfield_gt"                  #28
 447            "validator_has_no_event"                 #29
 448            "validator_has_events"                   #30
 449            "validator_has_no_event"                 #31
 450            "validator_has_events"                   #32
 451            "validator_has_no_event"                 #33
 452            "validator_has_events"                   #34
 453            "validator_has_no_event"                 #35
 454            "validator_has_events"                   #36
 455            "validator_has_no_event"                 #36
 456            "validator_has_events"                   #37
 457            "validator_has_no_event"                 #38
 458            "validator_has_events"                   #39
 459            "validator_has_no_event"                 #41
 460            "validator_has_events"                   #42
 461            "validator_has_no_event"                 #43
 462            "validator_has_events"                   #44
 463            "validator_has_no_event"                 #45
 464            "validator_has_events"                   #46
 465            "validator_has_no_event"                 #47
 466            "validator_has_events"                   #48
 467 )
 468
 469 diag "Test UST valid filters"
 470
 471 KERNEL_CHECK=0
 472 i=0
 473 while [ "$i" -lt "$UST_FILTER_COUNT" ]; do
 474
 475         test_valid_filter ust -u "tp:tptest" "${UST_FILTERS[$i]}" "${UST_VALIDATOR[$i]}"
 476
 477         if [ $? -eq 1 ]; then
 478                 stop_lttng_sessiond
 479                 exit 1
 480         fi
 481
 482         let "i++"
 483 done
 484
 485
 486 ### KERNEL TESTS
 487
 488 BIN_NAME="test_valid_filt"      # Current script name truncated by kernel
 489
 490 # One to one mapping between filters and validators
 491
 492 KERNEL_FILTERS=("intfield"                                              #1
 493          "intfield > 1"                                                 #2
 494          "intfield >= 1"                                                #3
 495          "intfield < 2"                                                 #4
 496          "intfield <= 2"                                                #5
 497          "intfield == 1"                                                #6
 498          "intfield != 99"                                               #7
 499          "!intfield"                                                    #8
 500          "-intfield"                                                    #9
 501          "--intfield"                                                   #10
 502          "+intfield"                                                    #11
 503          "++intfield"                                                   #12
 504          "intfield > 1 && longfield > 42"                               #13
 505          "intfield >= 42 && longfield <= 42"                            #14
 506          "intfield < 1 || longfield > 98"                               #15
 507          "(stringfield == \"test\" || intfield != 10) && intfield > 33" #16
 508          "intfield < 42.4242424242"                                     #17
 509          "\"test\" == \"test\""                                         #18 #Issue #342
 510          "stringfield == \"test\""                                      #19
 511          "stringfield == \"t*\""                                        #20
 512          "stringfield == \"*\""                                         #21
 513          $issue_356_filter                                              #22 #Issue #356
 514          "intfield < 0xDEADBEEF"                                        #23
 515          "intfield < 0x2"                                               #24
 516          "intfield < 02"                                                #25
 517          "stringfield2 == \"\\\*\""                                     #26
 518          "1.0 || intfield || 1.0"                                       #27
 519          "1 < intfield"                                                 #28
 520          "\$ctx.vtid == 0"                                              #29
 521          "\$ctx.vtid != 0"                                              #30
 522          "0 == \$ctx.vtid"                                              #31
 523          "0 != \$ctx.vtid"                                              #32
 524          "\$ctx.vpid == 0"                                              #33
 525          "\$ctx.vpid != 0"                                              #34
 526          "0 == \$ctx.vpid"                                              #35
 527          "0 != \$ctx.vpid"                                              #36
 528          "\$ctx.procname != \"$BIN_NAME\""                              #37
 529          "\$ctx.procname == \"$BIN_NAME\""                              #38
 530          "\"$BIN_NAME\" != \$ctx.procname"                              #39
 531          "\"$BIN_NAME\" == \$ctx.procname"                              #40
 532          "\$ctx.procname != \"$BIN_NAME*\""                             #41
 533          "\$ctx.procname == \"$BIN_NAME*\""                             #42
 534          "\"$BIN_NAME*\" != \$ctx.procname"                             #43
 535          "\"$BIN_NAME*\" == \$ctx.procname"                             #44
 536          "\$ctx.procname != \"*\""                                      #45
 537          "\$ctx.procname == \"*\""                                      #46
 538          "\"*\" != \$ctx.procname"                                      #47
 539          "\"*\" == \$ctx.procname"                                      #48
 540 )
 541
 542 KERNEL_FILTER_COUNT=${#KERNEL_FILTERS[@]}
 543
 544 KERNEL_VALIDATOR=("validator_intfield"              #1
 545            "validator_intfield_gt"                  #2
 546            "validator_intfield_ge"                  #3
 547            "validator_intfield_lt"                  #4
 548            "validator_intfield_le"                  #5
 549            "validator_intfield_eq"                  #6
 550            "validator_intfield_ne"                  #7
 551            "validator_intfield_not"                 #8
 552            "validator_intfield"                     #9
 553            "validator_intfield"                     #10
 554            "validator_intfield"                     #11
 555            "validator_intfield"                     #12
 556            "validator_intfield_gt_and_longfield_gt" #13
 557            "validator_intfield_ge_and_longfield_le" #14
 558            "validator_intfield_lt_or_longfield_gt"  #15
 559            "validator_mixed_str_or_int_and_int"     #16
 560            "validator_has_no_event"                 #17 #Unsupported by kernel
 561            "validator_true_statement"               #18
 562            "validator_true_statement"               #19
 563            "validator_true_statement"               #20
 564            "validator_true_statement"               #21
 565            "validator_intfield"                     #22
 566            "validator_true_statement"               #23
 567            "validator_intfield_lt"                  #24
 568            "validator_intfield_lt"                  #25
 569            "validator_true_statement"               #26
 570            "validator_has_no_event"                 #27 #Unsupported by kernel
 571            "validator_intfield_gt"                  #28
 572            "validator_has_no_event"                 #29
 573            "validator_has_events"                   #30
 574            "validator_has_no_event"                 #31
 575            "validator_has_events"                   #32
 576            "validator_has_no_event"                 #33
 577            "validator_has_events"                   #34
 578            "validator_has_no_event"                 #35
 579            "validator_has_events"                   #36
 580            "validator_has_no_event"                 #36
 581            "validator_has_events"                   #37
 582            "validator_has_no_event"                 #38
 583            "validator_has_events"                   #39
 584            "validator_has_no_event"                 #41
 585            "validator_has_events"                   #42
 586            "validator_has_no_event"                 #43
 587            "validator_has_events"                   #44
 588            "validator_has_no_event"                 #45
 589            "validator_has_events"                   #46
 590            "validator_has_no_event"                 #47
 591            "validator_has_events"                   #48
 592 )
 593
 594 if [ "$(id -u)" == "0" ]; then
 595         isroot=1
 596 else
 597         isroot=0
 598 fi
 599
 600 skip $isroot "Root access is needed. Skipping all kernel valid filter tests." $NUM_KERNEL_TESTS ||
 601 {
 602         diag "Test kernel valid filters"
 603
 604         KERNEL_CHECK=1
 605         modprobe lttng-test
 606         i=0
 607         while [ "$i" -lt "$KERNEL_FILTER_COUNT" ]; do
 608
 609                 test_valid_filter kernel -k "lttng_test_filter_event" \
 610                                 "${KERNEL_FILTERS[$i]}" "${KERNEL_VALIDATOR[$i]}"
 611
 612                 if [ $? -eq 1 ]; then
 613                         stop_lttng_sessiond
 614                         exit 1
 615                 fi
 616
 617                 let "i++"
 618         done
 619         rmmod lttng-test
 620 }
 621
 622 stop_lttng_sessiond