Coverage Report

Created: 2023-11-19 07:08

/src/git/git.c
Line
Count
Source (jump to first uncovered line)
1
#include "builtin.h"
2
#include "config.h"
3
#include "environment.h"
4
#include "exec-cmd.h"
5
#include "gettext.h"
6
#include "help.h"
7
#include "pager.h"
8
#include "read-cache-ll.h"
9
#include "run-command.h"
10
#include "alias.h"
11
#include "replace-object.h"
12
#include "setup.h"
13
#include "attr.h"
14
#include "shallow.h"
15
#include "trace.h"
16
#include "trace2.h"
17
18
0
#define RUN_SETUP   (1<<0)
19
0
#define RUN_SETUP_GENTLY  (1<<1)
20
0
#define USE_PAGER   (1<<2)
21
/*
22
 * require working tree to be present -- anything uses this needs
23
 * RUN_SETUP for reading from the configuration file.
24
 */
25
0
#define NEED_WORK_TREE    (1<<3)
26
0
#define DELAY_PAGER_CONFIG  (1<<4)
27
0
#define NO_PARSEOPT   (1<<5) /* parse-options is not used */
28
29
struct cmd_struct {
30
  const char *cmd;
31
  int (*fn)(int, const char **, const char *);
32
  unsigned int option;
33
};
34
35
const char git_usage_string[] =
36
  N_("git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]\n"
37
     "           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
38
     "           [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]\n"
39
     "           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
40
     "           [--config-env=<name>=<envvar>] <command> [<args>]");
41
42
const char git_more_info_string[] =
43
  N_("'git help -a' and 'git help -g' list available subcommands and some\n"
44
     "concept guides. See 'git help <command>' or 'git help <concept>'\n"
45
     "to read about a specific subcommand or concept.\n"
46
     "See 'git help git' for an overview of the system.");
47
48
static int use_pager = -1;
49
50
static void list_builtins(struct string_list *list, unsigned int exclude_option);
51
52
static void exclude_helpers_from_list(struct string_list *list)
53
0
{
54
0
  int i = 0;
55
56
0
  while (i < list->nr) {
57
0
    if (strstr(list->items[i].string, "--"))
58
0
      unsorted_string_list_delete_item(list, i, 0);
59
0
    else
60
0
      i++;
61
0
  }
62
0
}
63
64
static int match_token(const char *spec, int len, const char *token)
65
0
{
66
0
  int token_len = strlen(token);
67
68
0
  return len == token_len && !strncmp(spec, token, token_len);
69
0
}
70
71
static int list_cmds(const char *spec)
72
0
{
73
0
  struct string_list list = STRING_LIST_INIT_DUP;
74
0
  int i;
75
0
  int nongit;
76
77
  /*
78
  * Set up the repository so we can pick up any repo-level config (like
79
  * completion.commands).
80
  */
81
0
  setup_git_directory_gently(&nongit);
82
83
0
  while (*spec) {
84
0
    const char *sep = strchrnul(spec, ',');
85
0
    int len = sep - spec;
86
87
0
    if (match_token(spec, len, "builtins"))
88
0
      list_builtins(&list, 0);
89
0
    else if (match_token(spec, len, "main"))
90
0
      list_all_main_cmds(&list);
91
0
    else if (match_token(spec, len, "others"))
92
0
      list_all_other_cmds(&list);
93
0
    else if (match_token(spec, len, "nohelpers"))
94
0
      exclude_helpers_from_list(&list);
95
0
    else if (match_token(spec, len, "alias"))
96
0
      list_aliases(&list);
97
0
    else if (match_token(spec, len, "config"))
98
0
      list_cmds_by_config(&list);
99
0
    else if (len > 5 && !strncmp(spec, "list-", 5)) {
100
0
      struct strbuf sb = STRBUF_INIT;
101
102
0
      strbuf_add(&sb, spec + 5, len - 5);
103
0
      list_cmds_by_category(&list, sb.buf);
104
0
      strbuf_release(&sb);
105
0
    }
106
0
    else
107
0
      die(_("unsupported command listing type '%s'"), spec);
108
0
    spec += len;
109
0
    if (*spec == ',')
110
0
      spec++;
111
0
  }
112
0
  for (i = 0; i < list.nr; i++)
113
0
    puts(list.items[i].string);
114
0
  string_list_clear(&list, 0);
115
0
  return 0;
116
0
}
117
118
static void commit_pager_choice(void)
119
0
{
120
0
  switch (use_pager) {
121
0
  case 0:
122
0
    setenv("GIT_PAGER", "cat", 1);
123
0
    break;
124
0
  case 1:
125
0
    setup_pager();
126
0
    break;
127
0
  default:
128
0
    break;
129
0
  }
130
0
}
131
132
void setup_auto_pager(const char *cmd, int def)
133
0
{
134
0
  if (use_pager != -1 || pager_in_use())
135
0
    return;
136
0
  use_pager = check_pager_config(cmd);
137
0
  if (use_pager == -1)
138
0
    use_pager = def;
139
0
  commit_pager_choice();
140
0
}
141
142
static int handle_options(const char ***argv, int *argc, int *envchanged)
143
0
{
144
0
  const char **orig_argv = *argv;
145
146
0
  while (*argc > 0) {
147
0
    const char *cmd = (*argv)[0];
148
0
    if (cmd[0] != '-')
149
0
      break;
150
151
    /*
152
     * For legacy reasons, the "version" and "help"
153
     * commands can be written with "--" prepended
154
     * to make them look like flags.
155
     */
156
0
    if (!strcmp(cmd, "--help") || !strcmp(cmd, "-h") ||
157
0
        !strcmp(cmd, "--version") || !strcmp(cmd, "-v"))
158
0
      break;
159
160
    /*
161
     * Check remaining flags.
162
     */
163
0
    if (skip_prefix(cmd, "--exec-path", &cmd)) {
164
0
      if (*cmd == '=')
165
0
        git_set_exec_path(cmd + 1);
166
0
      else {
167
0
        puts(git_exec_path());
168
0
        trace2_cmd_name("_query_");
169
0
        exit(0);
170
0
      }
171
0
    } else if (!strcmp(cmd, "--html-path")) {
172
0
      puts(system_path(GIT_HTML_PATH));
173
0
      trace2_cmd_name("_query_");
174
0
      exit(0);
175
0
    } else if (!strcmp(cmd, "--man-path")) {
176
0
      puts(system_path(GIT_MAN_PATH));
177
0
      trace2_cmd_name("_query_");
178
0
      exit(0);
179
0
    } else if (!strcmp(cmd, "--info-path")) {
180
0
      puts(system_path(GIT_INFO_PATH));
181
0
      trace2_cmd_name("_query_");
182
0
      exit(0);
183
0
    } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
184
0
      use_pager = 1;
185
0
    } else if (!strcmp(cmd, "-P") || !strcmp(cmd, "--no-pager")) {
186
0
      use_pager = 0;
187
0
      if (envchanged)
188
0
        *envchanged = 1;
189
0
    } else if (!strcmp(cmd, "--no-replace-objects")) {
190
0
      disable_replace_refs();
191
0
      setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
192
0
      if (envchanged)
193
0
        *envchanged = 1;
194
0
    } else if (!strcmp(cmd, "--git-dir")) {
195
0
      if (*argc < 2) {
196
0
        fprintf(stderr, _("no directory given for '%s' option\n" ), "--git-dir");
197
0
        usage(git_usage_string);
198
0
      }
199
0
      setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
200
0
      if (envchanged)
201
0
        *envchanged = 1;
202
0
      (*argv)++;
203
0
      (*argc)--;
204
0
    } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
205
0
      setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
206
0
      if (envchanged)
207
0
        *envchanged = 1;
208
0
    } else if (!strcmp(cmd, "--namespace")) {
209
0
      if (*argc < 2) {
210
0
        fprintf(stderr, _("no namespace given for --namespace\n" ));
211
0
        usage(git_usage_string);
212
0
      }
213
0
      setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
214
0
      if (envchanged)
215
0
        *envchanged = 1;
216
0
      (*argv)++;
217
0
      (*argc)--;
218
0
    } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
219
0
      setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
220
0
      if (envchanged)
221
0
        *envchanged = 1;
222
0
    } else if (!strcmp(cmd, "--work-tree")) {
223
0
      if (*argc < 2) {
224
0
        fprintf(stderr, _("no directory given for '%s' option\n" ), "--work-tree");
225
0
        usage(git_usage_string);
226
0
      }
227
0
      setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
228
0
      if (envchanged)
229
0
        *envchanged = 1;
230
0
      (*argv)++;
231
0
      (*argc)--;
232
0
    } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
233
0
      setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
234
0
      if (envchanged)
235
0
        *envchanged = 1;
236
0
    } else if (!strcmp(cmd, "--bare")) {
237
0
      char *cwd = xgetcwd();
238
0
      is_bare_repository_cfg = 1;
239
0
      setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
240
0
      free(cwd);
241
0
      setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
242
0
      if (envchanged)
243
0
        *envchanged = 1;
244
0
    } else if (!strcmp(cmd, "-c")) {
245
0
      if (*argc < 2) {
246
0
        fprintf(stderr, _("-c expects a configuration string\n" ));
247
0
        usage(git_usage_string);
248
0
      }
249
0
      git_config_push_parameter((*argv)[1]);
250
0
      (*argv)++;
251
0
      (*argc)--;
252
0
    } else if (!strcmp(cmd, "--config-env")) {
253
0
      if (*argc < 2) {
254
0
        fprintf(stderr, _("no config key given for --config-env\n" ));
255
0
        usage(git_usage_string);
256
0
      }
257
0
      git_config_push_env((*argv)[1]);
258
0
      (*argv)++;
259
0
      (*argc)--;
260
0
    } else if (skip_prefix(cmd, "--config-env=", &cmd)) {
261
0
      git_config_push_env(cmd);
262
0
    } else if (!strcmp(cmd, "--literal-pathspecs")) {
263
0
      setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
264
0
      if (envchanged)
265
0
        *envchanged = 1;
266
0
    } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
267
0
      setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
268
0
      if (envchanged)
269
0
        *envchanged = 1;
270
0
    } else if (!strcmp(cmd, "--glob-pathspecs")) {
271
0
      setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
272
0
      if (envchanged)
273
0
        *envchanged = 1;
274
0
    } else if (!strcmp(cmd, "--noglob-pathspecs")) {
275
0
      setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
276
0
      if (envchanged)
277
0
        *envchanged = 1;
278
0
    } else if (!strcmp(cmd, "--icase-pathspecs")) {
279
0
      setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
280
0
      if (envchanged)
281
0
        *envchanged = 1;
282
0
    } else if (!strcmp(cmd, "--no-optional-locks")) {
283
0
      setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT, "0", 1);
284
0
      if (envchanged)
285
0
        *envchanged = 1;
286
0
    } else if (!strcmp(cmd, "--shallow-file")) {
287
0
      (*argv)++;
288
0
      (*argc)--;
289
0
      set_alternate_shallow_file(the_repository, (*argv)[0], 1);
290
0
      if (envchanged)
291
0
        *envchanged = 1;
292
0
    } else if (!strcmp(cmd, "-C")) {
293
0
      if (*argc < 2) {
294
0
        fprintf(stderr, _("no directory given for '%s' option\n" ), "-C");
295
0
        usage(git_usage_string);
296
0
      }
297
0
      if ((*argv)[1][0]) {
298
0
        if (chdir((*argv)[1]))
299
0
          die_errno("cannot change to '%s'", (*argv)[1]);
300
0
        if (envchanged)
301
0
          *envchanged = 1;
302
0
      }
303
0
      (*argv)++;
304
0
      (*argc)--;
305
0
    } else if (skip_prefix(cmd, "--list-cmds=", &cmd)) {
306
0
      trace2_cmd_name("_query_");
307
0
      if (!strcmp(cmd, "parseopt")) {
308
0
        struct string_list list = STRING_LIST_INIT_DUP;
309
0
        int i;
310
311
0
        list_builtins(&list, NO_PARSEOPT);
312
0
        for (i = 0; i < list.nr; i++)
313
0
          printf("%s ", list.items[i].string);
314
0
        string_list_clear(&list, 0);
315
0
        exit(0);
316
0
      } else {
317
0
        exit(list_cmds(cmd));
318
0
      }
319
0
    } else if (!strcmp(cmd, "--attr-source")) {
320
0
      if (*argc < 2) {
321
0
        fprintf(stderr, _("no attribute source given for --attr-source\n" ));
322
0
        usage(git_usage_string);
323
0
      }
324
0
      setenv(GIT_ATTR_SOURCE_ENVIRONMENT, (*argv)[1], 1);
325
0
      if (envchanged)
326
0
        *envchanged = 1;
327
0
      (*argv)++;
328
0
      (*argc)--;
329
0
    } else if (skip_prefix(cmd, "--attr-source=", &cmd)) {
330
0
      set_git_attr_source(cmd);
331
0
      setenv(GIT_ATTR_SOURCE_ENVIRONMENT, cmd, 1);
332
0
      if (envchanged)
333
0
        *envchanged = 1;
334
0
    } else {
335
0
      fprintf(stderr, _("unknown option: %s\n"), cmd);
336
0
      usage(git_usage_string);
337
0
    }
338
339
0
    (*argv)++;
340
0
    (*argc)--;
341
0
  }
342
0
  return (*argv) - orig_argv;
343
0
}
344
345
static int handle_alias(int *argcp, const char ***argv)
346
0
{
347
0
  int envchanged = 0, ret = 0, saved_errno = errno;
348
0
  int count, option_count;
349
0
  const char **new_argv;
350
0
  const char *alias_command;
351
0
  char *alias_string;
352
353
0
  alias_command = (*argv)[0];
354
0
  alias_string = alias_lookup(alias_command);
355
0
  if (alias_string) {
356
0
    if (*argcp > 1 && !strcmp((*argv)[1], "-h"))
357
0
      fprintf_ln(stderr, _("'%s' is aliased to '%s'"),
358
0
           alias_command, alias_string);
359
0
    if (alias_string[0] == '!') {
360
0
      struct child_process child = CHILD_PROCESS_INIT;
361
0
      int nongit_ok;
362
363
      /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
364
0
      setup_git_directory_gently(&nongit_ok);
365
366
0
      commit_pager_choice();
367
368
0
      child.use_shell = 1;
369
0
      child.clean_on_exit = 1;
370
0
      child.wait_after_clean = 1;
371
0
      child.trace2_child_class = "shell_alias";
372
0
      strvec_push(&child.args, alias_string + 1);
373
0
      strvec_pushv(&child.args, (*argv) + 1);
374
375
0
      trace2_cmd_alias(alias_command, child.args.v);
376
0
      trace2_cmd_list_config();
377
0
      trace2_cmd_list_env_vars();
378
0
      trace2_cmd_name("_run_shell_alias_");
379
380
0
      ret = run_command(&child);
381
0
      if (ret >= 0)   /* normal exit */
382
0
        exit(ret);
383
384
0
      die_errno(_("while expanding alias '%s': '%s'"),
385
0
          alias_command, alias_string + 1);
386
0
    }
387
0
    count = split_cmdline(alias_string, &new_argv);
388
0
    if (count < 0)
389
0
      die(_("bad alias.%s string: %s"), alias_command,
390
0
          _(split_cmdline_strerror(count)));
391
0
    option_count = handle_options(&new_argv, &count, &envchanged);
392
0
    if (envchanged)
393
0
      die(_("alias '%s' changes environment variables.\n"
394
0
            "You can use '!git' in the alias to do this"),
395
0
          alias_command);
396
0
    MOVE_ARRAY(new_argv - option_count, new_argv, count);
397
0
    new_argv -= option_count;
398
399
0
    if (count < 1)
400
0
      die(_("empty alias for %s"), alias_command);
401
402
0
    if (!strcmp(alias_command, new_argv[0]))
403
0
      die(_("recursive alias: %s"), alias_command);
404
405
0
    trace_argv_printf(new_argv,
406
0
          "trace: alias expansion: %s =>",
407
0
          alias_command);
408
409
0
    REALLOC_ARRAY(new_argv, count + *argcp);
410
    /* insert after command name */
411
0
    COPY_ARRAY(new_argv + count, *argv + 1, *argcp);
412
413
0
    trace2_cmd_alias(alias_command, new_argv);
414
0
    trace2_cmd_list_config();
415
0
    trace2_cmd_list_env_vars();
416
417
0
    *argv = new_argv;
418
0
    *argcp += count - 1;
419
420
0
    ret = 1;
421
0
  }
422
423
0
  errno = saved_errno;
424
425
0
  return ret;
426
0
}
427
428
static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
429
0
{
430
0
  int status, help;
431
0
  struct stat st;
432
0
  const char *prefix;
433
0
  int run_setup = (p->option & (RUN_SETUP | RUN_SETUP_GENTLY));
434
435
0
  help = argc == 2 && !strcmp(argv[1], "-h");
436
0
  if (help && (run_setup & RUN_SETUP))
437
    /* demote to GENTLY to allow 'git cmd -h' outside repo */
438
0
    run_setup = RUN_SETUP_GENTLY;
439
440
0
  if (run_setup & RUN_SETUP) {
441
0
    prefix = setup_git_directory();
442
0
  } else if (run_setup & RUN_SETUP_GENTLY) {
443
0
    int nongit_ok;
444
0
    prefix = setup_git_directory_gently(&nongit_ok);
445
0
  } else {
446
0
    prefix = NULL;
447
0
  }
448
0
  assert(!prefix || *prefix);
449
0
  precompose_argv_prefix(argc, argv, NULL);
450
0
  if (use_pager == -1 && run_setup &&
451
0
    !(p->option & DELAY_PAGER_CONFIG))
452
0
    use_pager = check_pager_config(p->cmd);
453
0
  if (use_pager == -1 && p->option & USE_PAGER)
454
0
    use_pager = 1;
455
0
  if (run_setup && startup_info->have_repository)
456
    /* get_git_dir() may set up repo, avoid that */
457
0
    trace_repo_setup();
458
0
  commit_pager_choice();
459
460
0
  if (!help && p->option & NEED_WORK_TREE)
461
0
    setup_work_tree();
462
463
0
  trace_argv_printf(argv, "trace: built-in: git");
464
0
  trace2_cmd_name(p->cmd);
465
0
  trace2_cmd_list_config();
466
0
  trace2_cmd_list_env_vars();
467
468
0
  validate_cache_entries(the_repository->index);
469
0
  status = p->fn(argc, argv, prefix);
470
0
  validate_cache_entries(the_repository->index);
471
472
0
  if (status)
473
0
    return status;
474
475
  /* Somebody closed stdout? */
476
0
  if (fstat(fileno(stdout), &st))
477
0
    return 0;
478
  /* Ignore write errors for pipes and sockets.. */
479
0
  if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
480
0
    return 0;
481
482
  /* Check for ENOSPC and EIO errors.. */
483
0
  if (fflush(stdout))
484
0
    die_errno(_("write failure on standard output"));
485
0
  if (ferror(stdout))
486
0
    die(_("unknown write failure on standard output"));
487
0
  if (fclose(stdout))
488
0
    die_errno(_("close failed on standard output"));
489
0
  return 0;
490
0
}
491
492
static struct cmd_struct commands[] = {
493
  { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
494
  { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
495
  { "annotate", cmd_annotate, RUN_SETUP },
496
  { "apply", cmd_apply, RUN_SETUP_GENTLY },
497
  { "archive", cmd_archive, RUN_SETUP_GENTLY },
498
  { "bisect", cmd_bisect, RUN_SETUP },
499
  { "blame", cmd_blame, RUN_SETUP },
500
  { "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },
501
  { "bugreport", cmd_bugreport, RUN_SETUP_GENTLY },
502
  { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
503
  { "cat-file", cmd_cat_file, RUN_SETUP },
504
  { "check-attr", cmd_check_attr, RUN_SETUP },
505
  { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
506
  { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
507
  { "check-ref-format", cmd_check_ref_format, NO_PARSEOPT  },
508
  { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
509
  { "checkout--worker", cmd_checkout__worker,
510
    RUN_SETUP | NEED_WORK_TREE },
511
  { "checkout-index", cmd_checkout_index,
512
    RUN_SETUP | NEED_WORK_TREE},
513
  { "cherry", cmd_cherry, RUN_SETUP },
514
  { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
515
  { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
516
  { "clone", cmd_clone },
517
  { "column", cmd_column, RUN_SETUP_GENTLY },
518
  { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
519
  { "commit-graph", cmd_commit_graph, RUN_SETUP },
520
  { "commit-tree", cmd_commit_tree, RUN_SETUP },
521
  { "config", cmd_config, RUN_SETUP_GENTLY | DELAY_PAGER_CONFIG },
522
  { "count-objects", cmd_count_objects, RUN_SETUP },
523
  { "credential", cmd_credential, RUN_SETUP_GENTLY | NO_PARSEOPT },
524
  { "credential-cache", cmd_credential_cache },
525
  { "credential-cache--daemon", cmd_credential_cache_daemon },
526
  { "credential-store", cmd_credential_store },
527
  { "describe", cmd_describe, RUN_SETUP },
528
  { "diagnose", cmd_diagnose, RUN_SETUP_GENTLY },
529
  { "diff", cmd_diff, NO_PARSEOPT },
530
  { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
531
  { "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
532
  { "diff-tree", cmd_diff_tree, RUN_SETUP | NO_PARSEOPT },
533
  { "difftool", cmd_difftool, RUN_SETUP_GENTLY },
534
  { "fast-export", cmd_fast_export, RUN_SETUP },
535
  { "fast-import", cmd_fast_import, RUN_SETUP | NO_PARSEOPT },
536
  { "fetch", cmd_fetch, RUN_SETUP },
537
  { "fetch-pack", cmd_fetch_pack, RUN_SETUP | NO_PARSEOPT },
538
  { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
539
  { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
540
  { "for-each-repo", cmd_for_each_repo, RUN_SETUP_GENTLY },
541
  { "format-patch", cmd_format_patch, RUN_SETUP },
542
  { "fsck", cmd_fsck, RUN_SETUP },
543
  { "fsck-objects", cmd_fsck, RUN_SETUP },
544
  { "fsmonitor--daemon", cmd_fsmonitor__daemon, RUN_SETUP },
545
  { "gc", cmd_gc, RUN_SETUP },
546
  { "get-tar-commit-id", cmd_get_tar_commit_id, NO_PARSEOPT },
547
  { "grep", cmd_grep, RUN_SETUP_GENTLY },
548
  { "hash-object", cmd_hash_object },
549
  { "help", cmd_help },
550
  { "hook", cmd_hook, RUN_SETUP },
551
  { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY | NO_PARSEOPT },
552
  { "init", cmd_init_db },
553
  { "init-db", cmd_init_db },
554
  { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
555
  { "log", cmd_log, RUN_SETUP },
556
  { "ls-files", cmd_ls_files, RUN_SETUP },
557
  { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
558
  { "ls-tree", cmd_ls_tree, RUN_SETUP },
559
  { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY },
560
  { "mailsplit", cmd_mailsplit, NO_PARSEOPT },
561
  { "maintenance", cmd_maintenance, RUN_SETUP },
562
  { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
563
  { "merge-base", cmd_merge_base, RUN_SETUP },
564
  { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
565
  { "merge-index", cmd_merge_index, RUN_SETUP | NO_PARSEOPT },
566
  { "merge-ours", cmd_merge_ours, RUN_SETUP | NO_PARSEOPT },
567
  { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
568
  { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
569
  { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
570
  { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
571
  { "merge-tree", cmd_merge_tree, RUN_SETUP },
572
  { "mktag", cmd_mktag, RUN_SETUP },
573
  { "mktree", cmd_mktree, RUN_SETUP },
574
  { "multi-pack-index", cmd_multi_pack_index, RUN_SETUP },
575
  { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
576
  { "name-rev", cmd_name_rev, RUN_SETUP },
577
  { "notes", cmd_notes, RUN_SETUP },
578
  { "pack-objects", cmd_pack_objects, RUN_SETUP },
579
  { "pack-redundant", cmd_pack_redundant, RUN_SETUP | NO_PARSEOPT },
580
  { "pack-refs", cmd_pack_refs, RUN_SETUP },
581
  { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY | NO_PARSEOPT },
582
  { "pickaxe", cmd_blame, RUN_SETUP },
583
  { "prune", cmd_prune, RUN_SETUP },
584
  { "prune-packed", cmd_prune_packed, RUN_SETUP },
585
  { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
586
  { "push", cmd_push, RUN_SETUP },
587
  { "range-diff", cmd_range_diff, RUN_SETUP | USE_PAGER },
588
  { "read-tree", cmd_read_tree, RUN_SETUP },
589
  { "rebase", cmd_rebase, RUN_SETUP | NEED_WORK_TREE },
590
  { "receive-pack", cmd_receive_pack },
591
  { "reflog", cmd_reflog, RUN_SETUP },
592
  { "remote", cmd_remote, RUN_SETUP },
593
  { "remote-ext", cmd_remote_ext, NO_PARSEOPT },
594
  { "remote-fd", cmd_remote_fd, NO_PARSEOPT },
595
  { "repack", cmd_repack, RUN_SETUP },
596
  { "replace", cmd_replace, RUN_SETUP },
597
  { "rerere", cmd_rerere, RUN_SETUP },
598
  { "reset", cmd_reset, RUN_SETUP },
599
  { "restore", cmd_restore, RUN_SETUP | NEED_WORK_TREE },
600
  { "rev-list", cmd_rev_list, RUN_SETUP | NO_PARSEOPT },
601
  { "rev-parse", cmd_rev_parse, NO_PARSEOPT },
602
  { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
603
  { "rm", cmd_rm, RUN_SETUP },
604
  { "send-pack", cmd_send_pack, RUN_SETUP },
605
  { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
606
  { "show", cmd_show, RUN_SETUP },
607
  { "show-branch", cmd_show_branch, RUN_SETUP },
608
  { "show-index", cmd_show_index, RUN_SETUP_GENTLY },
609
  { "show-ref", cmd_show_ref, RUN_SETUP },
610
  { "sparse-checkout", cmd_sparse_checkout, RUN_SETUP },
611
  { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
612
  { "stash", cmd_stash, RUN_SETUP | NEED_WORK_TREE },
613
  { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
614
  { "stripspace", cmd_stripspace },
615
  { "submodule--helper", cmd_submodule__helper, RUN_SETUP },
616
  { "switch", cmd_switch, RUN_SETUP | NEED_WORK_TREE },
617
  { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
618
  { "tag", cmd_tag, RUN_SETUP | DELAY_PAGER_CONFIG },
619
  { "unpack-file", cmd_unpack_file, RUN_SETUP | NO_PARSEOPT },
620
  { "unpack-objects", cmd_unpack_objects, RUN_SETUP | NO_PARSEOPT },
621
  { "update-index", cmd_update_index, RUN_SETUP },
622
  { "update-ref", cmd_update_ref, RUN_SETUP },
623
  { "update-server-info", cmd_update_server_info, RUN_SETUP },
624
  { "upload-archive", cmd_upload_archive, NO_PARSEOPT },
625
  { "upload-archive--writer", cmd_upload_archive_writer, NO_PARSEOPT },
626
  { "upload-pack", cmd_upload_pack },
627
  { "var", cmd_var, RUN_SETUP_GENTLY | NO_PARSEOPT },
628
  { "verify-commit", cmd_verify_commit, RUN_SETUP },
629
  { "verify-pack", cmd_verify_pack },
630
  { "verify-tag", cmd_verify_tag, RUN_SETUP },
631
  { "version", cmd_version },
632
  { "whatchanged", cmd_whatchanged, RUN_SETUP },
633
  { "worktree", cmd_worktree, RUN_SETUP },
634
  { "write-tree", cmd_write_tree, RUN_SETUP },
635
};
636
637
static struct cmd_struct *get_builtin(const char *s)
638
0
{
639
0
  int i;
640
0
  for (i = 0; i < ARRAY_SIZE(commands); i++) {
641
0
    struct cmd_struct *p = commands + i;
642
0
    if (!strcmp(s, p->cmd))
643
0
      return p;
644
0
  }
645
0
  return NULL;
646
0
}
647
648
int is_builtin(const char *s)
649
0
{
650
0
  return !!get_builtin(s);
651
0
}
652
653
static void list_builtins(struct string_list *out, unsigned int exclude_option)
654
0
{
655
0
  int i;
656
0
  for (i = 0; i < ARRAY_SIZE(commands); i++) {
657
0
    if (exclude_option &&
658
0
        (commands[i].option & exclude_option))
659
0
      continue;
660
0
    string_list_append(out, commands[i].cmd);
661
0
  }
662
0
}
663
664
void load_builtin_commands(const char *prefix, struct cmdnames *cmds)
665
0
{
666
0
  const char *name;
667
0
  int i;
668
669
  /*
670
   * Callers can ask for a subset of the commands based on a certain
671
   * prefix, which is then dropped from the added names. The names in
672
   * the `commands[]` array do not have the `git-` prefix, though,
673
   * therefore we must expect the `prefix` to at least start with `git-`.
674
   */
675
0
  if (!skip_prefix(prefix, "git-", &prefix))
676
0
    BUG("prefix '%s' must start with 'git-'", prefix);
677
678
0
  for (i = 0; i < ARRAY_SIZE(commands); i++)
679
0
    if (skip_prefix(commands[i].cmd, prefix, &name))
680
0
      add_cmdname(cmds, name, strlen(name));
681
0
}
682
683
#ifdef STRIP_EXTENSION
684
static void strip_extension(const char **argv)
685
{
686
  size_t len;
687
688
  if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
689
    argv[0] = xmemdupz(argv[0], len);
690
}
691
#else
692
#define strip_extension(cmd)
693
#endif
694
695
static void handle_builtin(int argc, const char **argv)
696
0
{
697
0
  struct strvec args = STRVEC_INIT;
698
0
  const char *cmd;
699
0
  struct cmd_struct *builtin;
700
701
0
  strip_extension(argv);
702
0
  cmd = argv[0];
703
704
  /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
705
0
  if (argc > 1 && !strcmp(argv[1], "--help")) {
706
0
    int i;
707
708
0
    argv[1] = argv[0];
709
0
    argv[0] = cmd = "help";
710
711
0
    for (i = 0; i < argc; i++) {
712
0
      strvec_push(&args, argv[i]);
713
0
      if (!i)
714
0
        strvec_push(&args, "--exclude-guides");
715
0
    }
716
717
0
    argc++;
718
0
    argv = args.v;
719
0
  }
720
721
0
  builtin = get_builtin(cmd);
722
0
  if (builtin)
723
0
    exit(run_builtin(builtin, argc, argv));
724
0
  strvec_clear(&args);
725
0
}
726
727
static void execv_dashed_external(const char **argv)
728
0
{
729
0
  struct child_process cmd = CHILD_PROCESS_INIT;
730
0
  int status;
731
732
0
  if (use_pager == -1 && !is_builtin(argv[0]))
733
0
    use_pager = check_pager_config(argv[0]);
734
0
  commit_pager_choice();
735
736
0
  strvec_pushf(&cmd.args, "git-%s", argv[0]);
737
0
  strvec_pushv(&cmd.args, argv + 1);
738
0
  cmd.clean_on_exit = 1;
739
0
  cmd.wait_after_clean = 1;
740
0
  cmd.silent_exec_failure = 1;
741
0
  cmd.trace2_child_class = "dashed";
742
743
0
  trace2_cmd_name("_run_dashed_");
744
745
  /*
746
   * The code in run_command() logs trace2 child_start/child_exit
747
   * events, so we do not need to report exec/exec_result events here.
748
   */
749
0
  trace_argv_printf(cmd.args.v, "trace: exec:");
750
751
  /*
752
   * If we fail because the command is not found, it is
753
   * OK to return. Otherwise, we just pass along the status code,
754
   * or our usual generic code if we were not even able to exec
755
   * the program.
756
   */
757
0
  status = run_command(&cmd);
758
759
  /*
760
   * If the child process ran and we are now going to exit, emit a
761
   * generic string as our trace2 command verb to indicate that we
762
   * launched a dashed command.
763
   */
764
0
  if (status >= 0)
765
0
    exit(status);
766
0
  else if (errno != ENOENT)
767
0
    exit(128);
768
0
}
769
770
static int run_argv(int *argcp, const char ***argv)
771
0
{
772
0
  int done_alias = 0;
773
0
  struct string_list cmd_list = STRING_LIST_INIT_NODUP;
774
0
  struct string_list_item *seen;
775
776
0
  while (1) {
777
    /*
778
     * If we tried alias and futzed with our environment,
779
     * it no longer is safe to invoke builtins directly in
780
     * general.  We have to spawn them as dashed externals.
781
     *
782
     * NEEDSWORK: if we can figure out cases
783
     * where it is safe to do, we can avoid spawning a new
784
     * process.
785
     */
786
0
    if (!done_alias)
787
0
      handle_builtin(*argcp, *argv);
788
0
    else if (get_builtin(**argv)) {
789
0
      struct child_process cmd = CHILD_PROCESS_INIT;
790
0
      int i;
791
792
      /*
793
       * The current process is committed to launching a
794
       * child process to run the command named in (**argv)
795
       * and exiting.  Log a generic string as the trace2
796
       * command verb to indicate this.  Note that the child
797
       * process will log the actual verb when it runs.
798
       */
799
0
      trace2_cmd_name("_run_git_alias_");
800
801
0
      commit_pager_choice();
802
803
0
      strvec_push(&cmd.args, "git");
804
0
      for (i = 0; i < *argcp; i++)
805
0
        strvec_push(&cmd.args, (*argv)[i]);
806
807
0
      trace_argv_printf(cmd.args.v, "trace: exec:");
808
809
      /*
810
       * if we fail because the command is not found, it is
811
       * OK to return. Otherwise, we just pass along the status code.
812
       */
813
0
      cmd.silent_exec_failure = 1;
814
0
      cmd.clean_on_exit = 1;
815
0
      cmd.wait_after_clean = 1;
816
0
      cmd.trace2_child_class = "git_alias";
817
0
      i = run_command(&cmd);
818
0
      if (i >= 0 || errno != ENOENT)
819
0
        exit(i);
820
0
      die("could not execute builtin %s", **argv);
821
0
    }
822
823
    /* .. then try the external ones */
824
0
    execv_dashed_external(*argv);
825
826
0
    seen = unsorted_string_list_lookup(&cmd_list, *argv[0]);
827
0
    if (seen) {
828
0
      int i;
829
0
      struct strbuf sb = STRBUF_INIT;
830
0
      for (i = 0; i < cmd_list.nr; i++) {
831
0
        struct string_list_item *item = &cmd_list.items[i];
832
833
0
        strbuf_addf(&sb, "\n  %s", item->string);
834
0
        if (item == seen)
835
0
          strbuf_addstr(&sb, " <==");
836
0
        else if (i == cmd_list.nr - 1)
837
0
          strbuf_addstr(&sb, " ==>");
838
0
      }
839
0
      die(_("alias loop detected: expansion of '%s' does"
840
0
            " not terminate:%s"), cmd_list.items[0].string, sb.buf);
841
0
    }
842
843
0
    string_list_append(&cmd_list, *argv[0]);
844
845
    /*
846
     * It could be an alias -- this works around the insanity
847
     * of overriding "git log" with "git show" by having
848
     * alias.log = show
849
     */
850
0
    if (!handle_alias(argcp, argv))
851
0
      break;
852
0
    done_alias = 1;
853
0
  }
854
855
0
  string_list_clear(&cmd_list, 0);
856
857
0
  return done_alias;
858
0
}
859
860
int cmd_main(int argc, const char **argv)
861
0
{
862
0
  const char *cmd;
863
0
  int done_help = 0;
864
865
0
  cmd = argv[0];
866
0
  if (!cmd)
867
0
    cmd = "git-help";
868
0
  else {
869
0
    const char *slash = find_last_dir_sep(cmd);
870
0
    if (slash)
871
0
      cmd = slash + 1;
872
0
  }
873
874
0
  trace_command_performance(argv);
875
876
  /*
877
   * "git-xxxx" is the same as "git xxxx", but we obviously:
878
   *
879
   *  - cannot take flags in between the "git" and the "xxxx".
880
   *  - cannot execute it externally (since it would just do
881
   *    the same thing over again)
882
   *
883
   * So we just directly call the builtin handler, and die if
884
   * that one cannot handle it.
885
   */
886
0
  if (skip_prefix(cmd, "git-", &cmd)) {
887
0
    argv[0] = cmd;
888
0
    handle_builtin(argc, argv);
889
0
    die(_("cannot handle %s as a builtin"), cmd);
890
0
  }
891
892
  /* Look for flags.. */
893
0
  argv++;
894
0
  argc--;
895
0
  handle_options(&argv, &argc, NULL);
896
897
0
  if (!argc) {
898
    /* The user didn't specify a command; give them help */
899
0
    commit_pager_choice();
900
0
    printf(_("usage: %s\n\n"), git_usage_string);
901
0
    list_common_cmds_help();
902
0
    printf("\n%s\n", _(git_more_info_string));
903
0
    exit(1);
904
0
  }
905
906
0
  if (!strcmp("--version", argv[0]) || !strcmp("-v", argv[0]))
907
0
    argv[0] = "version";
908
0
  else if (!strcmp("--help", argv[0]) || !strcmp("-h", argv[0]))
909
0
    argv[0] = "help";
910
911
0
  cmd = argv[0];
912
913
  /*
914
   * We use PATH to find git commands, but we prepend some higher
915
   * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
916
   * environment, and the $(gitexecdir) from the Makefile at build
917
   * time.
918
   */
919
0
  setup_path();
920
921
0
  while (1) {
922
0
    int was_alias = run_argv(&argc, &argv);
923
0
    if (errno != ENOENT)
924
0
      break;
925
0
    if (was_alias) {
926
0
      fprintf(stderr, _("expansion of alias '%s' failed; "
927
0
            "'%s' is not a git command\n"),
928
0
        cmd, argv[0]);
929
0
      exit(1);
930
0
    }
931
0
    if (!done_help) {
932
0
      cmd = argv[0] = help_unknown_cmd(cmd);
933
0
      done_help = 1;
934
0
    } else
935
0
      break;
936
0
  }
937
938
0
  fprintf(stderr, _("failed to run command '%s': %s\n"),
939
0
    cmd, strerror(errno));
940
941
0
  return 1;
942
0
}