1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) 2 /* Copyright (C) 2017-2018 Netronome Systems, Inc. */ 3 4 #include <ctype.h> 5 #include <errno.h> 6 #include <getopt.h> 7 #include <linux/bpf.h> 8 #include <stdio.h> 9 #include <stdlib.h> 10 #include <string.h> 11 12 #include <bpf/bpf.h> 13 #include <bpf/libbpf.h> 14 #include <bpf/btf.h> 15 16 #include "main.h" 17 18 #define BATCH_LINE_LEN_MAX 65536 19 #define BATCH_ARG_NB_MAX 4096 20 21 const char *bin_name; 22 static int last_argc; 23 static char **last_argv; 24 static int (*last_do_help)(int argc, char **argv); 25 json_writer_t *json_wtr; 26 bool pretty_output; 27 bool json_output; 28 bool show_pinned; 29 bool block_mount; 30 bool verifier_logs; 31 bool relaxed_maps; 32 bool use_loader; 33 struct btf *base_btf; 34 struct pinned_obj_table prog_table; 35 struct pinned_obj_table map_table; 36 struct pinned_obj_table link_table; 37 struct obj_refs_table refs_table; 38 39 static void __noreturn clean_and_exit(int i) 40 { 41 if (json_output) 42 jsonw_destroy(&json_wtr); 43 44 exit(i); 45 } 46 47 void usage(void) 48 { 49 last_do_help(last_argc - 1, last_argv + 1); 50 51 clean_and_exit(-1); 52 } 53 54 static int do_help(int argc, char **argv) 55 { 56 if (json_output) { 57 jsonw_null(json_wtr); 58 return 0; 59 } 60 61 fprintf(stderr, 62 "Usage: %s [OPTIONS] OBJECT { COMMAND | help }\n" 63 " %s batch file FILE\n" 64 " %s version\n" 65 "\n" 66 " OBJECT := { prog | map | link | cgroup | perf | net | feature | btf | gen | struct_ops | iter }\n" 67 " " HELP_SPEC_OPTIONS "\n" 68 "", 69 bin_name, bin_name, bin_name); 70 71 return 0; 72 } 73 74 static int do_version(int argc, char **argv) 75 { 76 #ifdef HAVE_LIBBFD_SUPPORT 77 const bool has_libbfd = true; 78 #else 79 const bool has_libbfd = false; 80 #endif 81 #ifdef BPFTOOL_WITHOUT_SKELETONS 82 const bool has_skeletons = false; 83 #else 84 const bool has_skeletons = true; 85 #endif 86 87 if (json_output) { 88 jsonw_start_object(json_wtr); /* root object */ 89 90 jsonw_name(json_wtr, "version"); 91 jsonw_printf(json_wtr, "\"%s\"", BPFTOOL_VERSION); 92 93 jsonw_name(json_wtr, "features"); 94 jsonw_start_object(json_wtr); /* features */ 95 jsonw_bool_field(json_wtr, "libbfd", has_libbfd); 96 jsonw_bool_field(json_wtr, "skeletons", has_skeletons); 97 jsonw_end_object(json_wtr); /* features */ 98 99 jsonw_end_object(json_wtr); /* root object */ 100 } else { 101 unsigned int nb_features = 0; 102 103 printf("%s v%s\n", bin_name, BPFTOOL_VERSION); 104 printf("features:"); 105 if (has_libbfd) { 106 printf(" libbfd"); 107 nb_features++; 108 } 109 if (has_skeletons) 110 printf("%s skeletons", nb_features++ ? "," : ""); 111 printf("\n"); 112 } 113 return 0; 114 } 115 116 int cmd_select(const struct cmd *cmds, int argc, char **argv, 117 int (*help)(int argc, char **argv)) 118 { 119 unsigned int i; 120 121 last_argc = argc; 122 last_argv = argv; 123 last_do_help = help; 124 125 if (argc < 1 && cmds[0].func) 126 return cmds[0].func(argc, argv); 127 128 for (i = 0; cmds[i].cmd; i++) { 129 if (is_prefix(*argv, cmds[i].cmd)) { 130 if (!cmds[i].func) { 131 p_err("command '%s' is not supported in bootstrap mode", 132 cmds[i].cmd); 133 return -1; 134 } 135 return cmds[i].func(argc - 1, argv + 1); 136 } 137 } 138 139 help(argc - 1, argv + 1); 140 141 return -1; 142 } 143 144 bool is_prefix(const char *pfx, const char *str) 145 { 146 if (!pfx) 147 return false; 148 if (strlen(str) < strlen(pfx)) 149 return false; 150 151 return !memcmp(str, pfx, strlen(pfx)); 152 } 153 154 /* Last argument MUST be NULL pointer */ 155 int detect_common_prefix(const char *arg, ...) 156 { 157 unsigned int count = 0; 158 const char *ref; 159 char msg[256]; 160 va_list ap; 161 162 snprintf(msg, sizeof(msg), "ambiguous prefix: '%s' could be '", arg); 163 va_start(ap, arg); 164 while ((ref = va_arg(ap, const char *))) { 165 if (!is_prefix(arg, ref)) 166 continue; 167 count++; 168 if (count > 1) 169 strncat(msg, "' or '", sizeof(msg) - strlen(msg) - 1); 170 strncat(msg, ref, sizeof(msg) - strlen(msg) - 1); 171 } 172 va_end(ap); 173 strncat(msg, "'", sizeof(msg) - strlen(msg) - 1); 174 175 if (count >= 2) { 176 p_err("%s", msg); 177 return -1; 178 } 179 180 return 0; 181 } 182 183 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep) 184 { 185 unsigned char *data = arg; 186 unsigned int i; 187 188 for (i = 0; i < n; i++) { 189 const char *pfx = ""; 190 191 if (!i) 192 /* nothing */; 193 else if (!(i % 16)) 194 fprintf(f, "\n"); 195 else if (!(i % 8)) 196 fprintf(f, " "); 197 else 198 pfx = sep; 199 200 fprintf(f, "%s%02hhx", i ? pfx : "", data[i]); 201 } 202 } 203 204 /* Split command line into argument vector. */ 205 static int make_args(char *line, char *n_argv[], int maxargs, int cmd_nb) 206 { 207 static const char ws[] = " \t\r\n"; 208 char *cp = line; 209 int n_argc = 0; 210 211 while (*cp) { 212 /* Skip leading whitespace. */ 213 cp += strspn(cp, ws); 214 215 if (*cp == '\0') 216 break; 217 218 if (n_argc >= (maxargs - 1)) { 219 p_err("too many arguments to command %d", cmd_nb); 220 return -1; 221 } 222 223 /* Word begins with quote. */ 224 if (*cp == '\'' || *cp == '"') { 225 char quote = *cp++; 226 227 n_argv[n_argc++] = cp; 228 /* Find ending quote. */ 229 cp = strchr(cp, quote); 230 if (!cp) { 231 p_err("unterminated quoted string in command %d", 232 cmd_nb); 233 return -1; 234 } 235 } else { 236 n_argv[n_argc++] = cp; 237 238 /* Find end of word. */ 239 cp += strcspn(cp, ws); 240 if (*cp == '\0') 241 break; 242 } 243 244 /* Separate words. */ 245 *cp++ = 0; 246 } 247 n_argv[n_argc] = NULL; 248 249 return n_argc; 250 } 251 252 static int do_batch(int argc, char **argv); 253 254 static const struct cmd cmds[] = { 255 { "help", do_help }, 256 { "batch", do_batch }, 257 { "prog", do_prog }, 258 { "map", do_map }, 259 { "link", do_link }, 260 { "cgroup", do_cgroup }, 261 { "perf", do_perf }, 262 { "net", do_net }, 263 { "feature", do_feature }, 264 { "btf", do_btf }, 265 { "gen", do_gen }, 266 { "struct_ops", do_struct_ops }, 267 { "iter", do_iter }, 268 { "version", do_version }, 269 { 0 } 270 }; 271 272 static int do_batch(int argc, char **argv) 273 { 274 char buf[BATCH_LINE_LEN_MAX], contline[BATCH_LINE_LEN_MAX]; 275 char *n_argv[BATCH_ARG_NB_MAX]; 276 unsigned int lines = 0; 277 int n_argc; 278 FILE *fp; 279 char *cp; 280 int err = 0; 281 int i; 282 283 if (argc < 2) { 284 p_err("too few parameters for batch"); 285 return -1; 286 } else if (!is_prefix(*argv, "file")) { 287 p_err("expected 'file', got: %s", *argv); 288 return -1; 289 } else if (argc > 2) { 290 p_err("too many parameters for batch"); 291 return -1; 292 } 293 NEXT_ARG(); 294 295 if (!strcmp(*argv, "-")) 296 fp = stdin; 297 else 298 fp = fopen(*argv, "r"); 299 if (!fp) { 300 p_err("Can't open file (%s): %s", *argv, strerror(errno)); 301 return -1; 302 } 303 304 if (json_output) 305 jsonw_start_array(json_wtr); 306 while (fgets(buf, sizeof(buf), fp)) { 307 cp = strchr(buf, '#'); 308 if (cp) 309 *cp = '\0'; 310 311 if (strlen(buf) == sizeof(buf) - 1) { 312 errno = E2BIG; 313 break; 314 } 315 316 /* Append continuation lines if any (coming after a line ending 317 * with '\' in the batch file). 318 */ 319 while ((cp = strstr(buf, "\\\n")) != NULL) { 320 if (!fgets(contline, sizeof(contline), fp) || 321 strlen(contline) == 0) { 322 p_err("missing continuation line on command %d", 323 lines); 324 err = -1; 325 goto err_close; 326 } 327 328 cp = strchr(contline, '#'); 329 if (cp) 330 *cp = '\0'; 331 332 if (strlen(buf) + strlen(contline) + 1 > sizeof(buf)) { 333 p_err("command %d is too long", lines); 334 err = -1; 335 goto err_close; 336 } 337 buf[strlen(buf) - 2] = '\0'; 338 strcat(buf, contline); 339 } 340 341 n_argc = make_args(buf, n_argv, BATCH_ARG_NB_MAX, lines); 342 if (!n_argc) 343 continue; 344 if (n_argc < 0) 345 goto err_close; 346 347 if (json_output) { 348 jsonw_start_object(json_wtr); 349 jsonw_name(json_wtr, "command"); 350 jsonw_start_array(json_wtr); 351 for (i = 0; i < n_argc; i++) 352 jsonw_string(json_wtr, n_argv[i]); 353 jsonw_end_array(json_wtr); 354 jsonw_name(json_wtr, "output"); 355 } 356 357 err = cmd_select(cmds, n_argc, n_argv, do_help); 358 359 if (json_output) 360 jsonw_end_object(json_wtr); 361 362 if (err) 363 goto err_close; 364 365 lines++; 366 } 367 368 if (errno && errno != ENOENT) { 369 p_err("reading batch file failed: %s", strerror(errno)); 370 err = -1; 371 } else { 372 if (!json_output) 373 printf("processed %d commands\n", lines); 374 } 375 err_close: 376 if (fp != stdin) 377 fclose(fp); 378 379 if (json_output) 380 jsonw_end_array(json_wtr); 381 382 return err; 383 } 384 385 int main(int argc, char **argv) 386 { 387 static const struct option options[] = { 388 { "json", no_argument, NULL, 'j' }, 389 { "help", no_argument, NULL, 'h' }, 390 { "pretty", no_argument, NULL, 'p' }, 391 { "version", no_argument, NULL, 'V' }, 392 { "bpffs", no_argument, NULL, 'f' }, 393 { "mapcompat", no_argument, NULL, 'm' }, 394 { "nomount", no_argument, NULL, 'n' }, 395 { "debug", no_argument, NULL, 'd' }, 396 { "use-loader", no_argument, NULL, 'L' }, 397 { "base-btf", required_argument, NULL, 'B' }, 398 { 0 } 399 }; 400 int opt, ret; 401 402 last_do_help = do_help; 403 pretty_output = false; 404 json_output = false; 405 show_pinned = false; 406 block_mount = false; 407 bin_name = argv[0]; 408 409 hash_init(prog_table.table); 410 hash_init(map_table.table); 411 hash_init(link_table.table); 412 413 opterr = 0; 414 while ((opt = getopt_long(argc, argv, "VhpjfLmndB:", 415 options, NULL)) >= 0) { 416 switch (opt) { 417 case 'V': 418 return do_version(argc, argv); 419 case 'h': 420 return do_help(argc, argv); 421 case 'p': 422 pretty_output = true; 423 /* fall through */ 424 case 'j': 425 if (!json_output) { 426 json_wtr = jsonw_new(stdout); 427 if (!json_wtr) { 428 p_err("failed to create JSON writer"); 429 return -1; 430 } 431 json_output = true; 432 } 433 jsonw_pretty(json_wtr, pretty_output); 434 break; 435 case 'f': 436 show_pinned = true; 437 break; 438 case 'm': 439 relaxed_maps = true; 440 break; 441 case 'n': 442 block_mount = true; 443 break; 444 case 'd': 445 libbpf_set_print(print_all_levels); 446 verifier_logs = true; 447 break; 448 case 'B': 449 base_btf = btf__parse(optarg, NULL); 450 if (libbpf_get_error(base_btf)) { 451 p_err("failed to parse base BTF at '%s': %ld\n", 452 optarg, libbpf_get_error(base_btf)); 453 base_btf = NULL; 454 return -1; 455 } 456 break; 457 case 'L': 458 use_loader = true; 459 break; 460 default: 461 p_err("unrecognized option '%s'", argv[optind - 1]); 462 if (json_output) 463 clean_and_exit(-1); 464 else 465 usage(); 466 } 467 } 468 469 argc -= optind; 470 argv += optind; 471 if (argc < 0) 472 usage(); 473 474 ret = cmd_select(cmds, argc, argv, do_help); 475 476 if (json_output) 477 jsonw_destroy(&json_wtr); 478 479 if (show_pinned) { 480 delete_pinned_obj_table(&prog_table); 481 delete_pinned_obj_table(&map_table); 482 delete_pinned_obj_table(&link_table); 483 } 484 btf__free(base_btf); 485 486 return ret; 487 } 488