No description
Find a file
Lioncash 326c69896b stream: Get rid of undefined behavior
It's undefined behavior to cast down to any other type and dereference
that pointer unless:

1. It's similar (*extremely* vague definition at face value, see below
   for clarification)

2. The casted to type is either the signed/unsigned variant of the
   original type. (e.g. it's fine to cast an int* to an unsigned int*
   and vice-versa).

3. The casted to pointer type is either std::byte*, char*, or unsigned
   char*.

With regards to type similarity, two types (X and Y) are considered
"similar" if:

1. They're the same type (naturally)

2. They're both pointers and the pointed-to types are similar (basically
   1. but for pointers)

3. They're both pointers to members of the same class and the types of
   the pointed-to members are similar in type.

4. They're both arrays of the same size or both arrays of unknown size
   *and* the array element types are similar.

Plus, doing it this way doesn't do a byte-by-byte appending to the
underlying std::vector and instead allocates all the necessary memory up
front and slaps the elements at the end of it.
2019-03-14 21:44:37 -03:00
externals aloha 2018-08-23 04:59:57 -03:00
include/sirit CMakeLists: Apply compilation flags to the sirit target 2019-03-14 19:30:54 -03:00
src stream: Get rid of undefined behavior 2019-03-14 21:44:37 -03:00
tests tests: Fix build error 2019-03-14 04:33:54 -03:00
.clang-format Change clang-format settings 2019-03-11 03:26:21 -03:00
.gitignore aloha 2018-08-23 04:59:57 -03:00
.gitmodules aloha 2018-08-23 04:59:57 -03:00
CMakeLists.txt Avoid CMake SPIR-V module dependencies 2018-11-16 03:59:28 -03:00
LICENSE.txt Upgrade from LGPLv2.1 to LGPLv3 2018-11-16 04:10:10 -03:00
README.md Remove Op prefix on Type instructions 2019-03-13 18:32:38 -03:00

Sirit

A runtime SPIR-V assembler. It aims to ease dynamic SPIR-V code generation without calling external applications (like Khronos' spirv-as)

Its design aims to move code that does not belong to the application in the library without, limitting its functionality.

What it does for you:

  • Sort declaration opcodes
  • Handle types and constant duplicates
  • Emit SPIR-V opcodes

What does not do for you:

  • Avoid ID duplicates (emitting the same instruction twice)
  • Dump code to disk
  • Handle code blocks/branches
  • Compile from a higher level language

It's in early stages of development, many instructions are missing since they are written manually instead of being generated from a file.

Example

class MyModule : public Sirit::Module {
public:
    MyModule() {}
    ~MyModule() = default;

    void Generate() {
        AddCapability(spv::Capability::Shader);
        SetMemoryModel(spv::AddressingModel::Logical, spv::MemoryModel::GLSL450);
        
        auto main_type{TypeFunction(TypeVoid())};
        auto main_func{Emit(OpFunction(TypeVoid(), spv::FunctionControlMask::MaskNone, main_type))};
        Emit(OpLabel());
        Emit(OpReturn());
        Emit(OpFunctionEnd());

        AddEntryPoint(spv::ExecutionModel::Vertex, main_func, "main");
    }
};

// Then...

MyModule module;
module.Generate();

std::vector<std::uint8_t> code{module.Assemble()};