repack: fix leaks on error with "goto cleanup"
[git.git] / attr.c
blob1053dfcd4b61b56e99df60e469ec4e757c80e860
1 /*
2 * Handle git attributes. See gitattributes(5) for a description of
3 * the file syntax, and attr.h for a description of the API.
5 * One basic design decision here is that we are not going to support
6 * an insanely large number of attributes.
7 */
9 #include "cache.h"
10 #include "config.h"
11 #include "exec-cmd.h"
12 #include "attr.h"
13 #include "dir.h"
14 #include "utf8.h"
15 #include "quote.h"
16 #include "revision.h"
17 #include "object-store.h"
18 #include "thread-utils.h"
20 const char git_attr__true[] = "(builtin)true";
21 const char git_attr__false[] = "\0(builtin)false";
22 static const char git_attr__unknown[] = "(builtin)unknown";
23 #define ATTR__TRUE git_attr__true
24 #define ATTR__FALSE git_attr__false
25 #define ATTR__UNSET NULL
26 #define ATTR__UNKNOWN git_attr__unknown
28 struct git_attr {
29 unsigned int attr_nr; /* unique attribute number */
30 char name[FLEX_ARRAY]; /* attribute name */
33 const char *git_attr_name(const struct git_attr *attr)
35 return attr->name;
38 struct attr_hashmap {
39 struct hashmap map;
40 pthread_mutex_t mutex;
43 static inline void hashmap_lock(struct attr_hashmap *map)
45 pthread_mutex_lock(&map->mutex);
48 static inline void hashmap_unlock(struct attr_hashmap *map)
50 pthread_mutex_unlock(&map->mutex);
53 /* The container for objects stored in "struct attr_hashmap" */
54 struct attr_hash_entry {
55 struct hashmap_entry ent;
56 const char *key; /* the key; memory should be owned by value */
57 size_t keylen; /* length of the key */
58 void *value; /* the stored value */
61 /* attr_hashmap comparison function */
62 static int attr_hash_entry_cmp(const void *cmp_data UNUSED,
63 const struct hashmap_entry *eptr,
64 const struct hashmap_entry *entry_or_key,
65 const void *keydata UNUSED)
67 const struct attr_hash_entry *a, *b;
69 a = container_of(eptr, const struct attr_hash_entry, ent);
70 b = container_of(entry_or_key, const struct attr_hash_entry, ent);
71 return (a->keylen != b->keylen) || strncmp(a->key, b->key, a->keylen);
75 * The global dictionary of all interned attributes. This
76 * is a singleton object which is shared between threads.
77 * Access to this dictionary must be surrounded with a mutex.
79 static struct attr_hashmap g_attr_hashmap = {
80 .map = HASHMAP_INIT(attr_hash_entry_cmp, NULL),
84 * Retrieve the 'value' stored in a hashmap given the provided 'key'.
85 * If there is no matching entry, return NULL.
87 static void *attr_hashmap_get(struct attr_hashmap *map,
88 const char *key, size_t keylen)
90 struct attr_hash_entry k;
91 struct attr_hash_entry *e;
93 hashmap_entry_init(&k.ent, memhash(key, keylen));
94 k.key = key;
95 k.keylen = keylen;
96 e = hashmap_get_entry(&map->map, &k, ent, NULL);
98 return e ? e->value : NULL;
101 /* Add 'value' to a hashmap based on the provided 'key'. */
102 static void attr_hashmap_add(struct attr_hashmap *map,
103 const char *key, size_t keylen,
104 void *value)
106 struct attr_hash_entry *e;
108 e = xmalloc(sizeof(struct attr_hash_entry));
109 hashmap_entry_init(&e->ent, memhash(key, keylen));
110 e->key = key;
111 e->keylen = keylen;
112 e->value = value;
114 hashmap_add(&map->map, &e->ent);
117 struct all_attrs_item {
118 const struct git_attr *attr;
119 const char *value;
121 * If 'macro' is non-NULL, indicates that 'attr' is a macro based on
122 * the current attribute stack and contains a pointer to the match_attr
123 * definition of the macro
125 const struct match_attr *macro;
129 * Reallocate and reinitialize the array of all attributes (which is used in
130 * the attribute collection process) in 'check' based on the global dictionary
131 * of attributes.
133 static void all_attrs_init(struct attr_hashmap *map, struct attr_check *check)
135 int i;
136 unsigned int size;
138 hashmap_lock(map);
140 size = hashmap_get_size(&map->map);
141 if (size < check->all_attrs_nr)
142 BUG("interned attributes shouldn't be deleted");
145 * If the number of attributes in the global dictionary has increased
146 * (or this attr_check instance doesn't have an initialized all_attrs
147 * field), reallocate the provided attr_check instance's all_attrs
148 * field and fill each entry with its corresponding git_attr.
150 if (size != check->all_attrs_nr) {
151 struct attr_hash_entry *e;
152 struct hashmap_iter iter;
154 REALLOC_ARRAY(check->all_attrs, size);
155 check->all_attrs_nr = size;
157 hashmap_for_each_entry(&map->map, &iter, e,
158 ent /* member name */) {
159 const struct git_attr *a = e->value;
160 check->all_attrs[a->attr_nr].attr = a;
164 hashmap_unlock(map);
167 * Re-initialize every entry in check->all_attrs.
168 * This re-initialization can live outside of the locked region since
169 * the attribute dictionary is no longer being accessed.
171 for (i = 0; i < check->all_attrs_nr; i++) {
172 check->all_attrs[i].value = ATTR__UNKNOWN;
173 check->all_attrs[i].macro = NULL;
177 static int attr_name_valid(const char *name, size_t namelen)
180 * Attribute name cannot begin with '-' and must consist of
181 * characters from [-A-Za-z0-9_.].
183 if (namelen <= 0 || *name == '-')
184 return 0;
185 while (namelen--) {
186 char ch = *name++;
187 if (! (ch == '-' || ch == '.' || ch == '_' ||
188 ('0' <= ch && ch <= '9') ||
189 ('a' <= ch && ch <= 'z') ||
190 ('A' <= ch && ch <= 'Z')) )
191 return 0;
193 return 1;
196 static void report_invalid_attr(const char *name, size_t len,
197 const char *src, int lineno)
199 struct strbuf err = STRBUF_INIT;
200 strbuf_addf(&err, _("%.*s is not a valid attribute name"),
201 (int) len, name);
202 fprintf(stderr, "%s: %s:%d\n", err.buf, src, lineno);
203 strbuf_release(&err);
207 * Given a 'name', lookup and return the corresponding attribute in the global
208 * dictionary. If no entry is found, create a new attribute and store it in
209 * the dictionary.
211 static const struct git_attr *git_attr_internal(const char *name, size_t namelen)
213 struct git_attr *a;
215 if (!attr_name_valid(name, namelen))
216 return NULL;
218 hashmap_lock(&g_attr_hashmap);
220 a = attr_hashmap_get(&g_attr_hashmap, name, namelen);
222 if (!a) {
223 FLEX_ALLOC_MEM(a, name, name, namelen);
224 a->attr_nr = hashmap_get_size(&g_attr_hashmap.map);
226 attr_hashmap_add(&g_attr_hashmap, a->name, namelen, a);
227 if (a->attr_nr != hashmap_get_size(&g_attr_hashmap.map) - 1)
228 die(_("unable to add additional attribute"));
231 hashmap_unlock(&g_attr_hashmap);
233 return a;
236 const struct git_attr *git_attr(const char *name)
238 return git_attr_internal(name, strlen(name));
241 /* What does a matched pattern decide? */
242 struct attr_state {
243 const struct git_attr *attr;
244 const char *setto;
247 struct pattern {
248 const char *pattern;
249 int patternlen;
250 int nowildcardlen;
251 unsigned flags; /* PATTERN_FLAG_* */
255 * One rule, as from a .gitattributes file.
257 * If is_macro is true, then u.attr is a pointer to the git_attr being
258 * defined.
260 * If is_macro is false, then u.pat is the filename pattern to which the
261 * rule applies.
263 * In either case, num_attr is the number of attributes affected by
264 * this rule, and state is an array listing them. The attributes are
265 * listed as they appear in the file (macros unexpanded).
267 struct match_attr {
268 union {
269 struct pattern pat;
270 const struct git_attr *attr;
271 } u;
272 char is_macro;
273 size_t num_attr;
274 struct attr_state state[FLEX_ARRAY];
277 static const char blank[] = " \t\r\n";
279 /* Flags usable in read_attr() and parse_attr_line() family of functions. */
280 #define READ_ATTR_MACRO_OK (1<<0)
281 #define READ_ATTR_NOFOLLOW (1<<1)
284 * Parse a whitespace-delimited attribute state (i.e., "attr",
285 * "-attr", "!attr", or "attr=value") from the string starting at src.
286 * If e is not NULL, write the results to *e. Return a pointer to the
287 * remainder of the string (with leading whitespace removed), or NULL
288 * if there was an error.
290 static const char *parse_attr(const char *src, int lineno, const char *cp,
291 struct attr_state *e)
293 const char *ep, *equals;
294 size_t len;
296 ep = cp + strcspn(cp, blank);
297 equals = strchr(cp, '=');
298 if (equals && ep < equals)
299 equals = NULL;
300 if (equals)
301 len = equals - cp;
302 else
303 len = ep - cp;
304 if (!e) {
305 if (*cp == '-' || *cp == '!') {
306 cp++;
307 len--;
309 if (!attr_name_valid(cp, len)) {
310 report_invalid_attr(cp, len, src, lineno);
311 return NULL;
313 } else {
315 * As this function is always called twice, once with
316 * e == NULL in the first pass and then e != NULL in
317 * the second pass, no need for attr_name_valid()
318 * check here.
320 if (*cp == '-' || *cp == '!') {
321 e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
322 cp++;
323 len--;
325 else if (!equals)
326 e->setto = ATTR__TRUE;
327 else {
328 e->setto = xmemdupz(equals + 1, ep - equals - 1);
330 e->attr = git_attr_internal(cp, len);
332 return ep + strspn(ep, blank);
335 static struct match_attr *parse_attr_line(const char *line, const char *src,
336 int lineno, unsigned flags)
338 size_t namelen, num_attr, i;
339 const char *cp, *name, *states;
340 struct match_attr *res = NULL;
341 int is_macro;
342 struct strbuf pattern = STRBUF_INIT;
344 cp = line + strspn(line, blank);
345 if (!*cp || *cp == '#')
346 return NULL;
347 name = cp;
349 if (strlen(line) >= ATTR_MAX_LINE_LENGTH) {
350 warning(_("ignoring overly long attributes line %d"), lineno);
351 return NULL;
354 if (*cp == '"' && !unquote_c_style(&pattern, name, &states)) {
355 name = pattern.buf;
356 namelen = pattern.len;
357 } else {
358 namelen = strcspn(name, blank);
359 states = name + namelen;
362 if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
363 starts_with(name, ATTRIBUTE_MACRO_PREFIX)) {
364 if (!(flags & READ_ATTR_MACRO_OK)) {
365 fprintf_ln(stderr, _("%s not allowed: %s:%d"),
366 name, src, lineno);
367 goto fail_return;
369 is_macro = 1;
370 name += strlen(ATTRIBUTE_MACRO_PREFIX);
371 name += strspn(name, blank);
372 namelen = strcspn(name, blank);
373 if (!attr_name_valid(name, namelen)) {
374 report_invalid_attr(name, namelen, src, lineno);
375 goto fail_return;
378 else
379 is_macro = 0;
381 states += strspn(states, blank);
383 /* First pass to count the attr_states */
384 for (cp = states, num_attr = 0; *cp; num_attr++) {
385 cp = parse_attr(src, lineno, cp, NULL);
386 if (!cp)
387 goto fail_return;
390 res = xcalloc(1, st_add3(sizeof(*res),
391 st_mult(sizeof(struct attr_state), num_attr),
392 is_macro ? 0 : namelen + 1));
393 if (is_macro) {
394 res->u.attr = git_attr_internal(name, namelen);
395 } else {
396 char *p = (char *)&(res->state[num_attr]);
397 memcpy(p, name, namelen);
398 res->u.pat.pattern = p;
399 parse_path_pattern(&res->u.pat.pattern,
400 &res->u.pat.patternlen,
401 &res->u.pat.flags,
402 &res->u.pat.nowildcardlen);
403 if (res->u.pat.flags & PATTERN_FLAG_NEGATIVE) {
404 warning(_("Negative patterns are ignored in git attributes\n"
405 "Use '\\!' for literal leading exclamation."));
406 goto fail_return;
409 res->is_macro = is_macro;
410 res->num_attr = num_attr;
412 /* Second pass to fill the attr_states */
413 for (cp = states, i = 0; *cp; i++) {
414 cp = parse_attr(src, lineno, cp, &(res->state[i]));
417 strbuf_release(&pattern);
418 return res;
420 fail_return:
421 strbuf_release(&pattern);
422 free(res);
423 return NULL;
427 * Like info/exclude and .gitignore, the attribute information can
428 * come from many places.
430 * (1) .gitattributes file of the same directory;
431 * (2) .gitattributes file of the parent directory if (1) does not have
432 * any match; this goes recursively upwards, just like .gitignore.
433 * (3) $GIT_DIR/info/attributes, which overrides both of the above.
435 * In the same file, later entries override the earlier match, so in the
436 * global list, we would have entries from info/attributes the earliest
437 * (reading the file from top to bottom), .gitattributes of the root
438 * directory (again, reading the file from top to bottom) down to the
439 * current directory, and then scan the list backwards to find the first match.
440 * This is exactly the same as what is_excluded() does in dir.c to deal with
441 * .gitignore file and info/excludes file as a fallback.
444 struct attr_stack {
445 struct attr_stack *prev;
446 char *origin;
447 size_t originlen;
448 unsigned num_matches;
449 unsigned alloc;
450 struct match_attr **attrs;
453 static void attr_stack_free(struct attr_stack *e)
455 unsigned i;
456 free(e->origin);
457 for (i = 0; i < e->num_matches; i++) {
458 struct match_attr *a = e->attrs[i];
459 size_t j;
461 for (j = 0; j < a->num_attr; j++) {
462 const char *setto = a->state[j].setto;
463 if (setto == ATTR__TRUE ||
464 setto == ATTR__FALSE ||
465 setto == ATTR__UNSET ||
466 setto == ATTR__UNKNOWN)
468 else
469 free((char *) setto);
471 free(a);
473 free(e->attrs);
474 free(e);
477 static void drop_attr_stack(struct attr_stack **stack)
479 while (*stack) {
480 struct attr_stack *elem = *stack;
481 *stack = elem->prev;
482 attr_stack_free(elem);
486 /* List of all attr_check structs; access should be surrounded by mutex */
487 static struct check_vector {
488 size_t nr;
489 size_t alloc;
490 struct attr_check **checks;
491 pthread_mutex_t mutex;
492 } check_vector;
494 static inline void vector_lock(void)
496 pthread_mutex_lock(&check_vector.mutex);
499 static inline void vector_unlock(void)
501 pthread_mutex_unlock(&check_vector.mutex);
504 static void check_vector_add(struct attr_check *c)
506 vector_lock();
508 ALLOC_GROW(check_vector.checks,
509 check_vector.nr + 1,
510 check_vector.alloc);
511 check_vector.checks[check_vector.nr++] = c;
513 vector_unlock();
516 static void check_vector_remove(struct attr_check *check)
518 int i;
520 vector_lock();
522 /* Find entry */
523 for (i = 0; i < check_vector.nr; i++)
524 if (check_vector.checks[i] == check)
525 break;
527 if (i >= check_vector.nr)
528 BUG("no entry found");
530 /* shift entries over */
531 for (; i < check_vector.nr - 1; i++)
532 check_vector.checks[i] = check_vector.checks[i + 1];
534 check_vector.nr--;
536 vector_unlock();
539 /* Iterate through all attr_check instances and drop their stacks */
540 static void drop_all_attr_stacks(void)
542 int i;
544 vector_lock();
546 for (i = 0; i < check_vector.nr; i++) {
547 drop_attr_stack(&check_vector.checks[i]->stack);
550 vector_unlock();
553 struct attr_check *attr_check_alloc(void)
555 struct attr_check *c = xcalloc(1, sizeof(struct attr_check));
557 /* save pointer to the check struct */
558 check_vector_add(c);
560 return c;
563 struct attr_check *attr_check_initl(const char *one, ...)
565 struct attr_check *check;
566 int cnt;
567 va_list params;
568 const char *param;
570 va_start(params, one);
571 for (cnt = 1; (param = va_arg(params, const char *)) != NULL; cnt++)
573 va_end(params);
575 check = attr_check_alloc();
576 check->nr = cnt;
577 check->alloc = cnt;
578 CALLOC_ARRAY(check->items, cnt);
580 check->items[0].attr = git_attr(one);
581 va_start(params, one);
582 for (cnt = 1; cnt < check->nr; cnt++) {
583 const struct git_attr *attr;
584 param = va_arg(params, const char *);
585 if (!param)
586 BUG("counted %d != ended at %d",
587 check->nr, cnt);
588 attr = git_attr(param);
589 if (!attr)
590 BUG("%s: not a valid attribute name", param);
591 check->items[cnt].attr = attr;
593 va_end(params);
594 return check;
597 struct attr_check *attr_check_dup(const struct attr_check *check)
599 struct attr_check *ret;
601 if (!check)
602 return NULL;
604 ret = attr_check_alloc();
606 ret->nr = check->nr;
607 ret->alloc = check->alloc;
608 DUP_ARRAY(ret->items, check->items, ret->nr);
610 return ret;
613 struct attr_check_item *attr_check_append(struct attr_check *check,
614 const struct git_attr *attr)
616 struct attr_check_item *item;
618 ALLOC_GROW(check->items, check->nr + 1, check->alloc);
619 item = &check->items[check->nr++];
620 item->attr = attr;
621 return item;
624 void attr_check_reset(struct attr_check *check)
626 check->nr = 0;
629 void attr_check_clear(struct attr_check *check)
631 FREE_AND_NULL(check->items);
632 check->alloc = 0;
633 check->nr = 0;
635 FREE_AND_NULL(check->all_attrs);
636 check->all_attrs_nr = 0;
638 drop_attr_stack(&check->stack);
641 void attr_check_free(struct attr_check *check)
643 if (check) {
644 /* Remove check from the check vector */
645 check_vector_remove(check);
647 attr_check_clear(check);
648 free(check);
652 static const char *builtin_attr[] = {
653 "[attr]binary -diff -merge -text",
654 NULL,
657 static void handle_attr_line(struct attr_stack *res,
658 const char *line,
659 const char *src,
660 int lineno,
661 unsigned flags)
663 struct match_attr *a;
665 a = parse_attr_line(line, src, lineno, flags);
666 if (!a)
667 return;
668 ALLOC_GROW_BY(res->attrs, res->num_matches, 1, res->alloc);
669 res->attrs[res->num_matches - 1] = a;
672 static struct attr_stack *read_attr_from_array(const char **list)
674 struct attr_stack *res;
675 const char *line;
676 int lineno = 0;
678 CALLOC_ARRAY(res, 1);
679 while ((line = *(list++)) != NULL)
680 handle_attr_line(res, line, "[builtin]", ++lineno,
681 READ_ATTR_MACRO_OK);
682 return res;
686 * Callers into the attribute system assume there is a single, system-wide
687 * global state where attributes are read from and when the state is flipped by
688 * calling git_attr_set_direction(), the stack frames that have been
689 * constructed need to be discarded so that subsequent calls into the
690 * attribute system will lazily read from the right place. Since changing
691 * direction causes a global paradigm shift, it should not ever be called while
692 * another thread could potentially be calling into the attribute system.
694 static enum git_attr_direction direction;
696 void git_attr_set_direction(enum git_attr_direction new_direction)
698 if (is_bare_repository() && new_direction != GIT_ATTR_INDEX)
699 BUG("non-INDEX attr direction in a bare repo");
701 if (new_direction != direction)
702 drop_all_attr_stacks();
704 direction = new_direction;
707 static struct attr_stack *read_attr_from_file(const char *path, unsigned flags)
709 struct strbuf buf = STRBUF_INIT;
710 int fd;
711 FILE *fp;
712 struct attr_stack *res;
713 int lineno = 0;
714 struct stat st;
716 if (flags & READ_ATTR_NOFOLLOW)
717 fd = open_nofollow(path, O_RDONLY);
718 else
719 fd = open(path, O_RDONLY);
721 if (fd < 0) {
722 warn_on_fopen_errors(path);
723 return NULL;
725 fp = xfdopen(fd, "r");
726 if (fstat(fd, &st)) {
727 warning_errno(_("cannot fstat gitattributes file '%s'"), path);
728 fclose(fp);
729 return NULL;
731 if (st.st_size >= ATTR_MAX_FILE_SIZE) {
732 warning(_("ignoring overly large gitattributes file '%s'"), path);
733 fclose(fp);
734 return NULL;
737 CALLOC_ARRAY(res, 1);
738 while (strbuf_getline(&buf, fp) != EOF) {
739 if (!lineno && starts_with(buf.buf, utf8_bom))
740 strbuf_remove(&buf, 0, strlen(utf8_bom));
741 handle_attr_line(res, buf.buf, path, ++lineno, flags);
744 fclose(fp);
745 strbuf_release(&buf);
746 return res;
749 static struct attr_stack *read_attr_from_buf(char *buf, const char *path,
750 unsigned flags)
752 struct attr_stack *res;
753 char *sp;
754 int lineno = 0;
756 if (!buf)
757 return NULL;
759 CALLOC_ARRAY(res, 1);
760 for (sp = buf; *sp;) {
761 char *ep;
762 int more;
764 ep = strchrnul(sp, '\n');
765 more = (*ep == '\n');
766 *ep = '\0';
767 handle_attr_line(res, sp, path, ++lineno, flags);
768 sp = ep + more;
770 free(buf);
772 return res;
775 static struct attr_stack *read_attr_from_blob(struct index_state *istate,
776 const struct object_id *tree_oid,
777 const char *path, unsigned flags)
779 struct object_id oid;
780 unsigned long sz;
781 enum object_type type;
782 void *buf;
783 unsigned short mode;
785 if (!tree_oid)
786 return NULL;
788 if (get_tree_entry(istate->repo, tree_oid, path, &oid, &mode))
789 return NULL;
791 buf = repo_read_object_file(istate->repo, &oid, &type, &sz);
792 if (!buf || type != OBJ_BLOB) {
793 free(buf);
794 return NULL;
797 return read_attr_from_buf(buf, path, flags);
800 static struct attr_stack *read_attr_from_index(struct index_state *istate,
801 const char *path, unsigned flags)
803 char *buf;
804 unsigned long size;
806 if (!istate)
807 return NULL;
810 * The .gitattributes file only applies to files within its
811 * parent directory. In the case of cone-mode sparse-checkout,
812 * the .gitattributes file is sparse if and only if all paths
813 * within that directory are also sparse. Thus, don't load the
814 * .gitattributes file since it will not matter.
816 * In the case of a sparse index, it is critical that we don't go
817 * looking for a .gitattributes file, as doing so would cause the
818 * index to expand.
820 if (!path_in_cone_mode_sparse_checkout(path, istate))
821 return NULL;
823 buf = read_blob_data_from_index(istate, path, &size);
824 if (!buf)
825 return NULL;
826 if (size >= ATTR_MAX_FILE_SIZE) {
827 warning(_("ignoring overly large gitattributes blob '%s'"), path);
828 return NULL;
831 return read_attr_from_buf(buf, path, flags);
834 static struct attr_stack *read_attr(struct index_state *istate,
835 const struct object_id *tree_oid,
836 const char *path, unsigned flags)
838 struct attr_stack *res = NULL;
840 if (direction == GIT_ATTR_INDEX) {
841 res = read_attr_from_index(istate, path, flags);
842 } else if (tree_oid) {
843 res = read_attr_from_blob(istate, tree_oid, path, flags);
844 } else if (!is_bare_repository()) {
845 if (direction == GIT_ATTR_CHECKOUT) {
846 res = read_attr_from_index(istate, path, flags);
847 if (!res)
848 res = read_attr_from_file(path, flags);
849 } else if (direction == GIT_ATTR_CHECKIN) {
850 res = read_attr_from_file(path, flags);
851 if (!res)
853 * There is no checked out .gitattributes file
854 * there, but we might have it in the index.
855 * We allow operation in a sparsely checked out
856 * work tree, so read from it.
858 res = read_attr_from_index(istate, path, flags);
862 if (!res)
863 CALLOC_ARRAY(res, 1);
864 return res;
867 static const char *git_etc_gitattributes(void)
869 static const char *system_wide;
870 if (!system_wide)
871 system_wide = system_path(ETC_GITATTRIBUTES);
872 return system_wide;
875 static const char *get_home_gitattributes(void)
877 if (!git_attributes_file)
878 git_attributes_file = xdg_config_home("attributes");
880 return git_attributes_file;
883 static int git_attr_system(void)
885 return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
888 static GIT_PATH_FUNC(git_path_info_attributes, INFOATTRIBUTES_FILE)
890 static void push_stack(struct attr_stack **attr_stack_p,
891 struct attr_stack *elem, char *origin, size_t originlen)
893 if (elem) {
894 elem->origin = origin;
895 if (origin)
896 elem->originlen = originlen;
897 elem->prev = *attr_stack_p;
898 *attr_stack_p = elem;
902 static void bootstrap_attr_stack(struct index_state *istate,
903 const struct object_id *tree_oid,
904 struct attr_stack **stack)
906 struct attr_stack *e;
907 unsigned flags = READ_ATTR_MACRO_OK;
909 if (*stack)
910 return;
912 /* builtin frame */
913 e = read_attr_from_array(builtin_attr);
914 push_stack(stack, e, NULL, 0);
916 /* system-wide frame */
917 if (git_attr_system()) {
918 e = read_attr_from_file(git_etc_gitattributes(), flags);
919 push_stack(stack, e, NULL, 0);
922 /* home directory */
923 if (get_home_gitattributes()) {
924 e = read_attr_from_file(get_home_gitattributes(), flags);
925 push_stack(stack, e, NULL, 0);
928 /* root directory */
929 e = read_attr(istate, tree_oid, GITATTRIBUTES_FILE, flags | READ_ATTR_NOFOLLOW);
930 push_stack(stack, e, xstrdup(""), 0);
932 /* info frame */
933 if (startup_info->have_repository)
934 e = read_attr_from_file(git_path_info_attributes(), flags);
935 else
936 e = NULL;
937 if (!e)
938 CALLOC_ARRAY(e, 1);
939 push_stack(stack, e, NULL, 0);
942 static void prepare_attr_stack(struct index_state *istate,
943 const struct object_id *tree_oid,
944 const char *path, int dirlen,
945 struct attr_stack **stack)
947 struct attr_stack *info;
948 struct strbuf pathbuf = STRBUF_INIT;
951 * At the bottom of the attribute stack is the built-in
952 * set of attribute definitions, followed by the contents
953 * of $(prefix)/etc/gitattributes and a file specified by
954 * core.attributesfile. Then, contents from
955 * .gitattributes files from directories closer to the
956 * root to the ones in deeper directories are pushed
957 * to the stack. Finally, at the very top of the stack
958 * we always keep the contents of $GIT_DIR/info/attributes.
960 * When checking, we use entries from near the top of the
961 * stack, preferring $GIT_DIR/info/attributes, then
962 * .gitattributes in deeper directories to shallower ones,
963 * and finally use the built-in set as the default.
965 bootstrap_attr_stack(istate, tree_oid, stack);
968 * Pop the "info" one that is always at the top of the stack.
970 info = *stack;
971 *stack = info->prev;
974 * Pop the ones from directories that are not the prefix of
975 * the path we are checking. Break out of the loop when we see
976 * the root one (whose origin is an empty string "") or the builtin
977 * one (whose origin is NULL) without popping it.
979 while ((*stack)->origin) {
980 int namelen = (*stack)->originlen;
981 struct attr_stack *elem;
983 elem = *stack;
984 if (namelen <= dirlen &&
985 !strncmp(elem->origin, path, namelen) &&
986 (!namelen || path[namelen] == '/'))
987 break;
989 *stack = elem->prev;
990 attr_stack_free(elem);
994 * bootstrap_attr_stack() should have added, and the
995 * above loop should have stopped before popping, the
996 * root element whose attr_stack->origin is set to an
997 * empty string.
999 assert((*stack)->origin);
1001 strbuf_addstr(&pathbuf, (*stack)->origin);
1002 /* Build up to the directory 'path' is in */
1003 while (pathbuf.len < dirlen) {
1004 size_t len = pathbuf.len;
1005 struct attr_stack *next;
1006 char *origin;
1008 /* Skip path-separator */
1009 if (len < dirlen && is_dir_sep(path[len]))
1010 len++;
1011 /* Find the end of the next component */
1012 while (len < dirlen && !is_dir_sep(path[len]))
1013 len++;
1015 if (pathbuf.len > 0)
1016 strbuf_addch(&pathbuf, '/');
1017 strbuf_add(&pathbuf, path + pathbuf.len, (len - pathbuf.len));
1018 strbuf_addf(&pathbuf, "/%s", GITATTRIBUTES_FILE);
1020 next = read_attr(istate, tree_oid, pathbuf.buf, READ_ATTR_NOFOLLOW);
1022 /* reset the pathbuf to not include "/.gitattributes" */
1023 strbuf_setlen(&pathbuf, len);
1025 origin = xstrdup(pathbuf.buf);
1026 push_stack(stack, next, origin, len);
1030 * Finally push the "info" one at the top of the stack.
1032 push_stack(stack, info, NULL, 0);
1034 strbuf_release(&pathbuf);
1037 static int path_matches(const char *pathname, int pathlen,
1038 int basename_offset,
1039 const struct pattern *pat,
1040 const char *base, int baselen)
1042 const char *pattern = pat->pattern;
1043 int prefix = pat->nowildcardlen;
1044 int isdir = (pathlen && pathname[pathlen - 1] == '/');
1046 if ((pat->flags & PATTERN_FLAG_MUSTBEDIR) && !isdir)
1047 return 0;
1049 if (pat->flags & PATTERN_FLAG_NODIR) {
1050 return match_basename(pathname + basename_offset,
1051 pathlen - basename_offset - isdir,
1052 pattern, prefix,
1053 pat->patternlen, pat->flags);
1055 return match_pathname(pathname, pathlen - isdir,
1056 base, baselen,
1057 pattern, prefix, pat->patternlen);
1060 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem);
1062 static int fill_one(struct all_attrs_item *all_attrs,
1063 const struct match_attr *a, int rem)
1065 size_t i;
1067 for (i = a->num_attr; rem > 0 && i > 0; i--) {
1068 const struct git_attr *attr = a->state[i - 1].attr;
1069 const char **n = &(all_attrs[attr->attr_nr].value);
1070 const char *v = a->state[i - 1].setto;
1072 if (*n == ATTR__UNKNOWN) {
1073 *n = v;
1074 rem--;
1075 rem = macroexpand_one(all_attrs, attr->attr_nr, rem);
1078 return rem;
1081 static int fill(const char *path, int pathlen, int basename_offset,
1082 const struct attr_stack *stack,
1083 struct all_attrs_item *all_attrs, int rem)
1085 for (; rem > 0 && stack; stack = stack->prev) {
1086 unsigned i;
1087 const char *base = stack->origin ? stack->origin : "";
1089 for (i = stack->num_matches; 0 < rem && 0 < i; i--) {
1090 const struct match_attr *a = stack->attrs[i - 1];
1091 if (a->is_macro)
1092 continue;
1093 if (path_matches(path, pathlen, basename_offset,
1094 &a->u.pat, base, stack->originlen))
1095 rem = fill_one(all_attrs, a, rem);
1099 return rem;
1102 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem)
1104 const struct all_attrs_item *item = &all_attrs[nr];
1106 if (item->macro && item->value == ATTR__TRUE)
1107 return fill_one(all_attrs, item->macro, rem);
1108 else
1109 return rem;
1113 * Marks the attributes which are macros based on the attribute stack.
1114 * This prevents having to search through the attribute stack each time
1115 * a macro needs to be expanded during the fill stage.
1117 static void determine_macros(struct all_attrs_item *all_attrs,
1118 const struct attr_stack *stack)
1120 for (; stack; stack = stack->prev) {
1121 unsigned i;
1122 for (i = stack->num_matches; i > 0; i--) {
1123 const struct match_attr *ma = stack->attrs[i - 1];
1124 if (ma->is_macro) {
1125 unsigned int n = ma->u.attr->attr_nr;
1126 if (!all_attrs[n].macro) {
1127 all_attrs[n].macro = ma;
1135 * Collect attributes for path into the array pointed to by check->all_attrs.
1136 * If check->check_nr is non-zero, only attributes in check[] are collected.
1137 * Otherwise all attributes are collected.
1139 static void collect_some_attrs(struct index_state *istate,
1140 const struct object_id *tree_oid,
1141 const char *path, struct attr_check *check)
1143 int pathlen, rem, dirlen;
1144 const char *cp, *last_slash = NULL;
1145 int basename_offset;
1147 for (cp = path; *cp; cp++) {
1148 if (*cp == '/' && cp[1])
1149 last_slash = cp;
1151 pathlen = cp - path;
1152 if (last_slash) {
1153 basename_offset = last_slash + 1 - path;
1154 dirlen = last_slash - path;
1155 } else {
1156 basename_offset = 0;
1157 dirlen = 0;
1160 prepare_attr_stack(istate, tree_oid, path, dirlen, &check->stack);
1161 all_attrs_init(&g_attr_hashmap, check);
1162 determine_macros(check->all_attrs, check->stack);
1164 rem = check->all_attrs_nr;
1165 fill(path, pathlen, basename_offset, check->stack, check->all_attrs, rem);
1168 void git_check_attr(struct index_state *istate,
1169 const struct object_id *tree_oid, const char *path,
1170 struct attr_check *check)
1172 int i;
1174 collect_some_attrs(istate, tree_oid, path, check);
1176 for (i = 0; i < check->nr; i++) {
1177 unsigned int n = check->items[i].attr->attr_nr;
1178 const char *value = check->all_attrs[n].value;
1179 if (value == ATTR__UNKNOWN)
1180 value = ATTR__UNSET;
1181 check->items[i].value = value;
1185 void git_all_attrs(struct index_state *istate, const struct object_id *tree_oid,
1186 const char *path, struct attr_check *check)
1188 int i;
1190 attr_check_reset(check);
1191 collect_some_attrs(istate, tree_oid, path, check);
1193 for (i = 0; i < check->all_attrs_nr; i++) {
1194 const char *name = check->all_attrs[i].attr->name;
1195 const char *value = check->all_attrs[i].value;
1196 struct attr_check_item *item;
1197 if (value == ATTR__UNSET || value == ATTR__UNKNOWN)
1198 continue;
1199 item = attr_check_append(check, git_attr(name));
1200 item->value = value;
1204 void attr_start(void)
1206 pthread_mutex_init(&g_attr_hashmap.mutex, NULL);
1207 pthread_mutex_init(&check_vector.mutex, NULL);