2 #include "repository.h"
4 #include "submodule-config.h"
7 #include "parse-options.h"
10 * submodule cache lookup structure
11 * There is one shared set of 'struct submodule' entries which can be
12 * looked up by their sha1 blob id of the .gitmodule file and either
13 * using path or name as key.
14 * for_path stores submodule entries with path as key
15 * for_name stores submodule entries with name as key
17 struct submodule_cache {
18 struct hashmap for_path;
19 struct hashmap for_name;
20 unsigned initialized:1;
24 * thin wrapper struct needed to insert 'struct submodule' entries to
27 struct submodule_entry {
28 struct hashmap_entry ent;
29 struct submodule *config;
37 static int config_path_cmp(const void *unused_cmp_data,
39 const void *entry_or_key,
40 const void *unused_keydata)
42 const struct submodule_entry *a = entry;
43 const struct submodule_entry *b = entry_or_key;
45 return strcmp(a->config->path, b->config->path) ||
46 hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
49 static int config_name_cmp(const void *unused_cmp_data,
51 const void *entry_or_key,
52 const void *unused_keydata)
54 const struct submodule_entry *a = entry;
55 const struct submodule_entry *b = entry_or_key;
57 return strcmp(a->config->name, b->config->name) ||
58 hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
61 static struct submodule_cache *submodule_cache_alloc(void)
63 return xcalloc(1, sizeof(struct submodule_cache));
66 static void submodule_cache_init(struct submodule_cache *cache)
68 hashmap_init(&cache->for_path, config_path_cmp, NULL, 0);
69 hashmap_init(&cache->for_name, config_name_cmp, NULL, 0);
70 cache->initialized = 1;
73 static void free_one_config(struct submodule_entry *entry)
75 free((void *) entry->config->path);
76 free((void *) entry->config->name);
77 free((void *) entry->config->branch);
78 free((void *) entry->config->update_strategy.command);
82 static void submodule_cache_clear(struct submodule_cache *cache)
84 struct hashmap_iter iter;
85 struct submodule_entry *entry;
87 if (!cache->initialized)
91 * We iterate over the name hash here to be symmetric with the
92 * allocation of struct submodule entries. Each is allocated by
93 * their .gitmodule blob sha1 and submodule name.
95 hashmap_iter_init(&cache->for_name, &iter);
96 while ((entry = hashmap_iter_next(&iter)))
97 free_one_config(entry);
99 hashmap_free(&cache->for_path, 1);
100 hashmap_free(&cache->for_name, 1);
101 cache->initialized = 0;
104 void submodule_cache_free(struct submodule_cache *cache)
106 submodule_cache_clear(cache);
110 static unsigned int hash_sha1_string(const unsigned char *sha1,
113 return memhash(sha1, 20) + strhash(string);
116 static void cache_put_path(struct submodule_cache *cache,
117 struct submodule *submodule)
119 unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
121 struct submodule_entry *e = xmalloc(sizeof(*e));
122 hashmap_entry_init(e, hash);
123 e->config = submodule;
124 hashmap_put(&cache->for_path, e);
127 static void cache_remove_path(struct submodule_cache *cache,
128 struct submodule *submodule)
130 unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
132 struct submodule_entry e;
133 struct submodule_entry *removed;
134 hashmap_entry_init(&e, hash);
135 e.config = submodule;
136 removed = hashmap_remove(&cache->for_path, &e, NULL);
140 static void cache_add(struct submodule_cache *cache,
141 struct submodule *submodule)
143 unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
145 struct submodule_entry *e = xmalloc(sizeof(*e));
146 hashmap_entry_init(e, hash);
147 e->config = submodule;
148 hashmap_add(&cache->for_name, e);
151 static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
152 const unsigned char *gitmodules_sha1, const char *path)
154 struct submodule_entry *entry;
155 unsigned int hash = hash_sha1_string(gitmodules_sha1, path);
156 struct submodule_entry key;
157 struct submodule key_config;
159 hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
160 key_config.path = path;
162 hashmap_entry_init(&key, hash);
163 key.config = &key_config;
165 entry = hashmap_get(&cache->for_path, &key, NULL);
167 return entry->config;
171 static struct submodule *cache_lookup_name(struct submodule_cache *cache,
172 const unsigned char *gitmodules_sha1, const char *name)
174 struct submodule_entry *entry;
175 unsigned int hash = hash_sha1_string(gitmodules_sha1, name);
176 struct submodule_entry key;
177 struct submodule key_config;
179 hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
180 key_config.name = name;
182 hashmap_entry_init(&key, hash);
183 key.config = &key_config;
185 entry = hashmap_get(&cache->for_name, &key, NULL);
187 return entry->config;
191 static int name_and_item_from_var(const char *var, struct strbuf *name,
194 const char *subsection, *key;
195 int subsection_len, parse;
196 parse = parse_config_key(var, "submodule", &subsection,
197 &subsection_len, &key);
198 if (parse < 0 || !subsection)
201 strbuf_add(name, subsection, subsection_len);
202 strbuf_addstr(item, key);
207 static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
208 const unsigned char *gitmodules_sha1, const char *name)
210 struct submodule *submodule;
211 struct strbuf name_buf = STRBUF_INIT;
213 submodule = cache_lookup_name(cache, gitmodules_sha1, name);
217 submodule = xmalloc(sizeof(*submodule));
219 strbuf_addstr(&name_buf, name);
220 submodule->name = strbuf_detach(&name_buf, NULL);
222 submodule->path = NULL;
223 submodule->url = NULL;
224 submodule->update_strategy.type = SM_UPDATE_UNSPECIFIED;
225 submodule->update_strategy.command = NULL;
226 submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
227 submodule->ignore = NULL;
228 submodule->branch = NULL;
229 submodule->recommend_shallow = -1;
231 hashcpy(submodule->gitmodules_sha1, gitmodules_sha1);
233 cache_add(cache, submodule);
238 static int parse_fetch_recurse(const char *opt, const char *arg,
241 switch (git_config_maybe_bool(opt, arg)) {
243 return RECURSE_SUBMODULES_ON;
245 return RECURSE_SUBMODULES_OFF;
247 if (!strcmp(arg, "on-demand"))
248 return RECURSE_SUBMODULES_ON_DEMAND;
251 die("bad %s argument: %s", opt, arg);
253 return RECURSE_SUBMODULES_ERROR;
257 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
259 return parse_fetch_recurse(opt, arg, 1);
262 int option_fetch_parse_recurse_submodules(const struct option *opt,
263 const char *arg, int unset)
273 *v = RECURSE_SUBMODULES_OFF;
276 *v = parse_fetch_recurse_submodules_arg(opt->long_name, arg);
278 *v = RECURSE_SUBMODULES_ON;
283 static int parse_update_recurse(const char *opt, const char *arg,
286 switch (git_config_maybe_bool(opt, arg)) {
288 return RECURSE_SUBMODULES_ON;
290 return RECURSE_SUBMODULES_OFF;
293 die("bad %s argument: %s", opt, arg);
294 return RECURSE_SUBMODULES_ERROR;
298 int parse_update_recurse_submodules_arg(const char *opt, const char *arg)
300 return parse_update_recurse(opt, arg, 1);
303 static int parse_push_recurse(const char *opt, const char *arg,
306 switch (git_config_maybe_bool(opt, arg)) {
308 /* There's no simple "on" value when pushing */
310 die("bad %s argument: %s", opt, arg);
312 return RECURSE_SUBMODULES_ERROR;
314 return RECURSE_SUBMODULES_OFF;
316 if (!strcmp(arg, "on-demand"))
317 return RECURSE_SUBMODULES_ON_DEMAND;
318 else if (!strcmp(arg, "check"))
319 return RECURSE_SUBMODULES_CHECK;
320 else if (!strcmp(arg, "only"))
321 return RECURSE_SUBMODULES_ONLY;
322 else if (die_on_error)
323 die("bad %s argument: %s", opt, arg);
325 return RECURSE_SUBMODULES_ERROR;
329 int parse_push_recurse_submodules_arg(const char *opt, const char *arg)
331 return parse_push_recurse(opt, arg, 1);
334 static void warn_multiple_config(const unsigned char *treeish_name,
335 const char *name, const char *option)
337 const char *commit_string = "WORKTREE";
339 commit_string = sha1_to_hex(treeish_name);
340 warning("%s:.gitmodules, multiple configurations found for "
341 "'submodule.%s.%s'. Skipping second one!",
342 commit_string, name, option);
345 struct parse_config_parameter {
346 struct submodule_cache *cache;
347 const unsigned char *treeish_name;
348 const unsigned char *gitmodules_sha1;
352 static int parse_config(const char *var, const char *value, void *data)
354 struct parse_config_parameter *me = data;
355 struct submodule *submodule;
356 struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
359 /* this also ensures that we only parse submodule entries */
360 if (!name_and_item_from_var(var, &name, &item))
363 submodule = lookup_or_create_by_name(me->cache,
367 if (!strcmp(item.buf, "path")) {
369 ret = config_error_nonbool(var);
370 else if (!me->overwrite && submodule->path)
371 warn_multiple_config(me->treeish_name, submodule->name,
375 cache_remove_path(me->cache, submodule);
376 free((void *) submodule->path);
377 submodule->path = xstrdup(value);
378 cache_put_path(me->cache, submodule);
380 } else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
381 /* when parsing worktree configurations we can die early */
382 int die_on_error = is_null_sha1(me->gitmodules_sha1);
383 if (!me->overwrite &&
384 submodule->fetch_recurse != RECURSE_SUBMODULES_NONE)
385 warn_multiple_config(me->treeish_name, submodule->name,
386 "fetchrecursesubmodules");
388 submodule->fetch_recurse = parse_fetch_recurse(
391 } else if (!strcmp(item.buf, "ignore")) {
393 ret = config_error_nonbool(var);
394 else if (!me->overwrite && submodule->ignore)
395 warn_multiple_config(me->treeish_name, submodule->name,
397 else if (strcmp(value, "untracked") &&
398 strcmp(value, "dirty") &&
399 strcmp(value, "all") &&
400 strcmp(value, "none"))
401 warning("Invalid parameter '%s' for config option "
402 "'submodule.%s.ignore'", value, name.buf);
404 free((void *) submodule->ignore);
405 submodule->ignore = xstrdup(value);
407 } else if (!strcmp(item.buf, "url")) {
409 ret = config_error_nonbool(var);
410 } else if (!me->overwrite && submodule->url) {
411 warn_multiple_config(me->treeish_name, submodule->name,
414 free((void *) submodule->url);
415 submodule->url = xstrdup(value);
417 } else if (!strcmp(item.buf, "update")) {
419 ret = config_error_nonbool(var);
420 else if (!me->overwrite &&
421 submodule->update_strategy.type != SM_UPDATE_UNSPECIFIED)
422 warn_multiple_config(me->treeish_name, submodule->name,
424 else if (parse_submodule_update_strategy(value,
425 &submodule->update_strategy) < 0)
426 die(_("invalid value for %s"), var);
427 } else if (!strcmp(item.buf, "shallow")) {
428 if (!me->overwrite && submodule->recommend_shallow != -1)
429 warn_multiple_config(me->treeish_name, submodule->name,
432 submodule->recommend_shallow =
433 git_config_bool(var, value);
434 } else if (!strcmp(item.buf, "branch")) {
435 if (!me->overwrite && submodule->branch)
436 warn_multiple_config(me->treeish_name, submodule->name,
439 free((void *)submodule->branch);
440 submodule->branch = xstrdup(value);
444 strbuf_release(&name);
445 strbuf_release(&item);
450 int gitmodule_oid_from_commit(const struct object_id *treeish_name,
451 struct object_id *gitmodules_oid,
456 if (is_null_oid(treeish_name)) {
457 oidclr(gitmodules_oid);
461 strbuf_addf(rev, "%s:.gitmodules", oid_to_hex(treeish_name));
462 if (get_oid(rev->buf, gitmodules_oid) >= 0)
468 /* This does a lookup of a submodule configuration by name or by path
469 * (key) with on-demand reading of the appropriate .gitmodules from
472 static const struct submodule *config_from(struct submodule_cache *cache,
473 const struct object_id *treeish_name, const char *key,
474 enum lookup_type lookup_type)
476 struct strbuf rev = STRBUF_INIT;
477 unsigned long config_size;
479 struct object_id oid;
480 enum object_type type;
481 const struct submodule *submodule = NULL;
482 struct parse_config_parameter parameter;
485 * If any parameter except the cache is a NULL pointer just
486 * return the first submodule. Can be used to check whether
487 * there are any submodules parsed.
489 if (!treeish_name || !key) {
490 struct hashmap_iter iter;
491 struct submodule_entry *entry;
493 entry = hashmap_iter_first(&cache->for_name, &iter);
496 return entry->config;
499 if (!gitmodule_oid_from_commit(treeish_name, &oid, &rev))
502 switch (lookup_type) {
504 submodule = cache_lookup_name(cache, oid.hash, key);
507 submodule = cache_lookup_path(cache, oid.hash, key);
513 config = read_sha1_file(oid.hash, &type, &config_size);
514 if (!config || type != OBJ_BLOB)
517 /* fill the submodule config into the cache */
518 parameter.cache = cache;
519 parameter.treeish_name = treeish_name->hash;
520 parameter.gitmodules_sha1 = oid.hash;
521 parameter.overwrite = 0;
522 git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
523 config, config_size, ¶meter);
524 strbuf_release(&rev);
527 switch (lookup_type) {
529 return cache_lookup_name(cache, oid.hash, key);
531 return cache_lookup_path(cache, oid.hash, key);
537 strbuf_release(&rev);
542 static void submodule_cache_check_init(struct repository *repo)
544 if (repo->submodule_cache && repo->submodule_cache->initialized)
547 if (!repo->submodule_cache)
548 repo->submodule_cache = submodule_cache_alloc();
550 submodule_cache_init(repo->submodule_cache);
553 int submodule_config_option(struct repository *repo,
554 const char *var, const char *value)
556 struct parse_config_parameter parameter;
558 submodule_cache_check_init(repo);
560 parameter.cache = repo->submodule_cache;
561 parameter.treeish_name = NULL;
562 parameter.gitmodules_sha1 = null_sha1;
563 parameter.overwrite = 1;
565 return parse_config(var, value, ¶meter);
568 int parse_submodule_config_option(const char *var, const char *value)
570 return submodule_config_option(the_repository, var, value);
573 const struct submodule *submodule_from_name(const struct object_id *treeish_name,
576 submodule_cache_check_init(the_repository);
577 return config_from(the_repository->submodule_cache, treeish_name, name, lookup_name);
580 const struct submodule *submodule_from_path(const struct object_id *treeish_name,
583 submodule_cache_check_init(the_repository);
584 return config_from(the_repository->submodule_cache, treeish_name, path, lookup_path);
587 const struct submodule *submodule_from_cache(struct repository *repo,
588 const struct object_id *treeish_name,
591 submodule_cache_check_init(repo);
592 return config_from(repo->submodule_cache, treeish_name,
596 void submodule_free(void)
598 if (the_repository->submodule_cache)
599 submodule_cache_clear(the_repository->submodule_cache);