From patchwork Wed Jun 23 15:55:14 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Siddhesh Poyarekar X-Patchwork-Id: 1496208 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=sourceware.org (client-ip=2620:52:3:1:0:246e:9693:128c; helo=sourceware.org; envelope-from=libc-alpha-bounces+incoming=patchwork.ozlabs.org@sourceware.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=sourceware.org header.i=@sourceware.org header.a=rsa-sha256 header.s=default header.b=pLwwf9sZ; dkim-atps=neutral Received: from sourceware.org (server2.sourceware.org [IPv6:2620:52:3:1:0:246e:9693:128c]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4G97DK0SNVz9sRN for ; Thu, 24 Jun 2021 01:56:33 +1000 (AEST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 22C6A3835408 for ; Wed, 23 Jun 2021 15:56:30 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 22C6A3835408 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1624463790; bh=DgG1nTTKCF6fWGP2NG96w5WWcxc4XfZt0DZHOhHkgl0=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=pLwwf9sZWwpVSIcChflOkIKZ+Ouz8Nd/gKc1U3G2mc81grPyLAs0mSW7xKcZsvuiI 5pgDaid9xF89k32VQSBJPKSsRAaXkWFja/z0nbaYO1UHX0adnstdXi91qM6yn8tf2n FdojS4idrcE5d/Z4i9rLB6tZNTMelat/cokA/Qh0= X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from cross.elm.relay.mailchannels.net (cross.elm.relay.mailchannels.net [23.83.212.46]) by sourceware.org (Postfix) with ESMTPS id D7CF73847825 for ; Wed, 23 Jun 2021 15:56:13 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org D7CF73847825 X-Sender-Id: dreamhost|x-authsender|siddhesh@gotplt.org Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 037C132129C; Wed, 23 Jun 2021 15:56:12 +0000 (UTC) Received: from pdx1-sub0-mail-a13.g.dreamhost.com (100-101-162-61.trex.outbound.svc.cluster.local [100.101.162.61]) (Authenticated sender: dreamhost) by relay.mailchannels.net (Postfix) with ESMTPA id 435BB3226B1; Wed, 23 Jun 2021 15:56:11 +0000 (UTC) X-Sender-Id: dreamhost|x-authsender|siddhesh@gotplt.org Received: from pdx1-sub0-mail-a13.g.dreamhost.com (pop.dreamhost.com [64.90.62.162]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384) by 100.101.162.61 (trex/6.3.3); Wed, 23 Jun 2021 15:56:11 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: dreamhost|x-authsender|siddhesh@gotplt.org X-MailChannels-Auth-Id: dreamhost X-Well-Made-Stretch: 21404fc9343957df_1624463771574_968786653 X-MC-Loop-Signature: 1624463771574:2242177638 X-MC-Ingress-Time: 1624463771574 Received: from pdx1-sub0-mail-a13.g.dreamhost.com (localhost [127.0.0.1]) by pdx1-sub0-mail-a13.g.dreamhost.com (Postfix) with ESMTP id F26B38044B; Wed, 23 Jun 2021 15:56:10 +0000 (UTC) Received: from rhbox.intra.reserved-bit.com (unknown [1.186.101.110]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) (Authenticated sender: siddhesh@gotplt.org) by pdx1-sub0-mail-a13.g.dreamhost.com (Postfix) with ESMTPSA id 50E747FF1B; Wed, 23 Jun 2021 15:56:08 +0000 (UTC) X-DH-BACKEND: pdx1-sub0-mail-a13 To: libc-alpha@sourceware.org Subject: [PATCH] mtrace: Deprecate mallwatch and tr_break Date: Wed, 23 Jun 2021 21:25:14 +0530 Message-Id: <20210623155514.3292784-1-siddhesh@sourceware.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 X-Spam-Status: No, score=-3494.6 required=5.0 tests=BAYES_00, GIT_PATCH_0, JMQ_SPF_NEUTRAL, KAM_DMARC_NONE, KAM_DMARC_STATUS, RCVD_IN_BARRACUDACENTRAL, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NEUTRAL, 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: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Siddhesh Poyarekar via Libc-alpha From: Siddhesh Poyarekar Reply-To: Siddhesh Poyarekar Errors-To: libc-alpha-bounces+incoming=patchwork.ozlabs.org@sourceware.org Sender: "Libc-alpha" The variable and function pair appear to provide a way for users to set conditional breakpoints in mtrace when a specific address is returned by the allocator. This can be achieved by using conditional breakpoints in gdb so it is redundant. There is no documentation of this interface in the manual either, so it appears to have been a hack that got added to debug malloc. Deprecate these symbols and do not call tr_break anymore. --- NEWS | 4 ++++ malloc/mtrace.c | 57 +++++++++++++++++-------------------------------- 2 files changed, 24 insertions(+), 37 deletions(-) diff --git a/NEWS b/NEWS index cadc40262f..536e80721a 100644 --- a/NEWS +++ b/NEWS @@ -64,6 +64,10 @@ Deprecated and removed features, and other changes affecting compatibility: * The function pthread_yield has been deprecated; programs should use the equivalent standard function sched_yield instead. +* The symbols mallwatch and tr_break are now deprecated and no longer used in + mtrace. Similar functionality can be achieved by using conditional + breakpoints within mtrace functions from within gdb. + Changes to build and runtime requirements: * On Linux, the shm_open, sem_open, and related functions now expect the diff --git a/malloc/mtrace.c b/malloc/mtrace.c index b65b21a933..6c2c58b706 100644 --- a/malloc/mtrace.c +++ b/malloc/mtrace.c @@ -50,8 +50,25 @@ static char *malloc_trace_buffer; __libc_lock_define_initialized (static, lock); -/* Address to breakpoint on accesses to... */ +#if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_34) +/* Compatibility symbols that were introduced to help break at allocation sites + for specific memory allocations. This is unusable with ASLR, although gdb + may allow predictable allocation addresses. Even then, gdb has watchpoint + and conditional breakpoint support which should provide the same + functionality without having this kludge. These symbols are preserved in + case some applications ended up linking against them but they don't actually + do anything anymore; not that they did much before anyway. */ + void *mallwatch; +compat_symbol (libc, mallwatch, mallwatch, GLIBC_2_0); + +void +tr_break (void) +{ +} +compat_symbol (libc, tr_break, tr_break, GLIBC_2_0); +#endif + /* Old hook values. */ static void (*tr_old_free_hook) (void *ptr, const void *); @@ -61,19 +78,6 @@ static void *(*tr_old_realloc_hook) (void *ptr, size_t size, static void *(*tr_old_memalign_hook) (size_t __alignment, size_t __size, const void *); -/* This function is called when the block being alloc'd, realloc'd, or - freed has an address matching the variable "mallwatch". In a debugger, - set "mallwatch" to the address of interest, then put a breakpoint on - tr_break. */ - -extern void tr_break (void) __THROW; -libc_hidden_proto (tr_break) -void -tr_break (void) -{ -} -libc_hidden_def (tr_break) - static void tr_where (const void *caller, Dl_info *info) { @@ -167,12 +171,6 @@ tr_freehook (void *ptr, const void *caller) tr_where (caller, info); /* Be sure to print it first. */ fprintf (mallstream, "- %p\n", ptr); - if (ptr == mallwatch) - { - __libc_lock_unlock (lock); - tr_break (); - __libc_lock_lock (lock); - } set_default_hooks (); if (tr_old_free_hook != NULL) (*tr_old_free_hook)(ptr, caller); @@ -203,9 +201,6 @@ tr_mallochook (size_t size, const void *caller) __libc_lock_unlock (lock); - if (hdr == mallwatch) - tr_break (); - return hdr; } @@ -214,9 +209,6 @@ tr_reallochook (void *ptr, size_t size, const void *caller) { void *hdr; - if (ptr == mallwatch) - tr_break (); - Dl_info mem; Dl_info *info = lock_and_info (caller, &mem); @@ -247,9 +239,6 @@ tr_reallochook (void *ptr, size_t size, const void *caller) __libc_lock_unlock (lock); - if (hdr == mallwatch) - tr_break (); - return hdr; } @@ -274,9 +263,6 @@ tr_memalignhook (size_t alignment, size_t size, const void *caller) __libc_lock_unlock (lock); - if (hdr == mallwatch) - tr_break (); - return hdr; } @@ -296,10 +282,7 @@ release_libc_mem (void) #endif -/* We enable tracing if either the environment variable MALLOC_TRACE - is set, or if the variable mallwatch has been patched to an address - that the debugging user wants us to stop on. When patching mallwatch, - don't forget to set a breakpoint on tr_break! */ +/* We enable tracing if the environment variable MALLOC_TRACE is set. */ void mtrace (void) @@ -321,7 +304,7 @@ mtrace (void) #else mallfile = getenv (mallenv); #endif - if (mallfile != NULL || mallwatch != NULL) + if (mallfile != NULL) { char *mtb = malloc (TRACE_BUFFER_SIZE); if (mtb == NULL)