manual/README.tunables

   1                         TUNABLE FRAMEWORK
   2                         =================
   3
   4 Tunables is a feature in the GNU C Library that allows application authors and
   5 distribution maintainers to alter the runtime library behaviour to match their
   6 workload.
   7
   8 The tunable framework allows modules within glibc to register variables that
   9 may be tweaked through an environment variable.  It aims to enforce a strict
  10 namespace rule to bring consistency to naming of these tunable environment
  11 variables across the project.  This document is a guide for glibc developers to
  12 add tunables to the framework.
  13
  14 ADDING A NEW TUNABLE
  15 --------------------
  16
  17 The TOP_NAMESPACE macro is defined by default as 'glibc'.  If distributions
  18 intend to add their own tunables, they should do so in a different top
  19 namespace by overriding the TOP_NAMESPACE macro for that tunable.  Downstream
  20 implementations are discouraged from using the 'glibc' top namespace for
  21 tunables they don't already have consensus to push upstream.
  22
  23 There are three steps to adding a tunable:
  24
  25 1. Add a tunable to the list and fully specify its properties:
  26
  27 For each tunable you want to add, make an entry in elf/dl-tunables.list.  The
  28 format of the file is as follows:
  29
  30 TOP_NAMESPACE {
  31   NAMESPACE1 {
  32     TUNABLE1 {
  33       # tunable attributes, one per line
  34     }
  35     # A tunable with default attributes, i.e. string variable.
  36     TUNABLE2
  37     TUNABLE3 {
  38       # its attributes
  39     }
  40   }
  41   NAMESPACE2 {
  42     ...
  43   }
  44 }
  45
  46 The list of allowed attributes are:
  47
  48 - type:                 Data type.  Defaults to STRING.  Allowed types are:
  49                         INT_32, UINT_64, SIZE_T and STRING.  Numeric types may
  50                         be in octal or hexadecimal format too.
  51
  52 - minval:               Optional minimum acceptable value.  For a string type
  53                         this is the minimum length of the value.
  54
  55 - maxval:               Optional maximum acceptable value.  For a string type
  56                         this is the maximum length of the value.
  57
  58 - default:              Specify an optional default value for the tunable.
  59
  60 - env_alias:            An alias environment variable
  61
  62 2. Use TUNABLE_GET/TUNABLE_SET/TUNABLE_SET_WITH_BOUNDS to get and set tunables.
  63
  64 3. OPTIONAL: If tunables in a namespace are being used multiple times within a
  65    specific module, set the TUNABLE_NAMESPACE macro to reduce the amount of
  66    typing.
  67
  68 GETTING AND SETTING TUNABLES
  69 ----------------------------
  70
  71 When the TUNABLE_NAMESPACE macro is defined, one may get tunables in that
  72 module using the TUNABLE_GET macro as follows:
  73
  74   val = TUNABLE_GET (check, int32_t, TUNABLE_CALLBACK (check_callback))
  75
  76 where 'check' is the tunable name, 'int32_t' is the C type of the tunable and
  77 'check_callback' is the function to call if the tunable got initialized to a
  78 non-default value.  The macro returns the value as type 'int32_t'.
  79
  80 The callback function should be defined as follows:
  81
  82   void
  83   TUNABLE_CALLBACK (check_callback) (int32_t *valp)
  84   {
  85   ...
  86   }
  87
  88 where it can expect the tunable value to be passed in VALP.
  89
  90 Tunables in the module can be updated using:
  91
  92   TUNABLE_SET (check, val)
  93
  94 where 'check' is the tunable name and 'val' is a value of same type.
  95
  96 To get and set tunables in a different namespace from that module, use the full
  97 form of the macros as follows:
  98
  99   val = TUNABLE_GET_FULL (glibc, cpu, hwcap_mask, uint64_t, NULL)
 100
 101   TUNABLE_SET_FULL (glibc, cpu, hwcap_mask, val)
 102
 103 where 'glibc' is the top namespace, 'cpu' is the tunable namespace and the
 104 remaining arguments are the same as the short form macros.
 105
 106 The minimum and maximum values can updated together with the tunable value
 107 using:
 108
 109   TUNABLE_SET_WITH_BOUNDS (check, val, min, max)
 110
 111 where 'check' is the tunable name, 'val' is a value of same type, 'min' and
 112 'max' are the minimum and maximum values of the tunable.
 113
 114 To set the minimum and maximum values of tunables in a different namespace
 115 from that module, use the full form of the macros as follows:
 116
 117   val = TUNABLE_GET_FULL (glibc, cpu, hwcap_mask, uint64_t, NULL)
 118
 119   TUNABLE_SET_WITH_BOUNDS_FULL (glibc, cpu, hwcap_mask, val, min, max)
 120
 121 where 'glibc' is the top namespace, 'cpu' is the tunable namespace and the
 122 remaining arguments are the same as the short form macros.
 123
 124 When TUNABLE_NAMESPACE is not defined in a module, TUNABLE_GET is equivalent to
 125 TUNABLE_GET_FULL, so you will need to provide full namespace information for
 126 both macros.  Likewise for TUNABLE_SET, TUNABLE_SET_FULL,
 127 TUNABLE_SET_WITH_BOUNDS and TUNABLE_SET_WITH_BOUNDS_FULL.
 128
 129 ** IMPORTANT NOTE **
 130
 131 The tunable list is set as read-only after the dynamic linker relocates itself,
 132 so setting tunable values must be limited only to tunables within the dynamic
 133 linker, that too before relocation.
 134
 135 FUTURE WORK
 136 -----------
 137
 138 The framework currently only allows a one-time initialization of variables
 139 through environment variables and in some cases, modification of variables via
 140 an API call.  A future goals for this project include:
 141
 142 - Setting system-wide and user-wide defaults for tunables through some
 143   mechanism like a configuration file.
 144
 145 - Allow tweaking of some tunables at runtime