File: error_handling_script.rst

package info (click to toggle)
llvm-toolchain-20 1%3A20.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 2,111,696 kB
  • sloc: cpp: 7,438,781; ansic: 1,393,871; asm: 1,012,926; python: 241,771; f90: 86,635; objc: 75,411; lisp: 42,144; pascal: 17,286; sh: 8,596; ml: 5,082; perl: 4,730; makefile: 3,591; awk: 3,523; javascript: 2,251; xml: 892; fortran: 672
file content (39 lines) | stat: -rw-r--r-- 1,306 bytes parent folder | download | duplicates (23)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
=====================
Error Handling Script
=====================

LLD provides the ability to hook into some error handling routines through a
user-provided script specified with ``--error-handling-script=<path to the script>``
when certain errors are encountered. This document specifies the requirements of
such a script.

Generic Requirements
====================

The script is expected to be available in the ``PATH`` or to be provided using a
full path. It must be executable. It is executed in the same environment as the
parent process.

Arguments
=========

LLD calls the error handling script using the following arguments::

    error-handling-script <tag> <tag-specific-arguments...>

The following tags are supported:

- ``missing-lib``: indicates that LLD failed to find a library. The library name
  is specified as the second argument, e.g. ``error-handling-script missing-lib
  mylib``

- ``undefined-symbol``: indicates that given symbol is marked as undefined. The
  unmangled symbol name is specified as the second argument, e.g.
  ``error-handling-script undefined-symbol mysymbol``

Return Value
============

Upon success, the script is expected to return 0. A non-zero value is
interpreted as an error and reported to the user. In both cases, LLD still
reports the original error.