[libc] add compile option for printf arg type array

[michaelrj]

Summary

This patch allows for adjusting the size of the array that printf uses
to track the types of arguments in index mode. This is useful for
optimizing the tradeoff between memory usage and performance.

[sivachandra]

libc/src/stdio/printf_core/parser.h

51

Normally, config params like this are all put in one single .h file, say in this printf_parser_config.h:

#ifndef LLVM_LIBC_PRINTF_INDEX_ARR_LEN
// Explain what this param is about.
#define LLVM_LIBC_PRINTF_INDEX_ARR_LEN 128
#endif

Include printf_parser_config.h in parser.h. Not sure if we really want a separate config file for the parser, may be just a printf_config.h file is sufficient.

[michaelrj]

move the config into a separate file.

[michaelrj]

rebase

[sivachandra]

libc/src/stdio/printf_core/printf_config.h

18

Nit: Give an example of what that "severity" will look like.

[michaelrj]

add description of how the index array being too small effects runtime.

libc/src/stdio/printf_core/parser.h

 //===-- Format string parser for printf -------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_LIBC_SRC_STDIO_PRINTF_CORE_PARSER_H
 #define LLVM_LIBC_SRC_STDIO_PRINTF_CORE_PARSER_H
 
 #include "src/__support/arg_list.h"
 #include "src/stdio/printf_core/core_structs.h"
+#include "src/stdio/printf_core/printf_config.h"
 
 #include <stddef.h>
 
 namespace __llvm_libc {
 namespace printf_core {
 
 class Parser {
   const char *__restrict str;
#ifndef LLVM_LIBC_PRINTF_DISABLE_INDEX_MODE
   // a relatively compact manner.
   struct TypeDesc {
     uint8_t size;
     PrimaryType primary_type;
     constexpr bool operator==(const TypeDesc &other) const {
       return (size == other.size) && (primary_type == other.primary_type);
     }
   };
-  // TODO: Make this size configurable via a compile option.
-  static constexpr size_t DESC_ARR_LEN = 32;
+
+  // Defined in printf_config.h
+  static constexpr size_t DESC_ARR_LEN = LLVM_LIBC_PRINTF_INDEX_ARR_LEN;
+
   // desc_arr stores the sizes of the variables in the ArgList. This is used in
   // index mode to reduce repeated string parsing. The sizes are stored as
   // TypeDesc objects, which store the size as well as minimal type information.
   // This is necessary because some systems separate the floating point and
   // integer values in va_args.
   TypeDesc desc_arr[DESC_ARR_LEN] = {{0, Integer}};
 
   // TODO: Look into object stores for optimization.
 
 #endif // LLVM_LIBC_PRINTF_DISABLE_INDEX_MODE
 

libc/src/stdio/printf_core/printf_config.h

+//===-- Printf Configuration Handler ----------------------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_LIBC_SRC_STDIO_PRINTF_CORE_PRINTF_CONFIG_H
+#define LLVM_LIBC_SRC_STDIO_PRINTF_CORE_PRINTF_CONFIG_H
+
+// The index array buffer is always initialized when printf is called. In cases
+// where index mode is necessary but memory is limited, or when index mode
+// performance is important and memory is available, this compile option
+// provides a knob to adjust memory usage to an appropriate level. 128 is picked
+// as the default size since that's big enough to handle even extreme cases and
+// the runtime penalty for not having enough space is severe.
+// When an index mode argument is requested, if its index is before the most
+// recently read index, then the arg list must be restarted from the beginning,
+// and all of the arguments before the new index must be requested with the
+// correct types. The index array caches the types of the values in the arg
+// list. For every number between the last index cached in the array and the
+// requested index, the format string must be parsed again to find the
+// type of that index. As an example, if the format string has 20 indexes, and
+// the index array is 10, then when the 20th index is requested the first 10
+// types can be found immediately, and then the format string must be parsed 10
+// times to find the types of the next 10 arguments.
+#ifndef LLVM_LIBC_PRINTF_INDEX_ARR_LEN
+#define LLVM_LIBC_PRINTF_INDEX_ARR_LEN 128
+#endif
+
+// TODO(michaelrj): Move the other printf configuration options into this file.
+
+#endif // LLVM_LIBC_SRC_STDIO_PRINTF_CORE_PRINTF_CONFIG_H