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 The grammar in glslang/MachineIndependent/glslang.y has to be recompiled with
  51 bison if it changes, the output files are committed to the repo to avoid every
  52 developer needing to have bison configured to compile the project when grammar
  53 changes are quite infrequent. For windows you can get binaries from
  54 [GnuWin32](http://gnuwin32.sourceforge.net/packages/bison.htm).
  55
  56 The command to rebuild is:
  57
  58 ```
  59 bison --defines=MachineIndependent/glslang_tab.cpp.h
  60       -t MachineIndependent/glslang.y
  61       -o MachineIndependent/glslang_tab.cpp
  62 ```
  63
  64 Programmatic Interfaces
  65 -----------------------
  66
  67 Another piece of software can programmatically translate shaders to an AST
  68 using one of two different interfaces:
  69 * A new C++ class-oriented interface, or
  70 * The original C functional interface
  71
  72 The `main()` in `StandAlone/StandAlone.cpp` shows examples using both styles.
  73
  74 ### C++ Class Interface (new, preferred)
  75
  76 This interface is in roughly the last 1/3 of `ShaderLang.h`.  It is in the
  77 glslang namespace and contains the following.
  78
  79 ```cxx
  80 const char* GetEsslVersionString();
  81 const char* GetGlslVersionString();
  82 bool InitializeProcess();
  83 void FinalizeProcess();
  84
  85 class TShader
  86     bool parse(...);
  87     void setStrings(...);
  88     const char* getInfoLog();
  89
  90 class TProgram
  91     void addShader(...);
  92     bool link(...);
  93     const char* getInfoLog();
  94     Reflection queries
  95 ```
  96
  97 See `ShaderLang.h` and the usage of it in `StandAlone/StandAlone.cpp` for more
  98 details.
  99
 100 ### C Functional Interface (orginal)
 101
 102 This interface is in roughly the first 2/3 of `ShaderLang.h`, and referred to
 103 as the `Sh*()` interface, as all the entry points start `Sh`.
 104
 105 The `Sh*()` interface takes a "compiler" call-back object, which it calls after
 106 building call back that is passed the AST and can then execute a backend on it.
 107
 108 The following is a simplified resulting run-time call stack:
 109
 110 ```c
 111 ShCompile(shader, compiler) -> compiler(AST) -> <back end>
 112 ```
 113
 114 In practice, `ShCompile()` takes shader strings, default version, and
 115 warning/error and other options for controling compilation.
 116
 117 Testing
 118 -------
 119
 120 Test results should always be included with a pull request that modifies
 121 functionality. There is a simple process for doing this, described here:
 122
 123 `Test` is an active test directory that contains test input and a
 124 subdirectory `baseResults` that contains the expected results of the
 125 tests.  Both the tests and `baseResults` are under source-code control.
 126 Executing the script `./runtests` will generate current results in
 127 the `localResults` directory and `diff` them against the `baseResults`.
 128
 129 When you want to update the tracked test results, they need to be
 130 copied from `localResults` to `baseResults`.  This can be done by
 131 the `bump` shell script.
 132
 133 The list of files tested comes from `testlist`, and lists input shaders
 134 in this directory, which must all be public for this to work.  However,
 135 you can add your own private list of tests, not tracked here, by using
 136 `localtestlist` to list non-tracked tests.  This is automatically read
 137 by `runtests` and included in the `diff` and `bump` process.
 138
 139 Basic Internal Operation
 140 ------------------------
 141
 142 * Initial lexical analysis is done by the preprocessor in
 143   `MachineIndependent/Preprocessor`, and then refined by a GLSL scanner
 144   in `MachineIndependent/Scan.cpp`.  There is currently no use of flex.
 145
 146 * Code is parsed using bison on `MachineIndependent/glslang.y` with the
 147   aid of a symbol table and an AST.  The symbol table is not passed on to
 148   the back-end; the intermediate representation stands on its own.
 149   The tree is built by the grammar productions, many of which are
 150   offloaded into `ParseHelper.cpp`, and by `Intermediate.cpp`.
 151
 152 * The intermediate representation is very high-level, and represented
 153   as an in-memory tree.   This serves to lose no information from the
 154   original program, and to have efficient transfer of the result from
 155   parsing to the back-end.  In the AST, constants are propogated and
 156   folded, and a very small amount of dead code is eliminated.
 157
 158   To aid linking and reflection, the last top-level branch in the AST
 159   lists all global symbols.
 160
 161 * The primary algorithm of the back-end compiler is to traverse the
 162   tree (high-level intermediate representation), and create an internal
 163   object code representation.  There is an example of how to do this
 164   in `MachineIndependent/intermOut.cpp`.
 165
 166 * Reduction of the tree to a linear byte-code style low-level intermediate
 167   representation is likely a good way to generate fully optimized code.
 168
 169 * There is currently some dead old-style linker-type code still lying around.
 170
 171 * Memory pool: parsing uses types derived from C++ `std` types, using a
 172   custom allocator that puts them in a memory pool.  This makes allocation
 173   of individual container/contents just few cycles and deallocation free.
 174   This pool is popped after the AST is made and processed.
 175
 176   The use is simple: if you are going to call `new`, there are three cases:
 177
 178   - the object comes from the pool (its base class has the macro
 179     `POOL_ALLOCATOR_NEW_DELETE` in it) and you do not have to call `delete`
 180
 181   - it is a `TString`, in which case call `NewPoolTString()`, which gets
 182     it from the pool, and there is no corresponding `delete`
 183
 184   - the object does not come from the pool, and you have to do normal
 185     C++ memory management of what you `new`