From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx2.suse.de (mx2.suse.de [195.135.220.15]) by sourceware.org (Postfix) with ESMTPS id 7307F3858D35 for ; Fri, 5 Jun 2020 10:06:42 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 7307F3858D35 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=suse.de Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=tdevries@suse.de X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.220.254]) by mx2.suse.de (Postfix) with ESMTP id CECA6AA6F; Fri, 5 Jun 2020 10:06:44 +0000 (UTC) Subject: [PATCH][gdb/testsuite] Don't leak tuiterm.exp spawn override From: Tom de Vries To: Pedro Alves , Andrew Burgess Cc: gdb-patches@sourceware.org, Tom Tromey References: <20200519163004.GA9045@delia> <20200602153830.GZ3522@embecosm.com> <72b3c10c-d316-9a0e-13e9-56dee7c765a7@redhat.com> <5d6277ac-76ea-5f47-ab9e-7da58fbddd6e@suse.de> Autocrypt: addr=tdevries@suse.de; keydata= xsBNBF0ltCcBCADDhsUnMMdEXiHFfqJdXeRvgqSEUxLCy/pHek88ALuFnPTICTwkf4g7uSR7 HvOFUoUyu8oP5mNb4VZHy3Xy8KRZGaQuaOHNhZAT1xaVo6kxjswUi3vYgGJhFMiLuIHdApoc u5f7UbV+egYVxmkvVLSqsVD4pUgHeSoAcIlm3blZ1sDKviJCwaHxDQkVmSsGXImaAU+ViJ5l CwkvyiiIifWD2SoOuFexZyZ7RUddLosgsO0npVUYbl6dEMq2a5ijGF6/rBs1m3nAoIgpXk6P TCKlSWVW6OCneTaKM5C387972qREtiArTakRQIpvDJuiR2soGfdeJ6igGA1FZjU+IsM5ABEB AAHNH1RvbSBkZSBWcmllcyA8dGRldnJpZXNAc3VzZS5kZT7CwKsEEwEIAD4WIQSsnSe5hKbL MK1mGmjuhV2rbOJEoAUCXSW0JwIbAwUJA8JnAAULCQgHAgYVCgkICwIEFgIDAQIeAQIXgAAh CRDuhV2rbOJEoBYhBKydJ7mEpsswrWYaaO6FXats4kSgc48H/Ra2lq5p3dHsrlQLqM7N68Fo eRDf3PMevXyMlrCYDGLVncQwMw3O/AkousktXKQ42DPJh65zoXB22yUt8m0g12xkLax98KFJ 5NyUloa6HflLl+wQL/uZjIdNUQaHQLw3HKwRMVi4l0/Jh/TygYG1Dtm8I4o708JS4y8GQxoQ UL0z1OM9hyM3gI2WVTTyprsBHy2EjMOu/2Xpod95pF8f90zBLajy6qXEnxlcsqreMaqmkzKn 3KTZpWRxNAS/IH3FbGQ+3RpWkNGSJpwfEMVCeyK5a1n7yt1podd1ajY5mA1jcaUmGppqx827 8TqyteNe1B/pbiUt2L/WhnTgW1NC1QDOwE0EXSW0JwEIAM99H34Bu4MKM7HDJVt864MXbx7B 1M93wVlpJ7Uq+XDFD0A0hIal028j+h6jA6bhzWto4RUfDl/9mn1StngNVFovvwtfzbamp6+W pKHZm9X5YvlIwCx131kTxCNDcF+/adRW4n8CU3pZWYmNVqhMUiPLxElA6QhXTtVBh1RkjCZQ Kmbd1szvcOfaD8s+tJABJzNZsmO2hVuFwkDrRN8Jgrh92a+yHQPd9+RybW2l7sJv26nkUH5Z 5s84P6894ebgimcprJdAkjJTgprl1nhgvptU5M9Uv85Pferoh2groQEAtRPlCGrZ2/2qVNe9 XJfSYbiyedvApWcJs5DOByTaKkcAEQEAAcLAkwQYAQgAJhYhBKydJ7mEpsswrWYaaO6FXats 4kSgBQJdJbQnAhsMBQkDwmcAACEJEO6FXats4kSgFiEErJ0nuYSmyzCtZhpo7oVdq2ziRKD3 twf7BAQBZ8TqR812zKAD7biOnWIJ0McV72PFBxmLIHp24UVe0ZogtYMxSWKLg3csh0yLVwc7 H3vldzJ9AoK3Qxp0Q6K/rDOeUy3HMqewQGcqrsRRh0NXDIQk5CgSrZslPe47qIbe3O7ik/MC q31FNIAQJPmKXX25B115MMzkSKlv4udfx7KdyxHrTSkwWZArLQiEZj5KG4cCKhIoMygPTA3U yGaIvI/BGOtHZ7bEBVUCFDFfOWJ26IOCoPnSVUvKPEOH9dv+sNy7jyBsP5QxeTqwxC/1ZtNS DUCSFQjqA6bEGwM22dP8OUY6SC94x1G81A9/xbtm9LQxKm0EiDH8KBMLfQ== Message-ID: <66a24a94-3492-7667-58c5-3c0e1330cea1@suse.de> Date: Fri, 5 Jun 2020 12:06:39 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.5.0 MIME-Version: 1.0 In-Reply-To: <5d6277ac-76ea-5f47-ab9e-7da58fbddd6e@suse.de> Content-Type: multipart/mixed; boundary="------------80E713C8DB9A82C5FD525E09" Content-Language: en-US X-Spam-Status: No, score=-16.3 required=5.0 tests=BAYES_00, GIT_PATCH_0, KAM_DMARC_STATUS, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 05 Jun 2020 10:06:44 -0000 This is a multi-part message in MIME format. --------------80E713C8DB9A82C5FD525E09 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit [ was: Re: [PATCH 3/3][gdb/testsuite] Warn about leaked global array ] On 04-06-2020 13:40, Tom de Vries wrote: > On 03-06-2020 11:49, Pedro Alves wrote: >> BTW, global variables alone aren't the full scope of the >> bleeding between testcases. There's also the case of >> testcases overriding procedures, like gdb.base/dbx.exp, >> but those are perhaps rare enough that we can continue >> handling it "manually" as before. > > AFAICT, that test-case does an effort to undo the override, though I'm > not sure how certain it is that the undo will be executed. > > Also, while working on the latest proposed patch, I also ran into > trouble related to the renaming of spawn in lib/tuiterm.exp. I wonder if > to address this we could wrap every tui test-case in > ... > tui_env { > ... > } > ... > and letting the tui_env proc deal with renaming and restoring the spawn. > We could even automate this in gdb_init/gdb_finish by calling > gdb_init_$subdir/gdb_finish_$subdir and handling it there. > That approach turned out to be not precise enough because also gdb.python/tui-window.exp imports tuiterm.exp. This fix uses a load_lib override. Any comments? Thanks - Tom --------------80E713C8DB9A82C5FD525E09 Content-Type: text/x-patch; charset=UTF-8; name="0001-gdb-testsuite-Don-t-leak-tuiterm.exp-spawn-override.patch" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename*0="0001-gdb-testsuite-Don-t-leak-tuiterm.exp-spawn-override.pat"; filename*1="ch" [gdb/testsuite] Don't leak tuiterm.exp spawn override In lib/tuiterm.exp the builtin spawn is overridden by a tui-specific version. After running the first test-case that imports tuiterm.exp, the override remains active, so it can cause trouble in subsequent test-cases, even if they do not import tuiterm.exp. See f.i. commit c8d4f6dfd9 "[gdb/testsuite] Fix spawn in tuiterm.exp". Fix this by: - adding a mechanism in load_lib that allows a file foo.exp to define procs gdb_init_foo and gdb_finish_foo, where gdb_init_foo is executed during load_lib, and gdb_finish_foo is executed during gdb_finish. - using this mechanism to do the spawn override in gdb_init_tuiterm, and restoring the original spawn in gdb_finish_tuiterm. Tested on x86_64-linux. gdb/testsuite/ChangeLog: 2020-06-05 Tom de Vries * lib/gdb.exp (gdb_finish_hooks): New global var. (load_lib): New override proc. (gdb_finish): Handle gdb_finish_hooks. * lib/tuiterm.exp (spawn): Rename to ... (tui_spawn): ... this. (toplevel): Move rename of spawn ... (gdb_init_tuiterm): ... here. New proc. (gdb_finish_tuiterm): New proc. --- gdb/testsuite/lib/gdb.exp | 42 ++++++++++++++++++++++++++++++++++++++++++ gdb/testsuite/lib/tuiterm.exp | 17 +++++++++++++++-- 2 files changed, 57 insertions(+), 2 deletions(-) diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp index 9a0620a2bf..986cfca99f 100644 --- a/gdb/testsuite/lib/gdb.exp +++ b/gdb/testsuite/lib/gdb.exp @@ -25,6 +25,42 @@ if {$tool == ""} { exit 2 } +# List of procs to run in gdb_finish. +set gdb_finish_hooks [list] + +# Override proc load_lib. +rename load_lib saved_load_lib + +# Run overriden load_lib. For FILE == foo.exp, run gdb_init_foo and schedule +# gdb_finish_foo, if they exist. +proc load_lib { file } { + + # Call overridden load_lib version. + set code [catch "saved_load_lib $file" result] + + # Do lib-specific initialization. + set lib_id [regsub -all {\.exp$} $file ""] + if { [info procs "gdb_init_${lib_id}"] != "" } { + gdb_init_${lib_id} + } + + # Schedule lib-specific finalization. + if { [info procs "gdb_finish_${lib_id}"] != "" } { + global gdb_finish_hooks + lappend gdb_finish_hooks gdb_finish_${lib_id} + } + + # Propagate errors. + if { $code == 1 } { + global errorInfo errorCode + return -code error -errorinfo $errorInfo -errorcode $errorCode $result + } elseif { $code > 1 } { + return -code $code $result + } + + return $result +} + load_lib libgloss.exp load_lib cache.exp load_lib gdb-utils.exp @@ -5225,6 +5261,12 @@ proc gdb_finish { } { } set banned_traced 0 } + + global gdb_finish_hooks + foreach gdb_finish_hook $gdb_finish_hooks { + $gdb_finish_hook + } + set gdb_finish_hooks [list] } global debug_format diff --git a/gdb/testsuite/lib/tuiterm.exp b/gdb/testsuite/lib/tuiterm.exp index 8c9f97af6e..680648564d 100644 --- a/gdb/testsuite/lib/tuiterm.exp +++ b/gdb/testsuite/lib/tuiterm.exp @@ -19,8 +19,7 @@ # array; but dejagnu doesn't export this globally. So, we have to # wrap spawn with our own function, so that we can capture this value. # The value is later used in calls to stty. -rename spawn builtin_spawn -proc spawn {args} { +proc tuiterm_spawn { args } { set result [uplevel builtin_spawn $args] global gdb_spawn_name upvar spawn_out spawn_out @@ -32,6 +31,20 @@ proc spawn {args} { return $result } +# Initialize tuiterm.exp environment. +proc gdb_init_tuiterm { } { + # Override spawn with tui_spawn. + rename spawn builtin_spawn + rename tuiterm_spawn spawn +} + +# Finalize tuiterm.exp environment. +proc gdb_finish_tuiterm { } { + # Restore spawn. + rename spawn tuiterm_spawn + rename builtin_spawn spawn +} + namespace eval Term { variable _rows variable _cols --------------80E713C8DB9A82C5FD525E09--