Merge branch 'rs/format-patch-pathspec-fix'
[alt-git.git] / attr.c
blob21e4ad25ada625885ebcc524facf6a9ce816d39e
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 "thread-utils.h"
18 const char git_attr__true[] = "(builtin)true";
19 const char git_attr__false[] = "\0(builtin)false";
20 static const char git_attr__unknown[] = "(builtin)unknown";
21 #define ATTR__TRUE git_attr__true
22 #define ATTR__FALSE git_attr__false
23 #define ATTR__UNSET NULL
24 #define ATTR__UNKNOWN git_attr__unknown
26 #ifndef DEBUG_ATTR
27 #define DEBUG_ATTR 0
28 #endif
30 struct git_attr {
31 int attr_nr; /* unique attribute number */
32 char name[FLEX_ARRAY]; /* attribute name */
35 const char *git_attr_name(const struct git_attr *attr)
37 return attr->name;
40 struct attr_hashmap {
41 struct hashmap map;
42 pthread_mutex_t mutex;
45 static inline void hashmap_lock(struct attr_hashmap *map)
47 pthread_mutex_lock(&map->mutex);
50 static inline void hashmap_unlock(struct attr_hashmap *map)
52 pthread_mutex_unlock(&map->mutex);
55 /* The container for objects stored in "struct attr_hashmap" */
56 struct attr_hash_entry {
57 struct hashmap_entry ent;
58 const char *key; /* the key; memory should be owned by value */
59 size_t keylen; /* length of the key */
60 void *value; /* the stored value */
63 /* attr_hashmap comparison function */
64 static int attr_hash_entry_cmp(const void *unused_cmp_data,
65 const struct hashmap_entry *eptr,
66 const struct hashmap_entry *entry_or_key,
67 const void *unused_keydata)
69 const struct attr_hash_entry *a, *b;
71 a = container_of(eptr, const struct attr_hash_entry, ent);
72 b = container_of(entry_or_key, const struct attr_hash_entry, ent);
73 return (a->keylen != b->keylen) || strncmp(a->key, b->key, a->keylen);
77 * The global dictionary of all interned attributes. This
78 * is a singleton object which is shared between threads.
79 * Access to this dictionary must be surrounded with a mutex.
81 static struct attr_hashmap g_attr_hashmap = {
82 .map = HASHMAP_INIT(attr_hash_entry_cmp, NULL),
86 * Retrieve the 'value' stored in a hashmap given the provided 'key'.
87 * If there is no matching entry, return NULL.
89 static void *attr_hashmap_get(struct attr_hashmap *map,
90 const char *key, size_t keylen)
92 struct attr_hash_entry k;
93 struct attr_hash_entry *e;
95 hashmap_entry_init(&k.ent, memhash(key, keylen));
96 k.key = key;
97 k.keylen = keylen;
98 e = hashmap_get_entry(&map->map, &k, ent, NULL);
100 return e ? e->value : NULL;
103 /* Add 'value' to a hashmap based on the provided 'key'. */
104 static void attr_hashmap_add(struct attr_hashmap *map,
105 const char *key, size_t keylen,
106 void *value)
108 struct attr_hash_entry *e;
110 e = xmalloc(sizeof(struct attr_hash_entry));
111 hashmap_entry_init(&e->ent, memhash(key, keylen));
112 e->key = key;
113 e->keylen = keylen;
114 e->value = value;
116 hashmap_add(&map->map, &e->ent);
119 struct all_attrs_item {
120 const struct git_attr *attr;
121 const char *value;
123 * If 'macro' is non-NULL, indicates that 'attr' is a macro based on
124 * the current attribute stack and contains a pointer to the match_attr
125 * definition of the macro
127 const struct match_attr *macro;
131 * Reallocate and reinitialize the array of all attributes (which is used in
132 * the attribute collection process) in 'check' based on the global dictionary
133 * of attributes.
135 static void all_attrs_init(struct attr_hashmap *map, struct attr_check *check)
137 int i;
138 unsigned int size;
140 hashmap_lock(map);
142 size = hashmap_get_size(&map->map);
143 if (size < check->all_attrs_nr)
144 BUG("interned attributes shouldn't be deleted");
147 * If the number of attributes in the global dictionary has increased
148 * (or this attr_check instance doesn't have an initialized all_attrs
149 * field), reallocate the provided attr_check instance's all_attrs
150 * field and fill each entry with its corresponding git_attr.
152 if (size != check->all_attrs_nr) {
153 struct attr_hash_entry *e;
154 struct hashmap_iter iter;
156 REALLOC_ARRAY(check->all_attrs, size);
157 check->all_attrs_nr = size;
159 hashmap_for_each_entry(&map->map, &iter, e,
160 ent /* member name */) {
161 const struct git_attr *a = e->value;
162 check->all_attrs[a->attr_nr].attr = a;
166 hashmap_unlock(map);
169 * Re-initialize every entry in check->all_attrs.
170 * This re-initialization can live outside of the locked region since
171 * the attribute dictionary is no longer being accessed.
173 for (i = 0; i < check->all_attrs_nr; i++) {
174 check->all_attrs[i].value = ATTR__UNKNOWN;
175 check->all_attrs[i].macro = NULL;
179 static int attr_name_valid(const char *name, size_t namelen)
182 * Attribute name cannot begin with '-' and must consist of
183 * characters from [-A-Za-z0-9_.].
185 if (namelen <= 0 || *name == '-')
186 return 0;
187 while (namelen--) {
188 char ch = *name++;
189 if (! (ch == '-' || ch == '.' || ch == '_' ||
190 ('0' <= ch && ch <= '9') ||
191 ('a' <= ch && ch <= 'z') ||
192 ('A' <= ch && ch <= 'Z')) )
193 return 0;
195 return 1;
198 static void report_invalid_attr(const char *name, size_t len,
199 const char *src, int lineno)
201 struct strbuf err = STRBUF_INIT;
202 strbuf_addf(&err, _("%.*s is not a valid attribute name"),
203 (int) len, name);
204 fprintf(stderr, "%s: %s:%d\n", err.buf, src, lineno);
205 strbuf_release(&err);
209 * Given a 'name', lookup and return the corresponding attribute in the global
210 * dictionary. If no entry is found, create a new attribute and store it in
211 * the dictionary.
213 static const struct git_attr *git_attr_internal(const char *name, int namelen)
215 struct git_attr *a;
217 if (!attr_name_valid(name, namelen))
218 return NULL;
220 hashmap_lock(&g_attr_hashmap);
222 a = attr_hashmap_get(&g_attr_hashmap, name, namelen);
224 if (!a) {
225 FLEX_ALLOC_MEM(a, name, name, namelen);
226 a->attr_nr = hashmap_get_size(&g_attr_hashmap.map);
228 attr_hashmap_add(&g_attr_hashmap, a->name, namelen, a);
229 assert(a->attr_nr ==
230 (hashmap_get_size(&g_attr_hashmap.map) - 1));
233 hashmap_unlock(&g_attr_hashmap);
235 return a;
238 const struct git_attr *git_attr(const char *name)
240 return git_attr_internal(name, strlen(name));
243 /* What does a matched pattern decide? */
244 struct attr_state {
245 const struct git_attr *attr;
246 const char *setto;
249 struct pattern {
250 const char *pattern;
251 int patternlen;
252 int nowildcardlen;
253 unsigned flags; /* PATTERN_FLAG_* */
257 * One rule, as from a .gitattributes file.
259 * If is_macro is true, then u.attr is a pointer to the git_attr being
260 * defined.
262 * If is_macro is false, then u.pat is the filename pattern to which the
263 * rule applies.
265 * In either case, num_attr is the number of attributes affected by
266 * this rule, and state is an array listing them. The attributes are
267 * listed as they appear in the file (macros unexpanded).
269 struct match_attr {
270 union {
271 struct pattern pat;
272 const struct git_attr *attr;
273 } u;
274 char is_macro;
275 unsigned num_attr;
276 struct attr_state state[FLEX_ARRAY];
279 static const char blank[] = " \t\r\n";
281 /* Flags usable in read_attr() and parse_attr_line() family of functions. */
282 #define READ_ATTR_MACRO_OK (1<<0)
283 #define READ_ATTR_NOFOLLOW (1<<1)
286 * Parse a whitespace-delimited attribute state (i.e., "attr",
287 * "-attr", "!attr", or "attr=value") from the string starting at src.
288 * If e is not NULL, write the results to *e. Return a pointer to the
289 * remainder of the string (with leading whitespace removed), or NULL
290 * if there was an error.
292 static const char *parse_attr(const char *src, int lineno, const char *cp,
293 struct attr_state *e)
295 const char *ep, *equals;
296 int len;
298 ep = cp + strcspn(cp, blank);
299 equals = strchr(cp, '=');
300 if (equals && ep < equals)
301 equals = NULL;
302 if (equals)
303 len = equals - cp;
304 else
305 len = ep - cp;
306 if (!e) {
307 if (*cp == '-' || *cp == '!') {
308 cp++;
309 len--;
311 if (!attr_name_valid(cp, len)) {
312 report_invalid_attr(cp, len, src, lineno);
313 return NULL;
315 } else {
317 * As this function is always called twice, once with
318 * e == NULL in the first pass and then e != NULL in
319 * the second pass, no need for attr_name_valid()
320 * check here.
322 if (*cp == '-' || *cp == '!') {
323 e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
324 cp++;
325 len--;
327 else if (!equals)
328 e->setto = ATTR__TRUE;
329 else {
330 e->setto = xmemdupz(equals + 1, ep - equals - 1);
332 e->attr = git_attr_internal(cp, len);
334 return ep + strspn(ep, blank);
337 static struct match_attr *parse_attr_line(const char *line, const char *src,
338 int lineno, unsigned flags)
340 int namelen;
341 int num_attr, i;
342 const char *cp, *name, *states;
343 struct match_attr *res = NULL;
344 int is_macro;
345 struct strbuf pattern = STRBUF_INIT;
347 cp = line + strspn(line, blank);
348 if (!*cp || *cp == '#')
349 return NULL;
350 name = cp;
352 if (*cp == '"' && !unquote_c_style(&pattern, name, &states)) {
353 name = pattern.buf;
354 namelen = pattern.len;
355 } else {
356 namelen = strcspn(name, blank);
357 states = name + namelen;
360 if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
361 starts_with(name, ATTRIBUTE_MACRO_PREFIX)) {
362 if (!(flags & READ_ATTR_MACRO_OK)) {
363 fprintf_ln(stderr, _("%s not allowed: %s:%d"),
364 name, src, lineno);
365 goto fail_return;
367 is_macro = 1;
368 name += strlen(ATTRIBUTE_MACRO_PREFIX);
369 name += strspn(name, blank);
370 namelen = strcspn(name, blank);
371 if (!attr_name_valid(name, namelen)) {
372 report_invalid_attr(name, namelen, src, lineno);
373 goto fail_return;
376 else
377 is_macro = 0;
379 states += strspn(states, blank);
381 /* First pass to count the attr_states */
382 for (cp = states, num_attr = 0; *cp; num_attr++) {
383 cp = parse_attr(src, lineno, cp, NULL);
384 if (!cp)
385 goto fail_return;
388 res = xcalloc(1,
389 sizeof(*res) +
390 sizeof(struct attr_state) * num_attr +
391 (is_macro ? 0 : namelen + 1));
392 if (is_macro) {
393 res->u.attr = git_attr_internal(name, namelen);
394 } else {
395 char *p = (char *)&(res->state[num_attr]);
396 memcpy(p, name, namelen);
397 res->u.pat.pattern = p;
398 parse_path_pattern(&res->u.pat.pattern,
399 &res->u.pat.patternlen,
400 &res->u.pat.flags,
401 &res->u.pat.nowildcardlen);
402 if (res->u.pat.flags & PATTERN_FLAG_NEGATIVE) {
403 warning(_("Negative patterns are ignored in git attributes\n"
404 "Use '\\!' for literal leading exclamation."));
405 goto fail_return;
408 res->is_macro = is_macro;
409 res->num_attr = num_attr;
411 /* Second pass to fill the attr_states */
412 for (cp = states, i = 0; *cp; i++) {
413 cp = parse_attr(src, lineno, cp, &(res->state[i]));
416 strbuf_release(&pattern);
417 return res;
419 fail_return:
420 strbuf_release(&pattern);
421 free(res);
422 return NULL;
426 * Like info/exclude and .gitignore, the attribute information can
427 * come from many places.
429 * (1) .gitattributes file of the same directory;
430 * (2) .gitattributes file of the parent directory if (1) does not have
431 * any match; this goes recursively upwards, just like .gitignore.
432 * (3) $GIT_DIR/info/attributes, which overrides both of the above.
434 * In the same file, later entries override the earlier match, so in the
435 * global list, we would have entries from info/attributes the earliest
436 * (reading the file from top to bottom), .gitattributes of the root
437 * directory (again, reading the file from top to bottom) down to the
438 * current directory, and then scan the list backwards to find the first match.
439 * This is exactly the same as what is_excluded() does in dir.c to deal with
440 * .gitignore file and info/excludes file as a fallback.
443 struct attr_stack {
444 struct attr_stack *prev;
445 char *origin;
446 size_t originlen;
447 unsigned num_matches;
448 unsigned alloc;
449 struct match_attr **attrs;
452 static void attr_stack_free(struct attr_stack *e)
454 int i;
455 free(e->origin);
456 for (i = 0; i < e->num_matches; i++) {
457 struct match_attr *a = e->attrs[i];
458 int j;
459 for (j = 0; j < a->num_attr; j++) {
460 const char *setto = a->state[j].setto;
461 if (setto == ATTR__TRUE ||
462 setto == ATTR__FALSE ||
463 setto == ATTR__UNSET ||
464 setto == ATTR__UNKNOWN)
466 else
467 free((char *) setto);
469 free(a);
471 free(e->attrs);
472 free(e);
475 static void drop_attr_stack(struct attr_stack **stack)
477 while (*stack) {
478 struct attr_stack *elem = *stack;
479 *stack = elem->prev;
480 attr_stack_free(elem);
484 /* List of all attr_check structs; access should be surrounded by mutex */
485 static struct check_vector {
486 size_t nr;
487 size_t alloc;
488 struct attr_check **checks;
489 pthread_mutex_t mutex;
490 } check_vector;
492 static inline void vector_lock(void)
494 pthread_mutex_lock(&check_vector.mutex);
497 static inline void vector_unlock(void)
499 pthread_mutex_unlock(&check_vector.mutex);
502 static void check_vector_add(struct attr_check *c)
504 vector_lock();
506 ALLOC_GROW(check_vector.checks,
507 check_vector.nr + 1,
508 check_vector.alloc);
509 check_vector.checks[check_vector.nr++] = c;
511 vector_unlock();
514 static void check_vector_remove(struct attr_check *check)
516 int i;
518 vector_lock();
520 /* Find entry */
521 for (i = 0; i < check_vector.nr; i++)
522 if (check_vector.checks[i] == check)
523 break;
525 if (i >= check_vector.nr)
526 BUG("no entry found");
528 /* shift entries over */
529 for (; i < check_vector.nr - 1; i++)
530 check_vector.checks[i] = check_vector.checks[i + 1];
532 check_vector.nr--;
534 vector_unlock();
537 /* Iterate through all attr_check instances and drop their stacks */
538 static void drop_all_attr_stacks(void)
540 int i;
542 vector_lock();
544 for (i = 0; i < check_vector.nr; i++) {
545 drop_attr_stack(&check_vector.checks[i]->stack);
548 vector_unlock();
551 struct attr_check *attr_check_alloc(void)
553 struct attr_check *c = xcalloc(1, sizeof(struct attr_check));
555 /* save pointer to the check struct */
556 check_vector_add(c);
558 return c;
561 struct attr_check *attr_check_initl(const char *one, ...)
563 struct attr_check *check;
564 int cnt;
565 va_list params;
566 const char *param;
568 va_start(params, one);
569 for (cnt = 1; (param = va_arg(params, const char *)) != NULL; cnt++)
571 va_end(params);
573 check = attr_check_alloc();
574 check->nr = cnt;
575 check->alloc = cnt;
576 CALLOC_ARRAY(check->items, cnt);
578 check->items[0].attr = git_attr(one);
579 va_start(params, one);
580 for (cnt = 1; cnt < check->nr; cnt++) {
581 const struct git_attr *attr;
582 param = va_arg(params, const char *);
583 if (!param)
584 BUG("counted %d != ended at %d",
585 check->nr, cnt);
586 attr = git_attr(param);
587 if (!attr)
588 BUG("%s: not a valid attribute name", param);
589 check->items[cnt].attr = attr;
591 va_end(params);
592 return check;
595 struct attr_check *attr_check_dup(const struct attr_check *check)
597 struct attr_check *ret;
599 if (!check)
600 return NULL;
602 ret = attr_check_alloc();
604 ret->nr = check->nr;
605 ret->alloc = check->alloc;
606 ALLOC_ARRAY(ret->items, ret->nr);
607 COPY_ARRAY(ret->items, check->items, ret->nr);
609 return ret;
612 struct attr_check_item *attr_check_append(struct attr_check *check,
613 const struct git_attr *attr)
615 struct attr_check_item *item;
617 ALLOC_GROW(check->items, check->nr + 1, check->alloc);
618 item = &check->items[check->nr++];
619 item->attr = attr;
620 return item;
623 void attr_check_reset(struct attr_check *check)
625 check->nr = 0;
628 void attr_check_clear(struct attr_check *check)
630 FREE_AND_NULL(check->items);
631 check->alloc = 0;
632 check->nr = 0;
634 FREE_AND_NULL(check->all_attrs);
635 check->all_attrs_nr = 0;
637 drop_attr_stack(&check->stack);
640 void attr_check_free(struct attr_check *check)
642 if (check) {
643 /* Remove check from the check vector */
644 check_vector_remove(check);
646 attr_check_clear(check);
647 free(check);
651 static const char *builtin_attr[] = {
652 "[attr]binary -diff -merge -text",
653 NULL,
656 static void handle_attr_line(struct attr_stack *res,
657 const char *line,
658 const char *src,
659 int lineno,
660 unsigned flags)
662 struct match_attr *a;
664 a = parse_attr_line(line, src, lineno, flags);
665 if (!a)
666 return;
667 ALLOC_GROW(res->attrs, res->num_matches + 1, res->alloc);
668 res->attrs[res->num_matches++] = a;
671 static struct attr_stack *read_attr_from_array(const char **list)
673 struct attr_stack *res;
674 const char *line;
675 int lineno = 0;
677 CALLOC_ARRAY(res, 1);
678 while ((line = *(list++)) != NULL)
679 handle_attr_line(res, line, "[builtin]", ++lineno,
680 READ_ATTR_MACRO_OK);
681 return res;
685 * Callers into the attribute system assume there is a single, system-wide
686 * global state where attributes are read from and when the state is flipped by
687 * calling git_attr_set_direction(), the stack frames that have been
688 * constructed need to be discarded so that subsequent calls into the
689 * attribute system will lazily read from the right place. Since changing
690 * direction causes a global paradigm shift, it should not ever be called while
691 * another thread could potentially be calling into the attribute system.
693 static enum git_attr_direction direction;
695 void git_attr_set_direction(enum git_attr_direction new_direction)
697 if (is_bare_repository() && new_direction != GIT_ATTR_INDEX)
698 BUG("non-INDEX attr direction in a bare repo");
700 if (new_direction != direction)
701 drop_all_attr_stacks();
703 direction = new_direction;
706 static struct attr_stack *read_attr_from_file(const char *path, unsigned flags)
708 int fd;
709 FILE *fp;
710 struct attr_stack *res;
711 char buf[2048];
712 int lineno = 0;
714 if (flags & READ_ATTR_NOFOLLOW)
715 fd = open_nofollow(path, O_RDONLY);
716 else
717 fd = open(path, O_RDONLY);
719 if (fd < 0) {
720 warn_on_fopen_errors(path);
721 return NULL;
723 fp = xfdopen(fd, "r");
725 CALLOC_ARRAY(res, 1);
726 while (fgets(buf, sizeof(buf), fp)) {
727 char *bufp = buf;
728 if (!lineno)
729 skip_utf8_bom(&bufp, strlen(bufp));
730 handle_attr_line(res, bufp, path, ++lineno, flags);
732 fclose(fp);
733 return res;
736 static struct attr_stack *read_attr_from_index(struct index_state *istate,
737 const char *path,
738 unsigned flags)
740 struct attr_stack *res;
741 char *buf, *sp;
742 int lineno = 0;
744 if (!istate)
745 return NULL;
748 * The .gitattributes file only applies to files within its
749 * parent directory. In the case of cone-mode sparse-checkout,
750 * the .gitattributes file is sparse if and only if all paths
751 * within that directory are also sparse. Thus, don't load the
752 * .gitattributes file since it will not matter.
754 * In the case of a sparse index, it is critical that we don't go
755 * looking for a .gitattributes file, as doing so would cause the
756 * index to expand.
758 if (!path_in_cone_mode_sparse_checkout(path, istate))
759 return NULL;
761 buf = read_blob_data_from_index(istate, path, NULL);
762 if (!buf)
763 return NULL;
765 CALLOC_ARRAY(res, 1);
766 for (sp = buf; *sp; ) {
767 char *ep;
768 int more;
770 ep = strchrnul(sp, '\n');
771 more = (*ep == '\n');
772 *ep = '\0';
773 handle_attr_line(res, sp, path, ++lineno, flags);
774 sp = ep + more;
776 free(buf);
777 return res;
780 static struct attr_stack *read_attr(struct index_state *istate,
781 const char *path, unsigned flags)
783 struct attr_stack *res = NULL;
785 if (direction == GIT_ATTR_INDEX) {
786 res = read_attr_from_index(istate, path, flags);
787 } else if (!is_bare_repository()) {
788 if (direction == GIT_ATTR_CHECKOUT) {
789 res = read_attr_from_index(istate, path, flags);
790 if (!res)
791 res = read_attr_from_file(path, flags);
792 } else if (direction == GIT_ATTR_CHECKIN) {
793 res = read_attr_from_file(path, flags);
794 if (!res)
796 * There is no checked out .gitattributes file
797 * there, but we might have it in the index.
798 * We allow operation in a sparsely checked out
799 * work tree, so read from it.
801 res = read_attr_from_index(istate, path, flags);
805 if (!res)
806 CALLOC_ARRAY(res, 1);
807 return res;
810 #if DEBUG_ATTR
811 static void debug_info(const char *what, struct attr_stack *elem)
813 fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
815 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
817 const char *value = v;
819 if (ATTR_TRUE(value))
820 value = "set";
821 else if (ATTR_FALSE(value))
822 value = "unset";
823 else if (ATTR_UNSET(value))
824 value = "unspecified";
826 fprintf(stderr, "%s: %s => %s (%s)\n",
827 what, attr->name, (char *) value, match);
829 #define debug_push(a) debug_info("push", (a))
830 #define debug_pop(a) debug_info("pop", (a))
831 #else
832 #define debug_push(a) do { ; } while (0)
833 #define debug_pop(a) do { ; } while (0)
834 #define debug_set(a,b,c,d) do { ; } while (0)
835 #endif /* DEBUG_ATTR */
837 static const char *git_etc_gitattributes(void)
839 static const char *system_wide;
840 if (!system_wide)
841 system_wide = system_path(ETC_GITATTRIBUTES);
842 return system_wide;
845 static const char *get_home_gitattributes(void)
847 if (!git_attributes_file)
848 git_attributes_file = xdg_config_home("attributes");
850 return git_attributes_file;
853 static int git_attr_system(void)
855 return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
858 static GIT_PATH_FUNC(git_path_info_attributes, INFOATTRIBUTES_FILE)
860 static void push_stack(struct attr_stack **attr_stack_p,
861 struct attr_stack *elem, char *origin, size_t originlen)
863 if (elem) {
864 elem->origin = origin;
865 if (origin)
866 elem->originlen = originlen;
867 elem->prev = *attr_stack_p;
868 *attr_stack_p = elem;
872 static void bootstrap_attr_stack(struct index_state *istate,
873 struct attr_stack **stack)
875 struct attr_stack *e;
876 unsigned flags = READ_ATTR_MACRO_OK;
878 if (*stack)
879 return;
881 /* builtin frame */
882 e = read_attr_from_array(builtin_attr);
883 push_stack(stack, e, NULL, 0);
885 /* system-wide frame */
886 if (git_attr_system()) {
887 e = read_attr_from_file(git_etc_gitattributes(), flags);
888 push_stack(stack, e, NULL, 0);
891 /* home directory */
892 if (get_home_gitattributes()) {
893 e = read_attr_from_file(get_home_gitattributes(), flags);
894 push_stack(stack, e, NULL, 0);
897 /* root directory */
898 e = read_attr(istate, GITATTRIBUTES_FILE, flags | READ_ATTR_NOFOLLOW);
899 push_stack(stack, e, xstrdup(""), 0);
901 /* info frame */
902 if (startup_info->have_repository)
903 e = read_attr_from_file(git_path_info_attributes(), flags);
904 else
905 e = NULL;
906 if (!e)
907 CALLOC_ARRAY(e, 1);
908 push_stack(stack, e, NULL, 0);
911 static void prepare_attr_stack(struct index_state *istate,
912 const char *path, int dirlen,
913 struct attr_stack **stack)
915 struct attr_stack *info;
916 struct strbuf pathbuf = STRBUF_INIT;
919 * At the bottom of the attribute stack is the built-in
920 * set of attribute definitions, followed by the contents
921 * of $(prefix)/etc/gitattributes and a file specified by
922 * core.attributesfile. Then, contents from
923 * .gitattributes files from directories closer to the
924 * root to the ones in deeper directories are pushed
925 * to the stack. Finally, at the very top of the stack
926 * we always keep the contents of $GIT_DIR/info/attributes.
928 * When checking, we use entries from near the top of the
929 * stack, preferring $GIT_DIR/info/attributes, then
930 * .gitattributes in deeper directories to shallower ones,
931 * and finally use the built-in set as the default.
933 bootstrap_attr_stack(istate, stack);
936 * Pop the "info" one that is always at the top of the stack.
938 info = *stack;
939 *stack = info->prev;
942 * Pop the ones from directories that are not the prefix of
943 * the path we are checking. Break out of the loop when we see
944 * the root one (whose origin is an empty string "") or the builtin
945 * one (whose origin is NULL) without popping it.
947 while ((*stack)->origin) {
948 int namelen = (*stack)->originlen;
949 struct attr_stack *elem;
951 elem = *stack;
952 if (namelen <= dirlen &&
953 !strncmp(elem->origin, path, namelen) &&
954 (!namelen || path[namelen] == '/'))
955 break;
957 debug_pop(elem);
958 *stack = elem->prev;
959 attr_stack_free(elem);
963 * bootstrap_attr_stack() should have added, and the
964 * above loop should have stopped before popping, the
965 * root element whose attr_stack->origin is set to an
966 * empty string.
968 assert((*stack)->origin);
970 strbuf_addstr(&pathbuf, (*stack)->origin);
971 /* Build up to the directory 'path' is in */
972 while (pathbuf.len < dirlen) {
973 size_t len = pathbuf.len;
974 struct attr_stack *next;
975 char *origin;
977 /* Skip path-separator */
978 if (len < dirlen && is_dir_sep(path[len]))
979 len++;
980 /* Find the end of the next component */
981 while (len < dirlen && !is_dir_sep(path[len]))
982 len++;
984 if (pathbuf.len > 0)
985 strbuf_addch(&pathbuf, '/');
986 strbuf_add(&pathbuf, path + pathbuf.len, (len - pathbuf.len));
987 strbuf_addf(&pathbuf, "/%s", GITATTRIBUTES_FILE);
989 next = read_attr(istate, pathbuf.buf, READ_ATTR_NOFOLLOW);
991 /* reset the pathbuf to not include "/.gitattributes" */
992 strbuf_setlen(&pathbuf, len);
994 origin = xstrdup(pathbuf.buf);
995 push_stack(stack, next, origin, len);
999 * Finally push the "info" one at the top of the stack.
1001 push_stack(stack, info, NULL, 0);
1003 strbuf_release(&pathbuf);
1006 static int path_matches(const char *pathname, int pathlen,
1007 int basename_offset,
1008 const struct pattern *pat,
1009 const char *base, int baselen)
1011 const char *pattern = pat->pattern;
1012 int prefix = pat->nowildcardlen;
1013 int isdir = (pathlen && pathname[pathlen - 1] == '/');
1015 if ((pat->flags & PATTERN_FLAG_MUSTBEDIR) && !isdir)
1016 return 0;
1018 if (pat->flags & PATTERN_FLAG_NODIR) {
1019 return match_basename(pathname + basename_offset,
1020 pathlen - basename_offset - isdir,
1021 pattern, prefix,
1022 pat->patternlen, pat->flags);
1024 return match_pathname(pathname, pathlen - isdir,
1025 base, baselen,
1026 pattern, prefix, pat->patternlen, pat->flags);
1029 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem);
1031 static int fill_one(const char *what, struct all_attrs_item *all_attrs,
1032 const struct match_attr *a, int rem)
1034 int i;
1036 for (i = a->num_attr - 1; rem > 0 && i >= 0; i--) {
1037 const struct git_attr *attr = a->state[i].attr;
1038 const char **n = &(all_attrs[attr->attr_nr].value);
1039 const char *v = a->state[i].setto;
1041 if (*n == ATTR__UNKNOWN) {
1042 debug_set(what,
1043 a->is_macro ? a->u.attr->name : a->u.pat.pattern,
1044 attr, v);
1045 *n = v;
1046 rem--;
1047 rem = macroexpand_one(all_attrs, attr->attr_nr, rem);
1050 return rem;
1053 static int fill(const char *path, int pathlen, int basename_offset,
1054 const struct attr_stack *stack,
1055 struct all_attrs_item *all_attrs, int rem)
1057 for (; rem > 0 && stack; stack = stack->prev) {
1058 int i;
1059 const char *base = stack->origin ? stack->origin : "";
1061 for (i = stack->num_matches - 1; 0 < rem && 0 <= i; i--) {
1062 const struct match_attr *a = stack->attrs[i];
1063 if (a->is_macro)
1064 continue;
1065 if (path_matches(path, pathlen, basename_offset,
1066 &a->u.pat, base, stack->originlen))
1067 rem = fill_one("fill", all_attrs, a, rem);
1071 return rem;
1074 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem)
1076 const struct all_attrs_item *item = &all_attrs[nr];
1078 if (item->macro && item->value == ATTR__TRUE)
1079 return fill_one("expand", all_attrs, item->macro, rem);
1080 else
1081 return rem;
1085 * Marks the attributes which are macros based on the attribute stack.
1086 * This prevents having to search through the attribute stack each time
1087 * a macro needs to be expanded during the fill stage.
1089 static void determine_macros(struct all_attrs_item *all_attrs,
1090 const struct attr_stack *stack)
1092 for (; stack; stack = stack->prev) {
1093 int i;
1094 for (i = stack->num_matches - 1; i >= 0; i--) {
1095 const struct match_attr *ma = stack->attrs[i];
1096 if (ma->is_macro) {
1097 int n = ma->u.attr->attr_nr;
1098 if (!all_attrs[n].macro) {
1099 all_attrs[n].macro = ma;
1107 * Collect attributes for path into the array pointed to by check->all_attrs.
1108 * If check->check_nr is non-zero, only attributes in check[] are collected.
1109 * Otherwise all attributes are collected.
1111 static void collect_some_attrs(struct index_state *istate,
1112 const char *path,
1113 struct attr_check *check)
1115 int pathlen, rem, dirlen;
1116 const char *cp, *last_slash = NULL;
1117 int basename_offset;
1119 for (cp = path; *cp; cp++) {
1120 if (*cp == '/' && cp[1])
1121 last_slash = cp;
1123 pathlen = cp - path;
1124 if (last_slash) {
1125 basename_offset = last_slash + 1 - path;
1126 dirlen = last_slash - path;
1127 } else {
1128 basename_offset = 0;
1129 dirlen = 0;
1132 prepare_attr_stack(istate, path, dirlen, &check->stack);
1133 all_attrs_init(&g_attr_hashmap, check);
1134 determine_macros(check->all_attrs, check->stack);
1136 rem = check->all_attrs_nr;
1137 fill(path, pathlen, basename_offset, check->stack, check->all_attrs, rem);
1140 void git_check_attr(struct index_state *istate,
1141 const char *path,
1142 struct attr_check *check)
1144 int i;
1146 collect_some_attrs(istate, path, check);
1148 for (i = 0; i < check->nr; i++) {
1149 size_t n = check->items[i].attr->attr_nr;
1150 const char *value = check->all_attrs[n].value;
1151 if (value == ATTR__UNKNOWN)
1152 value = ATTR__UNSET;
1153 check->items[i].value = value;
1157 void git_all_attrs(struct index_state *istate,
1158 const char *path, struct attr_check *check)
1160 int i;
1162 attr_check_reset(check);
1163 collect_some_attrs(istate, path, check);
1165 for (i = 0; i < check->all_attrs_nr; i++) {
1166 const char *name = check->all_attrs[i].attr->name;
1167 const char *value = check->all_attrs[i].value;
1168 struct attr_check_item *item;
1169 if (value == ATTR__UNSET || value == ATTR__UNKNOWN)
1170 continue;
1171 item = attr_check_append(check, git_attr(name));
1172 item->value = value;
1176 void attr_start(void)
1178 pthread_mutex_init(&g_attr_hashmap.mutex, NULL);
1179 pthread_mutex_init(&check_vector.mutex, NULL);