Introduce parser dialect

include/vast/Dialect/CMakeLists.txt

@@ -6,4 +6,5 @@ add_subdirectory(Core)
 add_subdirectory(HighLevel)
 add_subdirectory(LowLevel)
 add_subdirectory(Meta)
+add_subdirectory(Parser)
 add_subdirectory(Unsupported)

include/vast/Dialect/Parser/CMakeLists.txt

@@ -0,0 +1,3 @@
+# Copyright (c) 2024, Trail of Bits, Inc.
+
+add_vast_dialect_with_doc(Parser pr)

include/vast/Dialect/Parser/Dialect.hpp

@@ -0,0 +1,15 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#pragma once
+
+#include "vast/Util/Warnings.hpp"
+
+VAST_RELAX_WARNINGS
+#include <mlir/IR/Dialect.h>
+#include <mlir/IR/OperationSupport.h>
+VAST_RELAX_WARNINGS
+
+#include "vast/Dialect/Core/TypeTraits.hpp"
+
+// Pull in the dialect definition.
+#include "vast/Dialect/Parser/ParserDialect.h.inc"

include/vast/Dialect/Parser/Ops.hpp

@@ -0,0 +1,16 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#pragma once
+
+#include "vast/Util/Warnings.hpp"
+
+VAST_RELAX_WARNINGS
+#include <mlir/Interfaces/CallInterfaces.h>
+#include <mlir/Interfaces/InferTypeOpInterface.h>
+VAST_UNRELAX_WARNINGS
+
+#include "vast/Dialect/Parser/Dialect.hpp"
+#include "vast/Util/Common.hpp"
+
+#define GET_OP_CLASSES
+#include "vast/Dialect/Parser/Parser.h.inc"

include/vast/Dialect/Parser/Ops.td

@@ -0,0 +1,46 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#ifndef VAST_DIALECT_PARSER_OPS
+#define VAST_DIALECT_PARSER_OPS
+
+include "mlir/IR/OpBase.td"
+
+include "vast/Dialect/Core/Utils.td"
+include "vast/Dialect/Parser/Types.td"
+
+class Parser_Op< string mnemonic, list< Trait > traits = [] >
+  : Op< Parser_Dialect, mnemonic, traits >;
+
+def Parser_Source
+  : Parser_Op< "source" >
+  , Arguments< (ins Variadic<AnyType>:$arguments) >
+  , Results< (outs Variadic<Parser_DataType>:$result) >
+{
+  let summary = "Source of parsed data.";
+}
+
+def Paser_Sink
+  : Parser_Op< "sink" >
+  , Arguments< (ins Variadic<Parser_MaybeDataType>:$arguments) >
+  , Results< (outs Variadic<Parser_NoDataType>:$result) >
+{
+  let summary = "Sink of parsed data.";
+}
+
+def Parser_Parse
+  : Parser_Op< "parse" >
+  , Arguments< (ins Variadic<Parser_MaybeDataType>:$arguments) >
+  , Results< (outs Variadic<AnyType>:$result) >
+{
+  let summary = "Parsing operation data.";
+}
+
+def Parse_NoParse
+  : Parser_Op< "noparse" >
+  , Arguments< (ins Variadic<Parser_NoDataType>:$arguments) >
+  , Results< (outs Variadic<Parser_NoDataType>:$result) >
+{
+  let summary = "Non-parsing operation data.";
+}
+
+#endif // VAST_DIALECT_PARSER_OPS

include/vast/Dialect/Parser/Parser.td

@@ -0,0 +1,38 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#ifndef VAST_DIALECT_PARSER
+#define VAST_DIALECT_PARSER
+
+include "mlir/IR/OpBase.td"
+include "mlir/IR/OpAsmInterface.td"
+include "mlir/IR/SymbolInterfaces.td"
+include "mlir/Interfaces/SideEffectInterfaces.td"
+include "mlir/Interfaces/InferTypeOpInterface.td"
+include "mlir/IR/BuiltinAttributeInterfaces.td"
+
+def Parser_Dialect : Dialect {
+  let name = "pr";
+  let cppNamespace = "::vast::pr";
+
+  let summary = "Dialect for abstracting parsering logic.";
+
+  let description = [{
+    Dialect for abstracting parsering logic.
+
+    The goal of the dialect is to abstract the parsering logic
+    for easier uniform parser recognition.
+  }];
+
+  let extraClassDeclaration = [{
+    void registerTypes();
+  }];
+
+  let useDefaultTypePrinterParser = 1;
+
+  let hasConstantMaterializer = 1;
+}
+
+include "vast/Dialect/Parser/Ops.td"
+include "vast/Dialect/Parser/Types.td"
+
+#endif // VAST_DIALECT_PARSER

include/vast/Dialect/Parser/Types.hpp

@@ -0,0 +1,8 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#pragma once
+
+#include "vast/Dialect/Parser/Dialect.hpp"
+
+#define GET_TYPEDEF_CLASSES
+#include "vast/Dialect/Parser/ParserTypes.h.inc"

include/vast/Dialect/Parser/Types.td

@@ -0,0 +1,31 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#ifndef VAST_DIALECT_PARSER_TYPES
+#define VAST_DIALECT_PARSER_TYPES
+
+class Parser_Type< string name, string _mnemonic, list<Trait> traits = [] >
+    : TypeDef< Parser_Dialect, name, traits >
+{
+    let mnemonic = _mnemonic;
+}
+
+def Parser_DataType : Parser_Type< "Data", "data" > {
+    let summary = "Data type.";
+}
+
+def Parser_NoDataType : Parser_Type< "NoData", "nodata" > {
+    let summary = "No data type.";
+}
+
+def Parser_AnyDataType : Parser_Type< "AnyData", "anydata" > {
+    let summary = "Any data type.";
+}
+
+def Parser_MaybeDataType : Type<
+    Or< [
+        Parser_DataType.predicate,
+        Parser_AnyDataType.predicate
+    ]>
+>;
+
+#endif // VAST_DIALECT_PARSER_TYPES

lib/vast/Dialect/CMakeLists.txt

@@ -6,4 +6,5 @@ add_subdirectory(Core)
 add_subdirectory(HighLevel)
 add_subdirectory(LowLevel)
 add_subdirectory(Meta)
+add_subdirectory(Parser)
 add_subdirectory(Unsupported)

lib/vast/Dialect/Parser/CMakeLists.txt

@@ -0,0 +1,7 @@
+# Copyright (c) 2024, Trail of Bits, Inc.
+
+add_vast_dialect_library(Parser
+    Dialect.cpp
+    Ops.cpp
+    Types.cpp
+)

lib/vast/Dialect/Parser/Dialect.cpp

@@ -0,0 +1,30 @@
+// Copyright (c) 2024-present, Trail of Bits, Inc.
+//
+#include "vast/Dialect/Parser/Dialect.hpp"
+#include "vast/Dialect/Parser/Ops.hpp"
+
+#include <mlir/IR/Builders.h>
+#include <mlir/IR/DialectImplementation.h>
+#include <mlir/IR/DialectInterface.h>
+#include <mlir/IR/OpImplementation.h>
+#include <mlir/IR/TypeSupport.h>
+
+namespace vast::pr {
+    using OpBuilder = mlir::OpBuilder;
+
+    void ParserDialect::initialize() {
+        addOperations<
+            #define GET_OP_LIST
+            #include "vast/Dialect/Parser/Parser.cpp.inc"
+        >();
+    }
+
+    Operation *ParserDialect::materializeConstant(
+        OpBuilder &builder, Attribute value, Type type, Location loc
+    ) {
+        VAST_UNIMPLEMENTED;
+    }
+
+} // namespace vast::pr
+
+#include "vast/Dialect/Parser/ParserDialect.cpp.inc"

lib/vast/Dialect/Parser/Ops.cpp

@@ -0,0 +1,27 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#include "vast/Util/Warnings.hpp"
+
+VAST_RELAX_WARNINGS
+#include <mlir/IR/Builders.h>
+#include <mlir/IR/OpImplementation.h>
+#include <mlir/IR/OperationSupport.h>
+#include <mlir/IR/SymbolTable.h>
+
+#include <mlir/Interfaces/FunctionImplementation.h>
+#include <mlir/Interfaces/CallInterfaces.h>
+
+#include <mlir/Support/LLVM.h>
+#include <mlir/Support/LogicalResult.h>
+
+#include <llvm/Support/ErrorHandling.h>
+VAST_UNRELAX_WARNINGS
+
+#include "vast/Dialect/Parser/Dialect.hpp"
+#include "vast/Dialect/Parser/Ops.hpp"
+#include "vast/Dialect/Parser/Types.hpp"
+
+using namespace vast::pr;
+
+#define GET_OP_CLASSES
+#include "vast/Dialect/Parser/Parser.cpp.inc"

lib/vast/Dialect/Parser/Types.cpp

@@ -0,0 +1,28 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#include "vast/Util/Warnings.hpp"
+
+VAST_RELAX_WARNINGS
+#include <llvm/ADT/TypeSwitch.h>
+#include <mlir/IR/OpImplementation.h>
+#include <mlir/IR/DialectImplementation.h>
+VAST_RELAX_WARNINGS
+
+#include "vast/Dialect/Parser/Dialect.hpp"
+#include "vast/Dialect/Parser/Types.hpp"
+
+#include "vast/Util/Common.hpp"
+
+namespace vast::pr {
+
+    void ParserDialect::registerTypes() {
+        addTypes<
+            #define GET_TYPEDEF_LIST
+            #include "vast/Dialect/Parser/ParserTypes.cpp.inc"
+        >();
+    }
+
+} // namespace vast::pr
+
+#define  GET_TYPEDEF_CLASSES
+#include "vast/Dialect/Parser/ParserTypes.cpp.inc"