1
2DEBUGINFOD-CLIENT-CONFIGM(i7s)cellaneous Information ManDuEaBlUGINFOD-CLIENT-CONFIG(7)
3
4
5

NAME

7       debuginfod-client-config  -  debuginfod  client  environment variables,
8       cache control files and etc.
9
10

SYNOPSIS

12       Several environment variables and control files control  the  behaviour
13       of debuginfod client applications.
14
15
16
17

ENVIRONMENT VARIABLES

19       $TMPDIR
20              This environment variable points to a file system to be used for
21              temporary files.  The default is /tmp.
22
23
24       $DEBUGINFOD_URLS
25              This environment variable contains a list of  URL  prefixes  for
26              trusted  debuginfod instances.  Alternate URL prefixes are sepa‐
27              rated by space.  Avoid referential loops that cause a server  to
28              contact  itself,  directly  or indirectly - the results would be
29              hilarious.
30
31
32       $DEBUGINFOD_CACHE_PATH
33              This environment variable governs  the  location  of  the  cache
34              where  downloaded  files  and cache-control files are kept.  The
35              default directory is chosen based  on  other  environment  vari‐
36              ables, see below.
37
38
39       $DEBUGINFOD_PROGRESS
40              This environment variable governs the default progress function.
41              If set, and if a progressfn is not explicitly set, then the  li‐
42              brary  will  configure a default progressfn.  This function will
43              append a simple progress message periodically  to  stderr.   The
44              default is no progress function output.
45
46
47       $DEBUGINFOD_VERBOSE
48              This  environment  variable  governs the default file descriptor
49              for verbose output.  If set, and if a verbose fd is not  explic‐
50              itly   set,   then  the  verbose  output  will  be  produced  on
51              STDERR_FILENO.
52
53
54       $DEBUGINFOD_RETRY_LIMIT
55              This environment variable governs the default limit of retry at‐
56              tempts.  If  a  query  failed with errno other than ENOENT, will
57              initiate several attempts within the limit.
58
59
60       $DEBUGINFOD_TIMEOUT
61              This environment variable governs the download commencing  time‐
62              out for each debuginfod HTTP connection.  A server that fails to
63              provide at least 100K  of  data  within  this  many  seconds  is
64              skipped. The default is 90 seconds.  (Zero or negative means "no
65              timeout".)
66
67
68       $DEBUGINFOD_MAXTIME
69              This environment variable dictates how long the client will wait
70              to complete the download a file found on a server in seconds. It
71              is best used to ensure that a file is downloaded quickly  or  be
72              rejected. The default is 0 (infinite time).
73
74
75       $DEBUGINFOD_MAXSIZE
76              This environment variable dictates the maximum size of a file to
77              download in bytes. This is best used if the user would  like  to
78              ensure  only  small files are downloaded. A value of 0 causes no
79              consideration for size, and the client may attempt to download a
80              file of any size.  The default is 0 (infinite size).
81
82

CACHE

84       Before  each  query, the debuginfod client library checks for a need to
85       clean the cache.  If it's time to  clean,  the  library  traverses  the
86       cache  directory and removes downloaded debuginfo-related artifacts and
87       newly empty directories, if they have not been accessed recently.
88
89       Control files are located directly under  the  cache  directory.   They
90       contain  simple  decimal numbers to set cache-related configuration pa‐
91       rameters.  If the files do not exist, the client  library  creates  the
92       files with the default parameter values as content.
93
94       After each query, the debuginfod client library deposits newly received
95       files into a directory & file that is named based on the  build-id.   A
96       failed  query  is also cached by a special file.  The naming convention
97       used for these artifacts is deliberately undocumented.
98
99
100       $XDG_CACHE_HOME/debuginfod_client/
101              Default cache directory, if $XDG_CACHE_HOME is set.
102
103
104       $HOME/.cache/debuginfod_client/
105              Default cache directory, if $XDG_CACHE_HOME is not set.
106
107
108       $HOME/.debuginfod_client_cache/
109              Deprecated cache directory, used only if preexisting.
110
111
112       cache_clean_interval_s
113              This control file gives  the  interval  between  cache  cleaning
114              rounds,  in  seconds.   The  default is 86400, one day.  0 means
115              "immediately".
116
117
118       max_unused_age_s
119              This control file sets  how  long  unaccessed  debuginfo-related
120              files  are  retained,  in  seconds.   The default is 604800, one
121              week.  0 means "immediately".
122
123
124       cache_miss_s
125              This control file sets how long to remember a query failure,  in
126              seconds.   New  queries  for the same artifacts within this time
127              window are short-circuited (returning an immediate  failure  in‐
128              stead  of  sending  a  new  query to servers).  This accelerates
129              queries that probably would still fail.  The default is 600,  10
130              minutes.  0 means "forget immediately".
131
132
133
134                                                   DEBUGINFOD-CLIENT-CONFIG(7)