Merge remote-tracking branch 'origin/topic/bbannier/spicy-hook-priority'

CHANGES

@@ -1,3 +1,21 @@
+1.11.0-dev.137 | 2024-04-25 13:38:42 +0200
+
+  * Remove Spicy parser support for unsupported `&priority` attribute. (Benjamin Bannier, Corelight)
+
+  * Make spelling of hook `priority` consistent across Spicy and HILTI. (Benjamin Bannier, Corelight)
+
+    We were naming the priority attribute differently in Spicy (`priority`)
+    and HILTI (`&priority`). While e.g., a Spicy `Hook` could correct
+    extract its priority, this still could have lead to potential issues if
+    we were attempting to access the priority of a Spicy hook from HILTI as
+    we do not perform any adjustment of this attribute when lowering to
+    HILTI. This distinction also made it hard to generate intended code from
+    the outside using our API (e.g., from Zeek) since one needed to be aware
+    at which level the attribute was injected (Spicy or HILTI).
+
+    With this patch we internally translate a Spicy `priority` attribute to
+    `&attribute` syntax.
+
 1.11.0-dev.134 | 2024-04-25 13:36:59 +0200
 
   * Fix incremental skipping. (Benjamin Bannier, Corelight)

VERSION

@@ -1 +1 @@
-1.11.0-dev.134
+1.11.0-dev.137

spicy/toolchain/include/ast/declarations/hook.h

@@ -49,7 +49,7 @@ class Hook : public Declaration {
     auto unitFieldIndex() { return _unit_field_index; }
 
     hilti::Expression* priority() const {
-        if ( auto attr = attributes()->find("priority") )
+        if ( auto attr = attributes()->find("&priority") )
             return *attr->valueAsExpression();
         else
             return nullptr;

spicy/toolchain/src/compiler/parser/parser.yy

@@ -884,7 +884,7 @@ unit_hook_id: { driver->enableHookIDMode(); }
 
 unit_hook_attribute
               : FOREACH                          { $$ = builder->attribute("foreach", __loc__); }
-              | PRIORITY '=' expr                { $$ = builder->attribute("priority", std::move($3), __loc__); }
+              | PRIORITY '=' expr                { $$ = builder->attribute("&priority", std::move($3), __loc__); }
               | PROPERTY                         { if ( $1 != "%debug" ) error(@$, "unexpected hook property, only %debug permitted");
                                                    $$ = builder->attribute("%debug", __loc__);
                                                  }

spicy/toolchain/src/compiler/parser/scanner.ll

@@ -62,7 +62,7 @@ doc_field    [ \t]*##<[^\n]*\n?
 doc_text     [ \t]*##[^\n]*\n?
 comment      [ \t]*#[^#\n]*\n?
 
-attribute \&(bit-order|byte-order|chunked|convert|count|cxxname|default|eod|internal|ipv4|ipv6|hilti_type|length|max-size|no-emit|nosub|on-heap|optional|originator|parse-at|parse-from|priority|requires|responder|size|static|synchronize|transient|try|type|until|until-including|while|have_prototype)
+attribute \&(bit-order|byte-order|chunked|convert|count|cxxname|default|eod|internal|ipv4|ipv6|hilti_type|length|max-size|no-emit|nosub|on-heap|optional|originator|parse-at|parse-from|requires|responder|size|static|synchronize|transient|try|type|until|until-including|while|have_prototype)
 blank     [ \t]
 digit     [0-9]
 digits    {digit}+

tests/Baseline/spicy.types.unit.hooks-priorities/output

@@ -1,7 +1,10 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
 A: prio 15, 12345
+B: prio 10, 12345
 A: prio 7, 12345
 A: prio 0, 12345
 A: prio -5, 12345
-B: prio 10, 12345
 B: prio -10, 12345
+B: prio 15
+B: default prio
+B: prio -5

tests/spicy/types/unit/hooks-priorities.spicy

@@ -1,9 +1,10 @@
-# @TEST-EXEC:  echo 12345| spicy-driver -p A::tA %INPUT b.spicy | sort -s -k 1,1 >output
-# @TEST-EXEC:  btest-diff output
+# @TEST-EXEC: echo 12345| spicy-driver -p test1::A %INPUT b.spicy >>output
+# @TEST-EXEC: echo | spicy-driver -p test1::B %INPUT b.spicy >>output
+# @TEST-EXEC: btest-diff output
 
-module A;
+module test1;
 
-public type tA = unit {
+public type A = unit {
        a: bytes &size=5 {
             print "A: prio 0", self.a;
        }
@@ -13,24 +14,36 @@ public type tA = unit {
        }
 };
 
-on tA::a priority=-5 {
+on A::a priority=-5 {
     print "A: prio -5", self.a;
     }
 
-on tA::a priority=15 {
+on A::a priority=15 {
     print "A: prio 15", self.a;
     }
 
+public type B = unit {
+    on %done {
+        print "B: default prio";
+    }
+    on %done priority=-5 {
+        print "B: prio -5";
+    }
+    on %done priority=15 {
+        print "B: prio 15";
+    }
+};
+
 ### @TEST-START-FILE b.spicy
-module B;
+module test2;
 
-import A;
+import test1;
 
-on A::tA::a priority=-10 {
+on test1::A::a priority=-10 {
     print "B: prio -10", self.a;
     }
 
-on A::tA::a priority=10 {
+on test1::A::a priority=10 {
     print "B: prio 10", self.a;
     }
 ### @TEST-END-FILE test.txt