From patchwork Tue Nov 21 22:20:19 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Malcolm X-Patchwork-Id: 80519 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 9EE28388204B for ; Tue, 21 Nov 2023 22:22:07 +0000 (GMT) X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 80BC13858282 for ; Tue, 21 Nov 2023 22:20:27 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 80BC13858282 Authentication-Results: sourceware.org; dmarc=pass (p=none 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 80BC13858282 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=1700605234; cv=none; b=evHCS0cxD38IVO3Zckx78uJOPHPWuaOePN6GxC6dE+dC2SplhxBlaBPsSgu+qj3KguEN8+6OhZX2dmeqM6VIItWvyGVBVAhRQUNwIw37WWYtn7c8N7XJ9Jj0iVvGNPtza/xSgI7b3bPrja79fraBlXtD9pQOVeJojtlPWT3tBF8= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1700605234; c=relaxed/simple; bh=RJRF4jQ5sFvR9dnsnlmKYvo+hrORD4LAp8654PaSlS8=; h=DKIM-Signature:From:To:Subject:Date:Message-Id:MIME-Version; b=et/qzW97fYDbETK4d924rBL7ChX5FbFtnPrW9eeQkskEzGNve6aDySMebZI23qfneZWvKhUKUroqoN+PHByHTI0MP9UmNEp72ZU49BUkOOW1m8B7Yi8w8AACfT/bmOCmEjt/IJQUQcQbqDjIn/m17I2vEMU4Yxt1vc5fVIlIJlU= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1700605227; 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=gGDfKCwiRqcQ3M7tQE1zNzlpOhmyDNNvI/eOwTkj6UM=; b=QeHyJuqGdNYEr7F4B6un71FG0SmtGvPlpZQk1k/uO+Jol/INl/FJu3WyOPxvuALm5qnzLm 1IwI/Do38lbvwjZP6+Ui/th8Rup6vMzlGSkOFfR8Rp/sREkN2wITXbJkAxloFHf64vcHaQ 4aKw0BOHRotaAndeCEzDucpsORDarL8= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-442--uasDe6zNm-aYAxFFuPibA-1; Tue, 21 Nov 2023 17:20:24 -0500 X-MC-Unique: -uasDe6zNm-aYAxFFuPibA-1 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 93915821C21; Tue, 21 Nov 2023 22:20:23 +0000 (UTC) Received: from t14s.localdomain.com (unknown [10.22.10.115]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4C0BA492BFA; Tue, 21 Nov 2023 22:20:23 +0000 (UTC) From: David Malcolm To: gcc-patches@gcc.gnu.org, binutils@sourceware.org Cc: Nick Clifton , Simon Sobisch , David Malcolm Subject: [PATCH] binutils: v2: experimental use of libdiagnostics in gas Date: Tue, 21 Nov 2023 17:20:19 -0500 Message-Id: <20231121222019.646253-7-dmalcolm@redhat.com> In-Reply-To: <20231121222019.646253-1-dmalcolm@redhat.com> References: <20231106222959.2707741-1-dmalcolm@redhat.com> <20231121222019.646253-1-dmalcolm@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.10 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.4 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_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gcc-patches-bounces+patchwork=sourceware.org@gcc.gnu.org Changed in v2: * updated for change from diagnostic_location_t to const diagnostic_physical_location * * fix #if USE_DIAGNOSTICS to retain context and listing code Output from the example below with v2 is now: testsuite/gas/all/warn-1.s:3: warning: a warning message 3 | .warning "a warning message" ;# { dg-warning "Warning: a warning message" } testsuite/gas/all/warn-1.s:4: error: .warning argument must be a string 4 | .warning a warning message ;# { dg-error "Error: .warning argument must be a string" } testsuite/gas/all/warn-1.s:5: warning: .warning directive invoked in source file 5 | .warning ;# { dg-warning "Warning: .warning directive invoked in source file" } testsuite/gas/all/warn-1.s:6: warning: .warning directive invoked in source file 6 | .warning ".warning directive invoked in source file" ;# { dg-warning "Warning: .warning directive invoked in source file" } testsuite/gas/all/warn-1.s:7: warning: 7 | .warning "" ;# { dg-warning "Warning: " } and there's also now a way to toggle quoting of the source code (perhaps for use in the testsuite) Blurb from v1: Here's a patch for gas in binutils that makes it use libdiagnostics (with some nasty hardcoded paths to specific places on my hard drive to make it easier to develop the API). For now this hardcodes adding two sinks: a text sink on stderr, and also a SARIF output to stderr (which happens after all regular output). For example, without this patch: gas testsuite/gas/all/warn-1.s emits: VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV testsuite/gas/all/warn-1.s: Assembler messages: testsuite/gas/all/warn-1.s:3: Warning: a warning message testsuite/gas/all/warn-1.s:4: Error: .warning argument must be a string testsuite/gas/all/warn-1.s:5: Warning: .warning directive invoked in source file testsuite/gas/all/warn-1.s:6: Warning: .warning directive invoked in source file testsuite/gas/all/warn-1.s:7: Warning: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ whereas with this patch: LD_LIBRARY_PATH=/home/david/coding-3/gcc-newgit-canvas-2023/build/gcc ./as-new testsuite/gas/all/warn-1.s emits: VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV testsuite/gas/all/warn-1.s:3: warning: a warning message 3 | .warning "a warning message" ;# { dg-warning "Warning: a warning message" } | testsuite/gas/all/warn-1.s:4: error: .warning argument must be a string 4 | .warning a warning message ;# { dg-error "Error: .warning argument must be a string" } | testsuite/gas/all/warn-1.s:5: warning: .warning directive invoked in source file 5 | .warning ;# { dg-warning "Warning: .warning directive invoked in source file" } | testsuite/gas/all/warn-1.s:6: warning: .warning directive invoked in source file 6 | .warning ".warning directive invoked in source file" ;# { dg-warning "Warning: .warning directive invoked in source file" } | testsuite/gas/all/warn-1.s:7: warning: 7 | .warning "" ;# { dg-warning "Warning: " } | {"$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json", "version": "2.1.0", "runs": [{"tool": {"driver": {"rules": []}}, "invocations": [{"executionSuccessful": true, "toolExecutionNotifications": []}], "originalUriBaseIds": {"PWD": {"uri": "file:///home/david/coding-3/binutils-gdb/gas/"}}, "artifacts": [{"location": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "contents": {"text": ";# Test .warning directive.\n;# { dg-do assemble }\n .warning \"a warning message\"\t;# { dg-warning \"Warning: a warning message\" }\n .warning a warning message\t;# { dg-error \"Error: .warning argument must be a string\" }\n .warning\t\t\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n .warning \".warning directive invoked in source file\"\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n .warning \"\"\t\t\t;# { dg-warning \"Warning: \" }\n"}}], "results": [{"ruleId": "warning", "level": "warning", "message": {"text": "a warning message"}, "locations": [{"physicalLocation": {"artifactLocation": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "region": {"startLine": 3, "startColumn": 0, "endColumn": 1}, "contextRegion": {"startLine": 3, "snippet": {"text": " .warning \"a warning message\"\t;# { dg-warning \"Warning: a warning message\" }\n"}}}}], "relatedLocations": [{"physicalLocation": {"artifactLocation": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "region": {"startLine": 4, "startColumn": 0, "endColumn": 1}, "contextRegion": {"startLine": 4, "snippet": {"text": " .warning a warning message\t;# { dg-error \"Error: .warning argument must be a string\" }\n"}}}, "message": {"text": ".warning argument must be a string"}}, {"physicalLocation": {"artifactLocation": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "region": {"startLine": 5, "startColumn": 0, "endColumn": 1}, "contextRegion": {"startLine": 5, "snippet": {"text": " .warning\t\t\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n"}}}, "message": {"text": ".warning directive invoked in source file"}}, {"physicalLocation": {"artifactLocation": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "region": {"startLine": 6, "startColumn": 0, "endColumn": 1}, "contextRegion": {"startLine": 6, "snippet": {"text": " .warning \".warning directive invoked in source file\"\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n"}}}, "message": {"text": ".warning directive invoked in source file"}}, {"physicalLocation": {"artifactLocation": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "region": {"startLine": 7, "startColumn": 0, "endColumn": 1}, "contextRegion": {"startLine": 7, "snippet": {"text": " .warning \"\"\t\t\t;# { dg-warning \"Warning: \" }\n"}}}, "message": {"text": ""}}]}]}]} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For reference, running that SARIF through "python -m json.tool" to prettyify it gives: VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV { "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json", "version": "2.1.0", "runs": [ { "tool": { "driver": { "rules": [] } }, "invocations": [ { "executionSuccessful": true, "toolExecutionNotifications": [] } ], "originalUriBaseIds": { "PWD": { "uri": "file:///home/david/coding-3/binutils-gdb/gas/" } }, "artifacts": [ { "location": { "uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD" }, "contents": { "text": ";# Test .warning directive.\n;# { dg-do assemble }\n .warning \"a warning message\"\t;# { dg-warning \"Warning: a warning message\" }\n .warning a warning message\t;# { dg-error \"Error: .warning argument must be a string\" }\n .warning\t\t\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n .warning \".warning directive invoked in source file\"\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n .warning \"\"\t\t\t;# { dg-warning \"Warning: \" }\n" } } ], "results": [ { "ruleId": "warning", "level": "warning", "message": { "text": "a warning message" }, "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD" }, "region": { "startLine": 3, "startColumn": 0, "endColumn": 1 }, "contextRegion": { "startLine": 3, "snippet": { "text": " .warning \"a warning message\"\t;# { dg-warning \"Warning: a warning message\" }\n" } } } } ], "relatedLocations": [ { "physicalLocation": { "artifactLocation": { "uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD" }, "region": { "startLine": 4, "startColumn": 0, "endColumn": 1 }, "contextRegion": { "startLine": 4, "snippet": { "text": " .warning a warning message\t;# { dg-error \"Error: .warning argument must be a string\" }\n" } } }, "message": { "text": ".warning argument must be a string" } }, { "physicalLocation": { "artifactLocation": { "uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD" }, "region": { "startLine": 5, "startColumn": 0, "endColumn": 1 }, "contextRegion": { "startLine": 5, "snippet": { "text": " .warning\t\t\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n" } } }, "message": { "text": ".warning directive invoked in source file" } }, { "physicalLocation": { "artifactLocation": { "uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD" }, "region": { "startLine": 6, "startColumn": 0, "endColumn": 1 }, "contextRegion": { "startLine": 6, "snippet": { "text": " .warning \".warning directive invoked in source file\"\t;# { dg-warning \"Warning: .warning directive invoked in source file\" }\n" } } }, "message": { "text": ".warning directive invoked in source file" } }, { "physicalLocation": { "artifactLocation": { "uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD" }, "region": { "startLine": 7, "startColumn": 0, "endColumn": 1 }, "contextRegion": { "startLine": 7, "snippet": { "text": " .warning \"\"\t\t\t;# { dg-warning \"Warning: \" }\n" } } }, "message": { "text": "" } } ] } ] } ] } ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ gas/ChangeLog: * Makefile.am (GASLIBS): Add nasty hack with hardcoded path on my hard drive. * Makefile.in (GASLIBS): Likewise. * as.c (gas_init): Call messages_init. (main): Call messages_end. * as.h (messages_init): New decl. (messages_end): New decl. * messages.c (USE_LIBDIAGNOSTICS): New define. Add #include with nasty hardcoded path. (diag_mgr): New. (messages_init): New. (messages_end): New. (as_warn_internal): Add support for libdiagnostics. (as_bad_internal): Likewise. --- gas/Makefile.am | 3 ++- gas/Makefile.in | 4 +++- gas/as.c | 3 +++ gas/as.h | 3 +++ gas/messages.c | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 71 insertions(+), 2 deletions(-) diff --git a/gas/Makefile.am b/gas/Makefile.am index 0e98ca3ec85..fe92997129c 100644 --- a/gas/Makefile.am +++ b/gas/Makefile.am @@ -408,7 +408,8 @@ AM_CPPFLAGS = -I. -I$(srcdir) -I../bfd -I$(srcdir)/config \ # How to link with both our special library facilities # and the system's installed libraries. -GASLIBS = @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a +# FIXME: +GASLIBS = @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a /home/david/coding-3/gcc-newgit-canvas-2023/build/gcc/libdiagnostics.so # Files to be copied away after each stage in building. STAGESTUFF = *.@OBJEXT@ $(noinst_PROGRAMS) diff --git a/gas/Makefile.in b/gas/Makefile.in index fae3a47c144..2161d68f9c7 100644 --- a/gas/Makefile.in +++ b/gas/Makefile.in @@ -885,7 +885,9 @@ AM_CPPFLAGS = -I. -I$(srcdir) -I../bfd -I$(srcdir)/config \ # How to link with both our special library facilities # and the system's installed libraries. -GASLIBS = @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a + +# FIXME: +GASLIBS = @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a /home/david/coding-3/gcc-newgit-canvas-2023/build/gcc/libdiagnostics.so # Files to be copied away after each stage in building. STAGESTUFF = *.@OBJEXT@ $(noinst_PROGRAMS) diff --git a/gas/as.c b/gas/as.c index 6839c841588..2a8ce3734a0 100644 --- a/gas/as.c +++ b/gas/as.c @@ -1300,6 +1300,7 @@ gas_early_init (int *argcp, char ***argvp) static void gas_init (void) { + messages_init (); symbol_begin (); frag_init (); subsegs_begin (); @@ -1486,6 +1487,8 @@ main (int argc, char ** argv) input_scrub_end (); + messages_end (); + /* Use xexit instead of return, because under VMS environments they may not place the same interpretation on the value given. */ if (had_errors () != 0) diff --git a/gas/as.h b/gas/as.h index 99ffe77afd2..9d878a87df5 100644 --- a/gas/as.h +++ b/gas/as.h @@ -474,6 +474,9 @@ void as_bad_value_out_of_range (const char *, offsetT, offsetT, offsetT, void print_version_id (void); char * app_push (void); +void messages_init (void); +void messages_end (void); + /* Number of littlenums required to hold an extended precision number. */ #define MAX_LITTLENUMS 6 diff --git a/gas/messages.c b/gas/messages.c index 7c018acf69f..1854560dae7 100644 --- a/gas/messages.c +++ b/gas/messages.c @@ -21,6 +21,14 @@ #include #include +// FIXME: do some configury thing for this +#define USE_LIBDIAGNOSTICS 1 + +#if USE_LIBDIAGNOSTICS +// FIXME: need to fix this path, obviously +#include "/home/david/coding-3/gcc-newgit-canvas-2023/src/gcc/libdiagnostics.h" +#endif + /* If the system doesn't provide strsignal, we get it defined in libiberty but no declaration is supplied. Because, reasons. */ #if !defined (HAVE_STRSIGNAL) && !defined (strsignal) @@ -101,6 +109,29 @@ had_warnings (void) return warning_count; } +#if USE_LIBDIAGNOSTICS +static diagnostic_manager *diag_mgr; +#endif + +void messages_init (void) +{ +#if USE_LIBDIAGNOSTICS + diag_mgr = diagnostic_manager_new (); + diagnostic_manager_add_text_sink (diag_mgr, stderr, + DIAGNOSTIC_COLORIZE_IF_TTY); + diagnostic_manager_add_sarif_sink (diag_mgr, stderr, + DIAGNOSTIC_SARIF_VERSION_2_1_0); +#endif +} + +void messages_end (void) +{ +#if USE_LIBDIAGNOSTICS + diagnostic_manager_release (diag_mgr); + diag_mgr = NULL; +#endif +} + /* Nonzero if we've hit a 'bad error', and should not write an obj file, and exit with a nonzero error code. */ @@ -182,6 +213,20 @@ as_warn_internal (const char *file, unsigned int line, char *buffer) context = true; } +#if USE_LIBDIAGNOSTICS + const diagnostic_file *file_obj + = diagnostic_manager_new_file (diag_mgr, file, NULL); + + const diagnostic_physical_location *loc + = diagnostic_manager_new_location_from_file_and_line (diag_mgr, + file_obj, + line); + + diagnostic *d = diagnostic_begin (diag_mgr, + DIAGNOSTIC_LEVEL_WARNING); + diagnostic_set_location (d, loc); + diagnostic_finish (d, "%s", buffer); +#else identify (file); if (file) { @@ -192,6 +237,7 @@ as_warn_internal (const char *file, unsigned int line, char *buffer) } else fprintf (stderr, "%s%s\n", _("Warning: "), buffer); +#endif /* #else clause of #if USE_LIBDIAGNOSTICS */ if (context) as_report_context (); @@ -256,6 +302,19 @@ as_bad_internal (const char *file, unsigned int line, char *buffer) context = true; } +#if USE_LIBDIAGNOSTICS + const diagnostic_file *file_obj + = diagnostic_manager_new_file (diag_mgr, file, NULL); + const diagnostic_physical_location *loc + = diagnostic_manager_new_location_from_file_and_line (diag_mgr, + file_obj, + line); + + diagnostic *d = diagnostic_begin (diag_mgr, + DIAGNOSTIC_LEVEL_ERROR); + diagnostic_set_location (d, loc); + diagnostic_finish (d, "%s", buffer); +#else identify (file); if (file) { @@ -266,6 +325,7 @@ as_bad_internal (const char *file, unsigned int line, char *buffer) } else fprintf (stderr, "%s%s\n", _("Error: "), buffer); +#endif /* #else clause of #if USE_LIBDIAGNOSTICS */ if (context) as_report_context ();