lld/docs/WebAssembly.rst

   1 WebAssembly lld port
   2 ====================
   3
   4 The WebAssembly version of lld takes WebAssembly binaries as inputs and produces
   5 a WebAssembly binary as its output.  For the most part it tries to mimic the
   6 behaviour of traditional ELF linkers and specifically the ELF lld port.  Where
   7 possible the command line flags and the semantics should be the same.
   8
   9
  10 Object file format
  11 ------------------
  12
  13 The WebAssembly object file format used by LLVM and LLD is specified as part of
  14 the WebAssembly tool conventions on linking_.
  15
  16 This is the object format that the llvm will produce when run with the
  17 ``wasm32-unknown-unknown`` target.
  18
  19 Usage
  20 -----
  21
  22 The WebAssembly version of lld is installed as **wasm-ld**.  It shared many
  23 common linker flags with **ld.lld** but also includes several
  24 WebAssembly-specific options:
  25
  26 .. option:: --no-entry
  27
  28   Don't search for the entry point symbol (by default ``_start``).
  29
  30 .. option:: --export-table
  31
  32   Export the function table to the environment.
  33
  34 .. option:: --import-table
  35
  36   Import the function table from the environment.
  37
  38 .. option:: --export-all
  39
  40   Export all symbols (normally combined with --no-gc-sections)
  41
  42   Note that this will not export linker-generated mutable globals unless
  43   the resulting binaryen already includes the 'mutable-globals' features
  44   since that would otherwise create and invalid binaryen.
  45
  46 .. option:: --export-dynamic
  47
  48   When building an executable, export any non-hidden symbols.  By default only
  49   the entry point and any symbols marked as exports (either via the command line
  50   or via the `export-name` source attribute) are exported.
  51
  52 .. option:: --global-base=<value>
  53
  54   Address at which to place global data.
  55
  56 .. option:: --no-merge-data-segments
  57
  58   Disable merging of data segments.
  59
  60 .. option:: --stack-first
  61
  62   Place stack at start of linear memory rather than after data.
  63
  64 .. option:: --compress-relocations
  65
  66   Relocation targets in the code section are 5-bytes wide in order to
  67   potentially accommodate the largest LEB128 value.  This option will cause the
  68   linker to shrink the code section to remove any padding from the final
  69   output.  However because it affects code offset, this option is not
  70   compatible with outputting debug information.
  71
  72 .. option:: --allow-undefined
  73
  74   Allow undefined symbols in linked binary.  This is the legacy
  75   flag which corresponds to ``--unresolve-symbols=ignore`` +
  76   ``--import-undefined``.
  77
  78 .. option:: --allow-undefined-file=<filename>
  79
  80   Like ``--allow-undefined``, but the filename specified a flat list of
  81   symbols, one per line, which are allowed to be undefined.
  82
  83 .. option:: --unresolved-symbols=<method>
  84
  85   This is a more full featured version of ``--allow-undefined``.
  86   The semanatics of the different methods are as follows:
  87
  88   report-all:
  89
  90      Report all unresolved symbols.  This is the default.  Normally the linker
  91      will generate an error message for each reported unresolved symbol but the
  92      option ``--warn-unresolved-symbols`` can change this to a warning.
  93
  94   ignore-all:
  95
  96      Resolve all undefined symbols to zero.  For data and function addresses
  97      this is trivial.  For direct function calls, the linker will generate a
  98      trapping stub function in place of the undefined function.
  99
 100   import-dynamic:
 101
 102      Undefined symbols generate WebAssembly imports, including undefined data
 103      symbols.  This is somewhat similar to the --import-undefined option but
 104      works all symbol types.  This options puts limitations on the type of
 105      relocations that are allowed for imported data symbols.  Relocations that
 106      require absolute data addresses (i.e. All R_WASM_MEMORY_ADDR_I32) will
 107      generate an error if they cannot be resolved statically.  For clang/llvm
 108      this means inputs should be compiled with `-fPIC` (i.e. `pic` or
 109      `dynamic-no-pic` relocation models).  This options is useful for linking
 110      binaries that are themselves static (non-relocatable) but whose undefined
 111      symbols are resolved by a dynamic linker.  Since the dynamic linking API is
 112      experimental, this option currently requires `--experimental-pic` to also
 113      be specified.
 114
 115 .. option:: --import-memory
 116
 117   Import memory from the environment.
 118
 119 .. option:: --import-undefined
 120
 121    Generate WebAssembly imports for undefined symbols, where possible.  For
 122    example, for function symbols this is always possible, but in general this
 123    is not possible for undefined data symbols.  Undefined data symbols will
 124    still be reported as normal (in accordance with ``--unresolved-symbols``).
 125
 126 .. option:: --initial-memory=<value>
 127
 128   Initial size of the linear memory. Default: static data size.
 129
 130 .. option:: --max-memory=<value>
 131
 132   Maximum size of the linear memory. Default: unlimited.
 133
 134 By default the function table is neither imported nor exported, but defined
 135 for internal use only.
 136
 137 Behaviour
 138 ---------
 139
 140 In general, where possible, the WebAssembly linker attempts to emulate the
 141 behaviour of a traditional ELF linker, and in particular the ELF port of lld.
 142 For more specific details on how this is achieved see the tool conventions on
 143 linking_.
 144
 145 Function Signatures
 146 ~~~~~~~~~~~~~~~~~~~
 147
 148 One way in which the WebAssembly linker differs from traditional native linkers
 149 is that function signature checking is strict in WebAssembly.  It is a
 150 validation error for a module to contain a call site that doesn't agree with
 151 the target signature.  Even though this is undefined behaviour in C/C++, it is not
 152 uncommon to find this in real-world C/C++ programs.  For example, a call site in
 153 one compilation unit which calls a function defined in another compilation
 154 unit but with too many arguments.
 155
 156 In order not to generate such invalid modules, lld has two modes of handling such
 157 mismatches: it can simply error-out or it can create stub functions that will
 158 trap at runtime (functions that contain only an ``unreachable`` instruction)
 159 and use these stub functions at the otherwise invalid call sites.
 160
 161 The default behaviour is to generate these stub function and to produce
 162 a warning.  The ``--fatal-warnings`` flag can be used to disable this behaviour
 163 and error out if mismatched are found.
 164
 165 Exports
 166 ~~~~~~~
 167
 168 When building a shared library any symbols marked as ``visibility=default`` will
 169 be exported.
 170
 171 When building an executable, only the entry point (``_start``) and symbols with
 172 the ``WASM_SYMBOL_EXPORTED`` flag are exported by default.  In LLVM the
 173 ``WASM_SYMBOL_EXPORTED`` flag is set by the ``wasm-export-name`` attribute which
 174 in turn can be set using ``__attribute__((export_name))`` clang attribute.
 175
 176 In addition, symbols can be exported via the linker command line using
 177 ``--export`` (which will error if the symbol is not found) or
 178 ``--export-if-defined`` (which will not).
 179
 180 Finally, just like with native ELF linker the ``--export-dynamic`` flag can be
 181 used to export symbols in the executable which are marked as
 182 ``visibility=default``.
 183
 184 Imports
 185 ~~~~~~~
 186
 187 By default no undefined symbols are allowed in the final binary.  The flag
 188 ``--allow-undefined`` results in a WebAssembly import being defined for each
 189 undefined symbol.  It is then up to the runtime to provide such symbols.
 190 ``--allow-undefined-file`` is the same but allows a list of symbols to be
 191 specified.
 192
 193 Alternatively symbols can be marked in the source code as with the
 194 ``import_name`` and/or ``import_module`` clang attributes which signals that
 195 they are expected to be undefined at static link time.
 196
 197 Stub Libraries
 198 ~~~~~~~~~~~~~~
 199
 200 Another way to specify imports and exports is via a "stub library".  This
 201 feature is inspired by the ELF stub objects which are supported by the Solaris
 202 linker.  Stub libraries are text files that can be passed as normal linker
 203 inputs, similar to how linker scripts can be passed to the ELF linker.  The stub
 204 library is a stand-in for a set of symbols that will be available at runtime,
 205 but doesn't contain any actual code or data.  Instead it contains just a list of
 206 symbols, one per line.  Each symbol can specify zero or more dependencies.
 207 These dependencies are symbols that must be defined, and exported, by the output
 208 module if the symbol is question is imported/required by the output module.
 209
 210 For example, imagine the runtime provides an external symbol ``foo`` that
 211 depends on the ``malloc`` and ``free``.  This can be expressed simply as::
 212
 213   #STUB
 214   foo: malloc,free
 215
 216 Here we are saying that ``foo`` is allowed to be imported (undefined) but that
 217 if it is imported, then the output module must also export ``malloc`` and
 218 ``free`` to the runtime.  If ``foo`` is imported (undefined), but the output
 219 module does not define ``malloc`` and ``free`` then the link will fail.
 220
 221 Stub libraries must begin with ``#STUB`` on a line by itself.
 222
 223 Garbage Collection
 224 ~~~~~~~~~~~~~~~~~~
 225
 226 Since WebAssembly is designed with size in mind the linker defaults to
 227 ``--gc-sections`` which means that all unused functions and data segments will
 228 be stripped from the binary.
 229
 230 The symbols which are preserved by default are:
 231
 232 - The entry point (by default ``_start``).
 233 - Any symbol which is to be exported.
 234 - Any symbol transitively referenced by the above.
 235
 236 Weak Undefined Functions
 237 ~~~~~~~~~~~~~~~~~~~~~~~~
 238
 239 On native platforms, calls to weak undefined functions end up as calls to the
 240 null function pointer.  With WebAssembly, direct calls must reference a defined
 241 function (with the correct signature).  In order to handle this case the linker
 242 will generate function a stub containing only the ``unreachable`` instruction
 243 and use this for any direct references to an undefined weak function.
 244
 245 For example a runtime call to a weak undefined function ``foo`` will up trapping
 246 on ``unreachable`` inside and linker-generated function called
 247 ``undefined:foo``.
 248
 249 Missing features
 250 ----------------
 251
 252 - Merging of data section similar to ``SHF_MERGE`` in the ELF world is not
 253   supported.
 254 - No support for creating shared libraries.  The spec for shared libraries in
 255   WebAssembly is still in flux:
 256   https://github.com/WebAssembly/tool-conventions/blob/main/DynamicLinking.md
 257
 258 .. _linking: https://github.com/WebAssembly/tool-conventions/blob/main/Linking.md