102 lines · plain
1llvm-cxxmap - Mangled name remapping tool2=========================================3 4.. program:: llvm-cxxmap5 6SYNOPSIS7--------8 9:program:`llvm-cxxmap` [*options*] *symbol-file-1* *symbol-file-2*10 11DESCRIPTION12-----------13 14The :program:`llvm-cxxmap` tool performs fuzzy matching of C++ mangled names,15based on a file describing name components that should be considered equivalent.16 17The symbol files should contain a list of C++ mangled names (one per line).18Blank lines and lines starting with ``#`` are ignored. The output is a list19of pairs of equivalent symbols, one per line, of the form20 21.. code-block:: none22 23 <symbol-1> <symbol-2>24 25where ``<symbol-1>`` is a symbol from *symbol-file-1* and ``<symbol-2>`` is26a symbol from *symbol-file-2*. Mappings for which the two symbols are identical27are omitted.28 29OPTIONS30-------31 32.. program:: llvm-cxxmap33 34.. option:: -remapping-file=file, -r=file35 36 Specify a file containing a list of equivalence rules that should be used37 to determine whether two symbols are equivalent. Required.38 See :ref:`remapping-file`.39 40.. option:: -output=file, -o=file41 42 Specify a file to write the list of matched names to. If unspecified, the43 list will be written to stdout.44 45.. option:: -Wambiguous46 47 Produce a warning if there are multiple equivalent (but distinct) symbols in48 *symbol-file-2*.49 50.. option:: -Wincomplete51 52 Produce a warning if *symbol-file-1* contains a symbol for which there is no53 equivalent symbol in *symbol-file-2*.54 55.. _remapping-file:56 57REMAPPING FILE58--------------59 60The remapping file is a text file containing lines of the form61 62.. code-block:: none63 64 fragmentkind fragment1 fragment265 66where ``fragmentkind`` is one of ``name``, ``type``, or ``encoding``,67indicating whether the following mangled name fragments are68<`name <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.name>`_>s,69<`type <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.type>`_>s, or70<`encoding <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.encoding>`_>s,71respectively.72Blank lines and lines starting with ``#`` are ignored.73 74Unmangled C names can be expressed as an ``encoding`` that is a (length-prefixed)75<`source-name <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.source-name>`_>:76 77.. code-block:: none78 79 # C function "void foo_bar()" is remapped to C++ function "void foo::bar()".80 encoding 7foo_bar _Z3foo3barv81 82For convenience, built-in <substitution>s such as ``St`` and ``Ss``83are accepted as <name>s (even though they technically are not <name>s).84 85For example, to specify that ``absl::string_view`` and ``std::string_view``86should be treated as equivalent, the following remapping file could be used:87 88.. code-block:: none89 90 # absl::string_view is considered equivalent to std::string_view91 type N4absl11string_viewE St17basic_string_viewIcSt11char_traitsIcEE92 93 # std:: might be std::__1:: in libc++ or std::__cxx11:: in libstdc++94 name St St3__195 name St St7__cxx1196 97.. note::98 99 Symbol remapping is currently only supported for C++ mangled names100 following the Itanium C++ ABI mangling scheme. This covers all C++ targets101 supported by Clang other than Windows targets.102