Branch data Line data Source code
1 : : /* Retrieve ELF / DWARF / source files from the debuginfod.
2 : : Copyright (C) 2019-2021 Red Hat, Inc.
3 : : Copyright (C) 2021, 2022 Mark J. Wielaard <mark@klomp.org>
4 : : This file is part of elfutils.
5 : :
6 : : This file is free software; you can redistribute it and/or modify
7 : : it under the terms of either
8 : :
9 : : * the GNU Lesser General Public License as published by the Free
10 : : Software Foundation; either version 3 of the License, or (at
11 : : your option) any later version
12 : :
13 : : or
14 : :
15 : : * the GNU General Public License as published by the Free
16 : : Software Foundation; either version 2 of the License, or (at
17 : : your option) any later version
18 : :
19 : : or both in parallel, as here.
20 : :
21 : : elfutils is distributed in the hope that it will be useful, but
22 : : WITHOUT ANY WARRANTY; without even the implied warranty of
23 : : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 : : General Public License for more details.
25 : :
26 : : You should have received copies of the GNU General Public License and
27 : : the GNU Lesser General Public License along with this program. If
28 : : not, see <http://www.gnu.org/licenses/>. */
29 : :
30 : :
31 : : /* cargo-cult from libdwfl linux-kernel-modules.c */
32 : : /* In case we have a bad fts we include this before config.h because it
33 : : can't handle _FILE_OFFSET_BITS.
34 : : Everything we need here is fine if its declarations just come first.
35 : : Also, include sys/types.h before fts. On some systems fts.h is not self
36 : : contained. */
37 : : #ifdef BAD_FTS
38 : : #include <sys/types.h>
39 : : #include <fts.h>
40 : : #endif
41 : :
42 : : #include "config.h"
43 : : #include "debuginfod.h"
44 : : #include "system.h"
45 : : #include <ctype.h>
46 : : #include <errno.h>
47 : : #include <stdlib.h>
48 : : #include <gelf.h>
49 : :
50 : : /* We might be building a bootstrap dummy library, which is really simple. */
51 : : #ifdef DUMMY_LIBDEBUGINFOD
52 : :
53 : : debuginfod_client *debuginfod_begin (void) { errno = ENOSYS; return NULL; }
54 : : int debuginfod_find_debuginfo (debuginfod_client *c, const unsigned char *b,
55 : : int s, char **p) { return -ENOSYS; }
56 : : int debuginfod_find_executable (debuginfod_client *c, const unsigned char *b,
57 : : int s, char **p) { return -ENOSYS; }
58 : : int debuginfod_find_source (debuginfod_client *c, const unsigned char *b,
59 : : int s, const char *f, char **p) { return -ENOSYS; }
60 : : int debuginfod_find_section (debuginfod_client *c, const unsigned char *b,
61 : : int s, const char *scn, char **p)
62 : : { return -ENOSYS; }
63 : : void debuginfod_set_progressfn(debuginfod_client *c,
64 : : debuginfod_progressfn_t fn) { }
65 : : void debuginfod_set_verbose_fd(debuginfod_client *c, int fd) { }
66 : : void debuginfod_set_user_data (debuginfod_client *c, void *d) { }
67 : : void* debuginfod_get_user_data (debuginfod_client *c) { return NULL; }
68 : : const char* debuginfod_get_url (debuginfod_client *c) { return NULL; }
69 : : int debuginfod_add_http_header (debuginfod_client *c,
70 : : const char *h) { return -ENOSYS; }
71 : : const char* debuginfod_get_headers (debuginfod_client *c) { return NULL; }
72 : :
73 : : void debuginfod_end (debuginfod_client *c) { }
74 : :
75 : : #else /* DUMMY_LIBDEBUGINFOD */
76 : :
77 : : #include <assert.h>
78 : : #include <dirent.h>
79 : : #include <stdio.h>
80 : : #include <errno.h>
81 : : #include <unistd.h>
82 : : #include <fcntl.h>
83 : : #include <fts.h>
84 : : #include <regex.h>
85 : : #include <string.h>
86 : : #include <stdbool.h>
87 : : #include <linux/limits.h>
88 : : #include <time.h>
89 : : #include <utime.h>
90 : : #include <sys/syscall.h>
91 : : #include <sys/types.h>
92 : : #include <sys/stat.h>
93 : : #include <sys/utsname.h>
94 : : #include <curl/curl.h>
95 : :
96 : : /* If fts.h is included before config.h, its indirect inclusions may not
97 : : give us the right LFS aliases of these functions, so map them manually. */
98 : : #ifdef BAD_FTS
99 : : #ifdef _FILE_OFFSET_BITS
100 : : #define open open64
101 : : #define fopen fopen64
102 : : #endif
103 : : #else
104 : : #include <sys/types.h>
105 : : #include <fts.h>
106 : : #endif
107 : :
108 : : /* Older curl.h don't define CURL_AT_LEAST_VERSION. */
109 : : #ifndef CURL_AT_LEAST_VERSION
110 : : #define CURL_VERSION_BITS(x,y,z) ((x)<<16|(y)<<8|(z))
111 : : #define CURL_AT_LEAST_VERSION(x,y,z) \
112 : : (LIBCURL_VERSION_NUM >= CURL_VERSION_BITS(x, y, z))
113 : : #endif
114 : :
115 : : #include <pthread.h>
116 : :
117 : : static pthread_once_t init_control = PTHREAD_ONCE_INIT;
118 : :
119 : : static void
120 : 374 : libcurl_init(void)
121 : : {
122 : 374 : curl_global_init(CURL_GLOBAL_DEFAULT);
123 : 374 : }
124 : :
125 : : struct debuginfod_client
126 : : {
127 : : /* Progress/interrupt callback function. */
128 : : debuginfod_progressfn_t progressfn;
129 : :
130 : : /* Stores user data. */
131 : : void* user_data;
132 : :
133 : : /* Stores current/last url, if any. */
134 : : char* url;
135 : :
136 : : /* Accumulates outgoing http header names/values. */
137 : : int user_agent_set_p; /* affects add_default_headers */
138 : : struct curl_slist *headers;
139 : :
140 : : /* Flags the default_progressfn having printed something that
141 : : debuginfod_end needs to terminate. */
142 : : int default_progressfn_printed_p;
143 : :
144 : : /* Indicates whether the last query was cancelled by progressfn. */
145 : : bool progressfn_cancel;
146 : :
147 : : /* File descriptor to output any verbose messages if > 0. */
148 : : int verbose_fd;
149 : :
150 : : /* Maintain a long-lived curl multi-handle, which keeps a
151 : : connection/tls/dns cache to recently seen servers. */
152 : : CURLM *server_mhandle;
153 : :
154 : : /* Can contain all other context, like cache_path, server_urls,
155 : : timeout or other info gotten from environment variables, the
156 : : handle data, etc. So those don't have to be reparsed and
157 : : recreated on each request. */
158 : : char * winning_headers;
159 : : };
160 : :
161 : : /* The cache_clean_interval_s file within the debuginfod cache specifies
162 : : how frequently the cache should be cleaned. The file's st_mtime represents
163 : : the time of last cleaning. */
164 : : static const char *cache_clean_interval_filename = "cache_clean_interval_s";
165 : : static const long cache_clean_default_interval_s = 86400; /* 1 day */
166 : :
167 : : /* The cache_miss_default_s within the debuginfod cache specifies how
168 : : frequently the empty file should be released.*/
169 : : static const long cache_miss_default_s = 600; /* 10 min */
170 : : static const char *cache_miss_filename = "cache_miss_s";
171 : :
172 : : /* The cache_max_unused_age_s file within the debuginfod cache specifies the
173 : : the maximum time since last access that a file will remain in the cache. */
174 : : static const char *cache_max_unused_age_filename = "max_unused_age_s";
175 : : static const long cache_default_max_unused_age_s = 604800; /* 1 week */
176 : :
177 : : /* Location of the cache of files downloaded from debuginfods.
178 : : The default parent directory is $HOME, or '/' if $HOME doesn't exist. */
179 : : static const char *cache_default_name = ".debuginfod_client_cache";
180 : : static const char *cache_xdg_name = "debuginfod_client";
181 : :
182 : : /* URLs of debuginfods, separated by url_delim. */
183 : : static const char *url_delim = " ";
184 : :
185 : : /* Timeout for debuginfods, in seconds (to get at least 100K). */
186 : : static const long default_timeout = 90;
187 : :
188 : : /* Default retry count for download error. */
189 : : static const long default_retry_limit = 2;
190 : :
191 : : /* Data associated with a particular CURL easy handle. Passed to
192 : : the write callback. */
193 : : struct handle_data
194 : : {
195 : : /* Cache file to be written to in case query is successful. */
196 : : int fd;
197 : :
198 : : /* URL queried by this handle. */
199 : : char url[PATH_MAX];
200 : :
201 : : /* error buffer for this handle. */
202 : : char errbuf[CURL_ERROR_SIZE];
203 : :
204 : : /* This handle. */
205 : : CURL *handle;
206 : :
207 : : /* The client object whom we're serving. */
208 : : debuginfod_client *client;
209 : :
210 : : /* Pointer to handle that should write to fd. Initially points to NULL,
211 : : then points to the first handle that begins writing the target file
212 : : to the cache. Used to ensure that a file is not downloaded from
213 : : multiple servers unnecessarily. */
214 : : CURL **target_handle;
215 : : /* Response http headers for this client handle, sent from the server */
216 : : char *response_data;
217 : : size_t response_data_size;
218 : : };
219 : :
220 : : static size_t
221 : 6821 : debuginfod_write_callback (char *ptr, size_t size, size_t nmemb, void *data)
222 : : {
223 : 6821 : ssize_t count = size * nmemb;
224 : :
225 : 6821 : struct handle_data *d = (struct handle_data*)data;
226 : :
227 : : /* Indicate to other handles that they can abort their transfer. */
228 [ + + ]: 6821 : if (*d->target_handle == NULL)
229 : : {
230 : 242 : *d->target_handle = d->handle;
231 : : /* update the client object */
232 : 242 : const char *url = NULL;
233 : 242 : CURLcode curl_res = curl_easy_getinfo (d->handle,
234 : : CURLINFO_EFFECTIVE_URL, &url);
235 [ + - + - ]: 242 : if (curl_res == CURLE_OK && url)
236 : : {
237 : 242 : free (d->client->url);
238 : 242 : d->client->url = strdup(url); /* ok if fails */
239 : : }
240 : : }
241 : :
242 : : /* If this handle isn't the target handle, abort transfer. */
243 [ + - ]: 6821 : if (*d->target_handle != d->handle)
244 : : return -1;
245 : :
246 : 6821 : return (size_t) write(d->fd, (void*)ptr, count);
247 : : }
248 : :
249 : : /* handle config file read and write */
250 : : static int
251 : 904 : debuginfod_config_cache(debuginfod_client *c, char *config_path,
252 : : long cache_config_default_s,
253 : : struct stat *st)
254 : : {
255 : 904 : int fd = open(config_path, O_CREAT | O_RDWR, DEFFILEMODE);
256 [ - + ]: 904 : if (fd < 0)
257 : 0 : return -errno;
258 : :
259 [ - + ]: 904 : if (fstat (fd, st) < 0)
260 : : {
261 : 0 : int ret = -errno;
262 : 0 : close (fd);
263 : 0 : return ret;
264 : : }
265 : :
266 [ + + ]: 904 : if (st->st_size == 0)
267 : : {
268 [ - + ]: 76 : if (dprintf(fd, "%ld", cache_config_default_s) < 0)
269 : : {
270 : 0 : int ret = -errno;
271 : 0 : close (fd);
272 : 0 : return ret;
273 : : }
274 : :
275 : 76 : close (fd);
276 : 76 : return cache_config_default_s;
277 : : }
278 : :
279 : 828 : long cache_config;
280 : : /* PR29696 - NB: When using fdopen, the file descriptor is NOT
281 : : dup'ed and will be closed when the stream is closed. Manually
282 : : closing fd after fclose is called will lead to a race condition
283 : : where, if reused, the file descriptor will compete for its
284 : : regular use before being incorrectly closed here. */
285 : 828 : FILE *config_file = fdopen(fd, "r");
286 [ + - ]: 828 : if (config_file)
287 : : {
288 [ - + ]: 828 : if (fscanf(config_file, "%ld", &cache_config) != 1)
289 : 0 : cache_config = cache_config_default_s;
290 [ - + - - ]: 828 : if (0 != fclose (config_file) && c->verbose_fd >= 0)
291 : 0 : dprintf (c->verbose_fd, "fclose failed with %s (err=%d)\n",
292 : 0 : strerror (errno), errno);
293 : : }
294 : : else
295 : : {
296 : 0 : cache_config = cache_config_default_s;
297 [ # # # # ]: 0 : if (0 != close (fd) && c->verbose_fd >= 0)
298 : 0 : dprintf (c->verbose_fd, "close failed with %s (err=%d)\n",
299 : 0 : strerror (errno), errno);
300 : : }
301 : 828 : return cache_config;
302 : : }
303 : :
304 : : /* Delete any files that have been unmodied for a period
305 : : longer than $DEBUGINFOD_CACHE_CLEAN_INTERVAL_S. */
306 : : static int
307 : 898 : debuginfod_clean_cache(debuginfod_client *c,
308 : : char *cache_path, char *interval_path,
309 : : char *max_unused_path)
310 : : {
311 : 898 : time_t clean_interval, max_unused_age;
312 : 898 : int rc = -1;
313 : 898 : struct stat st;
314 : :
315 : : /* Create new interval file. */
316 : 898 : rc = debuginfod_config_cache(c, interval_path,
317 : : cache_clean_default_interval_s, &st);
318 [ + - ]: 898 : if (rc < 0)
319 : : return rc;
320 : 898 : clean_interval = (time_t)rc;
321 : :
322 : : /* Check timestamp of interval file to see whether cleaning is necessary. */
323 [ + + ]: 898 : if (time(NULL) - st.st_mtime < clean_interval)
324 : : /* Interval has not passed, skip cleaning. */
325 : : return 0;
326 : :
327 : : /* Update timestamp representing when the cache was last cleaned.
328 : : Do it at the start to reduce the number of threads trying to do a
329 : : cleanup simultaneously. */
330 : 2 : utime (interval_path, NULL);
331 : :
332 : : /* Read max unused age value from config file. */
333 : 2 : rc = debuginfod_config_cache(c, max_unused_path,
334 : : cache_default_max_unused_age_s, &st);
335 [ + - ]: 2 : if (rc < 0)
336 : : return rc;
337 : 2 : max_unused_age = (time_t)rc;
338 : :
339 : 2 : char * const dirs[] = { cache_path, NULL, };
340 : :
341 : 2 : FTS *fts = fts_open(dirs, 0, NULL);
342 [ - + ]: 2 : if (fts == NULL)
343 : 0 : return -errno;
344 : :
345 : 2 : regex_t re;
346 : 2 : const char * pattern = ".*/[a-f0-9]+(/debuginfo|/executable|/source.*|)$"; /* include dirs */
347 [ + - ]: 2 : if (regcomp (&re, pattern, REG_EXTENDED | REG_NOSUB) != 0)
348 : : return -ENOMEM;
349 : :
350 : 2 : FTSENT *f;
351 : 2 : long files = 0;
352 : 2 : time_t now = time(NULL);
353 [ + + ]: 24 : while ((f = fts_read(fts)) != NULL)
354 : : {
355 : : /* ignore any files that do not match the pattern. */
356 [ + + ]: 20 : if (regexec (&re, f->fts_path, 0, NULL, 0) != 0)
357 : 16 : continue;
358 : :
359 : 4 : files++;
360 [ - + ]: 4 : if (c->progressfn) /* inform/check progress callback */
361 [ # # ]: 0 : if ((c->progressfn) (c, files, 0))
362 : : break;
363 : :
364 [ + - + ]: 4 : switch (f->fts_info)
365 : : {
366 : 0 : case FTS_F:
367 : : /* delete file if max_unused_age has been met or exceeded w.r.t. atime. */
368 [ # # ]: 0 : if (now - f->fts_statp->st_atime >= max_unused_age)
369 : 0 : (void) unlink (f->fts_path);
370 : : break;
371 : :
372 : 2 : case FTS_DP:
373 : : /* Remove if old & empty. Weaken race against concurrent creation by
374 : : checking mtime. */
375 [ - + ]: 2 : if (now - f->fts_statp->st_mtime >= max_unused_age)
376 : 2 : (void) rmdir (f->fts_path);
377 : : break;
378 : :
379 : : default:
380 : 22 : ;
381 : : }
382 : : }
383 : 2 : fts_close (fts);
384 : 2 : regfree (&re);
385 : :
386 : 2 : return 0;
387 : : }
388 : :
389 : :
390 : : #define MAX_BUILD_ID_BYTES 64
391 : :
392 : :
393 : : static void
394 : 898 : add_default_headers(debuginfod_client *client)
395 : : {
396 [ + + ]: 898 : if (client->user_agent_set_p)
397 : 548 : return;
398 : :
399 : : /* Compute a User-Agent: string to send. The more accurately this
400 : : describes this host, the likelier that the debuginfod servers
401 : : might be able to locate debuginfo for us. */
402 : :
403 : 350 : char* utspart = NULL;
404 : 350 : struct utsname uts;
405 : 350 : int rc = 0;
406 : 350 : rc = uname (&uts);
407 [ + - ]: 350 : if (rc == 0)
408 : 350 : rc = asprintf(& utspart, "%s/%s", uts.sysname, uts.machine);
409 [ - + ]: 350 : if (rc < 0)
410 : 0 : utspart = NULL;
411 : :
412 : 350 : FILE *f = fopen ("/etc/os-release", "r");
413 [ - + ]: 350 : if (f == NULL)
414 : 0 : f = fopen ("/usr/lib/os-release", "r");
415 : 350 : char *id = NULL;
416 : 350 : char *version = NULL;
417 [ + - ]: 350 : if (f != NULL)
418 : : {
419 [ + + ]: 2450 : while (id == NULL || version == NULL)
420 : : {
421 : 2100 : char buf[128];
422 : 2100 : char *s = &buf[0];
423 [ + - ]: 2100 : if (fgets (s, sizeof(buf), f) == NULL)
424 : : break;
425 : :
426 : 2100 : int len = strlen (s);
427 [ - + ]: 2100 : if (len < 3)
428 : 0 : continue;
429 [ + - ]: 2100 : if (s[len - 1] == '\n')
430 : : {
431 : 2100 : s[len - 1] = '\0';
432 : 2100 : len--;
433 : : }
434 : :
435 : 2100 : char *v = strchr (s, '=');
436 [ + - - + ]: 2100 : if (v == NULL || strlen (v) < 2)
437 : 0 : continue;
438 : :
439 : : /* Split var and value. */
440 : 2100 : *v = '\0';
441 : 2100 : v++;
442 : :
443 : : /* Remove optional quotes around value string. */
444 [ + + ]: 2100 : if (*v == '"' || *v == '\'')
445 : : {
446 : 1400 : v++;
447 : 1400 : s[len - 1] = '\0';
448 : : }
449 [ + + ]: 2100 : if (strcmp (s, "ID") == 0)
450 : 350 : id = strdup (v);
451 [ + + ]: 2100 : if (strcmp (s, "VERSION_ID") == 0)
452 : 350 : version = strdup (v);
453 : : }
454 : 350 : fclose (f);
455 : : }
456 : :
457 : 350 : char *ua = NULL;
458 [ + - + - ]: 700 : rc = asprintf(& ua, "User-Agent: %s/%s,%s,%s/%s",
459 : : PACKAGE_NAME, PACKAGE_VERSION,
460 [ - + ]: 350 : utspart ?: "",
461 : : id ?: "",
462 : : version ?: "");
463 [ - + ]: 350 : if (rc < 0)
464 : 0 : ua = NULL;
465 : :
466 [ + - ]: 350 : if (ua)
467 : 350 : (void) debuginfod_add_http_header (client, ua);
468 : :
469 : 350 : free (ua);
470 : 350 : free (id);
471 : 350 : free (version);
472 : 350 : free (utspart);
473 : : }
474 : :
475 : : /* Add HTTP headers found in the given file, one per line. Blank lines or invalid
476 : : * headers are ignored.
477 : : */
478 : : static void
479 : 0 : add_headers_from_file(debuginfod_client *client, const char* filename)
480 : : {
481 : 0 : int vds = client->verbose_fd;
482 : 0 : FILE *f = fopen (filename, "r");
483 [ # # ]: 0 : if (f == NULL)
484 : : {
485 [ # # ]: 0 : if (vds >= 0)
486 : 0 : dprintf(vds, "header file %s: %s\n", filename, strerror(errno));
487 : 0 : return;
488 : : }
489 : :
490 : 0 : while (1)
491 : 0 : {
492 : 0 : char buf[8192];
493 : 0 : char *s = &buf[0];
494 [ # # ]: 0 : if (feof(f))
495 : : break;
496 [ # # ]: 0 : if (fgets (s, sizeof(buf), f) == NULL)
497 : : break;
498 [ # # ]: 0 : for (char *c = s; *c != '\0'; ++c)
499 [ # # ]: 0 : if (!isspace(*c))
500 : 0 : goto nonempty;
501 : 0 : continue;
502 : 0 : nonempty:
503 : 0 : ;
504 : 0 : size_t last = strlen(s)-1;
505 [ # # ]: 0 : if (s[last] == '\n')
506 : 0 : s[last] = '\0';
507 : 0 : int rc = debuginfod_add_http_header(client, s);
508 [ # # ]: 0 : if (rc < 0 && vds >= 0)
509 : 0 : dprintf(vds, "skipping bad header: %s\n", strerror(-rc));
510 : : }
511 : 0 : fclose (f);
512 : : }
513 : :
514 : :
515 : : #define xalloc_str(p, fmt, args...) \
516 : : do \
517 : : { \
518 : : if (asprintf (&p, fmt, args) < 0) \
519 : : { \
520 : : p = NULL; \
521 : : rc = -ENOMEM; \
522 : : goto out; \
523 : : } \
524 : : } while (0)
525 : :
526 : :
527 : : /* Offer a basic form of progress tracing */
528 : : static int
529 : 4 : default_progressfn (debuginfod_client *c, long a, long b)
530 : : {
531 : 4 : const char* url = debuginfod_get_url (c);
532 : 4 : int len = 0;
533 : :
534 : : /* We prefer to print the host part of the URL to keep the
535 : : message short. */
536 : 4 : if (url != NULL)
537 : : {
538 : 2 : const char* buildid = strstr(url, "buildid/");
539 [ + - ]: 2 : if (buildid != NULL)
540 : 2 : len = (buildid - url);
541 : : else
542 : 0 : len = strlen(url);
543 : : }
544 : :
545 [ + + ]: 4 : if (b == 0 || url==NULL) /* early stage */
546 : 6 : dprintf(STDERR_FILENO,
547 : 2 : "\rDownloading %c", "-/|\\"[a % 4]);
548 [ - + ]: 2 : else if (b < 0) /* download in progress but unknown total length */
549 : 0 : dprintf(STDERR_FILENO,
550 : : "\rDownloading from %.*s %ld",
551 : : len, url, a);
552 : : else /* download in progress, and known total length */
553 : 2 : dprintf(STDERR_FILENO,
554 : : "\rDownloading from %.*s %ld/%ld",
555 : : len, url, a, b);
556 : 4 : c->default_progressfn_printed_p = 1;
557 : :
558 : 4 : return 0;
559 : : }
560 : :
561 : : /* This is a callback function that receives http response headers in buffer for use
562 : : * in this program. https://curl.se/libcurl/c/CURLOPT_HEADERFUNCTION.html is the
563 : : * online documentation.
564 : : */
565 : : static size_t
566 : 2591 : header_callback (char * buffer, size_t size, size_t numitems, void * userdata)
567 : : {
568 : 2591 : struct handle_data *data = (struct handle_data *) userdata;
569 [ - + ]: 2591 : if (size != 1)
570 : : return 0;
571 [ + - ]: 2591 : if (data->client
572 [ + + ]: 2591 : && data->client->verbose_fd >= 0
573 [ + + ]: 222 : && numitems > 2)
574 : 194 : dprintf (data->client->verbose_fd, "header %.*s", (int)numitems, buffer);
575 : : // Some basic checks to ensure the headers received are of the expected format
576 [ + + ]: 2591 : if (strncasecmp(buffer, "X-DEBUGINFOD", 11)
577 [ + + ]: 648 : || buffer[numitems-2] != '\r'
578 [ + - ]: 646 : || buffer[numitems-1] != '\n'
579 [ - + ]: 646 : || (buffer == strstr(buffer, ":")) ){
580 : : return numitems;
581 : : }
582 : : /* Temporary buffer for realloc */
583 : 646 : char *temp = NULL;
584 [ + + ]: 646 : if (data->response_data == NULL)
585 : : {
586 : 240 : temp = malloc(numitems);
587 [ - + ]: 240 : if (temp == NULL)
588 : : return 0;
589 : : }
590 : : else
591 : : {
592 : 406 : temp = realloc(data->response_data, data->response_data_size + numitems);
593 [ - + ]: 406 : if (temp == NULL)
594 : : return 0;
595 : : }
596 : :
597 : 646 : memcpy(temp + data->response_data_size, buffer, numitems-1);
598 : 646 : data->response_data = temp;
599 : 646 : data->response_data_size += numitems-1;
600 : 646 : data->response_data[data->response_data_size-1] = '\n';
601 : 646 : data->response_data[data->response_data_size] = '\0';
602 : 646 : return numitems;
603 : : }
604 : :
605 : : /* Copy SRC to DEST, s,/,#,g */
606 : :
607 : : static void
608 : 84 : path_escape (const char *src, char *dest)
609 : : {
610 : 84 : unsigned q = 0;
611 : :
612 [ + - ]: 2990 : for (unsigned fi=0; q < PATH_MAX-2; fi++) /* -2, escape is 2 chars. */
613 [ + + + + ]: 2990 : switch (src[fi])
614 : : {
615 : 84 : case '\0':
616 : 84 : dest[q] = '\0';
617 : 84 : return;
618 : 392 : case '/': /* escape / to prevent dir escape */
619 : 392 : dest[q++]='#';
620 : 392 : dest[q++]='#';
621 : 392 : break;
622 : 2 : case '#': /* escape # to prevent /# vs #/ collisions */
623 : 2 : dest[q++]='#';
624 : 2 : dest[q++]='_';
625 : 2 : break;
626 : 2512 : default:
627 : 2512 : dest[q++]=src[fi];
628 : : }
629 : :
630 : 0 : dest[q] = '\0';
631 : : }
632 : :
633 : : /* Attempt to update the atime */
634 : : static void
635 : 78 : update_atime (int fd)
636 : : {
637 : 78 : struct timespec tvs[2];
638 : :
639 : 78 : tvs[0].tv_sec = tvs[1].tv_sec = 0;
640 : 78 : tvs[0].tv_nsec = UTIME_NOW;
641 : 78 : tvs[1].tv_nsec = UTIME_OMIT;
642 : :
643 : 78 : (void) futimens (fd, tvs); /* best effort */
644 : 78 : }
645 : :
646 : : /* Attempt to read an ELF/DWARF section with name SECTION from FD and write
647 : : it to a separate file in the debuginfod cache. If successful the absolute
648 : : path of the separate file containing SECTION will be stored in USR_PATH.
649 : : FD_PATH is the absolute path for FD.
650 : :
651 : : If the section cannot be extracted, then return a negative error code.
652 : : -ENOENT indicates that the parent file was able to be read but the
653 : : section name was not found. -EEXIST indicates that the section was
654 : : found but had type SHT_NOBITS. */
655 : :
656 : : static int
657 : 12 : extract_section (int fd, const char *section, char *fd_path, char **usr_path)
658 : : {
659 : 12 : elf_version (EV_CURRENT);
660 : :
661 : 12 : Elf *elf = elf_begin (fd, ELF_C_READ_MMAP_PRIVATE, NULL);
662 [ + - ]: 12 : if (elf == NULL)
663 : : return -EIO;
664 : :
665 : 12 : size_t shstrndx;
666 : 12 : int rc = elf_getshdrstrndx (elf, &shstrndx);
667 [ - + ]: 12 : if (rc < 0)
668 : : {
669 : 0 : rc = -EIO;
670 : 0 : goto out;
671 : : }
672 : :
673 : 12 : int sec_fd = -1;
674 : 12 : char *escaped_name = NULL;
675 : 12 : char *sec_path_tmp = NULL;
676 : 12 : Elf_Scn *scn = NULL;
677 : :
678 : : /* Try to find the target section and copy the contents into a
679 : : separate file. */
680 : 432 : while (true)
681 : 210 : {
682 : 222 : scn = elf_nextscn (elf, scn);
683 [ - + ]: 222 : if (scn == NULL)
684 : : {
685 : 0 : rc = -ENOENT;
686 : 4 : goto out;
687 : : }
688 : 222 : GElf_Shdr shdr_storage;
689 : 222 : GElf_Shdr *shdr = gelf_getshdr (scn, &shdr_storage);
690 [ - + ]: 222 : if (shdr == NULL)
691 : : {
692 : 0 : rc = -EIO;
693 : 0 : goto out;
694 : : }
695 : :
696 : 222 : const char *scn_name = elf_strptr (elf, shstrndx, shdr->sh_name);
697 [ - + ]: 222 : if (scn_name == NULL)
698 : : {
699 : 0 : rc = -EIO;
700 : 0 : goto out;
701 : : }
702 [ + + ]: 222 : if (strcmp (scn_name, section) == 0)
703 : : {
704 : : /* We found the desired section. */
705 [ + + ]: 12 : if (shdr->sh_type == SHT_NOBITS)
706 : : {
707 : 4 : rc = -EEXIST;
708 : 4 : goto out;
709 : : }
710 : :
711 : 8 : Elf_Data *data = NULL;
712 : 8 : data = elf_rawdata (scn, NULL);
713 [ - + ]: 8 : if (data == NULL)
714 : : {
715 : 0 : rc = -EIO;
716 : 0 : goto out;
717 : : }
718 : :
719 [ - + ]: 8 : if (data->d_buf == NULL)
720 : : {
721 : 0 : rc = -EIO;
722 : 0 : goto out;
723 : : }
724 : :
725 : : /* Compute the absolute filename we'll write the section to.
726 : : Replace the last component of FD_PATH with the path-escaped
727 : : section filename. */
728 : 8 : int i = strlen (fd_path);
729 [ + - ]: 92 : while (i >= 0)
730 : : {
731 [ + + ]: 92 : if (fd_path[i] == '/')
732 : : {
733 : 8 : fd_path[i] = '\0';
734 : 8 : break;
735 : : }
736 : 84 : --i;
737 : : }
738 : :
739 : 8 : escaped_name = malloc (strlen (section) * 2 + 1);
740 [ - + ]: 8 : if (escaped_name == NULL)
741 : : {
742 : 0 : rc = -ENOMEM;
743 : 0 : goto out;
744 : : }
745 : 8 : path_escape (section, escaped_name);
746 : :
747 : 8 : rc = asprintf (&sec_path_tmp, "%s/section-%s.XXXXXX",
748 : : fd_path, escaped_name);
749 [ - + ]: 8 : if (rc == -1)
750 : : {
751 : 0 : rc = -ENOMEM;
752 : 0 : goto out1;
753 : : }
754 : :
755 : 8 : sec_fd = mkstemp (sec_path_tmp);
756 [ - + ]: 8 : if (sec_fd < 0)
757 : : {
758 : 0 : rc = -EIO;
759 : 8 : goto out2;
760 : : }
761 : :
762 : 8 : ssize_t res = write_retry (sec_fd, data->d_buf, data->d_size);
763 [ + - - + ]: 8 : if (res < 0 || (size_t) res != data->d_size)
764 : : {
765 : 0 : rc = -EIO;
766 : 0 : goto out3;
767 : : }
768 : :
769 : : /* Success. Rename tmp file and update USR_PATH. */
770 : 8 : char *sec_path;
771 [ - + ]: 8 : if (asprintf (&sec_path, "%s/section-%s", fd_path, section) == -1)
772 : : {
773 : 0 : rc = -ENOMEM;
774 : 0 : goto out3;
775 : : }
776 : :
777 : 8 : rc = rename (sec_path_tmp, sec_path);
778 [ - + ]: 8 : if (rc < 0)
779 : : {
780 : 0 : free (sec_path);
781 : 0 : rc = -EIO;
782 : 0 : goto out3;
783 : : }
784 : :
785 [ + - ]: 8 : if (usr_path != NULL)
786 : 8 : *usr_path = sec_path;
787 : : else
788 : 0 : free (sec_path);
789 : 8 : update_atime(fd);
790 : 8 : rc = sec_fd;
791 : 8 : goto out2;
792 : : }
793 : : }
794 : :
795 : 0 : out3:
796 : 0 : close (sec_fd);
797 : 0 : unlink (sec_path_tmp);
798 : :
799 : 8 : out2:
800 : 8 : free (sec_path_tmp);
801 : :
802 : 8 : out1:
803 : 8 : free (escaped_name);
804 : :
805 : 12 : out:
806 : 12 : elf_end (elf);
807 : 12 : return rc;
808 : : }
809 : :
810 : : /* Search TARGET_CACHE_DIR for a debuginfo or executable file containing
811 : : an ELF/DWARF section with name SCN_NAME. If found, extract the section
812 : : to a separate file in TARGET_CACHE_DIR and return a file descriptor
813 : : for the section file. The path for this file will be stored in USR_PATH.
814 : : Return a negative errno if unsuccessful. -ENOENT indicates that SCN_NAME
815 : : is confirmed to not exist. */
816 : :
817 : : static int
818 : 16 : cache_find_section (const char *scn_name, const char *target_cache_dir,
819 : : char **usr_path)
820 : : {
821 : 16 : int debug_fd;
822 : 16 : int rc = -EEXIST;
823 : 16 : char parent_path[PATH_MAX];
824 : :
825 : : /* Check the debuginfo first. */
826 : 16 : snprintf (parent_path, PATH_MAX, "%s/debuginfo", target_cache_dir);
827 : 16 : debug_fd = open (parent_path, O_RDONLY);
828 [ + + ]: 16 : if (debug_fd >= 0)
829 : : {
830 : 8 : rc = extract_section (debug_fd, scn_name, parent_path, usr_path);
831 : 8 : close (debug_fd);
832 : : }
833 : :
834 : : /* If the debuginfo file couldn't be found or the section type was
835 : : SHT_NOBITS, check the executable. */
836 [ + + ]: 8 : if (rc == -EEXIST)
837 : : {
838 : 12 : snprintf (parent_path, PATH_MAX, "%s/executable", target_cache_dir);
839 : 12 : int exec_fd = open (parent_path, O_RDONLY);
840 : :
841 [ + + ]: 12 : if (exec_fd >= 0)
842 : : {
843 : 4 : rc = extract_section (exec_fd, scn_name, parent_path, usr_path);
844 : 4 : close (exec_fd);
845 : :
846 : : /* Don't return -ENOENT if the debuginfo wasn't opened. The
847 : : section may exist in the debuginfo but not the executable. */
848 [ - + ]: 4 : if (debug_fd < 0 && rc == -ENOENT)
849 : 0 : rc = -EREMOTE;
850 : : }
851 : : }
852 : :
853 : 16 : return rc;
854 : : }
855 : :
856 : : /* Query each of the server URLs found in $DEBUGINFOD_URLS for the file
857 : : with the specified build-id and type (debuginfo, executable, source or
858 : : section). If type is source, then type_arg should be a filename. If
859 : : type is section, then type_arg should be the name of an ELF/DWARF
860 : : section. Otherwise type_arg may be NULL. Return a file descriptor
861 : : for the target if successful, otherwise return an error code.
862 : : */
863 : : static int
864 : 968 : debuginfod_query_server (debuginfod_client *c,
865 : : const unsigned char *build_id,
866 : : int build_id_len,
867 : : const char *type,
868 : : const char *type_arg,
869 : : char **path)
870 : : {
871 : 968 : char *server_urls;
872 : 968 : char *urls_envvar;
873 : 968 : const char *section = NULL;
874 : 968 : const char *filename = NULL;
875 : 968 : char *cache_path = NULL;
876 : 968 : char *maxage_path = NULL;
877 : 968 : char *interval_path = NULL;
878 : 968 : char *cache_miss_path = NULL;
879 : 968 : char *target_cache_dir = NULL;
880 : 968 : char *target_cache_path = NULL;
881 : 968 : char *target_cache_tmppath = NULL;
882 : 968 : char suffix[PATH_MAX + 1]; /* +1 for zero terminator. */
883 : 968 : char build_id_bytes[MAX_BUILD_ID_BYTES * 2 + 1];
884 : 968 : int vfd = c->verbose_fd;
885 : 968 : int rc;
886 : :
887 : 968 : c->progressfn_cancel = false;
888 : :
889 [ + + ]: 968 : if (strcmp (type, "source") == 0)
890 : : filename = type_arg;
891 [ + + ]: 904 : else if (strcmp (type, "section") == 0)
892 : : {
893 : 16 : section = type_arg;
894 [ + - ]: 16 : if (section == NULL)
895 : : return -EINVAL;
896 : : }
897 : :
898 [ + + ]: 968 : if (vfd >= 0)
899 : : {
900 : 36 : dprintf (vfd, "debuginfod_find_%s ", type);
901 [ + + ]: 36 : if (build_id_len == 0) /* expect clean hexadecimal */
902 : 26 : dprintf (vfd, "%s", (const char *) build_id);
903 : : else
904 [ + + ]: 210 : for (int i = 0; i < build_id_len; i++)
905 : 200 : dprintf (vfd, "%02x", build_id[i]);
906 [ + + ]: 36 : if (filename != NULL)
907 : 2 : dprintf (vfd, " %s\n", filename);
908 : 36 : dprintf (vfd, "\n");
909 : : }
910 : :
911 : : /* Is there any server we can query? If not, don't do any work,
912 : : just return with ENOSYS. Don't even access the cache. */
913 : 968 : urls_envvar = getenv(DEBUGINFOD_URLS_ENV_VAR);
914 [ + + ]: 968 : if (vfd >= 0)
915 [ - + ]: 36 : dprintf (vfd, "server urls \"%s\"\n",
916 : : urls_envvar != NULL ? urls_envvar : "");
917 [ + + + + ]: 968 : if (urls_envvar == NULL || urls_envvar[0] == '\0')
918 : : {
919 : 70 : rc = -ENOSYS;
920 : 70 : goto out;
921 : : }
922 : :
923 : : /* Clear the obsolete data from a previous _find operation. */
924 : 898 : free (c->url);
925 : 898 : c->url = NULL;
926 : 898 : free (c->winning_headers);
927 : 898 : c->winning_headers = NULL;
928 : :
929 : : /* PR 27982: Add max size if DEBUGINFOD_MAXSIZE is set. */
930 : 898 : long maxsize = 0;
931 : 898 : const char *maxsize_envvar;
932 : 898 : maxsize_envvar = getenv(DEBUGINFOD_MAXSIZE_ENV_VAR);
933 [ + + ]: 898 : if (maxsize_envvar != NULL)
934 : 2 : maxsize = atol (maxsize_envvar);
935 : :
936 : : /* PR 27982: Add max time if DEBUGINFOD_MAXTIME is set. */
937 : 898 : long maxtime = 0;
938 : 898 : const char *maxtime_envvar;
939 : 898 : maxtime_envvar = getenv(DEBUGINFOD_MAXTIME_ENV_VAR);
940 [ + + ]: 898 : if (maxtime_envvar != NULL)
941 : 2 : maxtime = atol (maxtime_envvar);
942 [ + + ]: 898 : if (maxtime && vfd >= 0)
943 : 2 : dprintf(vfd, "using max time %lds\n", maxtime);
944 : :
945 : 898 : const char *headers_file_envvar;
946 : 898 : headers_file_envvar = getenv(DEBUGINFOD_HEADERS_FILE_ENV_VAR);
947 [ - + ]: 898 : if (headers_file_envvar != NULL)
948 : 0 : add_headers_from_file(c, headers_file_envvar);
949 : :
950 : : /* Maxsize is valid*/
951 [ + + ]: 898 : if (maxsize > 0)
952 : : {
953 [ + - ]: 2 : if (vfd)
954 : 2 : dprintf (vfd, "using max size %ldB\n", maxsize);
955 : 2 : char *size_header = NULL;
956 : 2 : rc = asprintf (&size_header, "X-DEBUGINFOD-MAXSIZE: %ld", maxsize);
957 [ - + ]: 2 : if (rc < 0)
958 : : {
959 : 0 : rc = -ENOMEM;
960 : 0 : goto out;
961 : : }
962 : 2 : rc = debuginfod_add_http_header(c, size_header);
963 : 2 : free(size_header);
964 [ - + ]: 2 : if (rc < 0)
965 : 0 : goto out;
966 : : }
967 : 898 : add_default_headers(c);
968 : :
969 : : /* Copy lowercase hex representation of build_id into buf. */
970 [ + + ]: 898 : if (vfd >= 0)
971 : 36 : dprintf (vfd, "checking build-id\n");
972 [ + - + + ]: 898 : if ((build_id_len >= MAX_BUILD_ID_BYTES) ||
973 : 886 : (build_id_len == 0 &&
974 [ - + ]: 886 : strlen ((const char *) build_id) > MAX_BUILD_ID_BYTES*2))
975 : : {
976 : 0 : rc = -EINVAL;
977 : 0 : goto out;
978 : : }
979 : :
980 [ + + ]: 898 : if (build_id_len == 0) /* expect clean hexadecimal */
981 : 886 : strcpy (build_id_bytes, (const char *) build_id);
982 : : else
983 [ + + ]: 252 : for (int i = 0; i < build_id_len; i++)
984 : 240 : sprintf(build_id_bytes + (i * 2), "%02x", build_id[i]);
985 : :
986 [ + + ]: 898 : if (filename != NULL)
987 : : {
988 [ + + ]: 60 : if (vfd >= 0)
989 : 2 : dprintf (vfd, "checking filename\n");
990 [ - + ]: 60 : if (filename[0] != '/') // must start with /
991 : : {
992 : 0 : rc = -EINVAL;
993 : 0 : goto out;
994 : : }
995 : :
996 : 60 : path_escape (filename, suffix);
997 : : /* If the DWARF filenames are super long, this could exceed
998 : : PATH_MAX and truncate/collide. Oh well, that'll teach
999 : : them! */
1000 : : }
1001 [ + + ]: 838 : else if (section != NULL)
1002 : 16 : path_escape (section, suffix);
1003 : : else
1004 : 822 : suffix[0] = '\0';
1005 : :
1006 [ + + + + ]: 898 : if (suffix[0] != '\0' && vfd >= 0)
1007 : 18 : dprintf (vfd, "suffix %s\n", suffix);
1008 : :
1009 : : /* set paths needed to perform the query
1010 : :
1011 : : example format
1012 : : cache_path: $HOME/.cache
1013 : : target_cache_dir: $HOME/.cache/0123abcd
1014 : : target_cache_path: $HOME/.cache/0123abcd/debuginfo
1015 : : target_cache_path: $HOME/.cache/0123abcd/source#PATH#TO#SOURCE ?
1016 : :
1017 : : $XDG_CACHE_HOME takes priority over $HOME/.cache.
1018 : : $DEBUGINFOD_CACHE_PATH takes priority over $HOME/.cache and $XDG_CACHE_HOME.
1019 : : */
1020 : :
1021 : : /* Determine location of the cache. The path specified by the debuginfod
1022 : : cache environment variable takes priority. */
1023 : 898 : char *cache_var = getenv(DEBUGINFOD_CACHE_PATH_ENV_VAR);
1024 [ + - + + ]: 898 : if (cache_var != NULL && strlen (cache_var) > 0)
1025 [ - + ]: 890 : xalloc_str (cache_path, "%s", cache_var);
1026 : : else
1027 : : {
1028 : : /* If a cache already exists in $HOME ('/' if $HOME isn't set), then use
1029 : : that. Otherwise use the XDG cache directory naming format. */
1030 [ - + - + ]: 16 : xalloc_str (cache_path, "%s/%s", getenv ("HOME") ?: "/", cache_default_name);
1031 : :
1032 : 8 : struct stat st;
1033 [ + + ]: 8 : if (stat (cache_path, &st) < 0)
1034 : : {
1035 : 6 : char cachedir[PATH_MAX];
1036 : 6 : char *xdg = getenv ("XDG_CACHE_HOME");
1037 : :
1038 [ + - + + ]: 6 : if (xdg != NULL && strlen (xdg) > 0)
1039 : 2 : snprintf (cachedir, PATH_MAX, "%s", xdg);
1040 : : else
1041 [ - + ]: 4 : snprintf (cachedir, PATH_MAX, "%s/.cache", getenv ("HOME") ?: "/");
1042 : :
1043 : : /* Create XDG cache directory if it doesn't exist. */
1044 [ + + ]: 6 : if (stat (cachedir, &st) == 0)
1045 : : {
1046 [ - + ]: 2 : if (! S_ISDIR (st.st_mode))
1047 : : {
1048 : 0 : rc = -EEXIST;
1049 : 0 : goto out;
1050 : : }
1051 : : }
1052 : : else
1053 : : {
1054 : 4 : rc = mkdir (cachedir, 0700);
1055 : :
1056 : : /* Also check for EEXIST and S_ISDIR in case another client just
1057 : : happened to create the cache. */
1058 [ - + ]: 4 : if (rc < 0
1059 [ # # ]: 0 : && (errno != EEXIST
1060 [ # # ]: 0 : || stat (cachedir, &st) != 0
1061 [ # # ]: 0 : || ! S_ISDIR (st.st_mode)))
1062 : : {
1063 : 0 : rc = -errno;
1064 : 0 : goto out;
1065 : : }
1066 : : }
1067 : :
1068 : 6 : free (cache_path);
1069 [ - + ]: 6 : xalloc_str (cache_path, "%s/%s", cachedir, cache_xdg_name);
1070 : : }
1071 : : }
1072 : :
1073 [ - + ]: 898 : xalloc_str (target_cache_dir, "%s/%s", cache_path, build_id_bytes);
1074 [ + + ]: 898 : if (section != NULL)
1075 [ - + ]: 16 : xalloc_str (target_cache_path, "%s/%s-%s", target_cache_dir, type, suffix);
1076 : : else
1077 [ - + ]: 882 : xalloc_str (target_cache_path, "%s/%s%s", target_cache_dir, type, suffix);
1078 [ - + ]: 898 : xalloc_str (target_cache_tmppath, "%s.XXXXXX", target_cache_path);
1079 : :
1080 : : /* XXX combine these */
1081 [ - + ]: 898 : xalloc_str (interval_path, "%s/%s", cache_path, cache_clean_interval_filename);
1082 [ - + ]: 898 : xalloc_str (cache_miss_path, "%s/%s", cache_path, cache_miss_filename);
1083 [ - + ]: 898 : xalloc_str (maxage_path, "%s/%s", cache_path, cache_max_unused_age_filename);
1084 : :
1085 [ + + ]: 898 : if (vfd >= 0)
1086 : 36 : dprintf (vfd, "checking cache dir %s\n", cache_path);
1087 : :
1088 : : /* Make sure cache dir exists. debuginfo_clean_cache will then make
1089 : : sure the interval, cache_miss and maxage files exist. */
1090 [ + + ]: 898 : if (mkdir (cache_path, ACCESSPERMS) != 0
1091 [ - + ]: 838 : && errno != EEXIST)
1092 : : {
1093 : 0 : rc = -errno;
1094 : 0 : goto out;
1095 : : }
1096 : :
1097 : 898 : rc = debuginfod_clean_cache(c, cache_path, interval_path, maxage_path);
1098 [ - + ]: 898 : if (rc != 0)
1099 : 0 : goto out;
1100 : :
1101 : : /* Check if the target is already in the cache. */
1102 : 898 : int fd = open(target_cache_path, O_RDONLY);
1103 [ + + ]: 898 : if (fd >= 0)
1104 : : {
1105 : 74 : struct stat st;
1106 [ - + ]: 74 : if (fstat(fd, &st) != 0)
1107 : : {
1108 : 0 : rc = -errno;
1109 : 0 : close (fd);
1110 : 72 : goto out;
1111 : : }
1112 : :
1113 : : /* If the file is non-empty, then we are done. */
1114 [ + + ]: 74 : if (st.st_size > 0)
1115 : : {
1116 [ + - ]: 70 : if (path != NULL)
1117 : : {
1118 : 70 : *path = strdup(target_cache_path);
1119 [ - + ]: 70 : if (*path == NULL)
1120 : : {
1121 : 0 : rc = -errno;
1122 : 0 : close (fd);
1123 : 0 : goto out;
1124 : : }
1125 : : }
1126 : : /* Success!!!! */
1127 : 70 : update_atime(fd);
1128 : 70 : rc = fd;
1129 : 70 : goto out;
1130 : : }
1131 : : else
1132 : : {
1133 : : /* The file is empty. Attempt to download only if enough time
1134 : : has passed since the last attempt. */
1135 : 4 : time_t cache_miss;
1136 : 4 : time_t target_mtime = st.st_mtime;
1137 : :
1138 : 4 : close(fd); /* no need to hold onto the negative-hit file descriptor */
1139 : :
1140 : 4 : rc = debuginfod_config_cache(c, cache_miss_path,
1141 : : cache_miss_default_s, &st);
1142 [ - + ]: 4 : if (rc < 0)
1143 : 0 : goto out;
1144 : :
1145 : 4 : cache_miss = (time_t)rc;
1146 [ + + ]: 4 : if (time(NULL) - target_mtime <= cache_miss)
1147 : : {
1148 : 2 : rc = -ENOENT;
1149 : 2 : goto out;
1150 : : }
1151 : : else
1152 : : /* TOCTOU non-problem: if another task races, puts a working
1153 : : download or an empty file in its place, unlinking here just
1154 : : means WE will try to download again as uncached. */
1155 : 2 : unlink(target_cache_path);
1156 : : }
1157 : : }
1158 [ - + ]: 824 : else if (errno == EACCES)
1159 : : /* Ensure old 000-permission files are not lingering in the cache. */
1160 : 0 : unlink(target_cache_path);
1161 : :
1162 [ + + ]: 826 : if (section != NULL)
1163 : : {
1164 : : /* Try to extract the section from a cached file before querying
1165 : : any servers. */
1166 : 16 : rc = cache_find_section (section, target_cache_dir, path);
1167 : :
1168 : : /* If the section was found or confirmed to not exist, then we
1169 : : are done. */
1170 [ + + ]: 16 : if (rc >= 0 || rc == -ENOENT)
1171 : 8 : goto out;
1172 : : }
1173 : :
1174 : 818 : long timeout = default_timeout;
1175 : 818 : const char* timeout_envvar = getenv(DEBUGINFOD_TIMEOUT_ENV_VAR);
1176 [ - + ]: 818 : if (timeout_envvar != NULL)
1177 : 0 : timeout = atoi (timeout_envvar);
1178 : :
1179 [ + + ]: 818 : if (vfd >= 0)
1180 : 28 : dprintf (vfd, "using timeout %ld\n", timeout);
1181 : :
1182 : : /* make a copy of the envvar so it can be safely modified. */
1183 : 818 : server_urls = strdup(urls_envvar);
1184 [ - + ]: 818 : if (server_urls == NULL)
1185 : : {
1186 : 0 : rc = -ENOMEM;
1187 : 0 : goto out;
1188 : : }
1189 : : /* thereafter, goto out0 on error*/
1190 : :
1191 : : /* Because of a race with cache cleanup / rmdir, try to mkdir/mkstemp up to twice. */
1192 [ + - ]: 818 : for(int i=0; i<2; i++) {
1193 : : /* (re)create target directory in cache */
1194 : 818 : (void) mkdir(target_cache_dir, 0700); /* files will be 0400 later */
1195 : :
1196 : : /* NB: write to a temporary file first, to avoid race condition of
1197 : : multiple clients checking the cache, while a partially-written or empty
1198 : : file is in there, being written from libcurl. */
1199 : 818 : fd = mkstemp (target_cache_tmppath);
1200 [ - + ]: 818 : if (fd >= 0) break;
1201 : : }
1202 [ - + ]: 818 : if (fd < 0) /* Still failed after two iterations. */
1203 : : {
1204 : 0 : rc = -errno;
1205 : 0 : goto out0;
1206 : : }
1207 : :
1208 : : /* Initialize the memory to zero */
1209 : 818 : char *strtok_saveptr;
1210 : 818 : char **server_url_list = NULL;
1211 : 818 : char *server_url = strtok_r(server_urls, url_delim, &strtok_saveptr);
1212 : : /* Count number of URLs. */
1213 : 818 : int num_urls = 0;
1214 : :
1215 [ + + ]: 1690 : while (server_url != NULL)
1216 : : {
1217 : : /* PR 27983: If the url is already set to be used use, skip it */
1218 : 872 : char *slashbuildid;
1219 [ + - + + ]: 872 : if (strlen(server_url) > 1 && server_url[strlen(server_url)-1] == '/')
1220 : : slashbuildid = "buildid";
1221 : : else
1222 : 812 : slashbuildid = "/buildid";
1223 : :
1224 : 872 : char *tmp_url;
1225 [ - + ]: 872 : if (asprintf(&tmp_url, "%s%s", server_url, slashbuildid) == -1)
1226 : : {
1227 : 0 : rc = -ENOMEM;
1228 : 0 : goto out1;
1229 : : }
1230 : : int url_index;
1231 [ + + ]: 994 : for (url_index = 0; url_index < num_urls; ++url_index)
1232 : : {
1233 [ + + ]: 126 : if(strcmp(tmp_url, server_url_list[url_index]) == 0)
1234 : : {
1235 : : url_index = -1;
1236 : : break;
1237 : : }
1238 : : }
1239 [ + + ]: 872 : if (url_index == -1)
1240 : : {
1241 [ + - ]: 4 : if (vfd >= 0)
1242 : 4 : dprintf(vfd, "duplicate url: %s, skipping\n", tmp_url);
1243 : 4 : free(tmp_url);
1244 : : }
1245 : : else
1246 : : {
1247 : 868 : num_urls++;
1248 : 868 : char ** realloc_ptr;
1249 : 868 : realloc_ptr = reallocarray(server_url_list, num_urls,
1250 : : sizeof(char*));
1251 [ - + ]: 868 : if (realloc_ptr == NULL)
1252 : : {
1253 : 0 : free (tmp_url);
1254 : 0 : rc = -ENOMEM;
1255 : 0 : goto out1;
1256 : : }
1257 : 868 : server_url_list = realloc_ptr;
1258 : 868 : server_url_list[num_urls-1] = tmp_url;
1259 : : }
1260 : 872 : server_url = strtok_r(NULL, url_delim, &strtok_saveptr);
1261 : : }
1262 : :
1263 : 818 : int retry_limit = default_retry_limit;
1264 : 818 : const char* retry_limit_envvar = getenv(DEBUGINFOD_RETRY_LIMIT_ENV_VAR);
1265 [ + + ]: 818 : if (retry_limit_envvar != NULL)
1266 : 4 : retry_limit = atoi (retry_limit_envvar);
1267 : :
1268 : 818 : CURLM *curlm = c->server_mhandle;
1269 [ - + ]: 818 : assert (curlm != NULL);
1270 : :
1271 : : /* Tracks which handle should write to fd. Set to the first
1272 : : handle that is ready to write the target file to the cache. */
1273 : 818 : CURL *target_handle = NULL;
1274 : 818 : struct handle_data *data = malloc(sizeof(struct handle_data) * num_urls);
1275 [ - + ]: 818 : if (data == NULL)
1276 : : {
1277 : 0 : rc = -ENOMEM;
1278 : 0 : goto out1;
1279 : : }
1280 : :
1281 : : /* thereafter, goto out2 on error. */
1282 : :
1283 : : /*The beginning of goto block query_in_parallel.*/
1284 : 818 : query_in_parallel:
1285 : 1906 : rc = -ENOENT; /* Reset rc to default.*/
1286 : :
1287 : : /* Initialize handle_data with default values. */
1288 [ + + ]: 3866 : for (int i = 0; i < num_urls; i++)
1289 : : {
1290 : 1960 : data[i].handle = NULL;
1291 : 1960 : data[i].fd = -1;
1292 : 1960 : data[i].errbuf[0] = '\0';
1293 : 1960 : data[i].response_data = NULL;
1294 : 1960 : data[i].response_data_size = 0;
1295 : : }
1296 : :
1297 : 1906 : char *escaped_string = NULL;
1298 : 1906 : size_t escaped_strlen = 0;
1299 [ + + ]: 1906 : if (filename)
1300 : : {
1301 : 58 : escaped_string = curl_easy_escape(&target_handle, filename+1, 0);
1302 [ - + ]: 58 : if (!escaped_string)
1303 : : {
1304 : 0 : rc = -ENOMEM;
1305 : 0 : goto out2;
1306 : : }
1307 : 58 : char *loc = escaped_string;
1308 : 58 : escaped_strlen = strlen(escaped_string);
1309 [ + + ]: 382 : while ((loc = strstr(loc, "%2F")))
1310 : : {
1311 : 324 : loc[0] = '/';
1312 : : //pull the string back after replacement
1313 : : // loc-escaped_string finds the distance from the origin to the new location
1314 : : // - 2 accounts for the 2F which remain and don't need to be measured.
1315 : : // The two above subtracted from escaped_strlen yields the remaining characters
1316 : : // in the string which we want to pull back
1317 : 324 : memmove(loc+1, loc+3,escaped_strlen - (loc-escaped_string) - 2);
1318 : : //Because the 2F was overwritten in the memmove (as desired) escaped_strlen is
1319 : : // now two shorter.
1320 : 324 : escaped_strlen -= 2;
1321 : : }
1322 : : }
1323 : : /* Initialize each handle. */
1324 [ + + ]: 3866 : for (int i = 0; i < num_urls; i++)
1325 : : {
1326 [ + - ]: 1960 : if ((server_url = server_url_list[i]) == NULL)
1327 : : break;
1328 [ + + ]: 1960 : if (vfd >= 0)
1329 : 58 : dprintf (vfd, "init server %d %s\n", i, server_url);
1330 : :
1331 : 1960 : data[i].fd = fd;
1332 : 1960 : data[i].target_handle = &target_handle;
1333 : 1960 : data[i].handle = curl_easy_init();
1334 [ - + ]: 1960 : if (data[i].handle == NULL)
1335 : : {
1336 [ # # ]: 0 : if (filename) curl_free (escaped_string);
1337 : 0 : rc = -ENETUNREACH;
1338 : 0 : goto out2;
1339 : : }
1340 : 1960 : data[i].client = c;
1341 : :
1342 [ + + ]: 1960 : if (filename) /* must start with / */
1343 : : {
1344 : : /* PR28034 escape characters in completed url to %hh format. */
1345 : 58 : snprintf(data[i].url, PATH_MAX, "%s/%s/%s/%s", server_url,
1346 : : build_id_bytes, type, escaped_string);
1347 : : }
1348 [ + + ]: 1902 : else if (section)
1349 : 8 : snprintf(data[i].url, PATH_MAX, "%s/%s/%s/%s", server_url,
1350 : : build_id_bytes, type, section);
1351 : : else
1352 : 1894 : snprintf(data[i].url, PATH_MAX, "%s/%s/%s", server_url, build_id_bytes, type);
1353 [ + + ]: 1960 : if (vfd >= 0)
1354 : 58 : dprintf (vfd, "url %d %s\n", i, data[i].url);
1355 : :
1356 : : /* Some boilerplate for checking curl_easy_setopt. */
1357 : : #define curl_easy_setopt_ck(H,O,P) do { \
1358 : : CURLcode curl_res = curl_easy_setopt (H,O,P); \
1359 : : if (curl_res != CURLE_OK) \
1360 : : { \
1361 : : if (vfd >= 0) \
1362 : : dprintf (vfd, \
1363 : : "Bad curl_easy_setopt: %s\n", \
1364 : : curl_easy_strerror(curl_res)); \
1365 : : rc = -EINVAL; \
1366 : : goto out2; \
1367 : : } \
1368 : : } while (0)
1369 : :
1370 : : /* Only allow http:// + https:// + file:// so we aren't being
1371 : : redirected to some unsupported protocol. */
1372 : : #if CURL_AT_LEAST_VERSION(7, 85, 0)
1373 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_PROTOCOLS_STR,
1374 : : "http,https,file");
1375 : : #else
1376 : : curl_easy_setopt_ck(data[i].handle, CURLOPT_PROTOCOLS,
1377 : : (CURLPROTO_HTTP | CURLPROTO_HTTPS | CURLPROTO_FILE));
1378 : : #endif
1379 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_URL, data[i].url);
1380 [ + + ]: 1960 : if (vfd >= 0)
1381 [ - + ]: 58 : curl_easy_setopt_ck(data[i].handle, CURLOPT_ERRORBUFFER,
1382 : : data[i].errbuf);
1383 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle,
1384 : : CURLOPT_WRITEFUNCTION,
1385 : : debuginfod_write_callback);
1386 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_WRITEDATA, (void*)&data[i]);
1387 [ + - ]: 1960 : if (timeout > 0)
1388 : : {
1389 : : /* Make sure there is at least some progress,
1390 : : try to get at least 100K per timeout seconds. */
1391 [ - + - - ]: 1960 : curl_easy_setopt_ck (data[i].handle, CURLOPT_LOW_SPEED_TIME,
1392 : : timeout);
1393 [ - + - - ]: 1960 : curl_easy_setopt_ck (data[i].handle, CURLOPT_LOW_SPEED_LIMIT,
1394 : : 100 * 1024L);
1395 : : }
1396 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_FILETIME, (long) 1);
1397 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_FOLLOWLOCATION, (long) 1);
1398 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_FAILONERROR, (long) 1);
1399 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_NOSIGNAL, (long) 1);
1400 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_HEADERFUNCTION,
1401 : : header_callback);
1402 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_HEADERDATA,
1403 : : (void *) &(data[i]));
1404 : : #if LIBCURL_VERSION_NUM >= 0x072a00 /* 7.42.0 */
1405 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_PATH_AS_IS, (long) 1);
1406 : : #else
1407 : : /* On old curl; no big deal, canonicalization here is almost the
1408 : : same, except perhaps for ? # type decorations at the tail. */
1409 : : #endif
1410 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_AUTOREFERER, (long) 1);
1411 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_ACCEPT_ENCODING, "");
1412 [ - + - - ]: 1960 : curl_easy_setopt_ck(data[i].handle, CURLOPT_HTTPHEADER, c->headers);
1413 : :
1414 : 1960 : curl_multi_add_handle(curlm, data[i].handle);
1415 : : }
1416 : :
1417 [ + + ]: 1906 : if (filename) curl_free(escaped_string);
1418 : : /* Query servers in parallel. */
1419 [ + + ]: 1906 : if (vfd >= 0)
1420 : 52 : dprintf (vfd, "query %d urls in parallel\n", num_urls);
1421 : 1906 : int still_running;
1422 : 1906 : long loops = 0;
1423 : 1906 : int committed_to = -1;
1424 : 1906 : bool verbose_reported = false;
1425 : 1906 : struct timespec start_time, cur_time;
1426 : :
1427 : 1906 : free (c->winning_headers);
1428 : 1906 : c->winning_headers = NULL;
1429 [ + + - + ]: 1906 : if ( maxtime > 0 && clock_gettime(CLOCK_MONOTONIC_RAW, &start_time) == -1)
1430 : : {
1431 : 0 : rc = -errno;
1432 : 0 : goto out2;
1433 : : }
1434 : 4054 : long delta = 0;
1435 : 4054 : do
1436 : : {
1437 : : /* Check to see how long querying is taking. */
1438 [ + + ]: 4054 : if (maxtime > 0)
1439 : : {
1440 [ - + ]: 4 : if (clock_gettime(CLOCK_MONOTONIC_RAW, &cur_time) == -1)
1441 : : {
1442 : 0 : rc = -errno;
1443 : 0 : goto out2;
1444 : : }
1445 : 4 : delta = cur_time.tv_sec - start_time.tv_sec;
1446 [ - + ]: 4 : if ( delta > maxtime)
1447 : : {
1448 : 0 : dprintf(vfd, "Timeout with max time=%lds and transfer time=%lds\n", maxtime, delta );
1449 : 0 : rc = -ETIME;
1450 : 0 : goto out2;
1451 : : }
1452 : : }
1453 : : /* Wait 1 second, the minimum DEBUGINFOD_TIMEOUT. */
1454 : 4054 : curl_multi_wait(curlm, NULL, 0, 1000, NULL);
1455 : 4054 : CURLMcode curlm_res = curl_multi_perform(curlm, &still_running);
1456 : :
1457 : : /* If the target file has been found, abort the other queries. */
1458 [ + + ]: 4054 : if (target_handle != NULL)
1459 : : {
1460 [ + + ]: 742 : for (int i = 0; i < num_urls; i++)
1461 [ + + ]: 449 : if (data[i].handle != target_handle)
1462 : 156 : curl_multi_remove_handle(curlm, data[i].handle);
1463 : : else
1464 : : {
1465 : 293 : committed_to = i;
1466 [ + + ]: 293 : if (c->winning_headers == NULL)
1467 : : {
1468 : 242 : c->winning_headers = data[committed_to].response_data;
1469 : 242 : data[committed_to].response_data = NULL;
1470 : 242 : data[committed_to].response_data_size = 0;
1471 : : }
1472 : :
1473 : : }
1474 : : }
1475 : :
1476 [ + + + + ]: 4054 : if (vfd >= 0 && !verbose_reported && committed_to >= 0)
1477 : : {
1478 [ - + - - ]: 36 : bool pnl = (c->default_progressfn_printed_p && vfd == STDERR_FILENO);
1479 : 18 : dprintf (vfd, "%scommitted to url %d\n", pnl ? "\n" : "",
1480 : : committed_to);
1481 [ - + ]: 18 : if (pnl)
1482 : 0 : c->default_progressfn_printed_p = 0;
1483 : : verbose_reported = true;
1484 : : }
1485 : :
1486 [ - + ]: 4054 : if (curlm_res != CURLM_OK)
1487 : : {
1488 [ # # # ]: 0 : switch (curlm_res)
1489 : : {
1490 : 0 : case CURLM_CALL_MULTI_PERFORM: continue;
1491 : : case CURLM_OUT_OF_MEMORY: rc = -ENOMEM; break;
1492 : 0 : default: rc = -ENETUNREACH; break;
1493 : : }
1494 : 0 : goto out2;
1495 : : }
1496 : :
1497 : 4054 : long dl_size = -1;
1498 [ + + + + : 4054 : if (target_handle && (c->progressfn || maxsize > 0))
- + ]
1499 : : {
1500 : : /* Get size of file being downloaded. NB: If going through
1501 : : deflate-compressing proxies, this number is likely to be
1502 : : unavailable, so -1 may show. */
1503 : 26 : CURLcode curl_res;
1504 : : #if CURL_AT_LEAST_VERSION(7, 55, 0)
1505 : 26 : curl_off_t cl;
1506 : 26 : curl_res = curl_easy_getinfo(target_handle,
1507 : : CURLINFO_CONTENT_LENGTH_DOWNLOAD_T,
1508 : : &cl);
1509 [ + - - + ]: 26 : if (curl_res == CURLE_OK && cl >= 0)
1510 : : dl_size = (cl > LONG_MAX ? LONG_MAX : (long)cl);
1511 : : #else
1512 : : double cl;
1513 : : curl_res = curl_easy_getinfo(target_handle,
1514 : : CURLINFO_CONTENT_LENGTH_DOWNLOAD,
1515 : : &cl);
1516 : : if (curl_res == CURLE_OK && cl >= 0)
1517 : : dl_size = (cl >= (double)(LONG_MAX+1UL) ? LONG_MAX : (long)cl);
1518 : : #endif
1519 : : /* If Content-Length is -1, try to get the size from
1520 : : X-Debuginfod-Size */
1521 [ # # ]: 0 : if (dl_size == -1 && c->winning_headers != NULL)
1522 : : {
1523 : 0 : long xdl;
1524 : 0 : char *hdr = strcasestr(c->winning_headers, "x-debuginfod-size");
1525 : 0 : size_t off = strlen("x-debuginfod-size:");
1526 : :
1527 [ # # # # ]: 0 : if (hdr != NULL && sscanf(hdr + off, "%ld", &xdl) == 1)
1528 : 0 : dl_size = xdl;
1529 : : }
1530 : : }
1531 : :
1532 [ + + ]: 4054 : if (c->progressfn) /* inform/check progress callback */
1533 : : {
1534 : 3322 : loops ++;
1535 : 3322 : long pa = loops; /* default param for progress callback */
1536 [ + + ]: 3322 : if (target_handle) /* we've committed to a server; report its download progress */
1537 : : {
1538 : : /* PR30809: Check actual size of cached file. This same
1539 : : fd is shared by all the multi-curl handles (but only
1540 : : one will end up writing to it). Another way could be
1541 : : to tabulate totals in debuginfod_write_callback(). */
1542 : 26 : struct stat cached;
1543 : 26 : int statrc = fstat(fd, &cached);
1544 [ + - ]: 26 : if (statrc == 0)
1545 : 26 : pa = (long) cached.st_size;
1546 : : else
1547 : : {
1548 : : /* Otherwise, query libcurl for its tabulated total.
1549 : : However, that counts http body length, not
1550 : : decoded/decompressed content length, so does not
1551 : : measure quite the same thing as dl. */
1552 : 0 : CURLcode curl_res;
1553 : : #if CURL_AT_LEAST_VERSION(7, 55, 0)
1554 : 0 : curl_off_t dl;
1555 : 0 : curl_res = curl_easy_getinfo(target_handle,
1556 : : CURLINFO_SIZE_DOWNLOAD_T,
1557 : : &dl);
1558 [ # # # # ]: 0 : if (curl_res == 0 && dl >= 0)
1559 : 0 : pa = (dl > LONG_MAX ? LONG_MAX : (long)dl);
1560 : : #else
1561 : : double dl;
1562 : : curl_res = curl_easy_getinfo(target_handle,
1563 : : CURLINFO_SIZE_DOWNLOAD,
1564 : : &dl);
1565 : : if (curl_res == 0)
1566 : : pa = (dl >= (double)(LONG_MAX+1UL) ? LONG_MAX : (long)dl);
1567 : : #endif
1568 : : }
1569 : : }
1570 : :
1571 [ + + - + ]: 6618 : if ((*c->progressfn) (c, pa, dl_size == -1 ? 0 : dl_size))
1572 : : {
1573 : 0 : c->progressfn_cancel = true;
1574 : 0 : break;
1575 : : }
1576 : : }
1577 : :
1578 : : /* Check to see if we are downloading something which exceeds maxsize, if set.*/
1579 [ + + - + ]: 4054 : if (target_handle && dl_size > maxsize && maxsize > 0)
1580 : : {
1581 [ # # ]: 0 : if (vfd >=0)
1582 : 0 : dprintf(vfd, "Content-Length too large.\n");
1583 : 0 : rc = -EFBIG;
1584 : 0 : goto out2;
1585 : : }
1586 [ + + ]: 4054 : } while (still_running);
1587 : :
1588 : : /* Check whether a query was successful. If so, assign its handle
1589 : : to verified_handle. */
1590 : : int num_msg;
1591 : : rc = -ENOENT;
1592 : 1912 : CURL *verified_handle = NULL;
1593 : 1912 : do
1594 : : {
1595 : 1912 : CURLMsg *msg;
1596 : :
1597 : 1912 : msg = curl_multi_info_read(curlm, &num_msg);
1598 [ + - + - ]: 1912 : if (msg != NULL && msg->msg == CURLMSG_DONE)
1599 : : {
1600 [ + + ]: 1912 : if (vfd >= 0)
1601 : : {
1602 : 116 : bool pnl = (c->default_progressfn_printed_p
1603 [ - + - - ]: 58 : && vfd == STDERR_FILENO);
1604 [ + - ]: 58 : dprintf (vfd, "%sserver response %s\n", pnl ? "\n" : "",
1605 : : curl_easy_strerror (msg->data.result));
1606 [ - + ]: 58 : if (pnl)
1607 : 0 : c->default_progressfn_printed_p = 0;
1608 [ + - ]: 64 : for (int i = 0; i < num_urls; i++)
1609 [ + + ]: 64 : if (msg->easy_handle == data[i].handle)
1610 : : {
1611 [ + + ]: 58 : if (strlen (data[i].errbuf) > 0)
1612 : 38 : dprintf (vfd, "url %d %s\n", i, data[i].errbuf);
1613 : : break;
1614 : : }
1615 : : }
1616 : :
1617 [ + + ]: 1912 : if (msg->data.result != CURLE_OK)
1618 : : {
1619 : 1670 : long resp_code;
1620 : 1670 : CURLcode ok0;
1621 : : /* Unsuccessful query, determine error code. */
1622 [ - + - - : 1670 : switch (msg->data.result)
- - - - +
+ - ]
1623 : : {
1624 : : case CURLE_COULDNT_RESOLVE_HOST: rc = -EHOSTUNREACH; break; // no NXDOMAIN
1625 : 0 : case CURLE_URL_MALFORMAT: rc = -EINVAL; break;
1626 : 1624 : case CURLE_COULDNT_CONNECT: rc = -ECONNREFUSED; break;
1627 : 1624 : case CURLE_PEER_FAILED_VERIFICATION: rc = -ECONNREFUSED; break;
1628 : 0 : case CURLE_REMOTE_ACCESS_DENIED: rc = -EACCES; break;
1629 : 0 : case CURLE_WRITE_ERROR: rc = -EIO; break;
1630 : 0 : case CURLE_OUT_OF_MEMORY: rc = -ENOMEM; break;
1631 : 0 : case CURLE_TOO_MANY_REDIRECTS: rc = -EMLINK; break;
1632 : 0 : case CURLE_SEND_ERROR: rc = -ECONNRESET; break;
1633 : 0 : case CURLE_RECV_ERROR: rc = -ECONNRESET; break;
1634 : 0 : case CURLE_OPERATION_TIMEDOUT: rc = -ETIME; break;
1635 : : case CURLE_HTTP_RETURNED_ERROR:
1636 : 44 : ok0 = curl_easy_getinfo (msg->easy_handle,
1637 : : CURLINFO_RESPONSE_CODE,
1638 : : &resp_code);
1639 : : /* 406 signals that the requested file was too large */
1640 [ + - + + ]: 44 : if ( ok0 == CURLE_OK && resp_code == 406)
1641 : : rc = -EFBIG;
1642 [ - + - - ]: 42 : else if (section != NULL && resp_code == 503)
1643 : : rc = -EINVAL;
1644 : : else
1645 : 44 : rc = -ENOENT;
1646 : : break;
1647 : 44 : default: rc = -ENOENT; break;
1648 : : }
1649 : : }
1650 : : else
1651 : : {
1652 : : /* Query completed without an error. Confirm that the
1653 : : response code is 200 when using HTTP/HTTPS and 0 when
1654 : : using file:// and set verified_handle. */
1655 : :
1656 [ + - ]: 242 : if (msg->easy_handle != NULL)
1657 : : {
1658 : 242 : char *effective_url = NULL;
1659 : 242 : long resp_code = 500;
1660 : 242 : CURLcode ok1 = curl_easy_getinfo (target_handle,
1661 : : CURLINFO_EFFECTIVE_URL,
1662 : : &effective_url);
1663 : 242 : CURLcode ok2 = curl_easy_getinfo (target_handle,
1664 : : CURLINFO_RESPONSE_CODE,
1665 : : &resp_code);
1666 [ + - + - ]: 242 : if(ok1 == CURLE_OK && ok2 == CURLE_OK && effective_url)
1667 : : {
1668 [ + + ]: 242 : if (strncasecmp (effective_url, "HTTP", 4) == 0)
1669 [ + - ]: 240 : if (resp_code == 200)
1670 : : {
1671 : 240 : verified_handle = msg->easy_handle;
1672 : 242 : break;
1673 : : }
1674 [ + - ]: 2 : if (strncasecmp (effective_url, "FILE", 4) == 0)
1675 [ + - ]: 2 : if (resp_code == 0)
1676 : : {
1677 : 2 : verified_handle = msg->easy_handle;
1678 : 2 : break;
1679 : : }
1680 : : }
1681 : : /* - libcurl since 7.52.0 version start to support
1682 : : CURLINFO_SCHEME;
1683 : : - before 7.61.0, effective_url would give us a
1684 : : url with upper case SCHEME added in the front;
1685 : : - effective_url between 7.61 and 7.69 can be lack
1686 : : of scheme if the original url doesn't include one;
1687 : : - since version 7.69 effective_url will be provide
1688 : : a scheme in lower case. */
1689 : : #if LIBCURL_VERSION_NUM >= 0x073d00 /* 7.61.0 */
1690 : : #if LIBCURL_VERSION_NUM <= 0x074500 /* 7.69.0 */
1691 : : char *scheme = NULL;
1692 : : CURLcode ok3 = curl_easy_getinfo (target_handle,
1693 : : CURLINFO_SCHEME,
1694 : : &scheme);
1695 : : if(ok3 == CURLE_OK && scheme)
1696 : : {
1697 : : if (startswith (scheme, "HTTP"))
1698 : : if (resp_code == 200)
1699 : : {
1700 : : verified_handle = msg->easy_handle;
1701 : : break;
1702 : : }
1703 : : }
1704 : : #endif
1705 : : #endif
1706 : : }
1707 : : }
1708 : : }
1709 [ + + ]: 1670 : } while (num_msg > 0);
1710 : :
1711 : : /* Create an empty file in the cache if the query fails with ENOENT and
1712 : : it wasn't cancelled early. */
1713 [ + + + - ]: 1906 : if (rc == -ENOENT && !c->progressfn_cancel)
1714 : : {
1715 : 280 : int efd = open (target_cache_path, O_CREAT|O_EXCL, DEFFILEMODE);
1716 [ + + ]: 280 : if (efd >= 0)
1717 : 278 : close(efd);
1718 : : }
1719 [ + + ]: 1626 : else if (rc == -EFBIG)
1720 : 2 : goto out2;
1721 : :
1722 : : /* If the verified_handle is NULL and rc != -ENOENT, the query fails with
1723 : : * an error code other than 404, then do several retry within the retry_limit.
1724 : : * Clean up all old handles and jump back to the beginning of query_in_parallel,
1725 : : * reinitialize handles and query again.*/
1726 [ + + ]: 1904 : if (verified_handle == NULL)
1727 : : {
1728 [ + + + + ]: 1662 : if (rc != -ENOENT && retry_limit-- > 0)
1729 : : {
1730 [ + + ]: 1088 : if (vfd >= 0)
1731 : 24 : dprintf (vfd, "Retry failed query, %d attempt(s) remaining\n", retry_limit);
1732 : : /* remove all handles from multi */
1733 [ + + ]: 2180 : for (int i = 0; i < num_urls; i++)
1734 : : {
1735 : 1092 : curl_multi_remove_handle(curlm, data[i].handle); /* ok to repeat */
1736 : 1092 : curl_easy_cleanup (data[i].handle);
1737 : 1092 : free(data[i].response_data);
1738 : : }
1739 : 1088 : free(c->winning_headers);
1740 : 1088 : c->winning_headers = NULL;
1741 : 1088 : goto query_in_parallel;
1742 : : }
1743 : : else
1744 : 574 : goto out2;
1745 : : }
1746 : :
1747 [ + + ]: 242 : if (vfd >= 0)
1748 : : {
1749 [ + - - - ]: 36 : bool pnl = c->default_progressfn_printed_p && vfd == STDERR_FILENO;
1750 : 18 : dprintf (vfd, "%sgot file from server\n", pnl ? "\n" : "");
1751 [ - + ]: 18 : if (pnl)
1752 : 0 : c->default_progressfn_printed_p = 0;
1753 : : }
1754 : :
1755 : : /* we've got one!!!! */
1756 : 242 : time_t mtime;
1757 : : #if defined(_TIME_BITS) && _TIME_BITS == 64
1758 : : CURLcode curl_res = curl_easy_getinfo(verified_handle, CURLINFO_FILETIME_T, (void*) &mtime);
1759 : : #else
1760 : 242 : CURLcode curl_res = curl_easy_getinfo(verified_handle, CURLINFO_FILETIME, (void*) &mtime);
1761 : : #endif
1762 [ + - ]: 242 : if (curl_res == CURLE_OK)
1763 : : {
1764 : 242 : struct timespec tvs[2];
1765 : 242 : tvs[0].tv_sec = 0;
1766 : 242 : tvs[0].tv_nsec = UTIME_OMIT;
1767 : 242 : tvs[1].tv_sec = mtime;
1768 : 242 : tvs[1].tv_nsec = 0;
1769 : 242 : (void) futimens (fd, tvs); /* best effort */
1770 : : }
1771 : :
1772 : : /* PR27571: make cache files casually unwriteable; dirs are already 0700 */
1773 : 242 : (void) fchmod(fd, 0400);
1774 : : /* PR31248: lseek back to beginning */
1775 : 242 : (void) lseek(fd, 0, SEEK_SET);
1776 : :
1777 : : /* rename tmp->real */
1778 : 242 : rc = rename (target_cache_tmppath, target_cache_path);
1779 [ - + ]: 242 : if (rc < 0)
1780 : : {
1781 : 0 : rc = -errno;
1782 : 0 : goto out2;
1783 : : /* Perhaps we need not give up right away; could retry or something ... */
1784 : : }
1785 : :
1786 : : /* remove all handles from multi */
1787 [ + + ]: 532 : for (int i = 0; i < num_urls; i++)
1788 : : {
1789 : 290 : curl_multi_remove_handle(curlm, data[i].handle); /* ok to repeat */
1790 : 290 : curl_easy_cleanup (data[i].handle);
1791 : 290 : free (data[i].response_data);
1792 : : }
1793 : :
1794 [ + + ]: 532 : for (int i = 0; i < num_urls; ++i)
1795 : 290 : free(server_url_list[i]);
1796 : 242 : free(server_url_list);
1797 : 242 : free (data);
1798 : 242 : free (server_urls);
1799 : :
1800 : : /* don't close fd - we're returning it */
1801 : : /* don't unlink the tmppath; it's already been renamed. */
1802 [ + + ]: 242 : if (path != NULL)
1803 : 238 : *path = strdup(target_cache_path);
1804 : :
1805 : 242 : rc = fd;
1806 : 242 : goto out;
1807 : :
1808 : : /* error exits */
1809 : 576 : out2:
1810 : : /* remove all handles from multi */
1811 [ + + ]: 1154 : for (int i = 0; i < num_urls; i++)
1812 : : {
1813 [ + - ]: 578 : if (data[i].handle != NULL)
1814 : : {
1815 : 578 : curl_multi_remove_handle(curlm, data[i].handle); /* ok to repeat */
1816 : 578 : curl_easy_cleanup (data[i].handle);
1817 : 578 : free (data[i].response_data);
1818 : : }
1819 : : }
1820 : :
1821 : 576 : unlink (target_cache_tmppath);
1822 : 576 : close (fd); /* before the rmdir, otherwise it'll fail */
1823 : 576 : (void) rmdir (target_cache_dir); /* nop if not empty */
1824 : 576 : free(data);
1825 : :
1826 : 576 : out1:
1827 [ + + ]: 1154 : for (int i = 0; i < num_urls; ++i)
1828 : 578 : free(server_url_list[i]);
1829 : 576 : free(server_url_list);
1830 : :
1831 : 576 : out0:
1832 : 576 : free (server_urls);
1833 : :
1834 : : /* general purpose exit */
1835 : 968 : out:
1836 : : /* Reset sent headers */
1837 : 968 : curl_slist_free_all (c->headers);
1838 : 968 : c->headers = NULL;
1839 : 968 : c->user_agent_set_p = 0;
1840 : :
1841 : : /* Conclude the last \r status line */
1842 : : /* Another possibility is to use the ANSI CSI n K EL "Erase in Line"
1843 : : code. That way, the previously printed messages would be erased,
1844 : : and without a newline. */
1845 [ + + ]: 968 : if (c->default_progressfn_printed_p)
1846 : 2 : dprintf(STDERR_FILENO, "\n");
1847 : :
1848 [ + + ]: 968 : if (vfd >= 0)
1849 : : {
1850 [ + + ]: 36 : if (rc < 0)
1851 : 10 : dprintf (vfd, "not found %s (err=%d)\n", strerror (-rc), rc);
1852 : : else
1853 : 26 : dprintf (vfd, "found %s (fd=%d)\n", target_cache_path, rc);
1854 : : }
1855 : :
1856 : 968 : free (cache_path);
1857 : 968 : free (maxage_path);
1858 : 968 : free (interval_path);
1859 : 968 : free (cache_miss_path);
1860 : 968 : free (target_cache_dir);
1861 : 968 : free (target_cache_path);
1862 : 968 : free (target_cache_tmppath);
1863 : 968 : return rc;
1864 : : }
1865 : :
1866 : :
1867 : :
1868 : : /* See debuginfod.h */
1869 : : debuginfod_client *
1870 : 378 : debuginfod_begin (void)
1871 : : {
1872 : : /* Initialize libcurl lazily, but only once. */
1873 : 378 : pthread_once (&init_control, libcurl_init);
1874 : :
1875 : 378 : debuginfod_client *client;
1876 : 378 : size_t size = sizeof (struct debuginfod_client);
1877 : 378 : client = calloc (1, size);
1878 : :
1879 [ + - ]: 378 : if (client != NULL)
1880 : : {
1881 [ + + ]: 378 : if (getenv(DEBUGINFOD_PROGRESS_ENV_VAR))
1882 : 2 : client->progressfn = default_progressfn;
1883 [ + + ]: 378 : if (getenv(DEBUGINFOD_VERBOSE_ENV_VAR))
1884 : 2 : client->verbose_fd = STDERR_FILENO;
1885 : : else
1886 : 376 : client->verbose_fd = -1;
1887 : :
1888 : : // allocate 1 curl multi handle
1889 : 378 : client->server_mhandle = curl_multi_init ();
1890 [ - + ]: 378 : if (client->server_mhandle == NULL)
1891 : 0 : goto out1;
1892 : : }
1893 : :
1894 : : // extra future initialization
1895 : :
1896 : 378 : goto out;
1897 : :
1898 : 0 : out1:
1899 : 0 : free (client);
1900 : 0 : client = NULL;
1901 : :
1902 : 378 : out:
1903 : 378 : return client;
1904 : : }
1905 : :
1906 : : void
1907 : 352 : debuginfod_set_user_data(debuginfod_client *client,
1908 : : void *data)
1909 : : {
1910 : 352 : client->user_data = data;
1911 : 352 : }
1912 : :
1913 : : void *
1914 : 0 : debuginfod_get_user_data(debuginfod_client *client)
1915 : : {
1916 : 0 : return client->user_data;
1917 : : }
1918 : :
1919 : : const char *
1920 : 40 : debuginfod_get_url(debuginfod_client *client)
1921 : : {
1922 [ + + ]: 4 : return client->url;
1923 : : }
1924 : :
1925 : : const char *
1926 : 40 : debuginfod_get_headers(debuginfod_client *client)
1927 : : {
1928 : 40 : return client->winning_headers;
1929 : : }
1930 : :
1931 : : void
1932 : 378 : debuginfod_end (debuginfod_client *client)
1933 : : {
1934 [ + - ]: 378 : if (client == NULL)
1935 : : return;
1936 : :
1937 : 378 : curl_multi_cleanup (client->server_mhandle);
1938 : 378 : curl_slist_free_all (client->headers);
1939 : 378 : free (client->winning_headers);
1940 : 378 : free (client->url);
1941 : 378 : free (client);
1942 : : }
1943 : :
1944 : : int
1945 : 210 : debuginfod_find_debuginfo (debuginfod_client *client,
1946 : : const unsigned char *build_id, int build_id_len,
1947 : : char **path)
1948 : : {
1949 : 210 : return debuginfod_query_server(client, build_id, build_id_len,
1950 : : "debuginfo", NULL, path);
1951 : : }
1952 : :
1953 : :
1954 : : /* See debuginfod.h */
1955 : : int
1956 : 678 : debuginfod_find_executable(debuginfod_client *client,
1957 : : const unsigned char *build_id, int build_id_len,
1958 : : char **path)
1959 : : {
1960 : 678 : return debuginfod_query_server(client, build_id, build_id_len,
1961 : : "executable", NULL, path);
1962 : : }
1963 : :
1964 : : /* See debuginfod.h */
1965 : 64 : int debuginfod_find_source(debuginfod_client *client,
1966 : : const unsigned char *build_id, int build_id_len,
1967 : : const char *filename, char **path)
1968 : : {
1969 : 64 : return debuginfod_query_server(client, build_id, build_id_len,
1970 : : "source", filename, path);
1971 : : }
1972 : :
1973 : : int
1974 : 16 : debuginfod_find_section (debuginfod_client *client,
1975 : : const unsigned char *build_id, int build_id_len,
1976 : : const char *section, char **path)
1977 : : {
1978 : 16 : int rc = debuginfod_query_server(client, build_id, build_id_len,
1979 : : "section", section, path);
1980 [ - + ]: 16 : if (rc != -EINVAL)
1981 : : return rc;
1982 : :
1983 : : /* The servers may have lacked support for section queries. Attempt to
1984 : : download the debuginfo or executable containing the section in order
1985 : : to extract it. */
1986 : 0 : rc = -EEXIST;
1987 : 0 : int fd = -1;
1988 : 0 : char *tmp_path = NULL;
1989 : :
1990 : 0 : fd = debuginfod_find_debuginfo (client, build_id, build_id_len, &tmp_path);
1991 [ # # ]: 0 : if (client->progressfn_cancel)
1992 : : {
1993 [ # # ]: 0 : if (fd >= 0)
1994 : : {
1995 : : /* This shouldn't happen, but we'll check this condition
1996 : : just in case. */
1997 : 0 : close (fd);
1998 : 0 : free (tmp_path);
1999 : : }
2000 : 0 : return -ENOENT;
2001 : : }
2002 [ # # ]: 0 : if (fd >= 0)
2003 : : {
2004 : 0 : rc = extract_section (fd, section, tmp_path, path);
2005 : 0 : close (fd);
2006 : : }
2007 : :
2008 [ # # ]: 0 : if (rc == -EEXIST)
2009 : : {
2010 : : /* Either the debuginfo couldn't be found or the section should
2011 : : be in the executable. */
2012 : 0 : fd = debuginfod_find_executable (client, build_id,
2013 : : build_id_len, &tmp_path);
2014 [ # # ]: 0 : if (fd >= 0)
2015 : : {
2016 : 0 : rc = extract_section (fd, section, tmp_path, path);
2017 : 0 : close (fd);
2018 : : }
2019 : : else
2020 : : /* Update rc so that we return the most recent error code. */
2021 : : rc = fd;
2022 : : }
2023 : :
2024 : 0 : free (tmp_path);
2025 : 0 : return rc;
2026 : : }
2027 : :
2028 : : /* Add an outgoing HTTP header. */
2029 : 1588 : int debuginfod_add_http_header (debuginfod_client *client, const char* header)
2030 : : {
2031 : : /* Sanity check header value is of the form Header: Value.
2032 : : It should contain at least one colon that isn't the first or
2033 : : last character. */
2034 : 1588 : char *colon = strchr (header, ':'); /* first colon */
2035 : 1588 : if (colon == NULL /* present */
2036 [ + - ]: 1588 : || colon == header /* not at beginning - i.e., have a header name */
2037 [ + - ]: 1588 : || *(colon + 1) == '\0') /* not at end - i.e., have a value */
2038 : : /* NB: but it's okay for a value to contain other colons! */
2039 : : return -EINVAL;
2040 : :
2041 : 1588 : struct curl_slist *temp = curl_slist_append (client->headers, header);
2042 [ + - ]: 1588 : if (temp == NULL)
2043 : : return -ENOMEM;
2044 : :
2045 : : /* Track if User-Agent: is being set. If so, signal not to add the
2046 : : default one. */
2047 [ + + ]: 1588 : if (startswith (header, "User-Agent:"))
2048 : 970 : client->user_agent_set_p = 1;
2049 : :
2050 : 1588 : client->headers = temp;
2051 : 1588 : return 0;
2052 : : }
2053 : :
2054 : :
2055 : : void
2056 : 720 : debuginfod_set_progressfn(debuginfod_client *client,
2057 : : debuginfod_progressfn_t fn)
2058 : : {
2059 : 720 : client->progressfn = fn;
2060 : 720 : }
2061 : :
2062 : : void
2063 : 64 : debuginfod_set_verbose_fd(debuginfod_client *client, int fd)
2064 : : {
2065 : 64 : client->verbose_fd = fd;
2066 : 64 : }
2067 : :
2068 : : #endif /* DUMMY_LIBDEBUGINFOD */
|
