debuginfod-client-config(7)

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.   This  environment  variable  may  be  set  by
28              /etc/profile.d scripts reading /etc/debuginfod/*.urls files.
29
30
31       $DEBUGINFOD_CACHE_PATH
32              This  environment  variable  governs  the  location of the cache
33              where downloaded files and cache-control files  are  kept.   The
34              default  directory  is  chosen  based on other environment vari‐
35              ables, see below.
36
37
38       $DEBUGINFOD_PROGRESS
39              This environment variable governs the default progress function.
40              If  set, and if a progressfn is not explicitly set, then the li‐
41              brary will configure a default progressfn.  This  function  will
42              append  a  simple  progress message periodically to stderr.  The
43              default is no progress function output.
44
45
46       $DEBUGINFOD_VERBOSE
47              This environment variable governs the  default  file  descriptor
48              for  verbose output.  If set, and if a verbose fd is not explic‐
49              itly  set,  then  the  verbose  output  will  be   produced   on
50              STDERR_FILENO.
51
52
53       $DEBUGINFOD_RETRY_LIMIT
54              This environment variable governs the default limit of retry at‐
55              tempts. If a query failed with errno  other  than  ENOENT,  will
56              initiate several attempts within the limit.
57
58
59       $DEBUGINFOD_TIMEOUT
60              This  environment variable governs the download commencing time‐
61              out for each debuginfod HTTP connection.  A server that fails to
62              provide  at  least  100K  of  data  within  this many seconds is
63              skipped. The default is 90 seconds.  (Zero or negative means "no
64              timeout".)
65
66
67       $DEBUGINFOD_MAXTIME
68              This environment variable dictates how long the client will wait
69              to complete the download a file found on a server in seconds. It
70              is  best  used to ensure that a file is downloaded quickly or be
71              rejected. The default is 0 (infinite time).
72
73
74       $DEBUGINFOD_MAXSIZE
75              This environment variable dictates the maximum size of a file to
76              download  in  bytes. This is best used if the user would like to
77              ensure only small files are downloaded. A value of 0  causes  no
78              consideration for size, and the client may attempt to download a
79              file of any size.  The default is 0 (infinite size).
80
81
82       $DEBUGINFOD_HEADERS_FILE
83              This environment variable points to a file that supplies headers
84              to  outbound  HTTP  requests,  one  per  line.  The header lines
85              shouldn't end with CRLF, unless that's the system  newline  con‐
86              vention. Whitespace-only lines are skipped.
87
88

CACHE

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