From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by sourceware.org (Postfix) with ESMTPS id 4FA933858D39 for ; Fri, 4 Mar 2022 10:52:05 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 4FA933858D39 Received: from mail-wr1-f71.google.com (mail-wr1-f71.google.com [209.85.221.71]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-623-Jn3S4UGxMIenZhpJbohj9w-1; Fri, 04 Mar 2022 05:52:02 -0500 X-MC-Unique: Jn3S4UGxMIenZhpJbohj9w-1 Received: by mail-wr1-f71.google.com with SMTP id f9-20020a5d58e9000000b001f0247e5e96so3224788wrd.15 for ; Fri, 04 Mar 2022 02:52:02 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:in-reply-to:references:date :message-id:mime-version; bh=XXDkxlwPq9L8zDOaSMdf5GD28DkqdH9QSi+uh0Z2FrA=; b=RnRMMSUENBZLfNBb1UDLGTErVtGEYCqRC90z8IV9TNgakZ6vwuiXVexc+tSO09PmC9 Q3V/LypBM9ihnfPNUY+/RiXVadnutiGKgmtnVN2Vdu2/Tf4CnajDex7+DmZ8e2M0utjh Fr223Fc4/kZKsAjSmGuhJGjwwb3tOoxDuADycF7wUHZk6aZIZ6VQ7H4IDOLL3lVpHxS3 r5UUIa0PJ+iys9O6lolBGbLwFpHXvpM0azmhV67wBPCSj34zJCr4Hs769WPJXi4/p4xG TR/XEVI2Bq1dl4ka5LFju1WLfB8lahYTy9zcf+8MuS/fNHUHF4jFljrnDlvqRprzbfKi eqjA== X-Gm-Message-State: AOAM530Qf9tWsUQjVaxvwJalaJgje4Nd4ZJS2yvhh12O5AvIldkQrWjy VEyTlJp1E0OBHfONgxIfybbV+lPyIwfFV2E64e4tiZ2M+FPhAflw0frAJjBzm7S9WQyLFOmlbo9 1kibgipWfXcKcHHBF1+cHDg== X-Received: by 2002:a05:6000:1866:b0:1ef:8a14:ab6a with SMTP id d6-20020a056000186600b001ef8a14ab6amr21612737wri.12.1646391119236; Fri, 04 Mar 2022 02:51:59 -0800 (PST) X-Google-Smtp-Source: ABdhPJzP8nUz2I3KoVOQllrjug6R2V7U8mDL83PTM94kwQ/W13P33wXhx89wgri0+HKz+kE1XozRQQ== X-Received: by 2002:a05:6000:1866:b0:1ef:8a14:ab6a with SMTP id d6-20020a056000186600b001ef8a14ab6amr21612732wri.12.1646391119057; Fri, 04 Mar 2022 02:51:59 -0800 (PST) Received: from localhost (host86-169-131-29.range86-169.btcentralplus.com. [86.169.131.29]) by smtp.gmail.com with ESMTPSA id o204-20020a1ca5d5000000b0038331f2f951sm13803517wme.0.2022.03.04.02.51.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 04 Mar 2022 02:51:58 -0800 (PST) From: Andrew Burgess To: Craig Blackmore Cc: gdb-patches@sourceware.org Subject: Re: [PATCH] gdb/python: add gdb.Architecture.format_address In-Reply-To: <3de8efa7-5563-4778-5925-81b9c0409720@embecosm.com> References: <20220211161721.3252422-1-aburgess@redhat.com> <83leyhs07f.fsf@gnu.org> <878ru4cepy.fsf@redhat.com> <837d9oumhd.fsf@gnu.org> <87sfsbattq.fsf@redhat.com> <3de8efa7-5563-4778-5925-81b9c0409720@embecosm.com> Date: Fri, 04 Mar 2022 10:51:57 +0000 Message-ID: <8735jyxa5u.fsf@redhat.com> MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain X-Spam-Status: No, score=-12.2 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H5, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) 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, 04 Mar 2022 10:52:06 -0000 Craig Blackmore writes: > Hi Andrew, > > On 22/02/2022 13:56, Andrew Burgess via Gdb-patches wrote: >> Eli Zaretskii writes: >> >>>> From: Andrew Burgess >>>> Cc: gdb-patches@sourceware.org >>>> Date: Mon, 21 Feb 2022 17:27:21 +0000 >>>> >>>> I'm certainly not against renaming, if we can come up with a better >>>> name... maybe 'format_address_info'? I don't know... I still kind of >>>> like 'format_address'... >>> I hope someone will come up with a better name. > format_address seems ok to me and I couldn't come up with anything better. >> diff --git a/gdb/python/py-arch.c b/gdb/python/py-arch.c >> index 0f273b344e4..95ae931e73e 100644 >> --- a/gdb/python/py-arch.c >> +++ b/gdb/python/py-arch.c >> @@ -348,6 +348,31 @@ gdbpy_all_architecture_names (PyObject *self, PyObject *args) >> return list.release (); >> } >> >> +/* Implement gdb.architecture.format_address(ADDR). Provide access to >> + GDB's print_address function from Python. The returned address will >> + have the format '0x..... '. */ >> + >> +static PyObject * >> +archpy_format_address (PyObject *self, PyObject *args, PyObject *kw) >> +{ >> + static const char *keywords[] = { "address", nullptr }; >> + PyObject *addr_obj; >> + CORE_ADDR addr; >> + struct gdbarch *gdbarch = nullptr; >> + >> + ARCHPY_REQUIRE_VALID (self, gdbarch); >> + >> + if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "O", keywords, &addr_obj)) >> + return nullptr; >> + >> + if (get_addr_from_python (addr_obj, &addr) < 0) >> + return nullptr; >> + >> + string_file buf; >> + print_address (gdbarch, addr, &buf); >> + return PyString_FromString (buf.c_str ()); >> +} >> + >> void _initialize_py_arch (); >> void >> _initialize_py_arch () >> @@ -391,6 +416,12 @@ group GROUP-NAME." }, >> METH_NOARGS, >> "register_groups () -> Iterator.\n\ >> Return an iterator over all of the register groups in this architecture." }, >> + { "format_address", (PyCFunction) archpy_format_address, >> + METH_VARARGS | METH_KEYWORDS, >> + "format_address (ADDRESS) -> String.\n\ >> +Format ADDRESS, an address within the currently selected inferior's\n\ >> +address space, as a string. The format of the returned string is\n\ >> +'ADDRESS ' without the quotes." }, >> {NULL} /* Sentinel */ >> }; >> >> diff --git a/gdb/testsuite/gdb.python/py-arch.exp b/gdb/testsuite/gdb.python/py-arch.exp >> index b55778b0b72..c4854033d8c 100644 >> --- a/gdb/testsuite/gdb.python/py-arch.exp >> +++ b/gdb/testsuite/gdb.python/py-arch.exp >> @@ -127,3 +127,18 @@ foreach a $arch_names b $py_arch_names { >> } >> } >> gdb_assert { $lists_match } >> + >> +# Check the gdb.Architecture.format_address method. >> +set main_addr [get_hexadecimal_valueof "&main" "UNKNOWN"] >> +gdb_test "python print(\"Got: \" + gdb.selected_inferior().architecture().format_address($main_addr))" \ >> + "Got: $main_addr
" \ >> + "gdb.Architecture.format_address, result should have no offset" >> +set next_addr [format 0x%x [expr $main_addr + 1]] >> +gdb_test "python print(\"Got: \" + gdb.selected_inferior().architecture().format_address($next_addr))" \ >> + "Got: $next_addr " \ >> + "gdb.Architecture.format_address, result should have an offset" >> +if {![is_address_zero_readable]} { >> + gdb_test "python print(\"Got: \" + gdb.selected_inferior().architecture().format_address(0))" \ >> + "Got: 0x0" \ >> + "gdb.Architecture.format_address for address 0" >> +} >> > The code LGTM. Just one query, is it necessary to add a test case for > printing the filename and line number when we have `set print > symbol-filename on`? Yes, I only learned about 'set print symbol-filename' during the doc review, and neglected to add a new test. I've posted a V2 patch which include a new test for this. Thanks, Andrew