gdb/testsuite/lib/mi-support.exp

   1 # Copyright 1999-2013 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 was based on a file written by Fred Fish. (fnf@cygnus.com)
  17
  18 # Test setup routines that work with the MI interpreter.
  19
  20 # The variable mi_gdb_prompt is a regexp which matches the gdb mi prompt.
  21 # Set it if it is not already set.
  22 global mi_gdb_prompt
  23 if ![info exists mi_gdb_prompt] then {
  24     set mi_gdb_prompt "\[(\]gdb\[)\] \r\n"
  25 }
  26
  27 global mi_inferior_spawn_id
  28 global mi_inferior_tty_name
  29
  30 set MIFLAGS "-i=mi"
  31
  32 set thread_selected_re "=thread-selected,id=\"\[0-9\]+\"\r\n"
  33 set gdbindex_warning_re "&\"warning: Skipping \[^\r\n\]+ \.gdb_index section in \[^\r\n\]+\"\r\n(?:&\"\\\\n\"\r\n)?"
  34 set library_loaded_re "=library-loaded\[^\n\]+\"\r\n(?:$gdbindex_warning_re)?"
  35 set breakpoint_re "=(?:breakpoint-created|breakpoint-deleted)\[^\n\]+\"\r\n"
  36
  37 #
  38 # mi_gdb_exit -- exit the GDB, killing the target program if necessary
  39 #
  40 proc mi_gdb_exit {} {
  41     catch mi_uncatched_gdb_exit
  42 }
  43
  44 proc mi_uncatched_gdb_exit {} {
  45     global GDB
  46     global INTERNAL_GDBFLAGS GDBFLAGS
  47     global verbose
  48     global gdb_spawn_id
  49     global gdb_prompt
  50     global mi_gdb_prompt
  51     global MIFLAGS
  52
  53     gdb_stop_suppressing_tests
  54
  55     if { [info procs sid_exit] != "" } {
  56         sid_exit
  57     }
  58
  59     if ![info exists gdb_spawn_id] {
  60         return
  61     }
  62
  63     verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS"
  64
  65     if { [is_remote host] && [board_info host exists fileid] } {
  66         send_gdb "999-gdb-exit\n"
  67         gdb_expect 10 {
  68             -re "y or n" {
  69                 send_gdb "y\n"
  70                 exp_continue
  71             }
  72             -re "Undefined command.*$gdb_prompt $" {
  73                 send_gdb "quit\n"
  74                 exp_continue
  75             }
  76             -re "DOSEXIT code" { }
  77             default { }
  78         }
  79     }
  80
  81     if ![is_remote host] {
  82         remote_close host
  83     }
  84     unset gdb_spawn_id
  85 }
  86
  87 #
  88 # default_mi_gdb_start [INFERIOR_PTY] -- start gdb running, default procedure
  89 #
  90 # INFERIOR_PTY should be set to separate-inferior-tty to have the inferior work
  91 # with it's own PTY. If set to same-inferior-tty, the inferior shares GDB's PTY.
  92 # The default value is same-inferior-tty.
  93 #
  94 # When running over NFS, particularly if running many simultaneous
  95 # tests on different hosts all using the same server, things can
  96 # get really slow.  Give gdb at least 3 minutes to start up.
  97 #
  98 proc default_mi_gdb_start { args } {
  99     global verbose use_gdb_stub
 100     global GDB
 101     global INTERNAL_GDBFLAGS GDBFLAGS
 102     global gdb_prompt
 103     global mi_gdb_prompt
 104     global timeout
 105     global gdb_spawn_id
 106     global MIFLAGS
 107
 108     gdb_stop_suppressing_tests
 109     set inferior_pty no-tty
 110
 111     # Set the default value, it may be overriden later by specific testfile.
 112     set use_gdb_stub [target_info exists use_gdb_stub]
 113
 114     if { [llength $args] == 1} {
 115         set inferior_pty [lindex $args 0]
 116     }
 117
 118     set separate_inferior_pty [string match $inferior_pty separate-inferior-tty]
 119
 120     # Start SID.
 121     if { [info procs sid_start] != "" } {
 122         verbose "Spawning SID"
 123         sid_start
 124     }
 125
 126     verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS"
 127
 128     if [info exists gdb_spawn_id] {
 129         return 0
 130     }
 131
 132     if ![is_remote host] {
 133         if { [which $GDB] == 0 } then {
 134             perror "$GDB does not exist."
 135             exit 1
 136         }
 137     }
 138
 139     # Create the new PTY for the inferior process.
 140     if { $separate_inferior_pty } {
 141         spawn -pty
 142         global mi_inferior_spawn_id
 143         global mi_inferior_tty_name
 144         set mi_inferior_spawn_id $spawn_id
 145         set mi_inferior_tty_name $spawn_out(slave,name)
 146     }
 147
 148     set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS [host_info gdb_opts]"]
 149     if { $res < 0 || $res == "" } {
 150         perror "Spawning $GDB failed."
 151         return 1
 152     }
 153     gdb_expect {
 154         -re "~\"GNU.*\r\n~\".*$mi_gdb_prompt$" {
 155             # We have a new format mi startup prompt.  If we are
 156             # running mi1, then this is an error as we should be
 157             # using the old-style prompt.
 158             if { $MIFLAGS == "-i=mi1" } {
 159                 perror "(mi startup) Got unexpected new mi prompt."
 160                 remote_close host
 161                 return -1
 162             }
 163             verbose "GDB initialized."
 164         }
 165         -re "\[^~\].*$mi_gdb_prompt$" {
 166             # We have an old format mi startup prompt.  If we are
 167             # not running mi1, then this is an error as we should be
 168             # using the new-style prompt.
 169             if { $MIFLAGS != "-i=mi1" } {
 170                 perror "(mi startup) Got unexpected old mi prompt."
 171                 remote_close host
 172                 return -1
 173             }
 174             verbose "GDB initialized."
 175         }
 176         -re ".*unrecognized option.*for a complete list of options." {
 177             untested "Skip mi tests (not compiled with mi support)."
 178             remote_close host
 179             return -1
 180         }
 181         -re ".*Interpreter `mi' unrecognized." {
 182             untested "Skip mi tests (not compiled with mi support)."
 183             remote_close host
 184             return -1
 185         }
 186         timeout {
 187             perror "(timeout) GDB never initialized after 10 seconds."
 188             remote_close host
 189             return -1
 190         }
 191     }
 192     set gdb_spawn_id -1
 193
 194     # FIXME: mi output does not go through pagers, so these can be removed.
 195     # force the height to "unlimited", so no pagers get used
 196     send_gdb "100-gdb-set height 0\n"
 197     gdb_expect 10 {
 198         -re ".*100-gdb-set height 0\r\n100\\\^done\r\n$mi_gdb_prompt$" {
 199             verbose "Setting height to 0." 2
 200         }
 201         timeout {
 202             warning "Couldn't set the height to 0"
 203         }
 204     }
 205     # force the width to "unlimited", so no wraparound occurs
 206     send_gdb "101-gdb-set width 0\n"
 207     gdb_expect 10 {
 208         -re ".*101-gdb-set width 0\r\n101\\\^done\r\n$mi_gdb_prompt$" {
 209             verbose "Setting width to 0." 2
 210         }
 211         timeout {
 212             warning "Couldn't set the width to 0."
 213         }
 214     }
 215     # If allowing the inferior to have its own PTY then assign the inferior
 216     # its own terminal device here.
 217     if { $separate_inferior_pty } {
 218         send_gdb "102-inferior-tty-set $mi_inferior_tty_name\n"
 219         gdb_expect 10 {
 220             -re ".*102\\\^done\r\n$mi_gdb_prompt$" {
 221                 verbose "redirect inferior output to new terminal device."
 222             }
 223             timeout {
 224                 warning "Couldn't redirect inferior output." 2
 225             }
 226         }
 227     }
 228
 229     mi_detect_async
 230
 231     return 0
 232 }
 233
 234 #
 235 # Overridable function. You can override this function in your
 236 # baseboard file.
 237 #
 238 proc mi_gdb_start { args } {
 239   return [default_mi_gdb_start $args]
 240 }
 241
 242 # Many of the tests depend on setting breakpoints at various places and
 243 # running until that breakpoint is reached.  At times, we want to start
 244 # with a clean-slate with respect to breakpoints, so this utility proc
 245 # lets us do this without duplicating this code everywhere.
 246 #
 247
 248 proc mi_delete_breakpoints {} {
 249     global mi_gdb_prompt
 250
 251 # FIXME: The mi operation won't accept a prompt back and will use the 'all' arg
 252     send_gdb "102-break-delete\n"
 253     gdb_expect 30 {
 254          -re "Delete all breakpoints.*y or n.*$" {
 255             send_gdb "y\n"
 256             exp_continue
 257          }
 258          -re "102-break-delete\r\n102\\\^done\r\n$mi_gdb_prompt$" {
 259              # This happens if there were no breakpoints
 260          }
 261          timeout { perror "Delete all breakpoints in mi_delete_breakpoints (timeout)" ; return }
 262     }
 263
 264 # The correct output is not "No breakpoints or watchpoints." but an
 265 # empty BreakpointTable. Also, a query is not acceptable with mi.
 266     send_gdb "103-break-list\n"
 267     gdb_expect 30 {
 268          -re "103-break-list\r\n103\\\^done,BreakpointTable=\{\}\r\n$mi_gdb_prompt$" {}
 269          -re "103-break-list\r\n103\\\^done,BreakpointTable=\{nr_rows=\".\",nr_cols=\".\",hdr=\\\[\{width=\".*\",alignment=\".*\",col_name=\"number\",colhdr=\"Num\"\}.*colhdr=\"Type\".*colhdr=\"Disp\".*colhdr=\"Enb\".*colhdr=\"Address\".*colhdr=\"What\".*\\\],body=\\\[\\\]\}\r\n$mi_gdb_prompt$" {}
 270          -re "103-break-list\r\n103\\\^doneNo breakpoints or watchpoints.\r\n\r\n$mi_gdb_prompt$" {warning "Unexpected console text received"}
 271          -re "$mi_gdb_prompt$" { perror "Breakpoints not deleted" ; return }
 272          -re "Delete all breakpoints.*or n.*$" {
 273             warning "Unexpected prompt for breakpoints deletion"
 274             send_gdb "y\n"
 275             exp_continue
 276         }
 277          timeout { perror "-break-list (timeout)" ; return }
 278     }
 279 }
 280
 281 proc mi_gdb_reinitialize_dir { subdir } {
 282     global mi_gdb_prompt
 283     global MIFLAGS
 284
 285     global suppress_flag
 286     if { $suppress_flag } {
 287         return
 288     }
 289
 290     if [is_remote host] {
 291         return ""
 292     }
 293
 294     if { $MIFLAGS == "-i=mi1" } {
 295       send_gdb "104-environment-directory\n"
 296       gdb_expect 60 {
 297         -re ".*Reinitialize source path to empty.*y or n. " {
 298             warning "Got confirmation prompt for dir reinitialization."
 299             send_gdb "y\n"
 300             gdb_expect 60 {
 301                 -re "$mi_gdb_prompt$" {}
 302                 timeout {error "Dir reinitialization failed (timeout)"}
 303             }
 304         }
 305         -re "$mi_gdb_prompt$" {}
 306           timeout {error "Dir reinitialization failed (timeout)"}
 307       }
 308     } else {
 309         send_gdb "104-environment-directory -r\n"
 310         gdb_expect 60 {
 311             -re "104\\\^done,source-path=.*\r\n$mi_gdb_prompt$" {}
 312             -re "$mi_gdb_prompt$" {}
 313             timeout {error "Dir reinitialization failed (timeout)"}
 314       }
 315     }
 316
 317     send_gdb "105-environment-directory $subdir\n"
 318     gdb_expect 60 {
 319         -re "Source directories searched.*$mi_gdb_prompt$" {
 320             verbose "Dir set to $subdir"
 321         }
 322         -re "105\\\^done.*\r\n$mi_gdb_prompt$" {
 323             # FIXME: We return just the prompt for now.
 324             verbose "Dir set to $subdir"
 325             # perror "Dir \"$subdir\" failed."
 326         }
 327     }
 328 }
 329
 330 # Send GDB the "target" command.
 331 # FIXME: Some of these patterns are not appropriate for MI.  Based on
 332 # config/monitor.exp:gdb_target_command.
 333 proc mi_gdb_target_cmd { targetname serialport } {
 334     global mi_gdb_prompt
 335
 336     set serialport_re [string_to_regexp $serialport]
 337     for {set i 1} {$i <= 3} {incr i} {
 338         send_gdb "47-target-select $targetname $serialport\n"
 339         gdb_expect 60 {
 340             -re "47\\^connected.*$mi_gdb_prompt" {
 341                 verbose "Set target to $targetname"
 342                 return 0
 343             }
 344             -re "unknown host.*$mi_gdb_prompt" {
 345                 verbose "Couldn't look up $serialport"
 346             }
 347             -re "Couldn't establish connection to remote.*$mi_gdb_prompt$" {
 348                 verbose "Connection failed"
 349             }
 350             -re "Remote MIPS debugging.*$mi_gdb_prompt$" {
 351                 verbose "Set target to $targetname"
 352                 return 0
 353             }
 354             -re "Remote debugging using .*$serialport_re.*$mi_gdb_prompt$" {
 355                 verbose "Set target to $targetname"
 356                 return 0
 357             }
 358             -re "Remote target $targetname connected to.*$mi_gdb_prompt$" {
 359                 verbose "Set target to $targetname"
 360                 return 0
 361             }
 362             -re "Connected to.*$mi_gdb_prompt$" {
 363                 verbose "Set target to $targetname"
 364                 return 0
 365             }
 366             -re "Ending remote.*$mi_gdb_prompt$" { }
 367             -re "Connection refused.*$mi_gdb_prompt$" {
 368                 verbose "Connection refused by remote target.  Pausing, and trying again."
 369                 sleep 5
 370                 continue
 371             }
 372             -re "Non-stop mode requested, but remote does not support non-stop.*$mi_gdb_prompt" {
 373                 unsupported "Non-stop mode not supported"
 374                 return 1
 375             }
 376             -re "Timeout reading from remote system.*$mi_gdb_prompt$" {
 377                 verbose "Got timeout error from gdb."
 378             }
 379             timeout {
 380                 send_gdb "\ 3"
 381                 break
 382             }
 383         }
 384     }
 385     return 1
 386 }
 387
 388 #
 389 # load a file into the debugger (file command only).
 390 # return a -1 if anything goes wrong.
 391 #
 392 proc mi_gdb_file_cmd { arg } {
 393     global verbose
 394     global loadpath
 395     global loadfile
 396     global GDB
 397     global mi_gdb_prompt
 398     global last_loaded_file
 399     upvar timeout timeout
 400
 401     set last_loaded_file $arg
 402
 403     if [is_remote host] {
 404         set arg [remote_download host $arg]
 405         if { $arg == "" } {
 406             error "download failed"
 407             return -1
 408         }
 409     }
 410
 411 # FIXME: Several of these patterns are only acceptable for console
 412 # output.  Queries are an error for mi.
 413     send_gdb "105-file-exec-and-symbols $arg\n"
 414     gdb_expect 120 {
 415         -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
 416             verbose "\t\tLoaded $arg into the $GDB"
 417             return 0
 418         }
 419         -re "has no symbol-table.*$mi_gdb_prompt$" {
 420             perror "$arg wasn't compiled with \"-g\""
 421             return -1
 422         }
 423         -re "Load new symbol table from \".*\".*y or n. $" {
 424             send_gdb "y\n"
 425             gdb_expect 120 {
 426                 -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
 427                     verbose "\t\tLoaded $arg with new symbol table into $GDB"
 428                     # All OK
 429                 }
 430                 timeout {
 431                     perror "(timeout) Couldn't load $arg, other program already loaded."
 432                     return -1
 433                 }
 434             }
 435         }
 436         -re "No such file or directory.*$mi_gdb_prompt$" {
 437             perror "($arg) No such file or directory\n"
 438             return -1
 439         }
 440         -re "105-file-exec-and-symbols .*\r\n105\\\^done\r\n$mi_gdb_prompt$" {
 441             # We (MI) are just giving the prompt back for now, instead of giving
 442             # some acknowledgement.
 443             return 0
 444         }
 445         timeout {
 446             perror "couldn't load $arg into $GDB (timed out)."
 447             return -1
 448         }
 449         eof {
 450             # This is an attempt to detect a core dump, but seems not to
 451             # work.  Perhaps we need to match .* followed by eof, in which
 452             # gdb_expect does not seem to have a way to do that.
 453             perror "couldn't load $arg into $GDB (end of file)."
 454             return -1
 455         }
 456     }
 457 }
 458
 459 #
 460 # connect to the target and download a file, if necessary.
 461 # return a -1 if anything goes wrong.
 462 #
 463 proc mi_gdb_target_load { } {
 464     global verbose
 465     global loadpath
 466     global loadfile
 467     global GDB
 468     global mi_gdb_prompt
 469
 470     if [target_info exists gdb_load_timeout] {
 471         set loadtimeout [target_info gdb_load_timeout]
 472     } else {
 473         set loadtimeout 1600
 474     }
 475
 476     if { [info procs gdbserver_gdb_load] != "" } {
 477         mi_gdb_test "kill" ".*" ""
 478         set res [gdbserver_gdb_load]
 479         set protocol [lindex $res 0]
 480         set gdbport [lindex $res 1]
 481
 482         if { [mi_gdb_target_cmd $protocol $gdbport] != 0 } {
 483             return -1
 484         }
 485     } elseif { [info procs send_target_sid] != "" } {
 486         # For SID, things get complex
 487         send_gdb "kill\n"
 488         gdb_expect 10 {
 489             -re ".*$mi_gdb_prompt$"
 490         }
 491         send_target_sid
 492         gdb_expect $loadtimeout {
 493             -re "\\^done.*$mi_gdb_prompt$" {
 494             }
 495             timeout {
 496                 perror "Unable to connect to SID target (timeout)"
 497                 return -1
 498             }
 499         }
 500         send_gdb "48-target-download\n"
 501         gdb_expect $loadtimeout {
 502             -re "48\\^done.*$mi_gdb_prompt$" {
 503             }
 504             timeout {
 505                 perror "Unable to download to SID target (timeout)"
 506                 return -1
 507             }
 508         }
 509     } elseif { [target_info protocol] == "sim" } {
 510         # For the simulator, just connect to it directly.
 511         send_gdb "47-target-select sim\n"
 512         gdb_expect $loadtimeout {
 513             -re "47\\^connected.*$mi_gdb_prompt$" {
 514             }
 515             timeout {
 516                 perror "Unable to select sim target (timeout)"
 517                 return -1
 518             }
 519         }
 520         send_gdb "48-target-download\n"
 521         gdb_expect $loadtimeout {
 522             -re "48\\^done.*$mi_gdb_prompt$" {
 523             }
 524             timeout {
 525                 perror "Unable to download to sim target (timeout)"
 526                 return -1
 527             }
 528         }
 529     } elseif { [target_info gdb_protocol] == "remote" } {
 530         # remote targets
 531         if { [mi_gdb_target_cmd "remote" [target_info netport]] != 0 } {
 532             perror "Unable to connect to remote target"
 533             return -1
 534         }
 535         send_gdb "48-target-download\n"
 536         gdb_expect $loadtimeout {
 537             -re "48\\^done.*$mi_gdb_prompt$" {
 538             }
 539             timeout {
 540                 perror "Unable to download to remote target (timeout)"
 541                 return -1
 542             }
 543         }
 544     }
 545     return 0
 546 }
 547
 548 #
 549 # load a file into the debugger.
 550 # return a -1 if anything goes wrong.
 551 #
 552 proc mi_gdb_load { arg } {
 553     if { $arg != "" } {
 554         return [mi_gdb_file_cmd $arg]
 555     }
 556     return 0
 557 }
 558
 559 # mi_gdb_test COMMAND PATTERN MESSAGE [IPATTERN] -- send a command to gdb;
 560 #   test the result.
 561 #
 562 # COMMAND is the command to execute, send to GDB with send_gdb.  If
 563 #   this is the null string no command is sent.
 564 # PATTERN is the pattern to match for a PASS, and must NOT include
 565 #   the \r\n sequence immediately before the gdb prompt.
 566 # MESSAGE is the message to be printed.  (If this is the empty string,
 567 #   then sometimes we don't call pass or fail at all; I don't
 568 #   understand this at all.)
 569 # IPATTERN is the pattern to match for the inferior's output.  This parameter
 570 #   is optional.  If present, it will produce a PASS if the match is
 571 #   successful, and a FAIL if unsuccessful.
 572 #
 573 # Returns:
 574 #    1 if the test failed,
 575 #    0 if the test passes,
 576 #   -1 if there was an internal error.
 577 #
 578 proc mi_gdb_test { args } {
 579     global verbose
 580     global mi_gdb_prompt
 581     global GDB expect_out
 582     global inferior_exited_re async
 583     upvar timeout timeout
 584
 585     set command [lindex $args 0]
 586     set pattern [lindex $args 1]
 587     set message [lindex $args 2]
 588
 589     if [llength $args]==4 {
 590         set ipattern [lindex $args 3]
 591     }
 592
 593     if [llength $args]==5 {
 594         set question_string [lindex $args 3]
 595         set response_string [lindex $args 4]
 596     } else {
 597         set question_string "^FOOBAR$"
 598     }
 599
 600     if $verbose>2 then {
 601         send_user "Sending \"$command\" to gdb\n"
 602         send_user "Looking to match \"$pattern\"\n"
 603         send_user "Message is \"$message\"\n"
 604     }
 605
 606     set result -1
 607     set string "${command}\n"
 608     set string_regex [string_to_regexp $command]
 609
 610     if { $command != "" } {
 611         while { "$string" != "" } {
 612             set foo [string first "\n" "$string"]
 613             set len [string length "$string"]
 614             if { $foo < [expr $len - 1] } {
 615                 set str [string range "$string" 0 $foo]
 616                 if { [send_gdb "$str"] != "" } {
 617                     global suppress_flag
 618
 619                     if { ! $suppress_flag } {
 620                         perror "Couldn't send $command to GDB."
 621                     }
 622                     fail "$message"
 623                     return $result
 624                 }
 625                 gdb_expect 2 {
 626                     -re "\[\r\n\]" { }
 627                     timeout { }
 628                 }
 629                 set string [string range "$string" [expr $foo + 1] end]
 630             } else {
 631                 break
 632             }
 633         }
 634         if { "$string" != "" } {
 635             if { [send_gdb "$string"] != "" } {
 636                 global suppress_flag
 637
 638                 if { ! $suppress_flag } {
 639                     perror "Couldn't send $command to GDB."
 640                 }
 641                 fail "$message"
 642                 return $result
 643             }
 644         }
 645     }
 646
 647     if [info exists timeout] {
 648         set tmt $timeout
 649     } else {
 650         global timeout
 651         if [info exists timeout] {
 652             set tmt $timeout
 653         } else {
 654             set tmt 60
 655         }
 656     }
 657     if {$async} {
 658         # With $prompt_re "" there may come arbitrary asynchronous response
 659         # from the previous command, before or after $string_regex.
 660         set string_regex ".*"
 661     }
 662     verbose -log "Expecting: ^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)"
 663     gdb_expect $tmt {
 664          -re "\\*\\*\\* DOSEXIT code.*" {
 665              if { $message != "" } {
 666                  fail "$message"
 667              }
 668              gdb_suppress_entire_file "GDB died"
 669              return -1
 670          }
 671          -re "Ending remote debugging.*$mi_gdb_prompt\[ \]*$" {
 672             if ![isnative] then {
 673                 warning "Can`t communicate to remote target."
 674             }
 675             gdb_exit
 676             gdb_start
 677             set result -1
 678         }
 679          -re "^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)" {
 680             # At this point, $expect_out(1,string) is the MI input command.
 681             # and $expect_out(2,string) is the MI output command.
 682             # If $expect_out(1,string) is "", then there was no MI input command here.
 683
 684             # NOTE, there is no trailing anchor because with GDB/MI,
 685             # asynchronous responses can happen at any point, causing more
 686             # data to be available.  Normally an anchor is used to make
 687             # sure the end of the output is matched, however, $mi_gdb_prompt
 688             # is just as good of an anchor since mi_gdb_test is meant to
 689             # match a single mi output command.  If a second GDB/MI output
 690             # response is sent, it will be in the buffer for the next
 691             # time mi_gdb_test is called.
 692             if ![string match "" $message] then {
 693                 pass "$message"
 694             }
 695             set result 0
 696         }
 697          -re "(${question_string})$" {
 698             send_gdb "$response_string\n"
 699             exp_continue
 700         }
 701          -re "Undefined.* command:.*$mi_gdb_prompt\[ \]*$" {
 702             perror "Undefined command \"$command\"."
 703              fail "$message"
 704             set result 1
 705         }
 706          -re "Ambiguous command.*$mi_gdb_prompt\[ \]*$" {
 707             perror "\"$command\" is not a unique command name."
 708              fail "$message"
 709             set result 1
 710         }
 711          -re "$inferior_exited_re with code \[0-9\]+.*$mi_gdb_prompt\[ \]*$" {
 712             if ![string match "" $message] then {
 713                 set errmsg "$message (the program exited)"
 714             } else {
 715                 set errmsg "$command (the program exited)"
 716             }
 717             fail "$errmsg"
 718             return -1
 719         }
 720          -re "The program is not being run.*$mi_gdb_prompt\[ \]*$" {
 721             if ![string match "" $message] then {
 722                 set errmsg "$message (the program is no longer running)"
 723             } else {
 724                 set errmsg "$command (the program is no longer running)"
 725             }
 726             fail "$errmsg"
 727             return -1
 728         }
 729          -re ".*$mi_gdb_prompt\[ \]*$" {
 730             if ![string match "" $message] then {
 731                 fail "$message"
 732             }
 733             set result 1
 734         }
 735          "<return>" {
 736             send_gdb "\n"
 737             perror "Window too small."
 738              fail "$message"
 739         }
 740          -re "\\(y or n\\) " {
 741             send_gdb "n\n"
 742             perror "Got interactive prompt."
 743              fail "$message"
 744         }
 745          eof {
 746              perror "Process no longer exists"
 747              if { $message != "" } {
 748                  fail "$message"
 749              }
 750              return -1
 751         }
 752          full_buffer {
 753             perror "internal buffer is full."
 754              fail "$message"
 755         }
 756         timeout {
 757             if ![string match "" $message] then {
 758                 fail "$message (timeout)"
 759             }
 760             set result 1
 761         }
 762     }
 763
 764     # If the GDB output matched, compare the inferior output.
 765     if { $result == 0 } {
 766         if [ info exists ipattern ] {
 767             if { ![target_info exists gdb,noinferiorio] } {
 768                 if { [target_info gdb_protocol] == "remote"
 769                     || [target_info gdb_protocol] == "extended-remote"
 770                     || [target_info protocol] == "sim"} {
 771
 772                     gdb_expect {
 773                         -re "$ipattern" {
 774                             pass "$message inferior output"
 775                         }
 776                         timeout {
 777                             fail "$message inferior output (timeout)"
 778                             set result 1
 779                         }
 780                     }
 781                 } else {
 782                     global mi_inferior_spawn_id
 783                     expect {
 784                         -i $mi_inferior_spawn_id -re "$ipattern" {
 785                             pass "$message inferior output"
 786                         }
 787                         timeout {
 788                             fail "$message inferior output (timeout)"
 789                             set result 1
 790                         }
 791                     }
 792                 }
 793             } else {
 794                 unsupported "$message inferior output"
 795             }
 796         }
 797     }
 798
 799     return $result
 800 }
 801
 802 #
 803 # MI run command.  (A modified version of gdb_run_cmd)
 804 #
 805
 806 # In patterns, the newline sequence ``\r\n'' is matched explicitly as
 807 # ``.*$'' could swallow up output that we attempt to match elsewhere.
 808
 809 proc mi_run_cmd_full {use_mi_command args} {
 810     global suppress_flag
 811     if { $suppress_flag } {
 812         return -1
 813     }
 814     global mi_gdb_prompt use_gdb_stub
 815     global thread_selected_re
 816     global library_loaded_re
 817
 818     if {$use_mi_command} {
 819         set run_prefix "220-exec-"
 820         set run_match "220"
 821     } else {
 822         set run_prefix ""
 823         set run_match ""
 824     }
 825
 826     if [target_info exists gdb_init_command] {
 827         send_gdb "[target_info gdb_init_command]\n"
 828         gdb_expect 30 {
 829             -re "$mi_gdb_prompt$" { }
 830             default {
 831                 perror "gdb_init_command for target failed"
 832                 return -1
 833             }
 834         }
 835     }
 836
 837     if { [mi_gdb_target_load] < 0 } {
 838         return -1
 839     }
 840
 841     if $use_gdb_stub {
 842         if [target_info exists gdb,do_reload_on_run] {
 843             send_gdb "${run_prefix}continue\n"
 844             gdb_expect 60 {
 845                 -re "${run_match}\\^running\[\r\n\]+\\*running,thread-id=\"\[^\"\]+\"\r\n$mi_gdb_prompt" {}
 846                 default {}
 847             }
 848             return 0
 849         }
 850
 851         if [target_info exists gdb,start_symbol] {
 852             set start [target_info gdb,start_symbol]
 853         } else {
 854             set start "start"
 855         }
 856
 857         # HACK: Should either use 000-jump or fix the target code
 858         # to better handle RUN.
 859         send_gdb  "jump *$start\n"
 860         warning "Using CLI jump command, expect run-to-main FAIL"
 861         return 0
 862     }
 863
 864     send_gdb "${run_prefix}run $args\n"
 865     gdb_expect {
 866         -re "${run_match}\\^running\r\n(\\*running,thread-id=\"\[^\"\]+\"\r\n|=thread-created,id=\"1\",group-id=\"\[0-9\]+\"\r\n)*(${library_loaded_re})*(${thread_selected_re})?${mi_gdb_prompt}" {
 867         }
 868         -re "\\^error,msg=\"The target does not support running in non-stop mode.\"" {
 869             unsupported "Non-stop mode not supported"
 870             return -1
 871         }
 872         timeout {
 873             perror "Unable to start target"
 874             return -1
 875         }
 876     }
 877     # NOTE: Shortly after this there will be a ``000*stopped,...(gdb)''
 878
 879     return 0
 880 }
 881
 882 # A wrapper for mi_run_cmd_full which uses -exec-run and
 883 # -exec-continue, as appropriate.  ARGS are passed verbatim to
 884 # mi_run_cmd_full.
 885 proc mi_run_cmd {args} {
 886     return [eval mi_run_cmd_full 1 $args]
 887 }
 888
 889 # A wrapper for mi_run_cmd_full which uses the CLI commands 'run' and
 890 # 'continue', as appropriate.  ARGS are passed verbatim to
 891 # mi_run_cmd_full.
 892 proc mi_run_with_cli {args} {
 893     return [eval mi_run_cmd_full 0 $args]
 894 }
 895
 896 #
 897 # Just like run-to-main but works with the MI interface
 898 #
 899
 900 proc mi_run_to_main { } {
 901     global suppress_flag
 902     if { $suppress_flag } {
 903         return -1
 904     }
 905
 906     global srcdir
 907     global subdir
 908     global binfile
 909     global srcfile
 910
 911     mi_delete_breakpoints
 912     mi_gdb_reinitialize_dir $srcdir/$subdir
 913     mi_gdb_load ${binfile}
 914
 915     mi_runto main
 916 }
 917
 918
 919 # Just like gdb's "runto" proc, it will run the target to a given
 920 # function.  The big difference here between mi_runto and mi_execute_to
 921 # is that mi_execute_to must have the inferior running already.  This
 922 # proc will (like gdb's runto) (re)start the inferior, too.
 923 #
 924 # FUNC is the linespec of the place to stop (it inserts a breakpoint here).
 925 # It returns:
 926 #   -1  if test suppressed, failed, timedout
 927 #    0  if test passed
 928
 929 proc mi_runto_helper {func run_or_continue} {
 930   global suppress_flag
 931   if { $suppress_flag } {
 932     return -1
 933   }
 934
 935   global mi_gdb_prompt expect_out
 936   global hex decimal fullname_syntax
 937
 938   set test "mi runto $func"
 939   mi_gdb_test "200-break-insert -t $func" \
 940     "200\\^done,bkpt=\{number=\"\[0-9\]+\",type=\"breakpoint\",disp=\"del\",enabled=\"y\",addr=\"$hex\",func=\"$func\(\\\(.*\\\)\)?\",file=\".*\",line=\"\[0-9\]*\",thread-groups=\\\[\"i1\"\\\],times=\"0\",original-location=\".*\"\}" \
 941     "breakpoint at $func"
 942
 943   if {![regexp {number="[0-9]+"} $expect_out(buffer) str]
 944       || ![scan $str {number="%d"} bkptno]} {
 945     set bkptno {[0-9]+}
 946   }
 947
 948   if {$run_or_continue == "run"} {
 949       if { [mi_run_cmd] < 0 } {
 950           return -1
 951       }
 952   } else {
 953       mi_send_resuming_command "exec-continue" "$test"
 954   }
 955
 956   mi_expect_stop "breakpoint-hit" $func ".*" ".*" "\[0-9\]+" { "" "disp=\"del\"" } $test
 957 }
 958
 959 proc mi_runto {func} {
 960     return [mi_runto_helper $func "run"]
 961 }
 962
 963 # Next to the next statement
 964 # For return values, see mi_execute_to_helper
 965
 966 proc mi_next { test } {
 967   return [mi_next_to {.*} {.*} {.*} {.*} $test]
 968 }
 969
 970
 971 # Step to the next statement
 972 # For return values, see mi_execute_to_helper
 973
 974 proc mi_step { test } {
 975   return [mi_step_to {.*} {.*} {.*} {.*} $test]
 976 }
 977
 978 set async "unknown"
 979
 980 proc mi_detect_async {} {
 981     global async
 982     global mi_gdb_prompt
 983
 984     send_gdb "show target-async\n"
 985
 986     gdb_expect {
 987         -re ".*Controlling the inferior in asynchronous mode is on...*$mi_gdb_prompt$" {
 988             set async 1
 989         }
 990         -re ".*$mi_gdb_prompt$" {
 991             set async 0
 992         }
 993         timeout {
 994             set async 0
 995         }
 996     }
 997     return $async
 998 }
 999
1000 # Wait for MI *stopped notification to appear.
1001 # The REASON, FUNC, ARGS, FILE and LINE are regular expressions
1002 # to match against whatever is output in *stopped.  FILE may also match
1003 # filename of a file without debug info.  ARGS should not include [] the
1004 # list of argument is enclosed in, and other regular expressions should
1005 # not include quotes.
1006 # If EXTRA is a list of one element, it's the regular expression
1007 # for output expected right after *stopped, and before GDB prompt.
1008 # If EXTRA is a list of two elements, the first element is for
1009 # output right after *stopped, and the second element is output
1010 # right after reason field.  The regex after reason should not include
1011 # the comma separating it from the following fields.
1012 #
1013 # When we fail to match output at all, -1 is returned.  If FILE does
1014 # match and the target system has no debug info for FILE return 0.
1015 # Otherwise, the line at which we stop is returned.  This is useful when
1016 # exact line is not possible to specify for some reason -- one can pass
1017 # the .* or "\[0-9\]*" regexps for line, and then check the line
1018 # programmatically.
1019 #
1020 # Do not pass .* for any argument if you are expecting more than one stop.
1021 proc mi_expect_stop { reason func args file line extra test } {
1022
1023     global mi_gdb_prompt
1024     global hex
1025     global decimal
1026     global fullname_syntax
1027     global async
1028     global thread_selected_re
1029     global breakpoint_re
1030
1031     set after_stopped ""
1032     set after_reason ""
1033     if { [llength $extra] == 2 } {
1034         set after_stopped [lindex $extra 0]
1035         set after_reason [lindex $extra 1]
1036         set after_reason "${after_reason},"
1037     } elseif { [llength $extra] == 1 } {
1038         set after_stopped [lindex $extra 0]
1039     }
1040
1041     if {$async} {
1042         set prompt_re ""
1043     } else {
1044         set prompt_re "$mi_gdb_prompt$"
1045     }
1046
1047     if { $reason == "really-no-reason" } {
1048         gdb_expect {
1049             -re "\\*stopped\r\n$prompt_re" {
1050                 pass "$test"
1051             }
1052             timeout {
1053                 fail "$test (unknown output after running)"
1054             }
1055         }
1056         return
1057     }
1058
1059     if { $reason == "exited-normally" } {
1060
1061         gdb_expect {
1062             -re "\\*stopped,reason=\"exited-normally\"\r\n$prompt_re" {
1063                 pass "$test"
1064             }
1065             -re ".*$mi_gdb_prompt$" {fail "continue to end (2)"}
1066             timeout {
1067                 fail "$test (unknown output after running)"
1068             }
1069         }
1070         return
1071     }
1072
1073     set args "\\\[$args\\\]"
1074
1075     set bn ""
1076     if { $reason == "breakpoint-hit" } {
1077         set bn {bkptno="[0-9]+",}
1078     } elseif { $reason == "solib-event" } {
1079         set bn ".*"
1080     }
1081
1082     set r ""
1083     if { $reason != "" } {
1084         set r "reason=\"$reason\","
1085     }
1086
1087
1088     set a $after_reason
1089
1090     set any "\[^\n\]*"
1091
1092     verbose -log "mi_expect_stop: expecting: \\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$func\",args=$args,(?:file=\"$any$file\",fullname=\"${fullname_syntax}$file\",line=\"$line\"|from=\"$file\")\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re|$breakpoint_re)*$prompt_re"
1093     gdb_expect {
1094         -re "\\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$func\",args=$args,(?:file=\"$any$file\",fullname=\"${fullname_syntax}$file\",line=\"($line)\"|from=\"$file\")\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re|$breakpoint_re)*$prompt_re" {
1095             pass "$test"
1096             if {[array names expect_out "2,string"] != ""} {
1097                 return $expect_out(2,string)
1098             }
1099             # No debug info available but $file does match.
1100             return 0
1101         }
1102         -re "\\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$any\",args=\[\\\[\{\]$any\[\\\]\}\],file=\"$any\",fullname=\"${fullname_syntax}$any\",line=\"\[0-9\]*\"\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re|$breakpoint_re)*$prompt_re" {
1103             verbose -log "got $expect_out(buffer)"
1104             fail "$test (stopped at wrong place)"
1105             return -1
1106         }
1107         -re ".*\r\n$mi_gdb_prompt$" {
1108             verbose -log "got $expect_out(buffer)"
1109             fail "$test (unknown output after running)"
1110             return -1
1111         }
1112         timeout {
1113             fail "$test (timeout)"
1114             return -1
1115         }
1116     }
1117 }
1118
1119 # Wait for MI *stopped notification related to an interrupt request to
1120 # appear.
1121 proc mi_expect_interrupt { test } {
1122     global mi_gdb_prompt
1123     global decimal
1124     global async
1125
1126     if {$async} {
1127         set prompt_re ""
1128     } else {
1129         set prompt_re "$mi_gdb_prompt$"
1130     }
1131
1132     set r "reason=\"signal-received\",signal-name=\"0\",signal-meaning=\"Signal 0\""
1133
1134     set any "\[^\n\]*"
1135
1136     # A signal can land anywhere, just ignore the location
1137     verbose -log "mi_expect_interrupt: expecting: \\*stopped,${r}$any\r\n$prompt_re"
1138     gdb_expect {
1139         -re "\\*stopped,${r}$any\r\n$prompt_re" {
1140             pass "$test"
1141             return 0
1142         }
1143         -re ".*\r\n$mi_gdb_prompt$" {
1144             verbose -log "got $expect_out(buffer)"
1145             fail "$test (unknown output after running)"
1146             return -1
1147         }
1148         timeout {
1149             fail "$test (timeout)"
1150             return -1
1151         }
1152     }
1153 }
1154
1155 # cmd should not include the number or newline (i.e. "exec-step 3", not
1156 # "220-exec-step 3\n"
1157
1158 # Can not match -re ".*\r\n${mi_gdb_prompt}", because of false positives
1159 # after the first prompt is printed.
1160
1161 proc mi_execute_to { cmd reason func args file line extra test } {
1162     global suppress_flag
1163     if { $suppress_flag } {
1164         return -1
1165     }
1166
1167     mi_send_resuming_command "$cmd" "$test"
1168     set r [mi_expect_stop $reason $func $args $file $line $extra $test]
1169     return $r
1170 }
1171
1172 proc mi_next_to { func args file line test } {
1173     mi_execute_to "exec-next" "end-stepping-range" "$func" "$args" \
1174         "$file" "$line" "" "$test"
1175 }
1176
1177 proc mi_step_to { func args file line test } {
1178     mi_execute_to "exec-step" "end-stepping-range" "$func" "$args" \
1179         "$file" "$line" "" "$test"
1180 }
1181
1182 proc mi_finish_to { func args file line result ret test } {
1183     mi_execute_to "exec-finish" "function-finished" "$func" "$args" \
1184         "$file" "$line" \
1185         ",gdb-result-var=\"$result\",return-value=\"$ret\"" \
1186         "$test"
1187 }
1188
1189 proc mi_continue_to {func} {
1190     mi_runto_helper $func "continue"
1191 }
1192
1193 proc mi0_execute_to { cmd reason func args file line extra test } {
1194     mi_execute_to_helper "$cmd" "$reason" "$func" "\{$args\}" \
1195         "$file" "$line" "$extra" "$test"
1196 }
1197
1198 proc mi0_next_to { func args file line test } {
1199     mi0_execute_to "exec-next" "end-stepping-range" "$func" "$args" \
1200         "$file" "$line" "" "$test"
1201 }
1202
1203 proc mi0_step_to { func args file line test } {
1204     mi0_execute_to "exec-step" "end-stepping-range" "$func" "$args" \
1205         "$file" "$line" "" "$test"
1206 }
1207
1208 proc mi0_finish_to { func args file line result ret test } {
1209     mi0_execute_to "exec-finish" "function-finished" "$func" "$args" \
1210         "$file" "$line" \
1211         ",gdb-result-var=\"$result\",return-value=\"$ret\"" \
1212         "$test"
1213 }
1214
1215 proc mi0_continue_to { bkptno func args file line test } {
1216     mi0_execute_to "exec-continue" "breakpoint-hit\",bkptno=\"$bkptno" \
1217         "$func" "$args" "$file" "$line" "" "$test"
1218 }
1219
1220 # Creates a breakpoint and checks the reported fields are as expected
1221 proc mi_create_breakpoint { location number disp func file line address test } {
1222     verbose -log "Expecting: 222\\^done,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",fullname=\".*\",line=\"$line\",thread-groups=\\\[\".*\"\\\],times=\"0\",original-location=\".*\"\}"
1223     mi_gdb_test "222-break-insert $location" \
1224         "222\\^done,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",fullname=\".*\",line=\"$line\",thread-groups=\\\[\".*\"\\\],times=\"0\",original-location=\".*\"\}" \
1225         $test
1226 }
1227
1228 proc mi_list_breakpoints { expected test } {
1229     set fullname ".*"
1230
1231     set body ""
1232     set first 1
1233
1234     foreach item $expected {
1235         if {$first == 0} {
1236             set body "$body,"
1237             set first 0
1238         }
1239         set number [lindex $item 0]
1240         set disp [lindex $item 1]
1241         set func [lindex $item 2]
1242         set file [lindex $item 3]
1243         set line [lindex $item 4]
1244         set address [lindex $item 5]
1245         set body "${body}bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\".*$file\",${fullname},line=\"$line\",thread-groups=\\\[\"i1\"\\\],times=\"0\",original-location=\".*\"\}"
1246         set first 0
1247     }
1248
1249     verbose -log "Expecting: 666\\\^done,BreakpointTable=\{nr_rows=\".\",nr_cols=\".\",hdr=\\\[\{width=\".*\",alignment=\".*\",col_name=\"number\",colhdr=\"Num\"\}.*colhdr=\"Type\".*colhdr=\"Disp\".*colhdr=\"Enb\".*colhdr=\"Address\".*colhdr=\"What\".*\\\],body=\\\[$body\\\]\}"
1250     mi_gdb_test "666-break-list" \
1251         "666\\\^done,BreakpointTable=\{nr_rows=\".\",nr_cols=\".\",hdr=\\\[\{width=\".*\",alignment=\".*\",col_name=\"number\",colhdr=\"Num\"\}.*colhdr=\"Type\".*colhdr=\"Disp\".*colhdr=\"Enb\".*colhdr=\"Address\".*colhdr=\"What\".*\\\],body=\\\[$body\\\]\}" \
1252         $test
1253 }
1254
1255 # Creates varobj named NAME for EXPRESSION.
1256 # Name cannot be "-".
1257 proc mi_create_varobj { name expression testname } {
1258     mi_gdb_test "-var-create $name * $expression" \
1259         "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=.*,has_more=\"0\"" \
1260         $testname
1261 }
1262
1263 proc mi_create_floating_varobj { name expression testname } {
1264     mi_gdb_test "-var-create $name @ $expression" \
1265         "\\^done,name=\"$name\",numchild=\"\(-1\|\[0-9\]+\)\",value=\".*\",type=.*" \
1266         $testname
1267 }
1268
1269
1270 # Same as mi_create_varobj, but also checks the reported type
1271 # of the varobj.
1272 proc mi_create_varobj_checked { name expression type testname } {
1273     mi_gdb_test "-var-create $name * $expression" \
1274         "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=\"$type\".*" \
1275         $testname
1276 }
1277
1278 # Same as mi_create_floating_varobj, but assumes the test is creating
1279 # a dynamic varobj that has children, so the value must be "{...}".
1280 proc mi_create_dynamic_varobj {name expression testname} {
1281     mi_gdb_test "-var-create $name @ $expression" \
1282         "\\^done,name=\"$name\",numchild=\"\(-1\|\[0-9\]+\)\",value=\"{\\.\\.\\.}\",type=.*" \
1283         $testname
1284 }
1285
1286 # Deletes the specified NAME.
1287 proc mi_delete_varobj { name testname } {
1288     mi_gdb_test "-var-delete $name" \
1289         "\\^done,ndeleted=.*" \
1290         $testname
1291 }
1292
1293 # Updates varobj named NAME and checks that all varobjs in EXPECTED
1294 # are reported as updated, and no other varobj is updated.
1295 # Assumes that no varobj is out of scope and that no varobj changes
1296 # types.
1297 proc mi_varobj_update { name expected testname } {
1298     set er "\\^done,changelist=\\\["
1299     set first 1
1300     foreach item $expected {
1301         set v "{name=\"$item\",in_scope=\"true\",type_changed=\"false\",has_more=\".\"}"
1302         if {$first == 1} {
1303             set er "$er$v"
1304             set first 0
1305         } else {
1306             set er "$er,$v"
1307         }
1308     }
1309     set er "$er\\\]"
1310
1311     verbose -log "Expecting: $er" 2
1312     mi_gdb_test "-var-update $name" $er $testname
1313 }
1314
1315 proc mi_varobj_update_with_child_type_change { name child_name new_type new_children testname } {
1316     set v "{name=\"$child_name\",in_scope=\"true\",type_changed=\"true\",new_type=\"$new_type\",new_num_children=\"$new_children\",has_more=\".\"}"
1317     set er "\\^done,changelist=\\\[$v\\\]"
1318     verbose -log "Expecting: $er"
1319     mi_gdb_test "-var-update $name" $er $testname
1320 }
1321
1322 proc mi_varobj_update_with_type_change { name new_type new_children testname } {
1323     mi_varobj_update_with_child_type_change $name $name $new_type $new_children $testname
1324 }
1325
1326 # A helper that turns a key/value list into a regular expression
1327 # matching some MI output.
1328 proc mi_varobj_update_kv_helper {list} {
1329     set first 1
1330     set rx ""
1331     foreach {key value} $list {
1332         if {!$first} {
1333             append rx ,
1334         }
1335         set first 0
1336         if {$key == "new_children"} {
1337             append rx "$key=\\\[$value\\\]"
1338         } else {
1339             append rx "$key=\"$value\""
1340         }
1341     }
1342     return $rx
1343 }
1344
1345 # A helper for mi_varobj_update_dynamic that computes a match
1346 # expression given a child list.
1347 proc mi_varobj_update_dynamic_helper {children} {
1348     set crx ""
1349
1350     set first 1
1351     foreach child $children {
1352         if {!$first} {
1353             append crx ,
1354         }
1355         set first 0
1356         append crx "{"
1357         append crx [mi_varobj_update_kv_helper $child]
1358         append crx "}"
1359     }
1360
1361     return $crx
1362 }
1363
1364 # Update a dynamic varobj named NAME.  CHILDREN is a list of children
1365 # that have been updated; NEW_CHILDREN is a list of children that were
1366 # added to the primary varobj.  Each child is a list of key/value
1367 # pairs that are expected.  SELF is a key/value list holding
1368 # information about the varobj itself.  TESTNAME is the name of the
1369 # test.
1370 proc mi_varobj_update_dynamic {name testname self children new_children} {
1371     if {[llength $new_children]} {
1372         set newrx [mi_varobj_update_dynamic_helper $new_children]
1373         lappend self new_children $newrx
1374     }
1375     set selfrx [mi_varobj_update_kv_helper $self]
1376     set crx [mi_varobj_update_dynamic_helper $children]
1377
1378     set er "\\^done,changelist=\\\[\{name=\"$name\",in_scope=\"true\""
1379     append er ",$selfrx\}"
1380     if {"$crx" != ""} {
1381         append er ",$crx"
1382     }
1383     append er "\\\]"
1384
1385     verbose -log "Expecting: $er"
1386     mi_gdb_test "-var-update $name" $er $testname
1387 }
1388
1389 proc mi_check_varobj_value { name value testname } {
1390
1391     mi_gdb_test "-var-evaluate-expression $name" \
1392         "\\^done,value=\"$value\"" \
1393         $testname
1394 }
1395
1396 # Helper proc which constructs a child regexp for
1397 # mi_list_varobj_children and mi_varobj_update_dynamic.
1398 proc mi_child_regexp {children add_child} {
1399     set children_exp {}
1400
1401     if {$add_child} {
1402         set pre "child="
1403     } else {
1404         set pre ""
1405     }
1406
1407     foreach item $children {
1408
1409         set name [lindex $item 0]
1410         set exp [lindex $item  1]
1411         set numchild [lindex $item 2]
1412         if {[llength $item] == 5} {
1413             set type [lindex $item 3]
1414             set value [lindex $item 4]
1415
1416             lappend children_exp\
1417                 "$pre{name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",value=\"$value\",type=\"$type\"(,thread-id=\"\[0-9\]+\")?}"
1418         } elseif {[llength $item] == 4} {
1419             set type [lindex $item 3]
1420
1421             lappend children_exp\
1422                 "$pre{name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",type=\"$type\"(,thread-id=\"\[0-9\]+\")?}"
1423         } else {
1424             lappend children_exp\
1425                 "$pre{name=\"$name\",exp=\"$exp\",numchild=\"$numchild\"(,thread-id=\"\[0-9\]+\")?}"
1426         }
1427     }
1428     return [join $children_exp ","]
1429 }
1430
1431 # Check the results of the:
1432 #
1433 #   -var-list-children VARNAME
1434 #
1435 # command.  The CHILDREN parement should be a list of lists.
1436 # Each inner list can have either 3 or 4 elements, describing
1437 # fields that gdb is expected to report for child variable object,
1438 # in the following order
1439 #
1440 #   - Name
1441 #   - Expression
1442 #   - Number of children
1443 #   - Type
1444 #
1445 # If inner list has 3 elements, the gdb is expected to output no
1446 # type for a child and no value.
1447 #
1448 # If the inner list has 4 elements, gdb output is expected to
1449 # have no value.
1450 #
1451 proc mi_list_varobj_children { varname children testname } {
1452     mi_list_varobj_children_range $varname "" "" [llength $children] $children \
1453       $testname
1454 }
1455
1456 # Like mi_list_varobj_children, but sets a subrange.  NUMCHILDREN is
1457 # the total number of children.
1458 proc mi_list_varobj_children_range {varname from to numchildren children testname} {
1459     set options ""
1460     if {[llength $varname] == 2} {
1461         set options [lindex $varname 1]
1462         set varname [lindex $varname 0]
1463     }
1464
1465     set children_exp_j [mi_child_regexp $children 1]
1466     if {$numchildren} {
1467         set expected "\\^done,numchild=\".*\",children=\\\[$children_exp_j.*\\\]"
1468     } {
1469         set expected "\\^done,numchild=\"0\""
1470     }
1471
1472     if {"$to" == ""} {
1473         append expected ",has_more=\"0\""
1474     } elseif {$to >= 0 && $numchildren > $to} {
1475         append expected ",has_more=\"1\""
1476     } else {
1477         append expected ",has_more=\"0\""
1478     }
1479
1480     verbose -log "Expecting: $expected"
1481
1482     mi_gdb_test "-var-list-children $options $varname $from $to" \
1483       $expected $testname
1484 }
1485
1486 # Verifies that variable object VARNAME has NUMBER children,
1487 # where each one is named $VARNAME.<index-of-child> and has type TYPE.
1488 proc mi_list_array_varobj_children { varname number type testname } {
1489     set t {}
1490     for {set i 0} {$i < $number} {incr i} {
1491         lappend t [list $varname.$i $i 0 $type]
1492     }
1493     mi_list_varobj_children $varname $t $testname
1494 }
1495
1496 # A list of two-element lists.  First element of each list is
1497 # a Tcl statement, and the second element is the line
1498 # number of source C file where the statement originates.
1499 set mi_autotest_data ""
1500 # The name of the source file for autotesting.
1501 set mi_autotest_source ""
1502
1503 proc count_newlines { string } {
1504     return [regexp -all "\n" $string]
1505 }
1506
1507 # Prepares for running inline tests in FILENAME.
1508 # See comments for mi_run_inline_test for detailed
1509 # explanation of the idea and syntax.
1510 proc mi_prepare_inline_tests { filename } {
1511
1512     global srcdir
1513     global subdir
1514     global mi_autotest_source
1515     global mi_autotest_data
1516
1517     set mi_autotest_data {}
1518
1519     set mi_autotest_source $filename
1520
1521     if { ! [regexp "^/" "$filename"] } then {
1522         set filename "$srcdir/$subdir/$filename"
1523     }
1524
1525     set chan [open $filename]
1526     set content [read $chan]
1527     set line_number 1
1528     while {1} {
1529         set start [string first "/*:" $content]
1530         if {$start != -1} {
1531             set end [string first ":*/" $content]
1532             if {$end == -1} {
1533                 error "Unterminated special comment in $filename"
1534             }
1535
1536             set prefix [string range $content 0 $start]
1537             set prefix_newlines [count_newlines $prefix]
1538
1539             set line_number [expr $line_number+$prefix_newlines]
1540             set comment_line $line_number
1541
1542             set comment [string range $content [expr $start+3] [expr $end-1]]
1543
1544             set comment_newlines [count_newlines $comment]
1545             set line_number [expr $line_number+$comment_newlines]
1546
1547             set comment [string trim $comment]
1548             set content [string range $content [expr $end+3] \
1549                              [string length $content]]
1550             lappend mi_autotest_data [list $comment $comment_line]
1551         } else {
1552             break
1553         }
1554     }
1555     close $chan
1556 }
1557
1558 # Helper to mi_run_inline_test below.
1559 # Return the list of all (statement,line_number) lists
1560 # that comprise TESTCASE.  The begin and end markers
1561 # are not included.
1562 proc mi_get_inline_test {testcase} {
1563
1564     global mi_gdb_prompt
1565     global mi_autotest_data
1566     global mi_autotest_source
1567
1568     set result {}
1569
1570     set seen_begin 0
1571     set seen_end 0
1572     foreach l $mi_autotest_data {
1573
1574         set comment [lindex $l 0]
1575
1576         if {$comment == "BEGIN: $testcase"} {
1577             set seen_begin 1
1578         } elseif {$comment == "END: $testcase"} {
1579             set seen_end 1
1580             break
1581         } elseif {$seen_begin==1} {
1582             lappend result $l
1583         }
1584     }
1585
1586     if {$seen_begin == 0} {
1587         error "Autotest $testcase not found"
1588     }
1589
1590     if {$seen_begin == 1 && $seen_end == 0} {
1591         error "Missing end marker for test $testcase"
1592     }
1593
1594     return $result
1595 }
1596
1597 # Sets temporary breakpoint at LOCATION.
1598 proc mi_tbreak {location} {
1599
1600     global mi_gdb_prompt
1601
1602     mi_gdb_test "-break-insert -t $location" \
1603         {\^done,bkpt=.*} \
1604         "run to $location (set breakpoint)"
1605 }
1606
1607 # Send COMMAND that must be a command that resumes
1608 # the inferior (run/continue/next/etc) and consumes
1609 # the "^running" output from it.
1610 proc mi_send_resuming_command_raw {command test} {
1611
1612     global mi_gdb_prompt
1613     global thread_selected_re
1614     global library_loaded_re
1615
1616     send_gdb "$command\n"
1617     gdb_expect {
1618         -re "\\^running\r\n\\*running,thread-id=\"\[^\"\]+\"\r\n($library_loaded_re)*($thread_selected_re)?${mi_gdb_prompt}" {
1619             # Note that lack of 'pass' call here -- this works around limitation
1620             # in DejaGNU xfail mechanism. mi-until.exp has this:
1621             #
1622             #     setup_kfail gdb/2104 "*-*-*"
1623             #     mi_execute_to ...
1624             #
1625             # and mi_execute_to uses mi_send_resuming_command.  If we use 'pass' here,
1626             # it will reset kfail, so when the actual test fails, it will be flagged
1627             # as real failure.
1628             return 0
1629         }
1630         -re "\\^error,msg=\"Displaced stepping is only supported in ARM mode\".*" {
1631             unsupported "$test (Thumb mode)"
1632             return -1
1633         }
1634         -re "\\^error,msg=.*" {
1635             fail "$test (MI error)"
1636             return -1
1637         }
1638         -re ".*${mi_gdb_prompt}" {
1639             fail "$test (failed to resume)"
1640             return -1
1641         }
1642         timeout {
1643             fail "$test"
1644             return -1
1645         }
1646     }
1647 }
1648
1649 proc mi_send_resuming_command {command test} {
1650     mi_send_resuming_command_raw -$command $test
1651 }
1652
1653 # Helper to mi_run_inline_test below.
1654 # Sets a temporary breakpoint at LOCATION and runs
1655 # the program using COMMAND.  When the program is stopped
1656 # returns the line at which it.  Returns -1 if line cannot
1657 # be determined.
1658 # Does not check that the line is the same as requested.
1659 # The caller can check itself if required.
1660 proc mi_continue_to_line {location test} {
1661
1662     mi_tbreak $location
1663     mi_send_resuming_command "exec-continue" "run to $location (exec-continue)"
1664     return [mi_get_stop_line $test]
1665 }
1666
1667 # Wait until gdb prints the current line.
1668 proc mi_get_stop_line {test} {
1669
1670   global mi_gdb_prompt
1671   global async
1672
1673   if {$async} {
1674       set prompt_re ""
1675   } else {
1676       set prompt_re "$mi_gdb_prompt$"
1677   }
1678
1679   gdb_expect {
1680       -re ".*line=\"(\[0-9\]*)\".*\r\n$prompt_re" {
1681           return $expect_out(1,string)
1682       }
1683       -re ".*$mi_gdb_prompt" {
1684           fail "wait for stop ($test)"
1685       }
1686       timeout {
1687           fail "wait for stop ($test)"
1688       }
1689   }
1690 }
1691
1692 # Run a MI test embedded in comments in a C file.
1693 # The C file should contain special comments in the following
1694 # three forms:
1695 #
1696 #    /*: BEGIN: testname :*/
1697 #    /*:  <Tcl statements> :*/
1698 #    /*: END: testname :*/
1699 #
1700 # This procedure find the begin and end marker for the requested
1701 # test. Then, a temporary breakpoint is set at the begin
1702 # marker and the program is run (from start).
1703 #
1704 # After that, for each special comment between the begin and end
1705 # marker, the Tcl statements are executed.  It is assumed that
1706 # for each comment, the immediately preceding line is executable
1707 # C statement.  Then, gdb will be single-stepped until that
1708 # preceding C statement is executed, and after that the
1709 # Tcl statements in the comment will be executed.
1710 #
1711 # For example:
1712 #
1713 #     /*: BEGIN: assignment-test :*/
1714 #     v = 10;
1715 #     /*: <Tcl code to check that 'v' is indeed 10 :*/
1716 #     /*: END: assignment-test :*/
1717 #
1718 # The mi_prepare_inline_tests function should be called before
1719 # calling this function.  A given C file can contain several
1720 # inline tests.  The names of the tests must be unique within one
1721 # C file.
1722 #
1723 proc mi_run_inline_test { testcase } {
1724
1725     global mi_gdb_prompt
1726     global hex
1727     global decimal
1728     global fullname_syntax
1729     global mi_autotest_source
1730
1731     set commands [mi_get_inline_test $testcase]
1732
1733     set first 1
1734     set line_now 1
1735
1736     foreach c $commands {
1737         set statements [lindex $c 0]
1738         set line [lindex $c 1]
1739         set line [expr $line-1]
1740
1741         # We want gdb to be stopped at the expression immediately
1742         # before the comment.  If this is the first comment, the
1743         # program is either not started yet or is in some random place,
1744         # so we run it.  For further comments, we might be already
1745         # standing at the right line. If not continue till the
1746         # right line.
1747
1748         if {$first==1} {
1749             # Start the program afresh.
1750             mi_tbreak "$mi_autotest_source:$line"
1751             mi_run_cmd
1752             set line_now [mi_get_stop_line "$testcase: step to $line"]
1753             set first 0
1754         } elseif {$line_now!=$line} {
1755             set line_now [mi_continue_to_line "$mi_autotest_source:$line" "continue to $line"]
1756         }
1757
1758         if {$line_now!=$line} {
1759             fail "$testcase: go to line $line"
1760         }
1761
1762         # We're not at the statement right above the comment.
1763         # Execute that statement so that the comment can test
1764         # the state after the statement is executed.
1765
1766         # Single-step past the line.
1767         if { [mi_send_resuming_command "exec-next" "$testcase: step over $line"] != 0 } {
1768             return -1
1769         }
1770         set line_now [mi_get_stop_line "$testcase: step over $line"]
1771
1772         # We probably want to use 'uplevel' so that statements
1773         # have direct access to global variables that the
1774         # main 'exp' file has set up.  But it's not yet clear,
1775         # will need more experience to be sure.
1776         eval $statements
1777     }
1778 }
1779
1780 proc get_mi_thread_list {name} {
1781   global expect_out
1782
1783   # MI will return a list of thread ids:
1784   #
1785   # -thread-list-ids
1786   # ^done,thread-ids=[thread-id="1",thread-id="2",...],number-of-threads="N"
1787   # (gdb)
1788   mi_gdb_test "-thread-list-ids" \
1789     {.*\^done,thread-ids={(thread-id="[0-9]+"(,)?)+},current-thread-id="[0-9]+",number-of-threads="[0-9]+"} \
1790     "-thread_list_ids ($name)"
1791
1792   set output {}
1793   if {[info exists expect_out(buffer)]} {
1794     set output $expect_out(buffer)
1795   }
1796
1797   set thread_list {}
1798   if {![regexp {thread-ids=\{(thread-id="[0-9]+"(,)?)*\}} $output threads]} {
1799     fail "finding threads in MI output ($name)"
1800   } else {
1801     pass "finding threads in MI output ($name)"
1802
1803     # Make list of console threads
1804     set start [expr {[string first \{ $threads] + 1}]
1805     set end   [expr {[string first \} $threads] - 1}]
1806     set threads [string range $threads $start $end]
1807     foreach thread [split $threads ,] {
1808       if {[scan $thread {thread-id="%d"} num]} {
1809         lappend thread_list $num
1810       }
1811     }
1812   }
1813
1814   return $thread_list
1815 }
1816
1817 # Check that MI and the console know of the same threads.
1818 # Appends NAME to all test names.
1819 proc check_mi_and_console_threads {name} {
1820   global expect_out
1821
1822   mi_gdb_test "-thread-list-ids" \
1823     {.*\^done,thread-ids={(thread-id="[0-9]+"(,)*)+},current-thread-id="[0-9]+",number-of-threads="[0-9]+"} \
1824     "-thread-list-ids ($name)"
1825   set mi_output {}
1826   if {[info exists expect_out(buffer)]} {
1827     set mi_output $expect_out(buffer)
1828   }
1829
1830   # GDB will return a list of thread ids and some more info:
1831   #
1832   # (gdb)
1833   # -interpreter-exec console "info threads"
1834   # ~"  4 Thread 2051 (LWP 7734)  0x401166b1 in __libc_nanosleep () at __libc_nanosleep:-1"
1835   # ~"  3 Thread 1026 (LWP 7733)   () at __libc_nanosleep:-1"
1836   # ~"  2 Thread 2049 (LWP 7732)  0x401411f8 in __poll (fds=0x804bb24, nfds=1, timeout=2000) at ../sysdeps/unix/sysv/linux/poll.c:63"
1837   # ~"* 1 Thread 1024 (LWP 7731)  main (argc=1, argv=0xbfffdd94) at ../../../src/gdb/testsuite/gdb.mi/pthreads.c:160"
1838   # FIXME: kseitz/2002-09-05: Don't use the hack-cli method.
1839   mi_gdb_test "info threads" \
1840     {.*(~".*"[\r\n]*)+.*} \
1841     "info threads ($name)"
1842   set console_output {}
1843   if {[info exists expect_out(buffer)]} {
1844     set console_output $expect_out(buffer)
1845   }
1846
1847   # Make a list of all known threads to console (gdb's thread IDs)
1848   set console_thread_list {}
1849   foreach line [split $console_output \n] {
1850     if {[string index $line 0] == "~"} {
1851       # This is a line from the console; trim off "~", " ", "*", and "\""
1852       set line [string trim $line ~\ \"\*]
1853       if {[scan $line "%d" id] == 1} {
1854         lappend console_thread_list $id
1855       }
1856     }
1857   }
1858
1859   # Now find the result string from MI
1860   set mi_result ""
1861   foreach line [split $mi_output \n] {
1862     if {[string range $line 0 4] == "^done"} {
1863       set mi_result $line
1864     }
1865   }
1866   if {$mi_result == ""} {
1867     fail "finding MI result string ($name)"
1868   } else {
1869     pass "finding MI result string ($name)"
1870   }
1871
1872   # Finally, extract the thread ids and compare them to the console
1873   set num_mi_threads_str ""
1874   if {![regexp {number-of-threads="[0-9]+"} $mi_result num_mi_threads_str]} {
1875     fail "finding number of threads in MI output ($name)"
1876   } else {
1877     pass "finding number of threads in MI output ($name)"
1878
1879     # Extract the number of threads from the MI result
1880     if {![scan $num_mi_threads_str {number-of-threads="%d"} num_mi_threads]} {
1881       fail "got number of threads from MI ($name)"
1882     } else {
1883       pass "got number of threads from MI ($name)"
1884
1885       # Check if MI and console have same number of threads
1886       if {$num_mi_threads != [llength $console_thread_list]} {
1887         fail "console and MI have same number of threads ($name)"
1888       } else {
1889         pass "console and MI have same number of threads ($name)"
1890
1891         # Get MI thread list
1892         set mi_thread_list [get_mi_thread_list $name]
1893
1894         # Check if MI and console have the same threads
1895         set fails 0
1896         foreach ct [lsort $console_thread_list] mt [lsort $mi_thread_list] {
1897           if {$ct != $mt} {
1898             incr fails
1899           }
1900         }
1901         if {$fails > 0} {
1902           fail "MI and console have same threads ($name)"
1903
1904           # Send a list of failures to the log
1905           send_log "Console has thread ids: $console_thread_list\n"
1906           send_log "MI has thread ids: $mi_thread_list\n"
1907         } else {
1908           pass "MI and console have same threads ($name)"
1909         }
1910       }
1911     }
1912   }
1913 }
1914
1915 # Download shared libraries to the target.
1916 proc mi_load_shlibs { args } {
1917     if {![is_remote target]} {
1918         return
1919     }
1920
1921     foreach file $args {
1922         gdb_download [shlib_target_file $file]
1923     }
1924
1925     # Even if the target supplies full paths for shared libraries,
1926     # they may not be paths for this system.
1927     mi_gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "\^done" ""
1928 }
1929
1930 proc mi_reverse_list { list } {
1931     if { [llength $list] <= 1 } {
1932         return $list
1933     }
1934     set tail [lrange $list 1 [llength $list]]
1935     set rtail [mi_reverse_list $tail]
1936     lappend rtail [lindex $list 0]
1937     return $rtail
1938 }
1939
1940 proc mi_check_thread_states { xstates test } {
1941     global expect_out
1942     set states [mi_reverse_list $xstates]
1943     set pattern ".*\\^done,threads=\\\["
1944     foreach s $states {
1945         set pattern "${pattern}(.*)state=\"$s\""
1946     }
1947     set pattern "${pattern}(,core=\"\[0-9\]*\")?\\\}\\\].*"
1948
1949     verbose -log "expecting: $pattern"
1950     mi_gdb_test "-thread-info" $pattern $test
1951 }
1952
1953 # Return a list of MI features supported by this gdb.
1954 proc mi_get_features {} {
1955     global expect_out mi_gdb_prompt
1956
1957     send_gdb "-list-features\n"
1958
1959     gdb_expect {
1960         -re "\\^done,features=\\\[(.*)\\\]\r\n$mi_gdb_prompt$" {
1961             regsub -all -- \" $expect_out(1,string) "" features
1962             return [split $features ,]
1963         }
1964         -re ".*\r\n$mi_gdb_prompt$" {
1965             verbose -log "got $expect_out(buffer)"
1966             return ""
1967         }
1968         timeout {
1969             verbose -log "timeout in mi_gdb_prompt"
1970             return ""
1971         }
1972     }
1973 }
1974
1975 # Variable Object Trees
1976 #
1977 # Yet another way to check varobjs. Pass mi_walk_varobj_tree a "list" of
1978 # variables (not unlike the actual source code definition), and it will
1979 # automagically test the children for you (by default).
1980 #
1981 # Example:
1982 #
1983 # source code:
1984 # struct bar {
1985 #   union {
1986 #     int integer;
1987 #     void *ptr;
1988 #   };
1989 #   const int *iPtr;
1990 # };
1991 #
1992 # class foo {
1993 # public:
1994 #   int a;
1995 #   struct {
1996 #     int b;
1997 #     struct bar *c;
1998 #   };
1999 # };
2000 #
2001 # foo *f = new foo (); <-- break here
2002 #
2003 # We want to check all the children of "f".
2004 #
2005 # Translate the above structures into the following tree:
2006 #
2007 # set tree {
2008 #   foo f {
2009 #     {} public {
2010 #       int a {}
2011 #       anonymous struct {
2012 #         {} public {
2013 #           int b {}
2014 #           {bar *} c {
2015 #             {} public {
2016 #               anonymous union {
2017 #                 {} public {
2018 #                   int integer {}
2019 #                   {void *} ptr {}
2020 #                 }
2021 #               }
2022 #               {const int *} iPtr {
2023 #                 {const int} {*iPtr} {}
2024 #               }
2025 #             }
2026 #           }
2027 #         }
2028 #       }
2029 #     }
2030 #   }
2031 # }
2032 #
2033 # mi_walk_varobj_tree c++ $tree
2034 #
2035 # If you'd prefer to walk the tree using your own callback,
2036 # simply pass the name of the callback to mi_walk_varobj_tree.
2037 #
2038 # This callback should take one argument, the name of the variable
2039 # to process.  This name is the name of a global array holding the
2040 # variable's properties (object name, type, etc).
2041 #
2042 # An example callback:
2043 #
2044 # proc my_callback {var} {
2045 #   upvar #0 $var varobj
2046 #
2047 #   puts "my_callback: called on varobj $varobj(obj_name)"
2048 # }
2049 #
2050 # The arrays created for each variable object contain the following
2051 # members:
2052 #
2053 # obj_name     - the object name for accessing this variable via MI
2054 # display_name - the display name for this variable (exp="display_name" in
2055 #                the output of -var-list-children)
2056 # type         - the type of this variable (type="type" in the output
2057 #                of -var-list-children, or the special tag "anonymous"
2058 # path_expr    - the "-var-info-path-expression" for this variable
2059 #                NOTE: This member cannot be used reliably with typedefs.
2060 #                Use with caution!
2061 #                See notes inside get_path_expr for more.
2062 # parent       - the variable name of the parent varobj
2063 # children     - a list of children variable names (which are the
2064 #                names Tcl arrays, not object names)
2065 #
2066 # For each variable object, an array containing the above fields will
2067 # be created under the root node (conveniently called, "root").  For example,
2068 # a variable object with handle "OBJ.public.0_anonymous.a" will have
2069 # a corresponding global Tcl variable named "root.OBJ.public.0_anonymous.a".
2070 #
2071 # Note that right now, this mechanism cannot be used for recursive data
2072 # structures like linked lists.
2073
2074 namespace eval ::varobj_tree {
2075   # An index which is appended to root varobjs to ensure uniqueness.
2076   variable _root_idx 0
2077
2078   # A procedure to help with debuggging varobj trees.
2079   # VARIABLE_NAME is the name of the variable to dump.
2080   # CMD, if present, is the name of the callback to output the contstructed
2081   #   strings. By default, it uses expect's "send_log" command.
2082   # TERM, if present, is a terminating character. By default it is the newline.
2083   #
2084   # To output to the terminal (not the expect log), use
2085   # mi_varobj_tree_dump_variable my_variable puts ""
2086
2087   proc mi_varobj_tree_dump_variable {variable_name {cmd send_log} {term "\n"}} {
2088     upvar #0 $variable_name varobj
2089
2090     eval "$cmd \"VAR = $variable_name$term\""
2091
2092     # Explicitly encode the array indices, since outputting them
2093     # in some logical order is better than what "array names" might
2094     # return.
2095     foreach idx {obj_name parent display_name type path_expr} {
2096       eval "$cmd \"\t$idx = $varobj($idx)$term\""
2097     }
2098
2099     # Output children
2100     set num [llength $varobj(children)]
2101     eval "$cmd \"\tnum_children = $num$term\""
2102     if {$num > 0} {
2103       eval "$cmd \"\tchildren = $varobj(children)$term\""
2104     }
2105   }
2106
2107   # The default callback used by mi_walk_varobj_tree.  This callback
2108   # simply checks all of VAR's children.  It specifically does not test
2109   # path expressions, since that is very problematic.
2110   #
2111   # This procedure may be used in custom callbacks.
2112   proc test_children_callback {variable_name} {
2113     upvar #0 $variable_name varobj
2114
2115     if {[llength $varobj(children)] > 0} {
2116       # Construct the list of children the way mi_list_varobj_children
2117       # expects to get it:
2118       # { {obj_name display_name num_children type} ... }
2119       set children_list {}
2120       foreach child $varobj(children) {
2121         upvar #0 $child c
2122         set clist [list [string_to_regexp $c(obj_name)] \
2123                        [string_to_regexp $c(display_name)] \
2124                        [llength $c(children)]]
2125         if {[string length $c(type)] > 0} {
2126           lappend clist [string_to_regexp $c(type)]
2127         }
2128         lappend children_list $clist
2129       }
2130
2131       mi_list_varobj_children $varobj(obj_name) $children_list \
2132           "VT: list children of $varobj(obj_name)"
2133     }
2134   }
2135
2136   # Set the properties of the varobj represented by
2137   # PARENT_VARIABLE - the name of the parent's variable
2138   # OBJNAME         - the MI object name of this variable
2139   # DISP_NAME       - the display name of this variable
2140   # TYPE            - the type of this variable
2141   # PATH            - the path expression for this variable
2142   # CHILDREN        - a list of the variable's children
2143   proc create_varobj {parent_variable objname disp_name \
2144                           type path children} {
2145     upvar #0 $parent_variable parent
2146
2147     set var_name "root.$objname"
2148     global $var_name
2149     array set $var_name [list obj_name $objname]
2150     array set $var_name [list display_name $disp_name]
2151     array set $var_name [list type $type]
2152     array set $var_name [list path_expr $path]
2153     array set $var_name [list parent "$parent_variable"]
2154     array set $var_name [list children \
2155                              [get_tree_children $var_name $children]]
2156     return $var_name
2157   }
2158
2159   # Should VARIABLE be used in path expressions?  The CPLUS_FAKE_CHILD
2160   # varobjs and anonymous structs/unions are not used for path expressions.
2161   proc is_path_expr_parent {variable} {
2162     upvar #0 $variable varobj
2163
2164     # If the varobj's type is "", it is a CPLUS_FAKE_CHILD.
2165     # If the tail of the varobj's object name is "%d_anonymous",
2166     # then it represents an anonymous struct or union.
2167     if {[string length $varobj(type)] == 0 \
2168             || [regexp {[0-9]+_anonymous$} $varobj(obj_name)]} {
2169       return false
2170     }
2171
2172     return true
2173   }
2174
2175   # Return the path expression for the variable named NAME in
2176   # parent varobj whose variable name is given by PARENT_VARIABLE.
2177   proc get_path_expr {parent_variable name type} {
2178     upvar #0 $parent_variable parent
2179     upvar #0 $parent_variable path_parent
2180
2181     # If TYPE is "", this is one of the CPLUS_FAKE_CHILD varobjs,
2182     # which has no path expression.  Likewsise for anonymous structs
2183     # and unions.
2184     if {[string length $type] == 0 \
2185             || [string compare $type "anonymous"] == 0} {
2186       return ""
2187     }
2188
2189     # Find the path parent variable.
2190     while {![is_path_expr_parent $parent_variable]} {
2191       set parent_variable $path_parent(parent)
2192       upvar #0 $parent_variable path_parent
2193     }
2194
2195     # This is where things get difficult.  We do not actually know
2196     # the real type for variables defined via typedefs, so we don't actually
2197     # know whether the parent is a structure/union or not.
2198     #
2199     # So we assume everything that isn't a simple type is a compound type.
2200     set stars ""
2201     regexp {\*+} $parent(type) stars
2202     set is_compound 1
2203     if {[string index $name 0] == "*"} {
2204       set is_compound 0
2205     }
2206
2207     if {[string index $parent(type) end] == "\]"} {
2208       # Parent is an array.
2209       return "($path_parent(path_expr))\[$name\]"
2210     } elseif {$is_compound} {
2211       # Parent is a structure or union or a pointer to one.
2212       if {[string length $stars]} {
2213         set join "->"
2214       } else {
2215         set join "."
2216       }
2217
2218       global root
2219
2220       # To make matters even more hideous, varobj.c has slightly different
2221       # path expressions for C and C++.
2222       set path_expr "($path_parent(path_expr))$join$name"
2223       if {[string compare -nocase $root(language) "c"] == 0} {
2224         return $path_expr
2225       } else {
2226         return "($path_expr)"
2227       }
2228     } else {
2229       # Parent is a pointer.
2230       return "*($path_parent(path_expr))"
2231     }
2232   }
2233
2234   # Process the CHILDREN (a list of varobj_tree elements) of the variable
2235   # given by PARENT_VARIABLE.  Returns a list of children variables.
2236   proc get_tree_children {parent_variable children} {
2237     upvar #0 $parent_variable parent
2238
2239     set field_idx 0
2240     set children_list {}
2241     foreach {type name children} $children {
2242       if {[string compare $parent_variable "root"] == 0} {
2243         # Root variable
2244         variable _root_idx
2245         incr _root_idx
2246         set objname "$name$_root_idx"
2247         set disp_name "$name"
2248         set path_expr "$name"
2249       } elseif {[string compare $type "anonymous"] == 0} {
2250         # Special case: anonymous types.  In this case, NAME will either be
2251         # "struct" or "union".
2252         set objname "$parent(obj_name).${field_idx}_anonymous"
2253         set disp_name "<anonymous $name>"
2254         set path_expr ""
2255         set type "$name {...}"
2256       } else {
2257         set objname "$parent(obj_name).$name"
2258         set disp_name $name
2259         set path_expr [get_path_expr $parent_variable $name $type]
2260       }
2261
2262       lappend children_list [create_varobj $parent_variable $objname \
2263                                  $disp_name $type $path_expr $children]
2264       incr field_idx
2265     }
2266
2267     return $children_list
2268   }
2269
2270   # The main procedure to call the given CALLBACK on the elements of the
2271   # given varobj TREE.  See detailed explanation above.
2272   proc walk_tree {language tree callback} {
2273     global root
2274     variable _root_idx
2275
2276     if {[llength $tree] < 3} {
2277       error "tree does not contain enough elements"
2278     }
2279
2280     set _root_idx 0
2281
2282     # Create root node and process the tree.
2283     array set root [list language $language]
2284     array set root [list obj_name "root"]
2285     array set root [list display_name "root"]
2286     array set root [list type "root"]
2287     array set root [list path_expr "root"]
2288     array set root [list parent "root"]
2289     array set root [list children [get_tree_children root $tree]]
2290
2291     # Walk the tree
2292     set all_nodes $root(children); # a stack of nodes
2293     while {[llength $all_nodes] > 0} {
2294       # "Pop" the name of the global variable containing this varobj's
2295       # information from the stack of nodes.
2296       set var_name [lindex $all_nodes 0]
2297       set all_nodes [lreplace $all_nodes 0 0]
2298
2299       # Bring the global named in VAR_NAME into scope as the local variable
2300       # VAROBJ.
2301       upvar #0 $var_name varobj
2302
2303       # Append any children of VAROBJ to the list of nodes to walk.
2304       if {[llength $varobj(children)] > 0} {
2305         set all_nodes [concat $all_nodes $varobj(children)]
2306       }
2307
2308       # If this is a root variable, create the variable object for it.
2309       if {[string compare $varobj(parent) "root"] == 0} {
2310         mi_create_varobj $varobj(obj_name) $varobj(display_name) \
2311             "VT: create root varobj for $varobj(display_name)"
2312       }
2313
2314       # Now call the callback for VAROBJ.
2315       uplevel #0 $callback $var_name
2316     }
2317   }
2318 }
2319
2320 # The default varobj tree callback, which simply tests -var-list-children.
2321 proc mi_varobj_tree_test_children_callback {variable} {
2322   ::varobj_tree::test_children_callback $variable
2323 }
2324
2325 # Walk the variable object tree given by TREE, calling the specified
2326 # CALLBACK.  By default this uses mi_varobj_tree_test_children_callback.
2327 proc mi_walk_varobj_tree {language tree \
2328                               {callback \
2329                                    mi_varobj_tree_test_children_callback}} {
2330   ::varobj_tree::walk_tree $language $tree $callback
2331 }