From: Nick Clifton <nickc@redhat.com>
To: binutils@sourceware.org
Subject: RFC: Maintaining a per-macro invocation count
Date: Wed, 08 May 2024 18:11:13 +0100 [thread overview]
Message-ID: <87pltw9qku.fsf@redhat.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 1408 bytes --]
Hi Guys,
The attached patch implements a extension to the assembler's macro
syntax, allowing a macro to access a count of the number of times that
it has been executed via the \+ pseudo-variable. ie like this:
.macro foo
.print "I have been invoked \+ times"
.endm
This syntax is similar to the already supported \@ pseudo-variable,
except that the count is maintained on a per-macro basis.
The drive for this extension is that I want to be able to generate
N references to unique symbols in file A and then N definitions of
those symbols in file B. Using assembler macros makes this easy,
providing that I can ensure that the names in file A will match those
in file B. ie:
fileA.s:
.macro gen_refs count
.dc.a ref_\+
.if \count > 1
gen_refs \count-1
.endif
.endm
gen_refs 1000
fileB.s:
.macro gen_defs count
.global ref_\+
ref_\+ :
.if \count > 1
gen_defs \count-1
.endif
.endm
gen_defs 1000
(This is part of a larger exercise to generate some micro benchmarks
for the assembler that exercise various different features. In this
case I am looking into relocation processing).
Comments, suggestions ?
Cheers
Nick
PS. In the course of creating this patch I noticed that the altmacto
test (gas/testsuite/gas/macros/altmacro.d) does not appear to be run.
So I have fixed that as well.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: gas.macro+.patch --]
[-- Type: text/x-patch, Size: 5836 bytes --]
diff --git a/gas/NEWS b/gas/NEWS
index cb58ca8fb8d..0fbd244c518 100644
--- a/gas/NEWS
+++ b/gas/NEWS
@@ -1,5 +1,9 @@
-*- text -*-
+* Assembler macros can now use the syntax \+ to access the number of times a
+ given macro has been executed. This is similar to the already existing \@
+ syntax, except that the count is maintained on a per-macro basis.
+
* Support the NF feature in Intel APX.
* Remove KEYLOCKER and SHA promotions from EVEX MAP4.
diff --git a/gas/doc/as.texi b/gas/doc/as.texi
index 42db11e91da..1fb97c4cd9f 100644
--- a/gas/doc/as.texi
+++ b/gas/doc/as.texi
@@ -6362,6 +6362,14 @@ Exit early from the current macro definition.
executed in this pseudo-variable; you can copy that number to your
output with @samp{\@@}, but @emph{only within a macro definition}.
+@cindex number of times a macro has been executed
+@cindex macro, execution count
+@item \+
+Similar to the @code{\@@} pseudo-variable, @command{@value{AS}} also maintains
+a per-macro count of the number of times that that macro has been executed.
+You can copy that number to your output with @samp{\+}, but
+@emph{only within a macro definition}.
+
@item LOCAL @var{name} [ , @dots{} ]
@emph{Warning: @code{LOCAL} is only available if you select ``alternate
macro syntax'' with @samp{--alternate} or @code{.altmacro}.}
diff --git a/gas/macro.c b/gas/macro.c
index e2ee39bc209..72d869d317f 100644
--- a/gas/macro.c
+++ b/gas/macro.c
@@ -56,7 +56,7 @@ int macro_defined;
/* Number of macro expansions that have been done. */
-static int macro_number;
+static unsigned int macro_number;
static void free_macro (macro_entry *);
@@ -668,6 +668,7 @@ define_macro (sb *in, sb *label, size_t (*get_line) (sb *))
macro->formal_count = 0;
macro->formals = 0;
macro->formal_hash = str_htab_create ();
+ macro->count = 0;
idx = sb_skip_white (0, in);
if (! buffer_and_nest ("MACRO", "ENDM", ¯o->sub, get_line))
@@ -846,11 +847,20 @@ macro_expand_body (sb *in, sb *out, formal_entry *formals,
}
else if (src < in->len && in->ptr[src] == '@')
{
- /* Sub in the macro invocation number. */
+ /* Sub in the total macro invocation number. */
char buffer[12];
src++;
- sprintf (buffer, "%d", macro_number);
+ sprintf (buffer, "%u", macro_number);
+ sb_add_string (out, buffer);
+ }
+ else if (src < in->len && in->ptr[src] == '+')
+ {
+ /* Sub in the current macro invocation number. */
+
+ char buffer[12];
+ src++;
+ sprintf (buffer, "%d", macro->count);
sb_add_string (out, buffer);
}
else if (src < in->len && in->ptr[src] == '&')
@@ -1227,7 +1237,10 @@ macro_expand (size_t idx, sb *in, macro_entry *m, sb *out)
sb_kill (&t);
if (!err)
- macro_number++;
+ {
+ macro_number++;
+ m->count++;
+ }
return err;
}
diff --git a/gas/macro.h b/gas/macro.h
index a12fb894bec..e87f64e70ca 100644
--- a/gas/macro.h
+++ b/gas/macro.h
@@ -60,13 +60,14 @@ typedef struct formal_struct {
typedef struct macro_struct
{
- sb sub; /* Substitution text. */
- int formal_count; /* Number of formal args. */
- formal_entry *formals; /* List of formal_structs. */
- htab_t formal_hash; /* Hash table of formals. */
- const char *name; /* Macro name. */
- const char *file; /* File the macro was defined in. */
- unsigned int line; /* Line number of definition. */
+ sb sub; /* Substitution text. */
+ int formal_count; /* Number of formal args. */
+ formal_entry * formals; /* List of formal_structs. */
+ htab_t formal_hash; /* Hash table of formals. */
+ const char * name; /* Macro name. */
+ const char * file; /* File the macro was defined in. */
+ unsigned int line; /* Line number of definition. */
+ unsigned int count; /* Invocation count. */
} macro_entry;
/* Whether any macros have been defined. */
diff --git a/gas/testsuite/gas/macros/altmacro.d b/gas/testsuite/gas/macros/altmacro.d
index 49c04aa3f79..e9ca349e1c7 100644
--- a/gas/testsuite/gas/macros/altmacro.d
+++ b/gas/testsuite/gas/macros/altmacro.d
@@ -1,3 +1,2 @@
-local
-.LL0001
-.LL0002
+#name: Local label generation in alternate macros (altmacro)
+
diff --git a/gas/testsuite/gas/macros/macros.exp b/gas/testsuite/gas/macros/macros.exp
index 38e613f088a..3108f3fcd56 100644
--- a/gas/testsuite/gas/macros/macros.exp
+++ b/gas/testsuite/gas/macros/macros.exp
@@ -100,3 +100,6 @@ if [string match "" [lindex [gas_run ../all/excl.s "-o /dev/null" ""] 0]] {
# prevented the assembler from parsing the rest of the file,
# and hence catching an erroroneous instruction.
gas_test_error "exit.s" "" ".exitm outside of a macro"
+
+run_list_test altmacro
+run_list_test count
--- /dev/null 2024-05-08 09:06:03.744530866 +0100
+++ current/gas/testsuite/gas/macros/altmacro.l 2024-05-08 17:45:47.116122421 +0100
@@ -0,0 +1,3 @@
+local.*
+.*LL0001
+.*LL0002
--- /dev/null 2024-05-08 09:06:03.744530866 +0100
+++ current/gas/testsuite/gas/macros/count.s 2024-05-08 17:35:31.770892104 +0100
@@ -0,0 +1,19 @@
+
+.macro mac1 count=10
+ .print "\@"
+ .print "\+"
+.if \count > 1
+ mac1 \count-1
+.endif
+.endm
+
+.macro mac2 count=100
+ .print "\@"
+ .print "\+"
+.if \count > 1
+ mac2 \count-1
+.endif
+.endm
+
+mac1 2
+mac2 3
--- /dev/null 2024-05-08 09:06:03.744530866 +0100
+++ current/gas/testsuite/gas/macros/count.d 2024-05-08 17:46:54.781255760 +0100
@@ -0,0 +1,3 @@
+#name: Macro counters (count.d)
+# Tests that \@ counts total macro invocation count
+# and that \+ counts individual macro invocation count.
--- /dev/null 2024-05-08 09:06:03.744530866 +0100
+++ current/gas/testsuite/gas/macros/count.l 2024-05-08 17:45:35.497099524 +0100
@@ -0,0 +1,10 @@
+0
+0
+1
+1
+2
+0
+3
+1
+4
+2
next reply other threads:[~2024-05-08 17:11 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-08 17:11 Nick Clifton [this message]
2024-05-14 1:12 ` Hans-Peter Nilsson
2024-05-15 9:42 ` Nick Clifton
2024-05-15 5:59 ` Fangrui Song
2024-05-15 9:45 ` Nick Clifton
2024-05-17 17:54 ` Fangrui Song
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87pltw9qku.fsf@redhat.com \
--to=nickc@redhat.com \
--cc=binutils@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).