diff mbox

Another board file for remote host

Message ID 87d2bbcyn8.fsf@codesourcery.com
State New, archived
Headers

Commit Message

Yao Qi Sept. 4, 2014, 1:18 p.m. UTC 
  Doug Evans <xdje42@gmail.com> writes:

> +global GDB
> +set GDB [file join [pwd] "../gdb"]
>
> Check if GDB has been set first, allow the user to
> pass this in from the command line.

GDB is always set in lib/gdb.exp and it is loaded earlier than the
board file.  In lib/gdb.exp:

if ![info exists GDB] {
    if ![is_remote host] {
	set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
    } else {
	set GDB [transform gdb]
    }
}

so we can't do the check here.

> +# The directory to copy files to.  In default, we choose ./remote-host, to
> +# avoiding messing up your HOME.  You can choose other directory as
> +# you like.
> +set host_dir [file join [pwd] "remote-host"]
>
> How about allowing the user to pass this in from the command line?
> By convention such variables are then uppercase.
>

That is fine to me.  In the updated patch, user can specify the
directory in command line via variable HOST_DIR.

> +
> +proc ${board}_download { board src dest } {
> +    global env board_type
> +    global host_dir
> +
> +    if { [llength $dest] > 0 } {
> +	set destfile [lindex $dest 0]
> +    } else {
> +	set destfile [file tail $src]
> +    }
>
> This doesn't feel right.
> I realize /usr/share/dejagnu/remote.exp:remote_download
> checks for whether the third parameter can be a list, but
> remote_download is a varargs function (the name of the last
> variable is "args") and is not a "board" function.
> Other ${foo}_download functions that are actual "board" functions,
> e.g., /usr/share/dejagnu/remote.exp:standard_download,
> or gdb/testsuite/boards/remote-stdio-gdbserver.exp,
> don't treat the third parameter as if it can be a list.

Yes, remote_download acts as a wrapper or an adapter to "board"
functions which are defined in board files.  In tcl, simple string is
also list, see,

% llength "foo"
1
% lindex "foo" 0     
foo

The code above is right to me but unnecessary.  Use dest as a string in
the updated patch.

Comments

Yao Qi Sept. 15, 2014, 4:41 a.m. UTC | #1 
Yao Qi <yao@codesourcery.com> writes:

>> +global GDB
>> +set GDB [file join [pwd] "../gdb"]
>>
>> Check if GDB has been set first, allow the user to
>> pass this in from the command line.
>
> GDB is always set in lib/gdb.exp and it is loaded earlier than the
> board file.  In lib/gdb.exp:
>
> if ![info exists GDB] {
>     if ![is_remote host] {
> 	set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
>     } else {
> 	set GDB [transform gdb]
>     }
> }
>
> so we can't do the check here.
>
>> +# The directory to copy files to.  In default, we choose ./remote-host, to
>> +# avoiding messing up your HOME.  You can choose other directory as
>> +# you like.
>> +set host_dir [file join [pwd] "remote-host"]
>>
>> How about allowing the user to pass this in from the command line?
>> By convention such variables are then uppercase.
>>
>
> That is fine to me.  In the updated patch, user can specify the
> directory in command line via variable HOST_DIR.
>
>> +
>> +proc ${board}_download { board src dest } {
>> +    global env board_type
>> +    global host_dir
>> +
>> +    if { [llength $dest] > 0 } {
>> +	set destfile [lindex $dest 0]
>> +    } else {
>> +	set destfile [file tail $src]
>> +    }
>>
>> This doesn't feel right.
>> I realize /usr/share/dejagnu/remote.exp:remote_download
>> checks for whether the third parameter can be a list, but
>> remote_download is a varargs function (the name of the last
>> variable is "args") and is not a "board" function.
>> Other ${foo}_download functions that are actual "board" functions,
>> e.g., /usr/share/dejagnu/remote.exp:standard_download,
>> or gdb/testsuite/boards/remote-stdio-gdbserver.exp,
>> don't treat the third parameter as if it can be a list.
>
> Yes, remote_download acts as a wrapper or an adapter to "board"
> functions which are defined in board files.  In tcl, simple string is
> also list, see,
>
> % llength "foo"
> 1
> % lindex "foo" 0     
> foo
>
> The code above is right to me but unnecessary.  Use dest as a string in
> the updated patch.

Hi, Doug,
How do you think of the updated patch?
https://sourceware.org/ml/gdb-patches/2014-09/msg00117.html
Doug Evans Sept. 15, 2014, 4:55 a.m. UTC | #2 
Actually I've been spending more time with this today, I know I owe
you a response.
I have an emacs buffer with a reply in progress.
Good timing ... :-)

On Sun, Sep 14, 2014 at 9:41 PM, Yao Qi <yao@codesourcery.com> wrote:
> Yao Qi <yao@codesourcery.com> writes:
>
>>> +global GDB
>>> +set GDB [file join [pwd] "../gdb"]
>>>
>>> Check if GDB has been set first, allow the user to
>>> pass this in from the command line.
>>
>> GDB is always set in lib/gdb.exp and it is loaded earlier than the
>> board file.  In lib/gdb.exp:
>>
>> if ![info exists GDB] {
>>     if ![is_remote host] {
>>       set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
>>     } else {
>>       set GDB [transform gdb]
>>     }
>> }
>>
>> so we can't do the check here.
>>
>>> +# The directory to copy files to.  In default, we choose ./remote-host, to
>>> +# avoiding messing up your HOME.  You can choose other directory as
>>> +# you like.
>>> +set host_dir [file join [pwd] "remote-host"]
>>>
>>> How about allowing the user to pass this in from the command line?
>>> By convention such variables are then uppercase.
>>>
>>
>> That is fine to me.  In the updated patch, user can specify the
>> directory in command line via variable HOST_DIR.
>>
>>> +
>>> +proc ${board}_download { board src dest } {
>>> +    global env board_type
>>> +    global host_dir
>>> +
>>> +    if { [llength $dest] > 0 } {
>>> +    set destfile [lindex $dest 0]
>>> +    } else {
>>> +    set destfile [file tail $src]
>>> +    }
>>>
>>> This doesn't feel right.
>>> I realize /usr/share/dejagnu/remote.exp:remote_download
>>> checks for whether the third parameter can be a list, but
>>> remote_download is a varargs function (the name of the last
>>> variable is "args") and is not a "board" function.
>>> Other ${foo}_download functions that are actual "board" functions,
>>> e.g., /usr/share/dejagnu/remote.exp:standard_download,
>>> or gdb/testsuite/boards/remote-stdio-gdbserver.exp,
>>> don't treat the third parameter as if it can be a list.
>>
>> Yes, remote_download acts as a wrapper or an adapter to "board"
>> functions which are defined in board files.  In tcl, simple string is
>> also list, see,
>>
>> % llength "foo"
>> 1
>> % lindex "foo" 0
>> foo
>>
>> The code above is right to me but unnecessary.  Use dest as a string in
>> the updated patch.
>
> Hi, Doug,
> How do you think of the updated patch?
> https://sourceware.org/ml/gdb-patches/2014-09/msg00117.html
>
> --
> Yao (齐尧)
Doug Evans Sept. 15, 2014, 5:34 a.m. UTC | #3 
Yao Qi <yao@codesourcery.com> writes:
> Doug Evans <xdje42@gmail.com> writes:
>
>> +global GDB
>> +set GDB [file join [pwd] "../gdb"]
>>
>> Check if GDB has been set first, allow the user to
>> pass this in from the command line.
>
> GDB is always set in lib/gdb.exp and it is loaded earlier than the
> board file.  In lib/gdb.exp:
>
> if ![info exists GDB] {
>     if ![is_remote host] {
> 	set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
>     } else {
> 	set GDB [transform gdb]
>     }
> }
>
> so we can't do the check here.

I deleted the setting of GDB in this file and was able to
run tests by passing GDB=/usr/bin/gdb on the command line.

I then tried not passing GDB= on the command line and I see /usr/bin/gdb
still being run (it's invoked as "gdb" without any path).  Bleah.

It would really be nice to make this work, but it's not critical
for this first checkin.
OTOH, I think this is way too subtle an issue and requires a comment.
Something like:

+# We have to explicitly specify GDB with the path to the copy in
+# in the build directory because otherwise it will be set to the
+# result of "transform GDB" since the harness thinks we're using
+# a remote host.  See lib/gdb.exp.
+set GDB [file join [pwd] "../gdb"]
+verbose -log "Overriding setting of GDB to $GDB"

There's no need for "global GDB" here.

>> +# The directory to copy files to.  In default, we choose ./remote-host, to
>> +# avoiding messing up your HOME.  You can choose other directory as
>> +# you like.
>> +set host_dir [file join [pwd] "remote-host"]
>>
>> How about allowing the user to pass this in from the command line?
>> By convention such variables are then uppercase.
>>
>
> That is fine to me.  In the updated patch, user can specify the
> directory in command line via variable HOST_DIR.
>
>> +
>> +proc ${board}_download { board src dest } {
>> +    global env board_type
>> +    global host_dir
>> +
>> +    if { [llength $dest] > 0 } {
>> +	set destfile [lindex $dest 0]
>> +    } else {
>> +	set destfile [file tail $src]
>> +    }
>>
>> This doesn't feel right.
>> I realize /usr/share/dejagnu/remote.exp:remote_download
>> checks for whether the third parameter can be a list, but
>> remote_download is a varargs function (the name of the last
>> variable is "args") and is not a "board" function.
>> Other ${foo}_download functions that are actual "board" functions,
>> e.g., /usr/share/dejagnu/remote.exp:standard_download,
>> or gdb/testsuite/boards/remote-stdio-gdbserver.exp,
>> don't treat the third parameter as if it can be a list.
>
> Yes, remote_download acts as a wrapper or an adapter to "board"
> functions which are defined in board files.  In tcl, simple string is
> also list, see,
>
> % llength "foo"
> 1
> % lindex "foo" 0     
> foo
>
> The code above is right to me but unnecessary.  Use dest as a string in
> the updated patch.

Besides the issue of setting GDB I have one more nit.
I found this useful while diagnosing failures:

 proc ${board}_download { board src dest } {
     global HOST_DIR
 
     if { ![file exists $HOST_DIR] } {
 	file mkdir $HOST_DIR
     }
 
     set destfile [file join $HOST_DIR $dest]
+    verbose -log "${board}_download: file copy -force $src $destfile"
     file copy -force $src $destfile
 
     return $destfile
 }

With those two issues addressed I'm happy.
[I'm sure more issues will arise as I'm seeing failures
I wouldn't have expected.  I didn't spend much time on them
and at any rate I think we can get this checked in so that
we can start addressing them collectively.]
diff mbox

Patch

diff --git a/gdb/testsuite/boards/local-remote-host-native.exp b/gdb/testsuite/boards/local-remote-host-native.exp
new file mode 100644
index 0000000..1119c2d
--- /dev/null
+++ b/gdb/testsuite/boards/local-remote-host-native.exp
@@ -0,0 +1,80 @@ 
+# Copyright 2014 Free Software Foundation, Inc.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# This file is a dejagnu "board file" and is used to run the testsuite
+# against local host, in remote host mode.
+#
+# This board file is used to emulate the real remote host testing, in
+# which file system of host and build are not shared.  This is achieved
+# by copying files from source directory to ${host_dir}.
+#
+# To use this file:
+# bash$ cd ${build_dir}/gdb
+# bash$ make check RUNTESTFLAGS="--host_board=local-remote-host-native --target_board=local-remote-host-native HOST_DIR=/tmp/foo/"
+#
+# We set both target board and host board together to test a native gdb
+# (host == target) on a remote host (host != build).  $HOST_DIR is the
+# directory for copying files to, to avoid messing up your HOME.  When
+# it is absent, files are copied to ./remote-host.
+
+if { $board_type == "target" } {
+    set_board_info compiler gcc
+}
+
+global GDB
+set GDB [file join [pwd] "../gdb"]
+
+set_board_info hostname 127.0.0.1
+
+set_board_info username $env(USER)
+
+# The ssh key should be correctly set up that you ssh to 127.0.0.1
+# without having to type password.
+set_board_info rsh_prog /usr/bin/ssh
+set_board_info rcp_prog /usr/bin/scp
+set_board_info file_transfer "rsh"
+
+if { ![info exists HOST_DIR] } {
+    set HOST_DIR [file join [pwd] "remote-host"]
+}
+
+if { $board_type == "host" } {
+    set_board_info gdb_opts "-d \"${HOST_DIR}\""
+}
+
+proc ${board}_spawn { board cmd } {
+    global board_info
+
+    set remote [board_info $board hostname]
+    set username [board_info $board username]
+    set RSH [board_info $board rsh_prog]
+
+    spawn $RSH -t -l $username $remote $cmd
+    set board_info($board,fileid) $spawn_id
+    return $spawn_id
+}
+
+proc ${board}_download { board src dest } {
+    global HOST_DIR
+
+    if { ![file exists $HOST_DIR] } {
+	file mkdir $HOST_DIR
+    }
+
+    set destfile [file join $HOST_DIR $dest]
+    file copy -force $src $destfile
+
+    return $destfile
+}