Skip to content

Commit

Permalink
[LangRef] Try to formalize the definition of "odr" in LLVM IR. (#92619)
Browse files Browse the repository at this point in the history
The current definition is a bit fuzzy... replace it with something
that's somewhat rigorous.

For functions, the definition is pretty narrow; as a consequence of
language-level non-determinism, it's impossible to tell whether two
functions are equivalent, so just embrace the non-determinism. For
constants, we're pretty strict; otherwise you end up concluding
constants can actually change value, which is bad for alias analysis. I
think C++ standard don't allow any non-deterministic operations in
constants, so we should be okay there? Poison is per-byte to allow some
ambiguity in the way padding is defined.
  • Loading branch information
efriedma-quic authored May 20, 2024
1 parent fdd245a commit c1d5cc9
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions llvm/docs/LangRef.rst
Original file line number Diff line number Diff line change
Expand Up @@ -290,13 +290,17 @@ linkage:
symbol is weak until linked, if not linked, the symbol becomes null
instead of being an undefined reference.
``linkonce_odr``, ``weak_odr``
Some languages allow differing globals to be merged, such as two
functions with different semantics. Other languages, such as
``C++``, ensure that only equivalent globals are ever merged (the
"one definition rule" --- "ODR"). Such languages can use the
``linkonce_odr`` and ``weak_odr`` linkage types to indicate that the
global will only be merged with equivalent globals. These linkage
types are otherwise the same as their non-``odr`` versions.
The ``odr`` suffix indicates that all globals defined with the given name
are equivalent, along the lines of the C++ "one definition rule" ("ODR").
Informally, this means we can inline functions and fold loads of constants.

Formally, use the following definition: when an ``odr`` function is
called, one of the definitions is non-deterministically chosen to run. For
``odr`` variables, if any byte in the value is not equal in all
initializers, that byte is a :ref:`poison value <poisonvalues>`. For
aliases and ifuncs, apply the rule for the underlying function or variable.

These linkage types are otherwise the same as their non-``odr`` versions.
``external``
If none of the above identifiers are used, the global is externally
visible, meaning that it participates in linkage and can be used to
Expand Down

0 comments on commit c1d5cc9

Please sign in to comment.