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 EA69A3858031 for ; Mon, 6 Nov 2023 22:30:16 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org EA69A3858031 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 EA69A3858031 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1699309821; cv=none; b=TU2Qa2q/l2dg6ZXTyuYEYfqlRMSRR+Ru8hMkwNBA92bApZu2wfkDfppNFwksta90w89+sxsu2wSH+W4EQiBIybRloAxFzb37uBcS2tE5QNhMtdwoMKLrfvLsEjDu/bbde5F6NXvYpkZpzXcRbBeEbp1OOJGAoqBegY9AaUn44Gk= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1699309821; c=relaxed/simple; bh=TYWETsFqeIF8UlO+WZoIiiwnERHrtPQle22TYglJdCQ=; h=DKIM-Signature:From:To:Subject:Date:Message-Id:MIME-Version; b=r6J31yiIphw9DC4Dww0d2ANaKMMkabuZMY+TI6RBfP+BHLmVSUcmpGl+XsPnTkRA5N9o0TVntBYgTLwBRDqVmkMoFP78zjE4DFoNbvLyzKywwtli4ZND0ux6+vmUZLWoIKJigkKKhGZMri5vGEnGmKS29aQjmkBg1HSstKvc1tA= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1699309816; 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=6/x29W9Ee+Wh7nKgdSgsRSFJPZcNqqmzkOv+leUyXc8=; b=U0hfcMkgbeNd3YrwrZiJdH6euSH/bXpPcVtvWE0DMscmdAvLUzTwe4XjZIgz8f3kJZlI09 XmX+TMNC/nALKYpbZ7a2vtjamA2pdW1Up8lNZo9xvBTELj7S3g0M1fv9/6HtWewn2I3xTq 8YYS+24ysdyv4SMFVSDH3ntGgepnb4o= 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-269-TM21x719PuKTGcNx04PT6g-1; Mon, 06 Nov 2023 17:30:13 -0500 X-MC-Unique: TM21x719PuKTGcNx04PT6g-1 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (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 C7242811E88; Mon, 6 Nov 2023 22:30:12 +0000 (UTC) Received: from t14s.localdomain.com (unknown [10.22.8.62]) by smtp.corp.redhat.com (Postfix) with ESMTP id 87A4E40C6EB9; Mon, 6 Nov 2023 22:30:12 +0000 (UTC) From: David Malcolm To: gcc-patches@gcc.gnu.org, binutils@sourceware.org Cc: Nick Clifton , Simon Sobisch , David Malcolm Subject: [PATCH] binutils: experimental use of libdiagnostics in gas Date: Mon, 6 Nov 2023 17:29:59 -0500 Message-Id: <20231106222959.2707741-4-dmalcolm@redhat.com> In-Reply-To: <20231106222959.2707741-1-dmalcolm@redhat.com> References: <20231106222959.2707741-1-dmalcolm@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.2 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="US-ASCII"; x-default=true 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_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,TXREP,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: 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: VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV= V 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=3D/home/david/coding-3/gcc-newgit-canvas-2023/build/gcc .= /as-new testsuite/gas/all/warn-1.s emits: VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV= V 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 argu= ment 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-war= ning "Warning: .warning directive invoked in source file" } | testsuite/gas/all/warn-1.s:7: warning: 7 | .warning "" ;# { dg-warning "Warning: " } | =09{"$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/mast= er/Schemata/sarif-schema-2.1.0.json", "version": "2.1.0", "runs": [{"tool":= {"driver": {"rules": []}}, "invocations": [{"executionSuccessful": true, "= toolExecutionNotifications": []}], "originalUriBaseIds": {"PWD": {"uri": "f= ile:///home/david/coding-3/binutils-gdb/gas/"}}, "artifacts": [{"location":= {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "contents": {"t= ext": ";# Test .warning directive.\n;# { dg-do assemble }\n .warning \"a wa= rning message\"\t;# { dg-warning \"Warning: a warning message\" }\n .warnin= g a warning message\t;# { dg-error \"Error: .warning argument must be a str= ing\" }\n .warning\t\t\t;# { dg-warning \"Warning: .warning directive invok= ed in source file\" }\n .warning \".warning directive invoked in source fil= e\"\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 me= ssage"}, "locations": [{"physicalLocation": {"artifactLocation": {"uri": "t= estsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "region": {"startLine": 3,= "startColumn": 0, "endColumn": 1}, "contextRegion": {"startLine": 3, "snip= pet": {"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}, "contextR= egion": {"startLine": 4, "snippet": {"text": " .warning a warning message\t= ;# { dg-error \"Error: .warning argument must be a string\" }\n"}}}, "messa= ge": {"text": ".warning argument must be a string"}}, {"physicalLocation": = {"artifactLocation": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PW= D"}, "region": {"startLine": 5, "startColumn": 0, "endColumn": 1}, "context= Region": {"startLine": 5, "snippet": {"text": " .warning\t\t\t;# { dg-warni= ng \"Warning: .warning directive invoked in source file\" }\n"}}}, "message= ": {"text": ".warning directive invoked in source file"}}, {"physicalLocati= on": {"artifactLocation": {"uri": "testsuite/gas/all/warn-1.s", "uriBaseId"= : "PWD"}, "region": {"startLine": 6, "startColumn": 0, "endColumn": 1}, "co= ntextRegion": {"startLine": 6, "snippet": {"text": " .warning \".warning di= rective invoked in source file\"\t;# { dg-warning \"Warning: .warning direc= tive invoked in source file\" }\n"}}}, "message": {"text": ".warning direct= ive invoked in source file"}}, {"physicalLocation": {"artifactLocation": {"= uri": "testsuite/gas/all/warn-1.s", "uriBaseId": "PWD"}, "region": {"startL= ine": 7, "startColumn": 0, "endColumn": 1}, "contextRegion": {"startLine": = 7, "snippet": {"text": " .warning \"\"\t\t\t;# { dg-warning \"Warning: \" }= \n"}}}, "message": {"text": ""}}]}]}]} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^= ^ which I see: - drops the leading "Assembler messages" warning, - changes the capitalization of the "Warning" -> "warning" etc - quotes the pertinent line in the .s file All of the locations are just lines; does gas do column numbers at all? (or ranges?) For reference, running the above SARIF through "python -m json.tool" to prettyify it gives: VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV= V { "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/mast= er/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 as= semble }\n .warning \"a warning message\"\t;# { dg-warning \"Warning: a war= ning message\" }\n .warning a warning message\t;# { dg-error \"Error: .warn= ing argument must be a string\" }\n .warning\t\t\t;# { dg-warning \"Warning= : .warning directive invoked in source file\" }\n .warning \".warning direc= tive invoked in source file\"\t;# { dg-warning \"Warning: .warning directiv= e 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 mess= age\"\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 messag= e\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-war= ning \"Warning: .warning directive invoked in source file\" }\n" } } }, "message": { "text": ".warning directive invoked in sour= ce 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 direc= tive invoked in source file\"\t;# { dg-warning \"Warning: .warning directiv= e invoked in source file\" }\n" } } }, "message": { "text": ".warning directive invoked in sour= ce 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;# { d= g-warning \"Warning: \" }\n" } } }, "message": { "text": "" } } ] } ] } ] } ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^= ^ Thoughts? gas/ChangeLog: =09* Makefile.am (GASLIBS): Add nasty hack with hardcoded path =09on my hard drive. =09* Makefile.in (GASLIBS): Likewise. =09* as.c (gas_init): Call messages_init. =09(main): Call messages_end. =09* as.h (messages_init): New decl. =09(messages_end): New decl. =09* messages.c (USE_LIBDIAGNOSTICS): New define. =09Add #include with nasty hardcoded path. =09(diag_mgr): New. =09(messages_init): New. =09(messages_end): New. =09(as_warn_internal): Add support for libdiagnostics. =09(as_bad_internal): Likewise. --- gas/Makefile.am | 3 ++- gas/Makefile.in | 4 ++- gas/as.c | 3 +++ gas/as.h | 3 +++ gas/messages.c | 68 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 79 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 =3D -I. -I$(srcdir) -I../bfd -I$(srcdir)/co= nfig \ # How to link with both our special library facilities # and the system's installed libraries. =20 -GASLIBS =3D @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a +# FIXME: +GASLIBS =3D @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a /home/= david/coding-3/gcc-newgit-canvas-2023/build/gcc/libdiagnostics.so =20 # Files to be copied away after each stage in building. STAGESTUFF =3D *.@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 =3D -I. -I$(srcdir) -I../bfd -I$(srcdir)/co= nfig \ =20 # How to link with both our special library facilities # and the system's installed libraries. -GASLIBS =3D @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a + +# FIXME: +GASLIBS =3D @OPCODES_LIB@ ../bfd/libbfd.la ../libiberty/libiberty.a /home/= david/coding-3/gcc-newgit-canvas-2023/build/gcc/libdiagnostics.so =20 # Files to be copied away after each stage in building. STAGESTUFF =3D *.@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) =20 input_scrub_end (); =20 + 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 () !=3D 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); =20 +void messages_init (void); +void messages_end (void); + /* Number of littlenums required to hold an extended precision number.=09*= / #define MAX_LITTLENUMS 6 =20 diff --git a/gas/messages.c b/gas/messages.c index 7c018acf69f..3cb8525fad9 100644 --- a/gas/messages.c +++ b/gas/messages.c @@ -21,6 +21,14 @@ #include #include =20 +// 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/libdiagnosti= cs.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; } =20 +#if USE_LIBDIAGNOSTICS +static diagnostic_manager *diag_mgr; +#endif + +void messages_init (void) +{ +#if USE_LIBDIAGNOSTICS + diag_mgr =3D diagnostic_manager_new (); + diagnostic_manager_add_text_sink (diag_mgr, stderr, +=09=09=09=09 DIAGNOSTIC_COLORIZE_IF_TTY); + diagnostic_manager_add_sarif_sink (diag_mgr, stderr, +=09=09=09=09 DIAGNOSTIC_SARIF_VERSION_2_1_0); +#endif +} + +void messages_end (void) +{ +#if USE_LIBDIAGNOSTICS + diagnostic_manager_release (diag_mgr); + diag_mgr =3D NULL; +#endif +} + /* Nonzero if we've hit a 'bad error', and should not write an obj file, and exit with a nonzero error code. */ =20 @@ -172,16 +203,34 @@ as_tsktsk (const char *format, ...) static void as_warn_internal (const char *file, unsigned int line, char *buffer) { +#if !USE_LIBDIAGNOSTICS bool context =3D false; +#endif =20 ++warning_count; =20 if (file =3D=3D NULL) { file =3D as_where_top (&line); +#if !USE_LIBDIAGNOSTICS context =3D true; +#endif } =20 +#if USE_LIBDIAGNOSTICS + const diagnostic_file *file_obj + =3D diagnostic_manager_new_file (diag_mgr, file, NULL); + + diagnostic_location_t loc + =3D diagnostic_manager_new_location_from_file_and_line (diag_mgr, +=09=09=09=09=09=09=09 file_obj, +=09=09=09=09=09=09=09 line); + + diagnostic *d =3D diagnostic_begin (diag_mgr, +=09=09=09=09 DIAGNOSTIC_LEVEL_WARNING); + diagnostic_set_location (d, loc); + diagnostic_finish (d, "%s", buffer); +#else identify (file); if (file) { @@ -199,6 +248,7 @@ as_warn_internal (const char *file, unsigned int line, = char *buffer) #ifndef NO_LISTING listing_warning (buffer); #endif +#endif /* #else clause of #if USE_LIBDIAGNOSTICS */ } =20 /* Send to stderr a string as a warning, and locate warning @@ -246,16 +296,33 @@ as_warn_where (const char *file, unsigned int line, c= onst char *format, ...) static void as_bad_internal (const char *file, unsigned int line, char *buffer) { +#if !USE_LIBDIAGNOSTICS bool context =3D false; +#endif =20 ++error_count; =20 if (file =3D=3D NULL) { file =3D as_where_top (&line); +#if !USE_LIBDIAGNOSTICS context =3D true; +#endif } =20 +#if USE_LIBDIAGNOSTICS + const diagnostic_file *file_obj + =3D diagnostic_manager_new_file (diag_mgr, file, NULL); + diagnostic_location_t loc + =3D diagnostic_manager_new_location_from_file_and_line (diag_mgr, +=09=09=09=09=09=09=09 file_obj, +=09=09=09=09=09=09=09 line); + + diagnostic *d =3D diagnostic_begin (diag_mgr, +=09=09=09=09 DIAGNOSTIC_LEVEL_ERROR); + diagnostic_set_location (d, loc); + diagnostic_finish (d, "%s", buffer); +#else identify (file); if (file) { @@ -269,6 +336,7 @@ as_bad_internal (const char *file, unsigned int line, c= har *buffer) =20 if (context) as_report_context (); +#endif /* #else clause of #if USE_LIBDIAGNOSTICS */ =20 #ifndef NO_LISTING listing_error (buffer); --=20 2.26.3