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 [![Build Status](https://travis-ci.org/KhronosGroup/glslang.svg?branch=master)](https://travis-ci.org/KhronosGroup/glslang)
  12 [![Build status](https://ci.appveyor.com/api/projects/status/q6fi9cb0qnhkla68/branch/master?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/glslang/branch/master)
  13
  14 An OpenGL and OpenGL ES shader front end and validator.
  15
  16 There are several components:
  17
  18 1. A GLSL/ESSL front-end for reference validation and translation of GLSL/ESSL into an AST.
  19
  20 2. An HLSL front-end for translation of a broad generic HLL into the AST. See [issue 362](https://github.com/KhronosGroup/glslang/issues/362) and [issue 701](https://github.com/KhronosGroup/glslang/issues/701) for current status.
  21
  22 3. A SPIR-V back end for translating the AST to SPIR-V.
  23
  24 4. A standalone wrapper, `glslangValidator`, that can be used as a command-line tool for the above.
  25
  26 How to add a feature protected by a version/extension/stage/profile:  See the
  27 comment in `glslang/MachineIndependent/Versions.cpp`.
  28
  29 Tasks waiting to be done are documented as GitHub issues.
  30
  31 Deprecations
  32 ------------
  33
  34 1. GLSLang, when installed through CMake, will install a `SPIRV` folder into
  35 `${CMAKE_INSTALL_INCLUDEDIR}`. This `SPIRV` folder is being moved to
  36 `glslang/SPIRV`. During the transition the `SPIRV` folder will be installed into
  37 both locations. The old install of `SPIRV/` will be removed as a CMake install
  38 target no sooner then May 1, 2020. See issue #1964.
  39
  40 Execution of Standalone Wrapper
  41 -------------------------------
  42
  43 To use the standalone binary form, execute `glslangValidator`, and it will print
  44 a usage statement.  Basic operation is to give it a file containing a shader,
  45 and it will print out warnings/errors and optionally an AST.
  46
  47 The applied stage-specific rules are based on the file extension:
  48 * `.vert` for a vertex shader
  49 * `.tesc` for a tessellation control shader
  50 * `.tese` for a tessellation evaluation shader
  51 * `.geom` for a geometry shader
  52 * `.frag` for a fragment shader
  53 * `.comp` for a compute shader
  54
  55 There is also a non-shader extension
  56 * `.conf` for a configuration file of limits, see usage statement for example
  57
  58 Building
  59 --------
  60
  61 Instead of building manually, you can also download the binaries for your
  62 platform directly from the [master-tot release][master-tot-release] on GitHub.
  63 Those binaries are automatically uploaded by the buildbots after successful
  64 testing and they always reflect the current top of the tree of the master
  65 branch.
  66
  67 ### Dependencies
  68
  69 * A C++11 compiler.
  70   (For MSVS: 2015 is recommended, 2013 is fully supported/tested, and 2010 support is attempted, but not tested.)
  71 * [CMake][cmake]: for generating compilation targets.
  72 * make: _Linux_, ninja is an alternative, if configured.
  73 * [Python 3.x][python]: for executing SPIRV-Tools scripts. (Optional if not using SPIRV-Tools and the 'External' subdirectory does not exist.)
  74 * [bison][bison]: _optional_, but needed when changing the grammar (glslang.y).
  75 * [googletest][googletest]: _optional_, but should use if making any changes to glslang.
  76
  77 ### Build steps
  78
  79 The following steps assume a Bash shell. On Windows, that could be the Git Bash
  80 shell or some other shell of your choosing.
  81
  82 #### 1) Check-Out this project
  83
  84 ```bash
  85 cd <parent of where you want glslang to be>
  86 git clone https://github.com/KhronosGroup/glslang.git
  87 ```
  88
  89 #### 2) Check-Out External Projects
  90
  91 ```bash
  92 cd <the directory glslang was cloned to, "External" will be a subdirectory>
  93 git clone https://github.com/google/googletest.git External/googletest
  94 ```
  95
  96 If you want to use googletest with Visual Studio 2013, you also need to check out an older version:
  97
  98 ```bash
  99 # to use googletest with Visual Studio 2013
 100 cd External/googletest
 101 git checkout 440527a61e1c91188195f7de212c63c77e8f0a45
 102 cd ../..
 103 ```
 104
 105 If you wish to assure that SPIR-V generated from HLSL is legal for Vulkan,
 106 or wish to invoke -Os to reduce SPIR-V size from HLSL or GLSL, install
 107 spirv-tools with this:
 108
 109 ```bash
 110 ./update_glslang_sources.py
 111 ```
 112
 113 #### 3) Configure
 114
 115 Assume the source directory is `$SOURCE_DIR` and the build directory is
 116 `$BUILD_DIR`. First ensure the build directory exists, then navigate to it:
 117
 118 ```bash
 119 mkdir -p $BUILD_DIR
 120 cd $BUILD_DIR
 121 ```
 122
 123 For building on Linux:
 124
 125 ```bash
 126 cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="$(pwd)/install" $SOURCE_DIR
 127 # "Release" (for CMAKE_BUILD_TYPE) could also be "Debug" or "RelWithDebInfo"
 128 ```
 129
 130 For building on Windows:
 131
 132 ```bash
 133 cmake $SOURCE_DIR -DCMAKE_INSTALL_PREFIX="$(pwd)/install"
 134 # The CMAKE_INSTALL_PREFIX part is for testing (explained later).
 135 ```
 136
 137 The CMake GUI also works for Windows (version 3.4.1 tested).
 138
 139 Also, consider using `git config --global core.fileMode false` (or with `--local`) on Windows
 140 to prevent the addition of execution permission on files.
 141
 142 #### 4) Build and Install
 143
 144 ```bash
 145 # for Linux:
 146 make -j4 install
 147
 148 # for Windows:
 149 cmake --build . --config Release --target install
 150 # "Release" (for --config) could also be "Debug", "MinSizeRel", or "RelWithDebInfo"
 151 ```
 152
 153 If using MSVC, after running CMake to configure, use the
 154 Configuration Manager to check the `INSTALL` project.
 155
 156 ### If you need to change the GLSL grammar
 157
 158 The grammar in `glslang/MachineIndependent/glslang.y` has to be recompiled with
 159 bison if it changes, the output files are committed to the repo to avoid every
 160 developer needing to have bison configured to compile the project when grammar
 161 changes are quite infrequent. For windows you can get binaries from
 162 [GnuWin32][bison-gnu-win32].
 163
 164 The command to rebuild is:
 165
 166 ```bash
 167 m4 -P MachineIndependent/glslang.m4 > MachineIndependent/glslang.y
 168 bison --defines=MachineIndependent/glslang_tab.cpp.h
 169       -t MachineIndependent/glslang.y
 170       -o MachineIndependent/glslang_tab.cpp
 171 ```
 172
 173 The above commands are also available in the bash script in `updateGrammar`,
 174 when executed from the glslang subdirectory of the glslang repository.
 175 With no arguments it builds the full grammar, and with a "web" argument,
 176 the web grammar subset (see more about the web subset in the next section).
 177
 178 ### Building to WASM for the Web and Node
 179
 180 Use the steps in [Build Steps](#build-steps), with the following notes/exceptions:
 181 * For building the web subset of core glslang:
 182   + execute `updateGrammar web` from the glslang subdirectory
 183     (or if using your own scripts, `m4` needs a `-DGLSLANG_WEB` argument)
 184   + set `-DENABLE_HLSL=OFF -DBUILD_TESTING=OFF -DENABLE_OPT=OFF -DINSTALL_GTEST=OFF`
 185   + turn on `-DENABLE_GLSLANG_WEB=ON`
 186   + optionally, for GLSL compilation error messages, turn on `-DENABLE_GLSLANG_WEB_DEVEL=ON`
 187 * `emsdk` needs to be present in your executable search path, *PATH* for
 188   Bash-like enivironments
 189   + [Instructions located
 190     here](https://emscripten.org/docs/getting_started/downloads.html#sdk-download-and-install)
 191 * Wrap cmake call: `emcmake cmake`
 192 * To get a fully minimized build, make sure to use `brotli` to compress the .js
 193   and .wasm files
 194
 195 Example:
 196
 197 ```sh
 198 emcmake cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_GLSLANG_WEB=ON \
 199     -DENABLE_HLSL=OFF -DBUILD_TESTING=OFF -DENABLE_OPT=OFF -DINSTALL_GTEST=OFF ..
 200 ```
 201
 202 Testing
 203 -------
 204
 205 Right now, there are two test harnesses existing in glslang: one is [Google
 206 Test](gtests/), one is the [`runtests` script](Test/runtests). The former
 207 runs unit tests and single-shader single-threaded integration tests, while
 208 the latter runs multiple-shader linking tests and multi-threaded tests.
 209
 210 ### Running tests
 211
 212 The [`runtests` script](Test/runtests) requires compiled binaries to be
 213 installed into `$BUILD_DIR/install`. Please make sure you have supplied the
 214 correct configuration to CMake (using `-DCMAKE_INSTALL_PREFIX`) when building;
 215 otherwise, you may want to modify the path in the `runtests` script.
 216
 217 Running Google Test-backed tests:
 218
 219 ```bash
 220 cd $BUILD_DIR
 221
 222 # for Linux:
 223 ctest
 224
 225 # for Windows:
 226 ctest -C {Debug|Release|RelWithDebInfo|MinSizeRel}
 227
 228 # or, run the test binary directly
 229 # (which gives more fine-grained control like filtering):
 230 <dir-to-glslangtests-in-build-dir>/glslangtests
 231 ```
 232
 233 Running `runtests` script-backed tests:
 234
 235 ```bash
 236 cd $SOURCE_DIR/Test && ./runtests
 237 ```
 238
 239 ### Contributing tests
 240
 241 Test results should always be included with a pull request that modifies
 242 functionality.
 243
 244 If you are writing unit tests, please use the Google Test framework and
 245 place the tests under the `gtests/` directory.
 246
 247 Integration tests are placed in the `Test/` directory. It contains test input
 248 and a subdirectory `baseResults/` that contains the expected results of the
 249 tests.  Both the tests and `baseResults/` are under source-code control.
 250
 251 Google Test runs those integration tests by reading the test input, compiling
 252 them, and then compare against the expected results in `baseResults/`. The
 253 integration tests to run via Google Test is registered in various
 254 `gtests/*.FromFile.cpp` source files. `glslangtests` provides a command-line
 255 option `--update-mode`, which, if supplied, will overwrite the golden files
 256 under the `baseResults/` directory with real output from that invocation.
 257 For more information, please check `gtests/` directory's
 258 [README](gtests/README.md).
 259
 260 For the `runtests` script, it will generate current results in the
 261 `localResults/` directory and `diff` them against the `baseResults/`.
 262 When you want to update the tracked test results, they need to be
 263 copied from `localResults/` to `baseResults/`.  This can be done by
 264 the `bump` shell script.
 265
 266 You can add your own private list of tests, not tracked publicly, by using
 267 `localtestlist` to list non-tracked tests.  This is automatically read
 268 by `runtests` and included in the `diff` and `bump` process.
 269
 270 Programmatic Interfaces
 271 -----------------------
 272
 273 Another piece of software can programmatically translate shaders to an AST
 274 using one of two different interfaces:
 275 * A new C++ class-oriented interface, or
 276 * The original C functional interface
 277
 278 The `main()` in `StandAlone/StandAlone.cpp` shows examples using both styles.
 279
 280 ### C++ Class Interface (new, preferred)
 281
 282 This interface is in roughly the last 1/3 of `ShaderLang.h`.  It is in the
 283 glslang namespace and contains the following, here with suggested calls
 284 for generating SPIR-V:
 285
 286 ```cxx
 287 const char* GetEsslVersionString();
 288 const char* GetGlslVersionString();
 289 bool InitializeProcess();
 290 void FinalizeProcess();
 291
 292 class TShader
 293     setStrings(...);
 294     setEnvInput(EShSourceHlsl or EShSourceGlsl, stage,  EShClientVulkan or EShClientOpenGL, 100);
 295     setEnvClient(EShClientVulkan or EShClientOpenGL, EShTargetVulkan_1_0 or EShTargetVulkan_1_1 or EShTargetOpenGL_450);
 296     setEnvTarget(EShTargetSpv, EShTargetSpv_1_0 or EShTargetSpv_1_3);
 297     bool parse(...);
 298     const char* getInfoLog();
 299
 300 class TProgram
 301     void addShader(...);
 302     bool link(...);
 303     const char* getInfoLog();
 304     Reflection queries
 305 ```
 306
 307 For just validating (not generating code), subsitute these calls:
 308
 309 ```cxx
 310     setEnvInput(EShSourceHlsl or EShSourceGlsl, stage,  EShClientNone, 0);
 311     setEnvClient(EShClientNone, 0);
 312     setEnvTarget(EShTargetNone, 0);
 313 ```
 314
 315 See `ShaderLang.h` and the usage of it in `StandAlone/StandAlone.cpp` for more
 316 details. There is a block comment giving more detail above the calls for
 317 `setEnvInput, setEnvClient, and setEnvTarget`.
 318
 319 ### C Functional Interface (original)
 320
 321 This interface is in roughly the first 2/3 of `ShaderLang.h`, and referred to
 322 as the `Sh*()` interface, as all the entry points start `Sh`.
 323
 324 The `Sh*()` interface takes a "compiler" call-back object, which it calls after
 325 building call back that is passed the AST and can then execute a backend on it.
 326
 327 The following is a simplified resulting run-time call stack:
 328
 329 ```c
 330 ShCompile(shader, compiler) -> compiler(AST) -> <back end>
 331 ```
 332
 333 In practice, `ShCompile()` takes shader strings, default version, and
 334 warning/error and other options for controlling compilation.
 335
 336 Basic Internal Operation
 337 ------------------------
 338
 339 * Initial lexical analysis is done by the preprocessor in
 340   `MachineIndependent/Preprocessor`, and then refined by a GLSL scanner
 341   in `MachineIndependent/Scan.cpp`.  There is currently no use of flex.
 342
 343 * Code is parsed using bison on `MachineIndependent/glslang.y` with the
 344   aid of a symbol table and an AST.  The symbol table is not passed on to
 345   the back-end; the intermediate representation stands on its own.
 346   The tree is built by the grammar productions, many of which are
 347   offloaded into `ParseHelper.cpp`, and by `Intermediate.cpp`.
 348
 349 * The intermediate representation is very high-level, and represented
 350   as an in-memory tree.   This serves to lose no information from the
 351   original program, and to have efficient transfer of the result from
 352   parsing to the back-end.  In the AST, constants are propogated and
 353   folded, and a very small amount of dead code is eliminated.
 354
 355   To aid linking and reflection, the last top-level branch in the AST
 356   lists all global symbols.
 357
 358 * The primary algorithm of the back-end compiler is to traverse the
 359   tree (high-level intermediate representation), and create an internal
 360   object code representation.  There is an example of how to do this
 361   in `MachineIndependent/intermOut.cpp`.
 362
 363 * Reduction of the tree to a linear byte-code style low-level intermediate
 364   representation is likely a good way to generate fully optimized code.
 365
 366 * There is currently some dead old-style linker-type code still lying around.
 367
 368 * Memory pool: parsing uses types derived from C++ `std` types, using a
 369   custom allocator that puts them in a memory pool.  This makes allocation
 370   of individual container/contents just few cycles and deallocation free.
 371   This pool is popped after the AST is made and processed.
 372
 373   The use is simple: if you are going to call `new`, there are three cases:
 374
 375   - the object comes from the pool (its base class has the macro
 376     `POOL_ALLOCATOR_NEW_DELETE` in it) and you do not have to call `delete`
 377
 378   - it is a `TString`, in which case call `NewPoolTString()`, which gets
 379     it from the pool, and there is no corresponding `delete`
 380
 381   - the object does not come from the pool, and you have to do normal
 382     C++ memory management of what you `new`
 383
 384
 385 [cmake]: https://cmake.org/
 386 [python]: https://www.python.org/
 387 [bison]: https://www.gnu.org/software/bison/
 388 [googletest]: https://github.com/google/googletest
 389 [bison-gnu-win32]: http://gnuwin32.sourceforge.net/packages/bison.htm
 390 [master-tot-release]: https://github.com/KhronosGroup/glslang/releases/tag/master-tot