README.md

   1 Also see the Khronos landing page for glslang as a reference front end:
   2
   3 https://www.khronos.org/opengles/sdk/tools/Reference-Compiler/
   4
   5 The above page includes where to get binaries, and is kept up to date
   6 regarding the feature level of glslang.
   7
   8 glslang
   9 =======
  10
  11 An OpenGL and OpenGL ES shader front end and validator.
  12
  13 There are two components:
  14
  15 1. A front-end library for programmatic parsing of GLSL/ESSL into an AST.
  16
  17 2. A standalone wrapper, `glslangValidator`, that can be used as a shader
  18    validation tool.
  19
  20 How to add a feature protected by a version/extension/stage/profile:  See the
  21 comment in `glslang/MachineIndependent/Versions.cpp`.
  22
  23 Things left to do:  See `Todo.txt`
  24
  25 Execution of Standalone Wrapper
  26 -------------------------------
  27
  28 To use the standalone binary form, execute `glslangValidator`, and it will print
  29 a usage statement.  Basic operation is to give it a file containing a shader,
  30 and it will print out warnings/errors and optionally an AST.
  31
  32 The applied stage-specific rules are based on the file extension:
  33 * `.vert` for a vertex shader
  34 * `.tesc` for a tessellation control shader
  35 * `.tese` for a tessellation evaluation shader
  36 * `.geom` for a geometry shader
  37 * `.frag` for a fragment shader
  38 * `.comp` for a compute shader
  39
  40 There is also a non-shader extension
  41 * `.conf` for a configuration file of limits, see usage statement for example
  42
  43 Building
  44 --------
  45
  46 CMake: The currently maintained and preferred way of building is through CMake.
  47 In MSVC, after running CMake, you may need to use the Configuration Manager to
  48 check the INSTALL project.
  49
  50 Programmatic Interfaces
  51 -----------------------
  52
  53 Another piece of software can programmatically translate shaders to an AST
  54 using one of two different interfaces:
  55 * A new C++ class-oriented interface, or
  56 * The original C functional interface
  57
  58 The `main()` in `StandAlone/StandAlone.cpp` shows examples using both styles.
  59
  60 ### C++ Class Interface (new, preferred)
  61
  62 This interface is in roughly the last 1/3 of `ShaderLang.h`.  It is in the
  63 glslang namespace and contains the following.
  64
  65 ```cxx
  66 const char* GetEsslVersionString();
  67 const char* GetGlslVersionString();
  68 bool InitializeProcess();
  69 void FinalizeProcess();
  70
  71 class TShader
  72     bool parse(...);
  73     void setStrings(...);
  74     const char* getInfoLog();
  75
  76 class TProgram
  77     void addShader(...);
  78     bool link(...);
  79     const char* getInfoLog();
  80     Reflection queries
  81 ```
  82
  83 See `ShaderLang.h` and the usage of it in `StandAlone/StandAlone.cpp` for more
  84 details.
  85
  86 ### C Functional Interface (orginal)
  87
  88 This interface is in roughly the first 2/3 of `ShaderLang.h`, and referred to
  89 as the `Sh*()` interface, as all the entry points start `Sh`.
  90
  91 The `Sh*()` interface takes a "compiler" call-back object, which it calls after
  92 building call back that is passed the AST and can then execute a backend on it.
  93
  94 The following is a simplified resulting run-time call stack:
  95
  96 ```c
  97 ShCompile(shader, compiler) -> compiler(AST) -> <back end>
  98 ```
  99
 100 In practice, `ShCompile()` takes shader strings, default version, and
 101 warning/error and other options for controling compilation.
 102
 103 Testing
 104 -------
 105
 106 Test results should always be included with a pull request that modifies
 107 functionality. There is a simple process for doing this, described here:
 108
 109 `Test` is an active test directory that contains test input and a
 110 subdirectory `baseResults` that contains the expected results of the
 111 tests.  Both the tests and `baseResults` are under source-code control.
 112 Executing the script `./runtests` will generate current results in
 113 the `localResults` directory and `diff` them against the `baseResults`.
 114
 115 When you want to update the tracked test results, they need to be
 116 copied from `localResults` to `baseResults`.  This can be done by
 117 the `bump` shell script.
 118
 119 The list of files tested comes from `testlist`, and lists input shaders
 120 in this directory, which must all be public for this to work.  However,
 121 you can add your own private list of tests, not tracked here, by using
 122 `localtestlist` to list non-tracked tests.  This is automatically read
 123 by `runtests` and included in the `diff` and `bump` process.
 124
 125 Basic Internal Operation
 126 ------------------------
 127
 128 * Initial lexical analysis is done by the preprocessor in
 129   `MachineIndependent/Preprocessor`, and then refined by a GLSL scanner
 130   in `MachineIndependent/Scan.cpp`.  There is currently no use of flex.
 131
 132 * Code is parsed using bison on `MachineIndependent/glslang.y` with the
 133   aid of a symbol table and an AST.  The symbol table is not passed on to
 134   the back-end; the intermediate representation stands on its own.
 135   The tree is built by the grammar productions, many of which are
 136   offloaded into `ParseHelper.cpp`, and by `Intermediate.cpp`.
 137
 138 * The intermediate representation is very high-level, and represented
 139   as an in-memory tree.   This serves to lose no information from the
 140   original program, and to have efficient transfer of the result from
 141   parsing to the back-end.  In the AST, constants are propogated and
 142   folded, and a very small amount of dead code is eliminated.
 143
 144   To aid linking and reflection, the last top-level branch in the AST
 145   lists all global symbols.
 146
 147 * The primary algorithm of the back-end compiler is to traverse the
 148   tree (high-level intermediate representation), and create an internal
 149   object code representation.  There is an example of how to do this
 150   in `MachineIndependent/intermOut.cpp`.
 151
 152 * Reduction of the tree to a linear byte-code style low-level intermediate
 153   representation is likely a good way to generate fully optimized code.
 154
 155 * There is currently some dead old-style linker-type code still lying around.
 156
 157 * Memory pool: parsing uses types derived from C++ `std` types, using a
 158   custom allocator that puts them in a memory pool.  This makes allocation
 159   of individual container/contents just few cycles and deallocation free.
 160   This pool is popped after the AST is made and processed.
 161
 162   The use is simple: if you are going to call `new`, there are three cases:
 163
 164   - the object comes from the pool (its base class has the macro
 165     `POOL_ALLOCATOR_NEW_DELETE` in it) and you do not have to call `delete`
 166
 167   - it is a `TString`, in which case call `NewPoolTString()`, which gets
 168     it from the pool, and there is no corresponding `delete`
 169
 170   - the object does not come from the pool, and you have to do normal
 171     C++ memory management of what you `new`