Branch data Line data Source code
1 : : /* Command-line frontend for retrieving ELF / DWARF / source files
2 : : from the debuginfod.
3 : : Copyright (C) 2019-2020 Red Hat, Inc.
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 the GNU General Public License as published by
8 : : the Free Software Foundation; either version 3 of the License, or
9 : : (at your option) any later version.
10 : :
11 : : elfutils is distributed in the hope that it will be useful, but
12 : : WITHOUT ANY WARRANTY; without even the implied warranty of
13 : : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 : : General Public License for more details.
15 : :
16 : : You should have received a copy of the GNU General Public License
17 : : along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 : :
19 : :
20 : : #include "config.h"
21 : : #include "printversion.h"
22 : : #include "debuginfod.h"
23 : : #include <errno.h>
24 : : #include <stdio.h>
25 : : #include <stdlib.h>
26 : : #include <string.h>
27 : : #include <time.h>
28 : : #include <argp.h>
29 : : #include <unistd.h>
30 : : #include <fcntl.h>
31 : : #include <gelf.h>
32 : : #include <libdwelf.h>
33 : :
34 : :
35 : : /* Name and version of program. */
36 : : ARGP_PROGRAM_VERSION_HOOK_DEF = print_version;
37 : :
38 : : /* Bug report address. */
39 : : ARGP_PROGRAM_BUG_ADDRESS_DEF = PACKAGE_BUGREPORT;
40 : :
41 : : /* Short description of program. */
42 : : static const char doc[] = N_("Request debuginfo-related content "
43 : : "from debuginfods listed in $" DEBUGINFOD_URLS_ENV_VAR ".");
44 : :
45 : : /* Strings for arguments in help texts. */
46 : : static const char args_doc[] = N_("debuginfo BUILDID\n"
47 : : "debuginfo PATH\n"
48 : : "executable BUILDID\n"
49 : : "executable PATH\n"
50 : : "source BUILDID /FILENAME\n"
51 : : "source PATH /FILENAME\n"
52 : : "section BUILDID SECTION-NAME\n"
53 : : "section PATH SECTION-NAME\n");
54 : :
55 : :
56 : : /* Definitions of arguments for argp functions. */
57 : : static const struct argp_option options[] =
58 : : {
59 : : { "verbose", 'v', NULL, 0, "Increase verbosity.", 0 },
60 : : { NULL, 0, NULL, 0, NULL, 0 }
61 : : };
62 : :
63 : : /* debuginfod connection handle. */
64 : : static debuginfod_client *client;
65 : : static int verbose;
66 : :
67 : 38 : int progressfn(debuginfod_client *c __attribute__((__unused__)),
68 : : long a, long b)
69 : : {
70 : 38 : static bool first = true;
71 : 38 : static struct timespec last;
72 : 38 : struct timespec now;
73 : 38 : uint64_t delta;
74 [ + + ]: 38 : if (!first)
75 : : {
76 : 24 : clock_gettime (CLOCK_MONOTONIC, &now);
77 : 24 : delta = ((now.tv_sec - last.tv_sec) * 1000000
78 : 24 : + (now.tv_nsec - last.tv_nsec) / 1000);
79 : : }
80 : : else
81 : : {
82 : 14 : first = false;
83 : 14 : delta = 250000;
84 : : }
85 : :
86 : : /* Show progress the first time and then at most 5 times a second. */
87 [ - + ]: 38 : if (delta > 200000)
88 : : {
89 : 14 : fprintf (stderr, "Progress %ld / %ld\n", a, b);
90 : 14 : clock_gettime (CLOCK_MONOTONIC, &last);
91 : : }
92 : 38 : return 0;
93 : : }
94 : :
95 : :
96 : 930 : static error_t parse_opt (int key, char *arg, struct argp_state *state)
97 : : {
98 : 930 : (void) arg;
99 : 930 : (void) state;
100 [ + + ]: 930 : switch (key)
101 : : {
102 : 50 : case 'v': verbose++;
103 : 50 : debuginfod_set_progressfn (client, & progressfn);
104 [ + + ]: 50 : if (verbose > 1)
105 : 32 : debuginfod_set_verbose_fd (client, STDERR_FILENO);
106 : : break;
107 : : default: return ARGP_ERR_UNKNOWN;
108 : : }
109 : : return 0;
110 : : }
111 : :
112 : :
113 : : /* Data structure to communicate with argp functions. */
114 : : static struct argp argp =
115 : : {
116 : : options, parse_opt, args_doc, doc, NULL, NULL, NULL
117 : : };
118 : :
119 : :
120 : :
121 : : int
122 : 176 : main(int argc, char** argv)
123 : : {
124 : 176 : elf_version (EV_CURRENT);
125 : :
126 : 176 : client = debuginfod_begin ();
127 [ - + ]: 176 : if (client == NULL)
128 : : {
129 : 0 : fprintf(stderr, "Couldn't create debuginfod client context\n");
130 : 0 : return 1;
131 : : }
132 : :
133 : : /* Exercise user data pointer, to support testing only. */
134 : 176 : debuginfod_set_user_data (client, (void *)"Progress");
135 : :
136 : 176 : int remaining;
137 : 176 : (void) argp_parse (&argp, argc, argv, ARGP_IN_ORDER|ARGP_NO_ARGS, &remaining, NULL);
138 : :
139 [ + - - + ]: 176 : if (argc < 2 || remaining+1 == argc) /* no arguments or at least two non-option words */
140 : : {
141 : 0 : argp_help (&argp, stderr, ARGP_HELP_USAGE, argv[0]);
142 : 0 : return 1;
143 : : }
144 : :
145 : : /* If we were passed an ELF file name in the BUILDID slot, look in there. */
146 : 176 : unsigned char* build_id = (unsigned char*) argv[remaining+1];
147 : 176 : int build_id_len = 0; /* assume text */
148 : :
149 : 176 : int any_non_hex = 0;
150 : 176 : int i;
151 [ + + ]: 7059 : for (i = 0; build_id[i] != '\0'; i++)
152 [ + + ]: 6883 : if ((build_id[i] >= '0' && build_id[i] <= '9') ||
153 : : (build_id[i] >= 'a' && build_id[i] <= 'f'))
154 : : ;
155 : : else
156 : 231 : any_non_hex = 1;
157 : :
158 : 176 : int fd = -1;
159 : 176 : Elf* elf = NULL;
160 [ + + ]: 176 : if (any_non_hex) /* raw build-id */
161 : : {
162 : 6 : fd = open ((char*) build_id, O_RDONLY);
163 [ - + ]: 6 : if (fd < 0)
164 : 0 : fprintf (stderr, "Cannot open %s: %s\n", build_id, strerror(errno));
165 : : }
166 [ + - ]: 6 : if (fd >= 0)
167 : : {
168 : 6 : elf = dwelf_elf_begin (fd);
169 [ - + ]: 6 : if (elf == NULL)
170 : 0 : fprintf (stderr, "Cannot open as ELF file %s: %s\n", build_id,
171 : : elf_errmsg (-1));
172 : : }
173 [ + + ]: 176 : if (elf != NULL)
174 : : {
175 : 6 : const void *extracted_build_id;
176 : 6 : ssize_t s = dwelf_elf_gnu_build_id(elf, &extracted_build_id);
177 [ + - ]: 6 : if (s > 0)
178 : : {
179 : : /* Success: replace the build_id pointer/len with the binary blob
180 : : that elfutils is keeping for us. It'll remain valid until elf_end(). */
181 : 6 : build_id = (unsigned char*) extracted_build_id;
182 : 6 : build_id_len = s;
183 : : }
184 : : else
185 : 6 : fprintf (stderr, "Cannot extract build-id from %s: %s\n", build_id, elf_errmsg(-1));
186 : : }
187 : :
188 : 176 : char *cache_name;
189 : 176 : int rc = 0;
190 : :
191 : : /* Check whether FILETYPE is valid and call the appropriate
192 : : debuginfod_find_* function. If FILETYPE is "source"
193 : : then ensure a FILENAME was also supplied as an argument. */
194 [ + + ]: 176 : if (strcmp(argv[remaining], "debuginfo") == 0)
195 : 71 : rc = debuginfod_find_debuginfo(client,
196 : : build_id, build_id_len,
197 : : &cache_name);
198 [ + + ]: 105 : else if (strcmp(argv[remaining], "executable") == 0)
199 : 66 : rc = debuginfod_find_executable(client,
200 : : build_id, build_id_len,
201 : : &cache_name);
202 [ + + ]: 39 : else if (strcmp(argv[remaining], "source") == 0)
203 : : {
204 [ + - - + ]: 31 : if (remaining+2 == argc || argv[remaining+2][0] != '/')
205 : : {
206 : 0 : fprintf(stderr, "If FILETYPE is \"source\" then absolute /FILENAME must be given\n");
207 : 0 : return 1;
208 : : }
209 : 31 : rc = debuginfod_find_source(client,
210 : : build_id, build_id_len,
211 : : argv[remaining+2], &cache_name);
212 : : }
213 [ + - ]: 8 : else if (strcmp(argv[remaining], "section") == 0)
214 : : {
215 [ - + ]: 8 : if (remaining+2 >= argc)
216 : : {
217 : 0 : fprintf(stderr,
218 : : "If FILETYPE is \"section\" then a section name must be given\n");
219 : 0 : return 1;
220 : : }
221 : 8 : rc = debuginfod_find_section(client, build_id, build_id_len,
222 : 8 : argv[remaining+2], &cache_name);
223 : : }
224 : : else
225 : : {
226 : 0 : argp_help (&argp, stderr, ARGP_HELP_USAGE, argv[0]);
227 : 0 : return 1;
228 : : }
229 : :
230 [ + + ]: 176 : if (verbose)
231 : : {
232 : 18 : const char* headers = debuginfod_get_headers(client);
233 [ + + ]: 18 : if (headers)
234 : 10 : fprintf(stderr, "Headers:\n%s", headers);
235 : 18 : const char* url = debuginfod_get_url (client);
236 [ + + ]: 18 : if (url != NULL)
237 : 11 : fprintf(stderr, "Downloaded from %s\n", url);
238 : : }
239 : :
240 : 176 : debuginfod_end (client);
241 [ + + ]: 176 : if (elf)
242 : 6 : elf_end(elf);
243 [ + + ]: 176 : if (fd >= 0)
244 : 6 : close (fd);
245 : :
246 [ + + ]: 176 : if (rc < 0)
247 : : {
248 : 17 : fprintf(stderr, "Server query failed: %s\n", strerror(-rc));
249 : 17 : return 1;
250 : : }
251 : : else
252 : 159 : close (rc);
253 : :
254 : 159 : printf("%s\n", cache_name);
255 : 159 : free (cache_name);
256 : :
257 : 159 : return 0;
258 : : }
|
