gdb/testsuite/gdb.python/python.exp

   1 # Copyright (C) 2008-2017 Free Software Foundation, Inc.
   2
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 3 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 # This file is part of the GDB testsuite.  It tests the mechanism
  17 # exposing values to Python.
  18
  19 load_lib gdb-python.exp
  20
  21 standard_testfile python.c python-1.c
  22
  23 if {[build_executable $testfile.exp $testfile \
  24          [list $srcfile $srcfile2] debug] == -1} {
  25     return -1
  26 }
  27
  28 # Start with a fresh gdb.
  29 gdb_exit
  30 gdb_start
  31 gdb_reinitialize_dir $srcdir/$subdir
  32
  33 set remote_source2_py [gdb_remote_download host \
  34                            ${srcdir}/${subdir}/source2.py]
  35
  36 # Do this instead of the skip_python_check.
  37 # We want to do some tests when Python is not present.
  38 gdb_test_multiple "python print (23)" "verify python support" {
  39     -re "not supported.*$gdb_prompt $"  {
  40       unsupported "python support is disabled"
  41
  42       # If Python is not supported, verify that sourcing a python script
  43       # causes an error.
  44       gdb_test "source $remote_source2_py" \
  45           "Error in sourced command file:.*" \
  46           "source source2.py when python disabled"
  47
  48       # Verify multi-line python commands cause an error.
  49       gdb_py_test_multiple "multi-line python command" \
  50           "python" "" \
  51           "print (23)" "" \
  52           "end" "not supported.*"
  53
  54       return -1
  55     }
  56     -re "$gdb_prompt $" {}
  57 }
  58
  59 gdb_py_test_multiple "multi-line python command" \
  60   "python" "" \
  61   "print (23)" "" \
  62   "end" "23"
  63
  64 # Spawn interactive Python help from a multi-line command, thus, after
  65 # a secondary prompt.
  66
  67 with_test_prefix "python interactive help" {
  68     set test "python; help(); end"
  69     gdb_test_multiple "python\nhelp()\nend" $test {
  70         -re ".*help utility.*help> $" {
  71             pass $test
  72
  73             # The "quit" must be seen on the output.  A buggy GDB
  74             # would not display it.
  75             gdb_test "quit" "^quit.*leaving help.*" "quit help"
  76         }
  77     }
  78 }
  79
  80 gdb_py_test_multiple "show python command" \
  81   "define zzq" "Type commands for definition of .* just \"end\"\\.*" \
  82   "python" "" \
  83   "print (23)" "" \
  84   "end" "" \
  85   "end" "" \
  86   "show user zzq" "User command \"zzq\":.*  python.*print \\(23\\).*  end"
  87
  88 gdb_py_test_multiple "indented multi-line python command" \
  89   "python" "" \
  90   "def foo ():" "" \
  91   "  print ('hello, world!')" "" \
  92   "foo ()" "" \
  93   "end" "hello, world!"
  94
  95 gdb_test "source $remote_source2_py" "yes" "source source2.py"
  96
  97 gdb_test "source -s source2.py" "yes" "source -s source2.py"
  98
  99 set remote_source2_symlink_notpy \
 100     [gdb_remote_download host ${srcdir}/${subdir}/source2.py \
 101          [standard_output_file "source2-symlink.notpy"]]
 102 set remote_source2_symlink_py [standard_output_file "source2-symlink.py"]
 103 remote_file host delete $remote_source2_symlink_py
 104 set status [remote_exec host "ln -sf $remote_source2_symlink_notpy $remote_source2_symlink_py"]
 105 set test "source -s source2-symlink.py"
 106 if {[lindex $status 0] == 0} {
 107     gdb_test "source -s $remote_source2_symlink_py" "yes" $test
 108 } else {
 109     unsupported "$test (host does not support symbolic links)"
 110 }
 111
 112 gdb_test "python print (gdb.current_objfile())" "None"
 113 gdb_test "python print (gdb.objfiles())" "\\\[\\\]"
 114
 115 # Test http://bugs.python.org/issue4434 workaround in configure.ac
 116 gdb_test "python import itertools; print ('IMPOR'+'TED')" "IMPORTED" "pythonX.Y/lib-dynload/*.so"
 117
 118 gdb_test_no_output \
 119     "python x = gdb.execute('printf \"%d\", 23', to_string = True)"
 120 gdb_test "python print (x)" "23"
 121
 122 # Test post_event.
 123 gdb_py_test_multiple "post event insertion" \
 124   "python" "" \
 125   "someVal = 0" "" \
 126   "class Foo(object):" "" \
 127   "  def __call__(self):" "" \
 128   "    global someVal" "" \
 129   "    someVal += 1" "" \
 130   "gdb.post_event(Foo())" "" \
 131   "end" ""
 132
 133 gdb_test "python print (someVal)" "1" "test post event execution"
 134 gdb_test "python gdb.post_event(str(1))" "RuntimeError: Posted event is not callable.*" "test non callable class"
 135
 136 # Test (no) pagination of the executed command.
 137 gdb_test "show height" {Number of lines gdb thinks are in a page is unlimited\.}
 138 set lines 10
 139 gdb_test_no_output "set height $lines"
 140
 141 set test "verify pagination beforehand"
 142 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
 143     -re "---Type <return>" {
 144         exp_continue
 145     }
 146     -re " to continue, or q <return>" {
 147         exp_continue
 148     }
 149     -re " to quit---$" {
 150         pass $test
 151     }
 152 }
 153 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination beforehand: q"
 154
 155 gdb_test "python if gdb.execute('python print (\"\\\\n\" * $lines)', to_string=True) == \"\\n\" * [expr $lines + 1]: print (\"yes\")" "yes" "gdb.execute does not page"
 156
 157 set test "verify pagination afterwards"
 158 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
 159     -re "---Type <return>" {
 160         exp_continue
 161     }
 162     -re " to continue, or q <return>" {
 163         exp_continue
 164     }
 165     -re " to quit---$" {
 166         pass $test
 167     }
 168 }
 169 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination afterwards: q"
 170
 171 gdb_test_no_output "set height 0"
 172
 173 gdb_test_no_output "python a = gdb.execute('help', to_string=True)" "collect help from uiout"
 174
 175 gdb_test "python print (a)" ".*aliases -- Aliases of other commands.*" "verify help to uiout"
 176
 177 # Test PR 12212, using InfThread.selected_thread() when no inferior is
 178 # loaded.
 179 gdb_py_test_silent_cmd "python nothread = gdb.selected_thread()" "Attempt to aquire thread with no inferior" 1
 180 gdb_test "python print (nothread == None)" "True" "ensure that no threads are returned"
 181
 182 gdb_py_test_multiple "register atexit function" \
 183     "python" "" \
 184     "import atexit" "" \
 185     "def printit(arg):" "" \
 186     "  print (arg)" "" \
 187     "atexit.register(printit, 'good bye world')" "" \
 188     "end" ""
 189
 190 send_gdb "quit\n"
 191 gdb_expect {
 192     -re "good bye world" {
 193         pass "atexit handling"
 194     }
 195     default {
 196         fail "atexit handling"
 197     }
 198 }
 199
 200 # Start with a fresh gdb.
 201 clean_restart ${testfile}
 202
 203 # The following tests require execution.
 204
 205 if ![runto_main] then {
 206     fail "can't run to main"
 207     return 0
 208 }
 209
 210 set lineno [gdb_get_line_number "Break to end."]
 211 runto $lineno
 212
 213 # Test gdb.decode_line.
 214 gdb_test "python gdb.decode_line(\"main.c:43\")" \
 215     "gdb.error: No source file named main.c.*" "test decode_line no source named main"
 216
 217 gdb_py_test_silent_cmd "python symtab = gdb.decode_line()" "test decode_line current location" 1
 218 gdb_test "python print (len(symtab))" "2" "test decode_line current location"
 219 gdb_test "python print (symtab\[0\])" "None" "test decode_line expression parse"
 220 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line current location"
 221
 222 if { [is_remote host] } {
 223     set python_c [string_to_regexp "python.c"]
 224 } else {
 225     set python_c [string_to_regexp "gdb.python/python.c"]
 226 }
 227 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "test decode_line current location filename"
 228 gdb_test "python print (symtab\[1\]\[0\].line)" "$lineno" "test decode_line current location line number"
 229
 230 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"python.c:26 if foo\")" "test decode_line python.c:26" 1
 231 gdb_test "python print (len(symtab))" "2" "test decode_line python.c:26 length"
 232 gdb_test "python print (symtab\[0\])" "if foo" "test decode_line expression parse"
 233 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line python.c:26 length"
 234 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "test decode_line python.c:26 filename"
 235 gdb_test "python print (symtab\[1\]\[0\].line)" "26" "test decode_line python.c:26 line number"
 236
 237 gdb_test "python gdb.decode_line(\"randomfunc\")" \
 238     "gdb.error: Function \"randomfunc\" not defined.*" "test decode_line randomfunc"
 239 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"func1\")" "test decode_line func1()" 1
 240 gdb_test "python print (len(symtab))" "2" "test decode_line func1 length"
 241 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line func1 length"
 242
 243 if { [is_remote host] } {
 244     set python_1_c [string_to_regexp "python-1.c"]
 245 } else {
 246     set python_1_c [string_to_regexp "gdb.python/python-1.c"]
 247 }
 248 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_1_c}" "test decode_line func1 filename"
 249
 250 # Set a default value for func1_lineno in case we fail to fetch the line number
 251 # below.
 252 set func1_lineno "noline"
 253
 254 # Fetch the line GDB thinks func1 starts at.  This may change depending
 255 # on the architecture and on how GDB handles the prologue of the function.
 256 gdb_test_multiple "info line func1" "info line func1" {
 257     -re "Line ($decimal) of .* starts at address $hex <func1> and ends at $hex <func1\\+$decimal>\.\[\r\n\]+$gdb_prompt $" {
 258         # Fetch the line number.
 259         set func1_lineno $expect_out(1,string)
 260     }
 261 }
 262
 263 gdb_test "python print (symtab\[1\]\[0\].line)" "$func1_lineno" "test decode_line func1 line number"
 264 gdb_py_test_silent_cmd {python symtab = gdb.decode_line ("func1,func2")} \
 265     "test decode_line func1,func2" 1
 266 gdb_test {python print (symtab[0])} ",func2" "stop at comma in linespec"
 267
 268 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"*0\")" "Test decode_line *0" 1
 269 gdb_test "python print (len(symtab))" "2" "test decode_line *0 result length"
 270 gdb_test "python print (symtab\[0\])" "None" "test decode_line *0 unparsed"
 271 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line *0 locations length"
 272 gdb_test "python print (symtab\[1\]\[0\].symtab)" "None" "test decode_line *0 filename"
 273 gdb_test "python print (symtab\[1\]\[0\].pc)" "0" "test decode_line *0 pc"
 274
 275 # gdb.write
 276 gdb_test "python print (sys.stderr)" ".*gdb.GdbOutputErrorFile (instance|object) at.*" "test stderr location"
 277 gdb_test "python print (sys.stdout)" ".*gdb.GdbOutputFile (instance|object) at.*" "test stdout location"
 278 gdb_test "python gdb.write(\"Foo\\n\")" "Foo" "test default write"
 279 gdb_test "python gdb.write(\"Error stream\\n\", stream=gdb.STDERR)" "Error stream" "test stderr write"
 280 gdb_test "python gdb.write(\"Normal stream\\n\", stream=gdb.STDOUT)" "Normal stream" "test stdout write"
 281 gdb_test "python gdb.write(\"Log stream\\n\", stream=gdb.STDLOG)" "Log stream" "test stdlog write"
 282
 283 # Turn on full stack printing for subsequent tests.
 284 gdb_py_test_silent_cmd "set python print-stack full" \
 285     "Set print-stack full for prompt tests" 1
 286
 287 # Test prompt substituion
 288
 289 gdb_py_test_multiple "prompt substitution" \
 290   "python" "" \
 291   "someCounter = 0" "" \
 292   "def prompt(current):" "" \
 293   "   global someCounter" "" \
 294   "   if (current == \"testfake \"):" "" \
 295   "      return None" "" \
 296   "   someCounter = someCounter + 1" "" \
 297   "   return \"py prompt \" + str (someCounter) + \" \"" "" \
 298   "end" ""
 299
 300 gdb_py_test_multiple "prompt substitution readline" \
 301   "python" "" \
 302   "pCounter = 0" "" \
 303   "def program_prompt(current):" "" \
 304   "   global pCounter" "" \
 305   "   if (current == \">\"):" "" \
 306   "      pCounter = pCounter + 1" "" \
 307   "      return \"python line \" + str (pCounter) + \": \"" "" \
 308   "   return None" "" \
 309   "end" ""
 310
 311 set newprompt "py prompt 1"
 312 set newprompt2 "py prompt 2"
 313 set testfake "testfake"
 314
 315 gdb_test_multiple "python gdb.prompt_hook = prompt" "set the hook" {
 316     -re "\[\r\n\]$newprompt $" {
 317         pass "set hook"
 318     }
 319 }
 320
 321 gdb_test_multiple "set prompt testfake " "set testfake prompt in GDB" {
 322     -re "\[\r\n\]$testfake $" {
 323         pass "set prompt testfake"
 324     }
 325 }
 326
 327 gdb_test_multiple "show prompt" "show testfake prompt" {
 328     -re "Gdb's prompt is \"$testfake \"..* $" {
 329         pass "show prompt shows guarded prompt"
 330     }
 331 }
 332
 333 gdb_test_multiple "set prompt blah " "set blah in GDB" {
 334     -re "\[\r\n\]$newprompt2 $" {
 335         pass "set prompt blah overriden"
 336     }
 337 }
 338
 339 gdb_test_multiple "python gdb.prompt_hook = None" "delete hook" {
 340     -re "\[\r\n\]$newprompt2 $" {
 341         pass "delete old hook"
 342     }
 343 }
 344
 345 gdb_test_multiple "set prompt $gdb_prompt " "set default prompt" {
 346     -re "\[\r\n\]$gdb_prompt $" {
 347         pass "set default prompt"
 348     }
 349 }
 350
 351 set working_dir ""
 352 gdb_test_multiple "pwd" "pwd" {
 353     -re "Working directory (.*)\\.\[\r\n\]+$gdb_prompt $" {
 354         set working_dir $expect_out(1,string)
 355     }
 356 }
 357
 358 gdb_test_multiple "python gdb.prompt_hook = program_prompt" "set the hook" {
 359     -re "\[\r\n\]$gdb_prompt $" {
 360         pass "set programming hook"
 361     }
 362 }
 363
 364 gdb_test_multiple "python" "test we ignore substituion for seconday prompts" {
 365     -re "\r\n>$" {
 366         pass "readline secondary are not substituted"
 367     }
 368 }
 369
 370 gdb_test_multiple "end" "end programming" {
 371     -re "\[\r\n\]$gdb_prompt $" {
 372         pass "end programming"
 373     }
 374 }
 375
 376 gdb_py_test_multiple "prompt substitution readline" \
 377   "python" "" \
 378   "import gdb.command.prompt" "" \
 379   "end" ""
 380
 381 gdb_test_multiple "set extended-prompt one two three " \
 382     "set basic extended prompt" {
 383     -re "\[\r\n\]one two three $" {
 384         pass "set basic extended prompt"
 385     }
 386 }
 387
 388 gdb_test_multiple "set extended-prompt \\w " \
 389     "set extended prompt working directory" {
 390     -re "\[\r\n\][string_to_regexp $working_dir] $" {
 391         pass "set extended prompt working directory"
 392     }
 393 }
 394
 395 gdb_test_multiple "set extended-prompt some param \\p{python print-stack} " \
 396     "set extended prompt parameter" {
 397     -re "\[\r\n\]some param full $" {
 398         pass "set extended prompt parameter"
 399     }
 400 }
 401
 402 # Start with a fresh gdb.
 403 clean_restart ${testfile}
 404
 405 # The following tests require execution.
 406
 407 if ![runto_main] then {
 408     fail "can't run to main"
 409     return 0
 410 }
 411
 412 # print-stack settings
 413 gdb_test "show python print-stack" \
 414     "The mode of Python stack printing on error is \"message\".*" \
 415     "Test print-stack show setting. Default is message."
 416 gdb_py_test_silent_cmd "set python print-stack full" \
 417     "Test print-stack set setting to full" 1
 418 gdb_test "show python print-stack" \
 419     "The mode of Python stack printing on error is \"full\".*" \
 420     "Test print-stack show setting to full"
 421 gdb_py_test_silent_cmd "set python print-stack none" \
 422     "Test print-stack set setting to none" 1
 423 gdb_test "show python print-stack" \
 424     "The mode of Python stack printing on error is \"none\".*" \
 425     "test print-stack show setting to none"
 426
 427 gdb_py_test_silent_cmd "set python print-stack message" \
 428     "Test print-stack set setting to message" 1
 429
 430 gdb_py_test_multiple "prompt substitution readline" \
 431   "python" "" \
 432   "pCounter = 0" "" \
 433   "def error_prompt(current):" "" \
 434   "   raise RuntimeError(\"Python exception called\")" "" \
 435   "end" ""
 436
 437 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
 438     -re "Python Exception (exceptions.RuntimeError|<(type 'exceptions.|class ')RuntimeError'>) Python exception called.*" {
 439         pass "set hook"
 440     }
 441 }
 442
 443 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
 444     "set the hook to default" 1
 445
 446 gdb_py_test_silent_cmd "set python print-stack full" \
 447     "set print-stack full for prompt error test" 1
 448
 449 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
 450     -re "Traceback.*File.*line.*RuntimeError.*Python exception called.*" {
 451         pass "set hook"
 452     }
 453 }
 454
 455 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
 456     "set the hook to default" 1
 457
 458 # Start with a fresh gdb.
 459 clean_restart ${testfile}
 460
 461 # The following tests require execution.
 462
 463 if ![runto_main] then {
 464     fail "can't run to main"
 465     return 0
 466 }
 467
 468 runto [gdb_get_line_number "Break at func2 call site."]
 469
 470 gdb_py_test_silent_cmd "python line = gdb.selected_frame().find_sal().line" "Get line number of func2 call site" 1
 471 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line == line)" "True" "test find_pc_line at func2 call site"
 472
 473 gdb_py_test_silent_cmd "step" "Step into func2" 1
 474 gdb_py_test_silent_cmd "up" "Step out of func2" 1
 475
 476 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line > line)" "True" "test find_pc_line with resume address"