2 #include "repository.h"
4 #include "submodule-config.h"
7 #include "object-store.h"
8 #include "parse-options.h"
11 * submodule cache lookup structure
12 * There is one shared set of 'struct submodule' entries which can be
13 * looked up by their sha1 blob id of the .gitmodules file and either
14 * using path or name as key.
15 * for_path stores submodule entries with path as key
16 * for_name stores submodule entries with name as key
18 struct submodule_cache
{
19 struct hashmap for_path
;
20 struct hashmap for_name
;
21 unsigned initialized
:1;
22 unsigned gitmodules_read
:1;
26 * thin wrapper struct needed to insert 'struct submodule' entries to
29 struct submodule_entry
{
30 struct hashmap_entry ent
;
31 struct submodule
*config
;
39 static int config_path_cmp(const void *unused_cmp_data
,
41 const void *entry_or_key
,
42 const void *unused_keydata
)
44 const struct submodule_entry
*a
= entry
;
45 const struct submodule_entry
*b
= entry_or_key
;
47 return strcmp(a
->config
->path
, b
->config
->path
) ||
48 oidcmp(&a
->config
->gitmodules_oid
, &b
->config
->gitmodules_oid
);
51 static int config_name_cmp(const void *unused_cmp_data
,
53 const void *entry_or_key
,
54 const void *unused_keydata
)
56 const struct submodule_entry
*a
= entry
;
57 const struct submodule_entry
*b
= entry_or_key
;
59 return strcmp(a
->config
->name
, b
->config
->name
) ||
60 oidcmp(&a
->config
->gitmodules_oid
, &b
->config
->gitmodules_oid
);
63 static struct submodule_cache
*submodule_cache_alloc(void)
65 return xcalloc(1, sizeof(struct submodule_cache
));
68 static void submodule_cache_init(struct submodule_cache
*cache
)
70 hashmap_init(&cache
->for_path
, config_path_cmp
, NULL
, 0);
71 hashmap_init(&cache
->for_name
, config_name_cmp
, NULL
, 0);
72 cache
->initialized
= 1;
75 static void free_one_config(struct submodule_entry
*entry
)
77 free((void *) entry
->config
->path
);
78 free((void *) entry
->config
->name
);
79 free((void *) entry
->config
->branch
);
80 free((void *) entry
->config
->update_strategy
.command
);
84 static void submodule_cache_clear(struct submodule_cache
*cache
)
86 struct hashmap_iter iter
;
87 struct submodule_entry
*entry
;
89 if (!cache
->initialized
)
93 * We iterate over the name hash here to be symmetric with the
94 * allocation of struct submodule entries. Each is allocated by
95 * their .gitmodules blob sha1 and submodule name.
97 hashmap_iter_init(&cache
->for_name
, &iter
);
98 while ((entry
= hashmap_iter_next(&iter
)))
99 free_one_config(entry
);
101 hashmap_free(&cache
->for_path
, 1);
102 hashmap_free(&cache
->for_name
, 1);
103 cache
->initialized
= 0;
104 cache
->gitmodules_read
= 0;
107 void submodule_cache_free(struct submodule_cache
*cache
)
109 submodule_cache_clear(cache
);
113 static unsigned int hash_oid_string(const struct object_id
*oid
,
116 return memhash(oid
->hash
, the_hash_algo
->rawsz
) + strhash(string
);
119 static void cache_put_path(struct submodule_cache
*cache
,
120 struct submodule
*submodule
)
122 unsigned int hash
= hash_oid_string(&submodule
->gitmodules_oid
,
124 struct submodule_entry
*e
= xmalloc(sizeof(*e
));
125 hashmap_entry_init(e
, hash
);
126 e
->config
= submodule
;
127 hashmap_put(&cache
->for_path
, e
);
130 static void cache_remove_path(struct submodule_cache
*cache
,
131 struct submodule
*submodule
)
133 unsigned int hash
= hash_oid_string(&submodule
->gitmodules_oid
,
135 struct submodule_entry e
;
136 struct submodule_entry
*removed
;
137 hashmap_entry_init(&e
, hash
);
138 e
.config
= submodule
;
139 removed
= hashmap_remove(&cache
->for_path
, &e
, NULL
);
143 static void cache_add(struct submodule_cache
*cache
,
144 struct submodule
*submodule
)
146 unsigned int hash
= hash_oid_string(&submodule
->gitmodules_oid
,
148 struct submodule_entry
*e
= xmalloc(sizeof(*e
));
149 hashmap_entry_init(e
, hash
);
150 e
->config
= submodule
;
151 hashmap_add(&cache
->for_name
, e
);
154 static const struct submodule
*cache_lookup_path(struct submodule_cache
*cache
,
155 const struct object_id
*gitmodules_oid
, const char *path
)
157 struct submodule_entry
*entry
;
158 unsigned int hash
= hash_oid_string(gitmodules_oid
, path
);
159 struct submodule_entry key
;
160 struct submodule key_config
;
162 oidcpy(&key_config
.gitmodules_oid
, gitmodules_oid
);
163 key_config
.path
= path
;
165 hashmap_entry_init(&key
, hash
);
166 key
.config
= &key_config
;
168 entry
= hashmap_get(&cache
->for_path
, &key
, NULL
);
170 return entry
->config
;
174 static struct submodule
*cache_lookup_name(struct submodule_cache
*cache
,
175 const struct object_id
*gitmodules_oid
, const char *name
)
177 struct submodule_entry
*entry
;
178 unsigned int hash
= hash_oid_string(gitmodules_oid
, name
);
179 struct submodule_entry key
;
180 struct submodule key_config
;
182 oidcpy(&key_config
.gitmodules_oid
, gitmodules_oid
);
183 key_config
.name
= name
;
185 hashmap_entry_init(&key
, hash
);
186 key
.config
= &key_config
;
188 entry
= hashmap_get(&cache
->for_name
, &key
, NULL
);
190 return entry
->config
;
194 int check_submodule_name(const char *name
)
196 /* Disallow empty names */
201 * Look for '..' as a path component. Check both '/' and '\\' as
202 * separators rather than is_dir_sep(), because we want the name rules
203 * to be consistent across platforms.
205 goto in_component
; /* always start inside component */
208 if (c
== '/' || c
== '\\') {
210 if (name
[0] == '.' && name
[1] == '.' &&
211 (!name
[2] || name
[2] == '/' || name
[2] == '\\'))
219 static int name_and_item_from_var(const char *var
, struct strbuf
*name
,
222 const char *subsection
, *key
;
223 int subsection_len
, parse
;
224 parse
= parse_config_key(var
, "submodule", &subsection
,
225 &subsection_len
, &key
);
226 if (parse
< 0 || !subsection
)
229 strbuf_add(name
, subsection
, subsection_len
);
230 if (check_submodule_name(name
->buf
) < 0) {
231 warning(_("ignoring suspicious submodule name: %s"), name
->buf
);
232 strbuf_release(name
);
236 strbuf_addstr(item
, key
);
241 static struct submodule
*lookup_or_create_by_name(struct submodule_cache
*cache
,
242 const struct object_id
*gitmodules_oid
, const char *name
)
244 struct submodule
*submodule
;
245 struct strbuf name_buf
= STRBUF_INIT
;
247 submodule
= cache_lookup_name(cache
, gitmodules_oid
, name
);
251 submodule
= xmalloc(sizeof(*submodule
));
253 strbuf_addstr(&name_buf
, name
);
254 submodule
->name
= strbuf_detach(&name_buf
, NULL
);
256 submodule
->path
= NULL
;
257 submodule
->url
= NULL
;
258 submodule
->update_strategy
.type
= SM_UPDATE_UNSPECIFIED
;
259 submodule
->update_strategy
.command
= NULL
;
260 submodule
->fetch_recurse
= RECURSE_SUBMODULES_NONE
;
261 submodule
->ignore
= NULL
;
262 submodule
->branch
= NULL
;
263 submodule
->recommend_shallow
= -1;
265 oidcpy(&submodule
->gitmodules_oid
, gitmodules_oid
);
267 cache_add(cache
, submodule
);
272 static int parse_fetch_recurse(const char *opt
, const char *arg
,
275 switch (git_parse_maybe_bool(arg
)) {
277 return RECURSE_SUBMODULES_ON
;
279 return RECURSE_SUBMODULES_OFF
;
281 if (!strcmp(arg
, "on-demand"))
282 return RECURSE_SUBMODULES_ON_DEMAND
;
285 die("bad %s argument: %s", opt
, arg
);
287 return RECURSE_SUBMODULES_ERROR
;
291 int parse_submodule_fetchjobs(const char *var
, const char *value
)
293 int fetchjobs
= git_config_int(var
, value
);
295 die(_("negative values not allowed for submodule.fetchjobs"));
299 int parse_fetch_recurse_submodules_arg(const char *opt
, const char *arg
)
301 return parse_fetch_recurse(opt
, arg
, 1);
304 int option_fetch_parse_recurse_submodules(const struct option
*opt
,
305 const char *arg
, int unset
)
315 *v
= RECURSE_SUBMODULES_OFF
;
318 *v
= parse_fetch_recurse_submodules_arg(opt
->long_name
, arg
);
320 *v
= RECURSE_SUBMODULES_ON
;
325 static int parse_update_recurse(const char *opt
, const char *arg
,
328 switch (git_parse_maybe_bool(arg
)) {
330 return RECURSE_SUBMODULES_ON
;
332 return RECURSE_SUBMODULES_OFF
;
335 die("bad %s argument: %s", opt
, arg
);
336 return RECURSE_SUBMODULES_ERROR
;
340 int parse_update_recurse_submodules_arg(const char *opt
, const char *arg
)
342 return parse_update_recurse(opt
, arg
, 1);
345 static int parse_push_recurse(const char *opt
, const char *arg
,
348 switch (git_parse_maybe_bool(arg
)) {
350 /* There's no simple "on" value when pushing */
352 die("bad %s argument: %s", opt
, arg
);
354 return RECURSE_SUBMODULES_ERROR
;
356 return RECURSE_SUBMODULES_OFF
;
358 if (!strcmp(arg
, "on-demand"))
359 return RECURSE_SUBMODULES_ON_DEMAND
;
360 else if (!strcmp(arg
, "check"))
361 return RECURSE_SUBMODULES_CHECK
;
362 else if (!strcmp(arg
, "only"))
363 return RECURSE_SUBMODULES_ONLY
;
364 else if (die_on_error
)
365 die("bad %s argument: %s", opt
, arg
);
367 return RECURSE_SUBMODULES_ERROR
;
371 int parse_push_recurse_submodules_arg(const char *opt
, const char *arg
)
373 return parse_push_recurse(opt
, arg
, 1);
376 static void warn_multiple_config(const struct object_id
*treeish_name
,
377 const char *name
, const char *option
)
379 const char *commit_string
= "WORKTREE";
381 commit_string
= oid_to_hex(treeish_name
);
382 warning("%s:.gitmodules, multiple configurations found for "
383 "'submodule.%s.%s'. Skipping second one!",
384 commit_string
, name
, option
);
387 static void warn_command_line_option(const char *var
, const char *value
)
389 warning(_("ignoring '%s' which may be interpreted as"
390 " a command-line option: %s"), var
, value
);
393 struct parse_config_parameter
{
394 struct submodule_cache
*cache
;
395 const struct object_id
*treeish_name
;
396 const struct object_id
*gitmodules_oid
;
401 * Parse a config item from .gitmodules.
403 * This does not handle submodule-related configuration from the main
404 * config store (.git/config, etc). Callers are responsible for
405 * checking for overrides in the main config store when appropriate.
407 static int parse_config(const char *var
, const char *value
, void *data
)
409 struct parse_config_parameter
*me
= data
;
410 struct submodule
*submodule
;
411 struct strbuf name
= STRBUF_INIT
, item
= STRBUF_INIT
;
414 /* this also ensures that we only parse submodule entries */
415 if (!name_and_item_from_var(var
, &name
, &item
))
418 submodule
= lookup_or_create_by_name(me
->cache
,
422 if (!strcmp(item
.buf
, "path")) {
424 ret
= config_error_nonbool(var
);
425 else if (looks_like_command_line_option(value
))
426 warn_command_line_option(var
, value
);
427 else if (!me
->overwrite
&& submodule
->path
)
428 warn_multiple_config(me
->treeish_name
, submodule
->name
,
432 cache_remove_path(me
->cache
, submodule
);
433 free((void *) submodule
->path
);
434 submodule
->path
= xstrdup(value
);
435 cache_put_path(me
->cache
, submodule
);
437 } else if (!strcmp(item
.buf
, "fetchrecursesubmodules")) {
438 /* when parsing worktree configurations we can die early */
439 int die_on_error
= is_null_oid(me
->gitmodules_oid
);
440 if (!me
->overwrite
&&
441 submodule
->fetch_recurse
!= RECURSE_SUBMODULES_NONE
)
442 warn_multiple_config(me
->treeish_name
, submodule
->name
,
443 "fetchrecursesubmodules");
445 submodule
->fetch_recurse
= parse_fetch_recurse(
448 } else if (!strcmp(item
.buf
, "ignore")) {
450 ret
= config_error_nonbool(var
);
451 else if (!me
->overwrite
&& submodule
->ignore
)
452 warn_multiple_config(me
->treeish_name
, submodule
->name
,
454 else if (strcmp(value
, "untracked") &&
455 strcmp(value
, "dirty") &&
456 strcmp(value
, "all") &&
457 strcmp(value
, "none"))
458 warning("Invalid parameter '%s' for config option "
459 "'submodule.%s.ignore'", value
, name
.buf
);
461 free((void *) submodule
->ignore
);
462 submodule
->ignore
= xstrdup(value
);
464 } else if (!strcmp(item
.buf
, "url")) {
466 ret
= config_error_nonbool(var
);
467 } else if (looks_like_command_line_option(value
)) {
468 warn_command_line_option(var
, value
);
469 } else if (!me
->overwrite
&& submodule
->url
) {
470 warn_multiple_config(me
->treeish_name
, submodule
->name
,
473 free((void *) submodule
->url
);
474 submodule
->url
= xstrdup(value
);
476 } else if (!strcmp(item
.buf
, "update")) {
478 ret
= config_error_nonbool(var
);
479 else if (!me
->overwrite
&&
480 submodule
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
)
481 warn_multiple_config(me
->treeish_name
, submodule
->name
,
483 else if (parse_submodule_update_strategy(value
,
484 &submodule
->update_strategy
) < 0 ||
485 submodule
->update_strategy
.type
== SM_UPDATE_COMMAND
)
486 die(_("invalid value for %s"), var
);
487 } else if (!strcmp(item
.buf
, "shallow")) {
488 if (!me
->overwrite
&& submodule
->recommend_shallow
!= -1)
489 warn_multiple_config(me
->treeish_name
, submodule
->name
,
492 submodule
->recommend_shallow
=
493 git_config_bool(var
, value
);
494 } else if (!strcmp(item
.buf
, "branch")) {
495 if (!me
->overwrite
&& submodule
->branch
)
496 warn_multiple_config(me
->treeish_name
, submodule
->name
,
499 free((void *)submodule
->branch
);
500 submodule
->branch
= xstrdup(value
);
504 strbuf_release(&name
);
505 strbuf_release(&item
);
510 static int gitmodule_oid_from_commit(const struct object_id
*treeish_name
,
511 struct object_id
*gitmodules_oid
,
516 if (is_null_oid(treeish_name
)) {
517 oidclr(gitmodules_oid
);
521 strbuf_addf(rev
, "%s:.gitmodules", oid_to_hex(treeish_name
));
522 if (get_oid(rev
->buf
, gitmodules_oid
) >= 0)
528 /* This does a lookup of a submodule configuration by name or by path
529 * (key) with on-demand reading of the appropriate .gitmodules from
532 static const struct submodule
*config_from(struct submodule_cache
*cache
,
533 const struct object_id
*treeish_name
, const char *key
,
534 enum lookup_type lookup_type
)
536 struct strbuf rev
= STRBUF_INIT
;
537 unsigned long config_size
;
539 struct object_id oid
;
540 enum object_type type
;
541 const struct submodule
*submodule
= NULL
;
542 struct parse_config_parameter parameter
;
545 * If any parameter except the cache is a NULL pointer just
546 * return the first submodule. Can be used to check whether
547 * there are any submodules parsed.
549 if (!treeish_name
|| !key
) {
550 struct hashmap_iter iter
;
551 struct submodule_entry
*entry
;
553 entry
= hashmap_iter_first(&cache
->for_name
, &iter
);
556 return entry
->config
;
559 if (!gitmodule_oid_from_commit(treeish_name
, &oid
, &rev
))
562 switch (lookup_type
) {
564 submodule
= cache_lookup_name(cache
, &oid
, key
);
567 submodule
= cache_lookup_path(cache
, &oid
, key
);
573 config
= read_object_file(&oid
, &type
, &config_size
);
574 if (!config
|| type
!= OBJ_BLOB
)
577 /* fill the submodule config into the cache */
578 parameter
.cache
= cache
;
579 parameter
.treeish_name
= treeish_name
;
580 parameter
.gitmodules_oid
= &oid
;
581 parameter
.overwrite
= 0;
582 git_config_from_mem(parse_config
, CONFIG_ORIGIN_SUBMODULE_BLOB
, rev
.buf
,
583 config
, config_size
, ¶meter
, NULL
);
584 strbuf_release(&rev
);
587 switch (lookup_type
) {
589 return cache_lookup_name(cache
, &oid
, key
);
591 return cache_lookup_path(cache
, &oid
, key
);
597 strbuf_release(&rev
);
602 static void submodule_cache_check_init(struct repository
*repo
)
604 if (repo
->submodule_cache
&& repo
->submodule_cache
->initialized
)
607 if (!repo
->submodule_cache
)
608 repo
->submodule_cache
= submodule_cache_alloc();
610 submodule_cache_init(repo
->submodule_cache
);
614 * Note: This function is private for a reason, the '.gitmodules' file should
615 * not be used as as a mechanism to retrieve arbitrary configuration stored in
618 * Runs the provided config function on the '.gitmodules' file found in the
621 static void config_from_gitmodules(config_fn_t fn
, struct repository
*repo
, void *data
)
623 if (repo
->worktree
) {
624 char *file
= repo_worktree_path(repo
, GITMODULES_FILE
);
625 git_config_from_file(fn
, file
, data
);
630 static int gitmodules_cb(const char *var
, const char *value
, void *data
)
632 struct repository
*repo
= data
;
633 struct parse_config_parameter parameter
;
635 parameter
.cache
= repo
->submodule_cache
;
636 parameter
.treeish_name
= NULL
;
637 parameter
.gitmodules_oid
= &null_oid
;
638 parameter
.overwrite
= 1;
640 return parse_config(var
, value
, ¶meter
);
643 void repo_read_gitmodules(struct repository
*repo
)
645 submodule_cache_check_init(repo
);
647 if (repo_read_index(repo
) < 0)
650 if (!is_gitmodules_unmerged(repo
->index
))
651 config_from_gitmodules(gitmodules_cb
, repo
, repo
);
653 repo
->submodule_cache
->gitmodules_read
= 1;
656 void gitmodules_config_oid(const struct object_id
*commit_oid
)
658 struct strbuf rev
= STRBUF_INIT
;
659 struct object_id oid
;
661 submodule_cache_check_init(the_repository
);
663 if (gitmodule_oid_from_commit(commit_oid
, &oid
, &rev
)) {
664 git_config_from_blob_oid(gitmodules_cb
, rev
.buf
,
665 &oid
, the_repository
);
667 strbuf_release(&rev
);
669 the_repository
->submodule_cache
->gitmodules_read
= 1;
672 static void gitmodules_read_check(struct repository
*repo
)
674 submodule_cache_check_init(repo
);
676 /* read the repo's .gitmodules file if it hasn't been already */
677 if (!repo
->submodule_cache
->gitmodules_read
)
678 repo_read_gitmodules(repo
);
681 const struct submodule
*submodule_from_name(struct repository
*r
,
682 const struct object_id
*treeish_name
,
685 gitmodules_read_check(r
);
686 return config_from(r
->submodule_cache
, treeish_name
, name
, lookup_name
);
689 const struct submodule
*submodule_from_path(struct repository
*r
,
690 const struct object_id
*treeish_name
,
693 gitmodules_read_check(r
);
694 return config_from(r
->submodule_cache
, treeish_name
, path
, lookup_path
);
697 void submodule_free(struct repository
*r
)
699 if (r
->submodule_cache
)
700 submodule_cache_clear(r
->submodule_cache
);
703 struct fetch_config
{
705 int *recurse_submodules
;
708 static int gitmodules_fetch_config(const char *var
, const char *value
, void *cb
)
710 struct fetch_config
*config
= cb
;
711 if (!strcmp(var
, "submodule.fetchjobs")) {
712 *(config
->max_children
) = parse_submodule_fetchjobs(var
, value
);
714 } else if (!strcmp(var
, "fetch.recursesubmodules")) {
715 *(config
->recurse_submodules
) = parse_fetch_recurse_submodules_arg(var
, value
);
722 void fetch_config_from_gitmodules(int *max_children
, int *recurse_submodules
)
724 struct fetch_config config
= {
725 .max_children
= max_children
,
726 .recurse_submodules
= recurse_submodules
728 config_from_gitmodules(gitmodules_fetch_config
, the_repository
, &config
);
731 static int gitmodules_update_clone_config(const char *var
, const char *value
,
735 if (!strcmp(var
, "submodule.fetchjobs"))
736 *max_jobs
= parse_submodule_fetchjobs(var
, value
);
740 void update_clone_config_from_gitmodules(int *max_jobs
)
742 config_from_gitmodules(gitmodules_update_clone_config
, the_repository
, &max_jobs
);