From patchwork Tue Jul 1 03:12:24 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aaron Merey X-Patchwork-Id: 115348 X-Patchwork-Delegate: mark@klomp.org Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id CE1D03854A8E for ; Tue, 1 Jul 2025 03:14:51 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org CE1D03854A8E Authentication-Results: sourceware.org; dkim=pass (1024-bit key, unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=gp4P731W X-Original-To: elfutils-devel@sourceware.org Delivered-To: elfutils-devel@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTP id 3C6CB3856DFA for ; Tue, 1 Jul 2025 03:13:17 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 3C6CB3856DFA Authentication-Results: sourceware.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 3C6CB3856DFA Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1751339597; cv=none; b=Wyo+47aH02vhok+juoQS8LxsXb4wYDEwG7xX/lA+HKOZS3QSqvBSJdJQW3tjiqvnknUGRUNNYpRvTnjQUyNMXm3AUYYgiMW2tyOhcGDGaKMMYfZLD5MX2UtpjhbDdlZ8Bk80vVHVScpqrjfGgxyslNVjSacuUXK1K5byrMu8na8= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1751339597; c=relaxed/simple; bh=Riz8SFSaul6JtEYnAY1GrSirpMCLh8hi5OhhQZfat2Q=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=N3QlckqXA9VWpDRggTHsifw2buFpWKA8rFHAZqfNZXxqEL0b5kLU2imV5qBDBae725mkEgoB0y4ESEejNZs+DCFxFEbYX6+RH+mMShFqzs18rB5Ib5qPRdeEIRERGCFpAU4FXpRU68hUBN1anpIWKR4uA1AttX5yR0wEQMm28Sk= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 3C6CB3856DFA DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1751339597; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=NVoDJqR1NG7Old/zFdjzn1Y/oIp/dyAtNpXX70tc0z0=; b=gp4P731WDNmwi0NxyVksAI6fHuGf4gDAdlbFAiO+KBov0mxKYZ92eBoU83cjjTIwnx0fcJ twCRCNOrTw547o03hkXFOwfGis63cGqZ1V4wOOQyb1FzL0RmvFVTWAvhzDLX9gc//t2Xzn vUAR35cX9hwU+ejtE3veS1rokUJ8Eeo= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-314-TzBnBmHdN2m9M3YXNHp2Yw-1; Mon, 30 Jun 2025 23:13:15 -0400 X-MC-Unique: TzBnBmHdN2m9M3YXNHp2Yw-1 X-Mimecast-MFC-AGG-ID: TzBnBmHdN2m9M3YXNHp2Yw_1751339594 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 3A6211800289 for ; Tue, 1 Jul 2025 03:13:14 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.22.80.66]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 3681F30001B1; Tue, 1 Jul 2025 03:13:12 +0000 (UTC) From: Aaron Merey To: elfutils-devel@sourceware.org Cc: Aaron Merey Subject: [PATCH 07/16] doc: Add elf_getshdrstrndx.3 and elf_getshstrndx.3 Date: Mon, 30 Jun 2025 23:12:24 -0400 Message-ID: <20250701031248.1106390-7-amerey@redhat.com> In-Reply-To: <20250701031248.1106390-1-amerey@redhat.com> References: <20250701031248.1106390-1-amerey@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: fNrjdzP6RZdL1yLJlW2Na_GD_Cf13tZHqSkJAHW76Aw_1751339594 X-Mimecast-Originator: redhat.com content-type: text/plain; charset="US-ASCII"; x-default=true X-Spam-Status: No, score=-13.1 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_NONE, RCVD_IN_HOSTKARMA_W, RCVD_IN_MSPIKE_H5, RCVD_IN_MSPIKE_WL, RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: elfutils-devel@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Elfutils-devel mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: elfutils-devel-bounces~patchwork=sourceware.org@sourceware.org Signed-off-by: Aaron Merey --- doc/Makefile.am | 2 ++ doc/elf_getshdrstrndx.3 | 80 +++++++++++++++++++++++++++++++++++++++++ doc/elf_getshstrndx.3 | 1 + 3 files changed, 83 insertions(+) create mode 100644 doc/elf_getshdrstrndx.3 create mode 100644 doc/elf_getshstrndx.3 diff --git a/doc/Makefile.am b/doc/Makefile.am index cf60a271..129c612d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -71,7 +71,9 @@ notrans_dist_man3_MANS= elf32_checksum.3 \ elf_getphdrnum.3 \ elf_getscn.3 \ elf_getshdrnum.3 \ + elf_getshdrstrndx.3 \ elf_getshnum.3 \ + elf_getshstrndx.3 \ elf_hash.3 \ elf_kind.3 \ elf_memory.3 \ diff --git a/doc/elf_getshdrstrndx.3 b/doc/elf_getshdrstrndx.3 new file mode 100644 index 00000000..b3bdca0f --- /dev/null +++ b/doc/elf_getshdrstrndx.3 @@ -0,0 +1,80 @@ +.TH ELF_GETSHDRSTRNDX 3 2025-06-30 "Libelf" "Libelf Programmer's Manual" + +.SH NAME +elf_getshdrstrndx, elf_getshstrndx \- retrieve the section header string table index +.SH SYNOPSIS +.nf +#include + +.B int elf_getshdrstrndx("Elf *elf", "size_t *dst"); +.B int elf_getshstrndx("Elf *elf", "size_t *dst"); +.fi +.SH DESCRIPTION +The +.BR elf_getshdrstrndx () +function retrieves the section header string table index from the ELF descriptor +.IR elf , +and stores it in the location pointed to by +.IR dst . + +This function handles both standard ELF values and extended section indexing. +In the latter case, if the section header string table index field of the ELF +header contains +.B SHN_XINDEX, +then the true index is stored in the +.B sh_link +field of section 0, which this function reads either from memory or directly +from the file. + +The function +.BR elf_getshstrndx () +is a deprecated alias for +.BR elf_getshdrstrndx () +and should not be used in new code. + +.SH PARAMETERS +.TP +.I elf +A pointer to an +.B Elf +descriptor opened with +.BR elf_begin (3). +The descriptor must be of kind +.B ELF_K_ELF . + +.TP +.I dst +A pointer to a +.B size_t +location where the index of the section header string table will be stored. +Must not be NULL. + +.SH RETURN VALUE +Returns 0 on success and stores the section header string table index in +.IR dst . +Returns \-1 on failure. + +.SH SEE ALSO +.BR libelf (3), +.BR elf (5) + +.SH ATTRIBUTES +.TS +allbox; +lbx lb lb +l l l. +Interface Attribute Value +T{ +.na +.nh +.BR elf_getshdrstrndx (),\~elf_getshstrndx () +T} Thread safety MT-Safe +.TE + +.SH REPORTING BUGS +Report bugs to or https://sourceware.org/bugzilla/. + +.SH HISTORY +.B elf_getshdrstrndx +first appeared in elfutils 0.142. This function is a elfutils libelf extension and +may not be available in other libelf implementations. diff --git a/doc/elf_getshstrndx.3 b/doc/elf_getshstrndx.3 new file mode 100644 index 00000000..22a2251f --- /dev/null +++ b/doc/elf_getshstrndx.3 @@ -0,0 +1 @@ +.so man3/elf_getshdrstrndx.3