[libc-commits] [PATCH] D152588: [libc][docs] Add undefined behavior doc to site

[Michael Jones via Phabricator via libc-commits]

This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
Closed by commit rG99686c5ed178: [libc][docs] Add undefined behavior doc to site (authored by michaelrj).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D152588/new/

https://reviews.llvm.org/D152588

Files:
  libc/docs/dev/index.rst
  libc/docs/dev/undefined_behavior.rst


Index: libc/docs/dev/undefined_behavior.rst
===================================================================
--- /dev/null
+++ libc/docs/dev/undefined_behavior.rst
@@ -0,0 +1,64 @@
+===========================
+Defining Undefined Behavior
+===========================
+
+.. contents:: Table of Contents
+   :depth: 2
+   :local:
+
+The C standard leaves behavior undefined or implementation defined in many
+places. Undefined behavior is behavior that the standards leave up to the
+implementation. As an implementation, LLVM's libc must provide a result for any
+input, including inputs for which the result is undefined. This page provides
+examples of how these situations are handled in existing code, followed by
+guidelines to help determine the right approach for new situations.
+
+Guidelines
+==========
+Most undefined behavior is outside the scope of normal use. Follow these
+guidelines and the resulting code should behave predictably even in unexpected
+situations.
+
+#. Follow the standards.
+#. Avoid giving an incorrect answer.
+    #. In general, correct answer > correct answer (wrong format) > no answer > crash the program >>>>>>> incorrect answer.
+    #. The C library is called frequently in performance critical situations, and so can't afford to do thorough error checking and correction.
+    #. It also cannot give the incorrect answer for any reasonable input, since it is so foundational.
+    #. This leaves crashing or address space corruption as a probable option for a libc function in an ambiguous state.
+#. Don't overcomplicate undefined situations.
+    #. It's better to have a slightly confusing result for an undefined input than 100 extra lines of code that are never used for a well defined input.
+    #. LLVM's libc is also used for embedded systems that care a lot about code size.
+    #. Unreasonable inputs can have unreasonable outputs.
+#. Match other implementations when it makes sense.
+    #. Every libc has to make these choices, and sometimes others have already found the right choice.
+    #. Be careful, just because there is a consensus doesn't make that consensus right.
+#. LLVM's libc should be consistent with itself.
+    #. Similar inputs to the same function should yield similar results, even when the inputs are undefined.
+    #. The same input to similar functions should also yield similar results.
+    #. The same input to the same function on different platforms should yield the same result, unless there's a specific reason not to (e.g. 64 bit long vs 32 bit long).
+#. Write down the decision.
+    #. Every libc has to make a decision on how to handle undefined inputs. Users should be able to find what LLVM's libc does.
+    #. While users shouldn't rely on undefined behavior, it shouldn't surprise them.
+
+Approaches
+==========
+
+Matching Behavior Against Existing Implementations
+--------------------------------------------------
+Existing implementations have already chosen how to handle undefined situations, and sometimes there are benefits to matching those decisions, such as in the case of atoi. The C Standard defines atoi as being equivalent to a call to strtol, with the result cast from long to int. The standard also clarifies that any input that cannot be represented as an int causes undefined behavior. For the strtol function, the standard instead defines inputs that cannot be represented in a long int as returning LONG_MAX or LONG_MIN, according to their sign. The decision of whether to cast the result from strtol or to handle integer overflow like strtol does is left to the implementation. LLVM's libc performs the raw cast, since the atoi function is fuzz tested against the implementation from glibc. By matching a known good implementation, LLVM's libc can more effectively be checked for correctness in this case.
+
+Simplifying Handling Invalid Inputs
+-----------------------------------
+When handling invalid inputs, the output should be simple to code, and simple for the user to understand. An example of this is how the printf function handles invalid conversion specifiers. A conversion specifier is a segment of the format string that starts with a %. At the end of a conversion specifier is the character that determines the behavior for the conversion, called the conversion name. As an example, the conversion specifier %d has the conversion name of d which represents an integer conversion. If the conversion name is instead an invalid character such as ? then the behavior is undefined. When passed an invalid conversion specifier like %? LLVM's libc defines the output as the raw text of the conversion specifier. This simplifies the algorithm and makes the result obvious and predictable for the user.
+
+Conforming to Existing Practice
+-------------------------------
+There are some behaviors that are technically undefined, but are otherwise consistent across implementations, such as how printf handles length modifiers on inappropriate conversions. For each conversion name there is a list of length modifiers that can apply to it. If a length modifier is applied to a conversion specifier that it doesn't apply to, then the behavior is undefined. For most conversions, LLVM's libc ignores any length modifier that doesn't apply. As an example, a conversion of %hf would be read as an f float conversion with the h length modifier. The h length modifier doesn't apply to floating point conversions and so %hf is the same as %f. There is one exception, which is the L length modifier on integer conversions. Many libcs handle the L length modifier like the ll length modifier when applied to integer conversions, despite L only applying to float conversions in the standard. LLVM's libc follows this convention because it is a useful feature that is simple to implement and has a predictable outcome for the user.
+
+Interpreting the Standard's Reasoning
+-------------------------------------
+Often the standard will imply an intended behavior through what it states is undefined, such as in the case of printf's handling of the %% conversion. The %% conversion is used to write a % character, since it's used as the start of a conversion specifier. The standard specifies that %% must be the complete conversion specifier, and any options would make the conversion undefined. The conversion specifier %10% can therefore be interpreted as a % conversion with a width of 10, but the standard implies that this is not necessary. By making the options undefined, the standard implies a desired behavior for %% with options. The implied behavior is to ignore all options and always print %. This still leaves the behavior of %*% ambiguous, since the star normally consumes an argument to be used as the width. Since % conversions ignore the width, it would be reasonable to not read the argument in this case, but it would add additional complexity to the parsing logic. For that reason, the implementation in LLVM's libc will consume an argument for %*%, although the value is ignored. Adding additional logic for unreasonable edge cases, such as this one, is unnecessary.
+
+Ignoring Bug-For-Bug Compatibility
+----------------------------------
+Any long running implementations will have bugs and deviations from the standard. Hyrum's Law states that “all observable behaviors of your system will be depended on by somebody” which includes these bugs. An example of a long-standing bug is glibc's scanf float parsing behavior. The behavior is specifically defined in the standard, but it isn't adhered to by all libc implementations. There is a longstanding bug in glibc where it incorrectly parses the string 100er and this caused the C standard to add that specific example to the definition for scanf. The intended behavior is for scanf, when parsing a float, to parse the longest possibly valid prefix and then accept it if and only if that complete parsed value is a float. In the case of 100er the longest possibly valid prefix is 100e but the float parsed from that string is only 100. Since there is no number after the e it shouldn't be included in the float, so scanf should return a parsing error. For LLVM's libc it was decided to follow the standard, even though glibc's version is slightly simpler to implement and this edge case is rare. Following the standard must be the first priority, since that's the goal of the library.
Index: libc/docs/dev/index.rst
===================================================================
--- libc/docs/dev/index.rst
+++ libc/docs/dev/index.rst
@@ -17,5 +17,6 @@
    ground_truth_specification
    header_generation
    implementation_standard
+   undefined_behavior
    api_test
    mechanics_of_public_api


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D152588.530607.patch
Type: text/x-patch
Size: 8708 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libc-commits/attachments/20230612/ff7bbac7/attachment-0001.bin>