From patchwork Fri Feb 10 01:59:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aaron Merey X-Patchwork-Id: 64620 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 988303858C74 for ; Fri, 10 Feb 2023 02:01:51 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 988303858C74 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1675994511; bh=Z/DHAVmoaJQfGD8oyt3oTcRlTXrnY6WF141OoNHjrYU=; h=To:Cc:Subject:Date:In-Reply-To:References:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From:Reply-To:From; b=KLk+mgYoQ084y5ySIC3nYMk2ljk9IkVkhBMtVEA74T4XCgerhD7dJjNc7EnzmYo03 CkRpy7e9Wgd0KJNl6vXK3p7j4QA7bUwEEV6triM4r7ctIuVmvepx+fVUpmV7bAB5l7 bmQvwDDSu+PhScB/WJP+v2DupHxx4r4g5NUJYREI= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org 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 20F203857400 for ; Fri, 10 Feb 2023 02:00:08 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 20F203857400 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-507-PLAASrLwOvSxYjGjj1fv6A-1; Thu, 09 Feb 2023 21:00:04 -0500 X-MC-Unique: PLAASrLwOvSxYjGjj1fv6A-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 2EDAD87B2A1; Fri, 10 Feb 2023 02:00:04 +0000 (UTC) Received: from localhost.localdomain (unknown [10.22.10.224]) by smtp.corp.redhat.com (Postfix) with ESMTP id DCD94C16022; Fri, 10 Feb 2023 02:00:03 +0000 (UTC) To: gdb-patches@sourceware.org Cc: tom@tromey.com, keiths@redhat.com, Aaron Merey Subject: [PATCH 2/2] gdb/source: Fix open_source_file error handling Date: Thu, 9 Feb 2023 20:59:42 -0500 Message-Id: <20230210015942.3180401-3-amerey@redhat.com> In-Reply-To: <20230210015942.3180401-1-amerey@redhat.com> References: <20230210015942.3180401-1-amerey@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.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_NONE, RCVD_IN_MSPIKE_H2, 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: 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-Patchwork-Original-From: Aaron Merey via Gdb-patches From: Aaron Merey Reply-To: Aaron Merey Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" open_source_file relies on errno to communicate the reason for a missing source file. open_source_file may also call debuginfod_find_source. It is possible for debuginfod_find_source to set errno to a value unrelated to the reason for a failed download. This can result in bogus error messages being reported as the reason for a missing source file. The following error message should instead be "No such file or directory": Temporary breakpoint 1, 0x00005555556f4de0 in main () (gdb) list Downloading source file /usr/src/debug/glibc-2.36-8.fc37.x86_64/elf/ 1 /usr/src/debug/glibc-2.36-8.fc37.x86_64/elf/: Directory not empty. Fix this by having open_source_file return a negative errno if it fails to open a source file. Use this value to generate the error message instead of errno. Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=29999 --- gdb/debuginfod-support.h | 15 +++++++++------ gdb/source-cache.c | 2 +- gdb/source.c | 40 ++++++++++++++++++++++++++++++---------- gdb/source.h | 5 +++-- 4 files changed, 43 insertions(+), 19 deletions(-) diff --git a/gdb/debuginfod-support.h b/gdb/debuginfod-support.h index 542d1688fa1..633600a79da 100644 --- a/gdb/debuginfod-support.h +++ b/gdb/debuginfod-support.h @@ -33,8 +33,9 @@ source file path is `/my/source/foo.c`, then SRC_PATH should be `/my/build/../source/foo.c`. - If the file is successfully retrieved, its path on the local machine - is stored in DESTNAME. If GDB is not built with debuginfod, this + If the file is successfully retrieved, return a file descriptor and store + the file's local path in DESTNAME. If unsuccessful, print an error message + and return a negative errno. If GDB is not built with debuginfod, this function returns -ENOSYS. */ extern scoped_fd @@ -51,8 +52,9 @@ debuginfod_source_query (const unsigned char *build_id, FILENAME should be the name or path of the main binary associated with the separate debug info. It is used for printing messages to the user. - If the file is successfully retrieved, its path on the local machine - is stored in DESTNAME. If GDB is not built with debuginfod, this + If the file is successfully retrieved, return a file descriptor and store + the file's local path in DESTNAME. If unsuccessful, print an error message + and return a negative errno. If GDB is not built with debuginfod, this function returns -ENOSYS. */ extern scoped_fd @@ -69,8 +71,9 @@ debuginfod_debuginfo_query (const unsigned char *build_id, FILENAME should be the name or path associated with the executable. It is used for printing messages to the user. - If the file is successfully retrieved, its path on the local machine - is stored in DESTNAME. If GDB is not built with debuginfod, this + If the file is successfully retrieved, return a file descriptor and store + the file's local path in DESTNAME. If unsuccessful, print an error message + and return a negative errno. If GDB is not built with debuginfod, this function returns -ENOSYS. */ extern scoped_fd debuginfod_exec_query (const unsigned char *build_id, diff --git a/gdb/source-cache.c b/gdb/source-cache.c index b7410d46293..77b357cb42b 100644 --- a/gdb/source-cache.c +++ b/gdb/source-cache.c @@ -95,7 +95,7 @@ source_cache::get_plain_source_lines (struct symtab *s, { scoped_fd desc (open_source_file (s)); if (desc.get () < 0) - perror_with_name (symtab_to_filename_for_display (s)); + perror_with_name (symtab_to_filename_for_display (s), -desc.get ()); struct stat st; if (fstat (desc.get (), &st) < 0) diff --git a/gdb/source.c b/gdb/source.c index be5af180c49..ca0e8d51fbd 100644 --- a/gdb/source.c +++ b/gdb/source.c @@ -1069,7 +1069,7 @@ find_and_open_source (const char *filename, the attempt to read this source file failed. GDB will then display the filename and line number instead. */ if (!source_open) - return scoped_fd (-1); + return scoped_fd (-ECANCELED); /* Quick way out if we already know its full name. */ if (*fullname) @@ -1160,11 +1160,15 @@ find_and_open_source (const char *filename, OPEN_MODE, fullname); } + /* If the file wasn't found, then openp will have set errno accordingly. */ + if (result < 0) + result = -errno; + return scoped_fd (result); } /* Open a source file given a symtab S. Returns a file descriptor or - negative number for error. + negative errno for error. This function is a convenience function to find_and_open_source. */ @@ -1172,7 +1176,7 @@ scoped_fd open_source_file (struct symtab *s) { if (!s) - return scoped_fd (-1); + return scoped_fd (-EINVAL); gdb::unique_xmalloc_ptr fullname (s->fullname); s->fullname = NULL; @@ -1200,10 +1204,21 @@ open_source_file (struct symtab *s) /* Query debuginfod for the source file. */ if (build_id != nullptr && !srcpath.empty ()) - fd = debuginfod_source_query (build_id->data, - build_id->size, - srcpath.c_str (), - &fullname); + { + scoped_fd query_fd + = debuginfod_source_query (build_id->data, + build_id->size, + srcpath.c_str (), + &fullname); + + /* Don't return a negative errno from debuginfod_source_query. + It handles the reporting of its own errors. */ + if (query_fd.get () >= 0) + { + s->fullname = fullname.release (); + return query_fd; + } + } } } @@ -1306,6 +1321,7 @@ print_source_lines_base (struct symtab *s, int line, int stopline, print_source_lines_flags flags) { bool noprint = false; + int errcode = ENOENT; int nlines = stopline - line; struct ui_out *uiout = current_uiout; @@ -1336,7 +1352,10 @@ print_source_lines_base (struct symtab *s, int line, int stopline, scoped_fd desc = open_source_file (s); last_source_error = desc.get () < 0; if (last_source_error) - noprint = true; + { + noprint = true; + errcode = -desc.get (); + } } } else @@ -1354,7 +1373,7 @@ print_source_lines_base (struct symtab *s, int line, int stopline, char *name = (char *) alloca (len); xsnprintf (name, len, "%d\t%s", line, filename); - print_sys_errmsg (name, errno); + print_sys_errmsg (name, errcode); } else { @@ -1627,7 +1646,8 @@ search_command_helper (const char *regex, int from_tty, bool forward) scoped_fd desc (open_source_file (loc->symtab ())); if (desc.get () < 0) - perror_with_name (symtab_to_filename_for_display (loc->symtab ())); + perror_with_name (symtab_to_filename_for_display (loc->symtab ()), + -desc.get ()); int line = (forward ? last_line_listed + 1 diff --git a/gdb/source.h b/gdb/source.h index 61d1bcd883b..dd6f58c579c 100644 --- a/gdb/source.h +++ b/gdb/source.h @@ -67,7 +67,8 @@ extern void init_source_path (void); The caller is responsible for freeing FULLNAME. On Failure - An invalid file descriptor is returned (the return value is negative). + An invalid file descriptor is returned. The value of this file + descriptor is a negative errno indicating the reason for the failure. FULLNAME is set to NULL. */ extern scoped_fd find_and_open_source (const char *filename, const char *dirname, @@ -81,7 +82,7 @@ extern gdb::unique_xmalloc_ptr find_source_or_rewrite (const char *filename, const char *dirname); /* Open a source file given a symtab S. Returns a file descriptor or - negative number for error. */ + negative errno indicating the reason for the failure. */ extern scoped_fd open_source_file (struct symtab *s); extern gdb::unique_xmalloc_ptr rewrite_source_path (const char *path);