summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--Documentation/technical/api-submodule-config.txt45
-rw-r--r--Makefile2
-rw-r--r--submodule-config.c443
-rw-r--r--submodule-config.h27
-rw-r--r--submodule.c1
-rw-r--r--submodule.h1
-rwxr-xr-xt/t7411-submodule-config.sh85
-rw-r--r--test-submodule-config.c66
9 files changed, 671 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 422c5382c1..337c1215c1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -204,6 +204,7 @@
/test-sha1-array
/test-sigchain
/test-string-list
+/test-submodule-config
/test-subprocess
/test-svn-fe
/test-urlmatch-normalization
diff --git a/Documentation/technical/api-submodule-config.txt b/Documentation/technical/api-submodule-config.txt
new file mode 100644
index 0000000000..1fbde41bf6
--- /dev/null
+++ b/Documentation/technical/api-submodule-config.txt
@@ -0,0 +1,45 @@
+submodule config cache API
+==========================
+
+The submodule config cache API allows to read submodule
+configurations/information from specified revisions. Internally
+information is lazily read into a cache that is used to avoid
+unnecessary parsing of the same .gitmodule files. Lookups can be done by
+submodule path or name.
+
+Usage
+-----
+
+The caller can look up information about submodules by using the
+`submodule_from_path()` or `submodule_from_name()` functions. They return
+a `struct submodule` which contains the values. The API automatically
+initializes and allocates the needed infrastructure on-demand.
+
+If the internal cache might grow too big or when the caller is done with
+the API, all internally cached values can be freed with submodule_free().
+
+Data Structures
+---------------
+
+`struct submodule`::
+
+ This structure is used to return the information about one
+ submodule for a certain revision. It is returned by the lookup
+ functions.
+
+Functions
+---------
+
+`void submodule_free()`::
+
+ Use these to free the internally cached values.
+
+`const struct submodule *submodule_from_path(const unsigned char *commit_sha1, const char *path)`::
+
+ Lookup values for one submodule by its commit_sha1 and path.
+
+`const struct submodule *submodule_from_name(const unsigned char *commit_sha1, const char *name)`::
+
+ The same as above but lookup by name.
+
+For an example usage see test-submodule-config.c.
diff --git a/Makefile b/Makefile
index 54ec511dff..5d9a63fb3c 100644
--- a/Makefile
+++ b/Makefile
@@ -594,6 +594,7 @@ TEST_PROGRAMS_NEED_X += test-sha1
TEST_PROGRAMS_NEED_X += test-sha1-array
TEST_PROGRAMS_NEED_X += test-sigchain
TEST_PROGRAMS_NEED_X += test-string-list
+TEST_PROGRAMS_NEED_X += test-submodule-config
TEST_PROGRAMS_NEED_X += test-subprocess
TEST_PROGRAMS_NEED_X += test-svn-fe
TEST_PROGRAMS_NEED_X += test-urlmatch-normalization
@@ -784,6 +785,7 @@ LIB_OBJS += strbuf.o
LIB_OBJS += streaming.o
LIB_OBJS += string-list.o
LIB_OBJS += submodule.o
+LIB_OBJS += submodule-config.o
LIB_OBJS += symlinks.o
LIB_OBJS += tag.o
LIB_OBJS += trace.o
diff --git a/submodule-config.c b/submodule-config.c
new file mode 100644
index 0000000000..ea82edb11f
--- /dev/null
+++ b/submodule-config.c
@@ -0,0 +1,443 @@
+#include "cache.h"
+#include "submodule-config.h"
+#include "submodule.h"
+#include "strbuf.h"
+
+/*
+ * submodule cache lookup structure
+ * There is one shared set of 'struct submodule' entries which can be
+ * looked up by their sha1 blob id of the .gitmodule file and either
+ * using path or name as key.
+ * for_path stores submodule entries with path as key
+ * for_name stores submodule entries with name as key
+ */
+struct submodule_cache {
+ struct hashmap for_path;
+ struct hashmap for_name;
+};
+
+/*
+ * thin wrapper struct needed to insert 'struct submodule' entries to
+ * the hashmap
+ */
+struct submodule_entry {
+ struct hashmap_entry ent;
+ struct submodule *config;
+};
+
+enum lookup_type {
+ lookup_name,
+ lookup_path
+};
+
+static struct submodule_cache cache;
+static int is_cache_init;
+
+static int config_path_cmp(const struct submodule_entry *a,
+ const struct submodule_entry *b,
+ const void *unused)
+{
+ return strcmp(a->config->path, b->config->path) ||
+ hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
+}
+
+static int config_name_cmp(const struct submodule_entry *a,
+ const struct submodule_entry *b,
+ const void *unused)
+{
+ return strcmp(a->config->name, b->config->name) ||
+ hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
+}
+
+static void cache_init(struct submodule_cache *cache)
+{
+ hashmap_init(&cache->for_path, (hashmap_cmp_fn) config_path_cmp, 0);
+ hashmap_init(&cache->for_name, (hashmap_cmp_fn) config_name_cmp, 0);
+}
+
+static void free_one_config(struct submodule_entry *entry)
+{
+ free((void *) entry->config->path);
+ free((void *) entry->config->name);
+ free(entry->config);
+}
+
+static void cache_free(struct submodule_cache *cache)
+{
+ struct hashmap_iter iter;
+ struct submodule_entry *entry;
+
+ /*
+ * We iterate over the name hash here to be symmetric with the
+ * allocation of struct submodule entries. Each is allocated by
+ * their .gitmodule blob sha1 and submodule name.
+ */
+ hashmap_iter_init(&cache->for_name, &iter);
+ while ((entry = hashmap_iter_next(&iter)))
+ free_one_config(entry);
+
+ hashmap_free(&cache->for_path, 1);
+ hashmap_free(&cache->for_name, 1);
+}
+
+static unsigned int hash_sha1_string(const unsigned char *sha1,
+ const char *string)
+{
+ return memhash(sha1, 20) + strhash(string);
+}
+
+static void cache_put_path(struct submodule_cache *cache,
+ struct submodule *submodule)
+{
+ unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
+ submodule->path);
+ struct submodule_entry *e = xmalloc(sizeof(*e));
+ hashmap_entry_init(e, hash);
+ e->config = submodule;
+ hashmap_put(&cache->for_path, e);
+}
+
+static void cache_remove_path(struct submodule_cache *cache,
+ struct submodule *submodule)
+{
+ unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
+ submodule->path);
+ struct submodule_entry e;
+ struct submodule_entry *removed;
+ hashmap_entry_init(&e, hash);
+ e.config = submodule;
+ removed = hashmap_remove(&cache->for_path, &e, NULL);
+ free(removed);
+}
+
+static void cache_add(struct submodule_cache *cache,
+ struct submodule *submodule)
+{
+ unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
+ submodule->name);
+ struct submodule_entry *e = xmalloc(sizeof(*e));
+ hashmap_entry_init(e, hash);
+ e->config = submodule;
+ hashmap_add(&cache->for_name, e);
+}
+
+static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
+ const unsigned char *gitmodules_sha1, const char *path)
+{
+ struct submodule_entry *entry;
+ unsigned int hash = hash_sha1_string(gitmodules_sha1, path);
+ struct submodule_entry key;
+ struct submodule key_config;
+
+ hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
+ key_config.path = path;
+
+ hashmap_entry_init(&key, hash);
+ key.config = &key_config;
+
+ entry = hashmap_get(&cache->for_path, &key, NULL);
+ if (entry)
+ return entry->config;
+ return NULL;
+}
+
+static struct submodule *cache_lookup_name(struct submodule_cache *cache,
+ const unsigned char *gitmodules_sha1, const char *name)
+{
+ struct submodule_entry *entry;
+ unsigned int hash = hash_sha1_string(gitmodules_sha1, name);
+ struct submodule_entry key;
+ struct submodule key_config;
+
+ hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
+ key_config.name = name;
+
+ hashmap_entry_init(&key, hash);
+ key.config = &key_config;
+
+ entry = hashmap_get(&cache->for_name, &key, NULL);
+ if (entry)
+ return entry->config;
+ return NULL;
+}
+
+static int name_and_item_from_var(const char *var, struct strbuf *name,
+ struct strbuf *item)
+{
+ const char *subsection, *key;
+ int subsection_len, parse;
+ parse = parse_config_key(var, "submodule", &subsection,
+ &subsection_len, &key);
+ if (parse < 0 || !subsection)
+ return 0;
+
+ strbuf_add(name, subsection, subsection_len);
+ strbuf_addstr(item, key);
+
+ return 1;
+}
+
+static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
+ const unsigned char *gitmodules_sha1, const char *name)
+{
+ struct submodule *submodule;
+ struct strbuf name_buf = STRBUF_INIT;
+
+ submodule = cache_lookup_name(cache, gitmodules_sha1, name);
+ if (submodule)
+ return submodule;
+
+ submodule = xmalloc(sizeof(*submodule));
+
+ strbuf_addstr(&name_buf, name);
+ submodule->name = strbuf_detach(&name_buf, NULL);
+
+ submodule->path = NULL;
+ submodule->url = NULL;
+ submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
+ submodule->ignore = NULL;
+
+ hashcpy(submodule->gitmodules_sha1, gitmodules_sha1);
+
+ cache_add(cache, submodule);
+
+ return submodule;
+}
+
+static void warn_multiple_config(const unsigned char *commit_sha1,
+ const char *name, const char *option)
+{
+ const char *commit_string = "WORKTREE";
+ if (commit_sha1)
+ commit_string = sha1_to_hex(commit_sha1);
+ warning("%s:.gitmodules, multiple configurations found for "
+ "'submodule.%s.%s'. Skipping second one!",
+ commit_string, name, option);
+}
+
+struct parse_config_parameter {
+ struct submodule_cache *cache;
+ const unsigned char *commit_sha1;
+ const unsigned char *gitmodules_sha1;
+ int overwrite;
+};
+
+static int parse_config(const char *var, const char *value, void *data)
+{
+ struct parse_config_parameter *me = data;
+ struct submodule *submodule;
+ struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
+ int ret = 0;
+
+ /* this also ensures that we only parse submodule entries */
+ if (!name_and_item_from_var(var, &name, &item))
+ return 0;
+
+ submodule = lookup_or_create_by_name(me->cache, me->gitmodules_sha1,
+ name.buf);
+
+ if (!strcmp(item.buf, "path")) {
+ struct strbuf path = STRBUF_INIT;
+ if (!value) {
+ ret = config_error_nonbool(var);
+ goto release_return;
+ }
+ if (!me->overwrite && submodule->path != NULL) {
+ warn_multiple_config(me->commit_sha1, submodule->name,
+ "path");
+ goto release_return;
+ }
+
+ if (submodule->path)
+ cache_remove_path(me->cache, submodule);
+ free((void *) submodule->path);
+ strbuf_addstr(&path, value);
+ submodule->path = strbuf_detach(&path, NULL);
+ cache_put_path(me->cache, submodule);
+ } else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
+ if (!me->overwrite &&
+ submodule->fetch_recurse != RECURSE_SUBMODULES_NONE) {
+ warn_multiple_config(me->commit_sha1, submodule->name,
+ "fetchrecursesubmodules");
+ goto release_return;
+ }
+
+ submodule->fetch_recurse = parse_fetch_recurse_submodules_arg(var, value);
+ } else if (!strcmp(item.buf, "ignore")) {
+ struct strbuf ignore = STRBUF_INIT;
+ if (!me->overwrite && submodule->ignore != NULL) {
+ warn_multiple_config(me->commit_sha1, submodule->name,
+ "ignore");
+ goto release_return;
+ }
+ if (!value) {
+ ret = config_error_nonbool(var);
+ goto release_return;
+ }
+ if (strcmp(value, "untracked") && strcmp(value, "dirty") &&
+ strcmp(value, "all") && strcmp(value, "none")) {
+ warning("Invalid parameter '%s' for config option "
+ "'submodule.%s.ignore'", value, var);
+ goto release_return;
+ }
+
+ free((void *) submodule->ignore);
+ strbuf_addstr(&ignore, value);
+ submodule->ignore = strbuf_detach(&ignore, NULL);
+ } else if (!strcmp(item.buf, "url")) {
+ struct strbuf url = STRBUF_INIT;
+ if (!value) {
+ ret = config_error_nonbool(var);
+ goto release_return;
+ }
+ if (!me->overwrite && submodule->url != NULL) {
+ warn_multiple_config(me->commit_sha1, submodule->name,
+ "url");
+ goto release_return;
+ }
+
+ free((void *) submodule->url);
+ strbuf_addstr(&url, value);
+ submodule->url = strbuf_detach(&url, NULL);
+ }
+
+release_return:
+ strbuf_release(&name);
+ strbuf_release(&item);
+
+ return ret;
+}
+
+static int gitmodule_sha1_from_commit(const unsigned char *commit_sha1,
+ unsigned char *gitmodules_sha1)
+{
+ struct strbuf rev = STRBUF_INIT;
+ int ret = 0;
+
+ if (is_null_sha1(commit_sha1)) {
+ hashcpy(gitmodules_sha1, null_sha1);
+ return 1;
+ }
+
+ strbuf_addf(&rev, "%s:.gitmodules", sha1_to_hex(commit_sha1));
+ if (get_sha1(rev.buf, gitmodules_sha1) >= 0)
+ ret = 1;
+
+ strbuf_release(&rev);
+ return ret;
+}
+
+/* This does a lookup of a submodule configuration by name or by path
+ * (key) with on-demand reading of the appropriate .gitmodules from
+ * revisions.
+ */
+static const struct submodule *config_from(struct submodule_cache *cache,
+ const unsigned char *commit_sha1, const char *key,
+ enum lookup_type lookup_type)
+{
+ struct strbuf rev = STRBUF_INIT;
+ unsigned long config_size;
+ char *config;
+ unsigned char sha1[20];
+ enum object_type type;
+ const struct submodule *submodule = NULL;
+ struct parse_config_parameter parameter;
+
+ /*
+ * If any parameter except the cache is a NULL pointer just
+ * return the first submodule. Can be used to check whether
+ * there are any submodules parsed.
+ */
+ if (!commit_sha1 || !key) {
+ struct hashmap_iter iter;
+ struct submodule_entry *entry;
+
+ hashmap_iter_init(&cache->for_name, &iter);
+ entry = hashmap_iter_next(&iter);
+ if (!entry)
+ return NULL;
+ return entry->config;
+ }
+
+ if (!gitmodule_sha1_from_commit(commit_sha1, sha1))
+ return NULL;
+
+ switch (lookup_type) {
+ case lookup_name:
+ submodule = cache_lookup_name(cache, sha1, key);
+ break;
+ case lookup_path:
+ submodule = cache_lookup_path(cache, sha1, key);
+ break;
+ }
+ if (submodule)
+ return submodule;
+
+ config = read_sha1_file(sha1, &type, &config_size);
+ if (!config)
+ return NULL;
+
+ if (type != OBJ_BLOB) {
+ free(config);
+ return NULL;
+ }
+
+ /* fill the submodule config into the cache */
+ parameter.cache = cache;
+ parameter.commit_sha1 = commit_sha1;
+ parameter.gitmodules_sha1 = sha1;
+ parameter.overwrite = 0;
+ git_config_from_buf(parse_config, rev.buf, config, config_size,
+ &parameter);
+ free(config);
+
+ switch (lookup_type) {
+ case lookup_name:
+ return cache_lookup_name(cache, sha1, key);
+ case lookup_path:
+ return cache_lookup_path(cache, sha1, key);
+ default:
+ return NULL;
+ }
+}
+
+static const struct submodule *config_from_path(struct submodule_cache *cache,
+ const unsigned char *commit_sha1, const char *path)
+{
+ return config_from(cache, commit_sha1, path, lookup_path);
+}
+
+static const struct submodule *config_from_name(struct submodule_cache *cache,
+ const unsigned char *commit_sha1, const char *name)
+{
+ return config_from(cache, commit_sha1, name, lookup_name);
+}
+
+static void ensure_cache_init(void)
+{
+ if (is_cache_init)
+ return;
+
+ cache_init(&cache);
+ is_cache_init = 1;
+}
+
+const struct submodule *submodule_from_name(const unsigned char *commit_sha1,
+ const char *name)
+{
+ ensure_cache_init();
+ return config_from_name(&cache, commit_sha1, name);
+}
+
+const struct submodule *submodule_from_path(const unsigned char *commit_sha1,
+ const char *path)
+{
+ ensure_cache_init();
+ return config_from_path(&cache, commit_sha1, path);
+}
+
+void submodule_free(void)
+{
+ cache_free(&cache);
+ is_cache_init = 0;
+}
diff --git a/submodule-config.h b/submodule-config.h
new file mode 100644
index 0000000000..cd68030e58
--- /dev/null
+++ b/submodule-config.h
@@ -0,0 +1,27 @@
+#ifndef SUBMODULE_CONFIG_CACHE_H
+#define SUBMODULE_CONFIG_CACHE_H
+
+#include "hashmap.h"
+#include "strbuf.h"
+
+/*
+ * Submodule entry containing the information about a certain submodule
+ * in a certain revision.
+ */
+struct submodule {
+ const char *path;
+ const char *name;
+ const char *url;
+ int fetch_recurse;
+ const char *ignore;
+ /* the sha1 blob id of the responsible .gitmodules file */
+ unsigned char gitmodules_sha1[20];
+};
+
+const struct submodule *submodule_from_name(const unsigned char *commit_sha1,
+ const char *name);
+const struct submodule *submodule_from_path(const unsigned char *commit_sha1,
+ const char *path);
+void submodule_free(void);
+
+#endif /* SUBMODULE_CONFIG_H */
diff --git a/submodule.c b/submodule.c
index b8747f5c26..7822dc57a5 100644
--- a/submodule.c
+++ b/submodule.c
@@ -355,6 +355,7 @@ int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
default:
if (!strcmp(arg, "on-demand"))
return RECURSE_SUBMODULES_ON_DEMAND;
+ /* TODO: remove the die for history parsing here */
die("bad %s argument: %s", opt, arg);
}
}
diff --git a/submodule.h b/submodule.h
index 7beec4822b..920fef3d88 100644
--- a/submodule.h
+++ b/submodule.h
@@ -5,6 +5,7 @@ struct diff_options;
struct argv_array;
enum {
+ RECURSE_SUBMODULES_NONE = -2,
RECURSE_SUBMODULES_ON_DEMAND = -1,
RECURSE_SUBMODULES_OFF = 0,
RECURSE_SUBMODULES_DEFAULT = 1,
diff --git a/t/t7411-submodule-config.sh b/t/t7411-submodule-config.sh
new file mode 100755
index 0000000000..2602bc515b
--- /dev/null
+++ b/t/t7411-submodule-config.sh
@@ -0,0 +1,85 @@
+#!/bin/sh
+#
+# Copyright (c) 2014 Heiko Voigt
+#
+
+test_description='Test submodules config cache infrastructure
+
+This test verifies that parsing .gitmodules configuration directly
+from the database works.
+'
+
+TEST_NO_CREATE_REPO=1
+. ./test-lib.sh
+
+test_expect_success 'submodule config cache setup' '
+ mkdir submodule &&
+ (cd submodule &&
+ git init &&
+ echo a >a &&
+ git add . &&
+ git commit -ma
+ ) &&
+ mkdir super &&
+ (cd super &&
+ git init &&
+ git submodule add ../submodule &&
+ git submodule add ../submodule a &&
+ git commit -m "add as submodule and as a" &&
+ git mv a b &&
+ git commit -m "move a to b"
+ )
+'
+
+cat >super/expect <<EOF
+Submodule name: 'a' for path 'a'
+Submodule name: 'a' for path 'b'
+Submodule name: 'submodule' for path 'submodule'
+Submodule name: 'submodule' for path 'submodule'
+EOF
+
+test_expect_success 'test parsing and lookup of submodule config by path' '
+ (cd super &&
+ test-submodule-config \
+ HEAD^ a \
+ HEAD b \
+ HEAD^ submodule \
+ HEAD submodule \
+ >actual &&
+ test_cmp expect actual
+ )
+'
+
+test_expect_success 'test parsing and lookup of submodule config by name' '
+ (cd super &&
+ test-submodule-config --name \
+ HEAD^ a \
+ HEAD a \
+ HEAD^ submodule \
+ HEAD submodule \
+ >actual &&
+ test_cmp expect actual
+ )
+'
+
+cat >super/expect_error <<EOF
+Submodule name: 'a' for path 'b'
+Submodule name: 'submodule' for path 'submodule'
+EOF
+
+test_expect_success 'error in one submodule config lets continue' '
+ (cd super &&
+ cp .gitmodules .gitmodules.bak &&
+ echo " value = \"" >>.gitmodules &&
+ git add .gitmodules &&
+ mv .gitmodules.bak .gitmodules &&
+ git commit -m "add error" &&
+ test-submodule-config \
+ HEAD b \
+ HEAD submodule \
+ >actual &&
+ test_cmp expect_error actual
+ )
+'
+
+test_done
diff --git a/test-submodule-config.c b/test-submodule-config.c
new file mode 100644
index 0000000000..f3c391860d
--- /dev/null
+++ b/test-submodule-config.c
@@ -0,0 +1,66 @@
+#include "cache.h"
+#include "submodule-config.h"
+
+static void die_usage(int argc, char **argv, const char *msg)
+{
+ fprintf(stderr, "%s\n", msg);
+ fprintf(stderr, "Usage: %s [<commit> <submodulepath>] ...\n", argv[0]);
+ exit(1);
+}
+
+int main(int argc, char **argv)
+{
+ char **arg = argv;
+ int my_argc = argc;
+ int output_url = 0;
+ int lookup_name = 0;
+
+ arg++;
+ my_argc--;
+ while (starts_with(arg[0], "--")) {
+ if (!strcmp(arg[0], "--url"))
+ output_url = 1;
+ if (!strcmp(arg[0], "--name"))
+ lookup_name = 1;
+ arg++;
+ my_argc--;
+ }
+
+ if (my_argc % 2 != 0)
+ die_usage(argc, argv, "Wrong number of arguments.");
+
+ while (*arg) {
+ unsigned char commit_sha1[20];
+ const struct submodule *submodule;
+ const char *commit;
+ const char *path_or_name;
+
+ commit = arg[0];
+ path_or_name = arg[1];
+
+ if (commit[0] == '\0')
+ hashcpy(commit_sha1, null_sha1);
+ else if (get_sha1(commit, commit_sha1) < 0)
+ die_usage(argc, argv, "Commit not found.");
+
+ if (lookup_name) {
+ submodule = submodule_from_name(commit_sha1, path_or_name);
+ } else
+ submodule = submodule_from_path(commit_sha1, path_or_name);
+ if (!submodule)
+ die_usage(argc, argv, "Submodule not found.");
+
+ if (output_url)
+ printf("Submodule url: '%s' for path '%s'\n",
+ submodule->url, submodule->path);
+ else
+ printf("Submodule name: '%s' for path '%s'\n",
+ submodule->name, submodule->path);
+
+ arg += 2;
+ }
+
+ submodule_free();
+
+ return 0;
+}