Merge branch 'mc/credential-helper-www-authenticate'
[git/debian.git] / attr.c
blob657ee52229ee3efca65a7e6e5dcadbc83cbbbe70
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 "alloc.h"
11 #include "config.h"
12 #include "exec-cmd.h"
13 #include "attr.h"
14 #include "dir.h"
15 #include "utf8.h"
16 #include "quote.h"
17 #include "revision.h"
18 #include "object-store.h"
19 #include "thread-utils.h"
21 const char git_attr__true[] = "(builtin)true";
22 const char git_attr__false[] = "\0(builtin)false";
23 static const char git_attr__unknown[] = "(builtin)unknown";
24 #define ATTR__TRUE git_attr__true
25 #define ATTR__FALSE git_attr__false
26 #define ATTR__UNSET NULL
27 #define ATTR__UNKNOWN git_attr__unknown
29 struct git_attr {
30 unsigned int attr_nr; /* unique attribute number */
31 char name[FLEX_ARRAY]; /* attribute name */
34 const char *git_attr_name(const struct git_attr *attr)
36 return attr->name;
39 struct attr_hashmap {
40 struct hashmap map;
41 pthread_mutex_t mutex;
44 static inline void hashmap_lock(struct attr_hashmap *map)
46 pthread_mutex_lock(&map->mutex);
49 static inline void hashmap_unlock(struct attr_hashmap *map)
51 pthread_mutex_unlock(&map->mutex);
54 /* The container for objects stored in "struct attr_hashmap" */
55 struct attr_hash_entry {
56 struct hashmap_entry ent;
57 const char *key; /* the key; memory should be owned by value */
58 size_t keylen; /* length of the key */
59 void *value; /* the stored value */
62 /* attr_hashmap comparison function */
63 static int attr_hash_entry_cmp(const void *cmp_data UNUSED,
64 const struct hashmap_entry *eptr,
65 const struct hashmap_entry *entry_or_key,
66 const void *keydata UNUSED)
68 const struct attr_hash_entry *a, *b;
70 a = container_of(eptr, const struct attr_hash_entry, ent);
71 b = container_of(entry_or_key, const struct attr_hash_entry, ent);
72 return (a->keylen != b->keylen) || strncmp(a->key, b->key, a->keylen);
76 * The global dictionary of all interned attributes. This
77 * is a singleton object which is shared between threads.
78 * Access to this dictionary must be surrounded with a mutex.
80 static struct attr_hashmap g_attr_hashmap = {
81 .map = HASHMAP_INIT(attr_hash_entry_cmp, NULL),
85 * Retrieve the 'value' stored in a hashmap given the provided 'key'.
86 * If there is no matching entry, return NULL.
88 static void *attr_hashmap_get(struct attr_hashmap *map,
89 const char *key, size_t keylen)
91 struct attr_hash_entry k;
92 struct attr_hash_entry *e;
94 hashmap_entry_init(&k.ent, memhash(key, keylen));
95 k.key = key;
96 k.keylen = keylen;
97 e = hashmap_get_entry(&map->map, &k, ent, NULL);
99 return e ? e->value : NULL;
102 /* Add 'value' to a hashmap based on the provided 'key'. */
103 static void attr_hashmap_add(struct attr_hashmap *map,
104 const char *key, size_t keylen,
105 void *value)
107 struct attr_hash_entry *e;
109 e = xmalloc(sizeof(struct attr_hash_entry));
110 hashmap_entry_init(&e->ent, memhash(key, keylen));
111 e->key = key;
112 e->keylen = keylen;
113 e->value = value;
115 hashmap_add(&map->map, &e->ent);
118 struct all_attrs_item {
119 const struct git_attr *attr;
120 const char *value;
122 * If 'macro' is non-NULL, indicates that 'attr' is a macro based on
123 * the current attribute stack and contains a pointer to the match_attr
124 * definition of the macro
126 const struct match_attr *macro;
130 * Reallocate and reinitialize the array of all attributes (which is used in
131 * the attribute collection process) in 'check' based on the global dictionary
132 * of attributes.
134 static void all_attrs_init(struct attr_hashmap *map, struct attr_check *check)
136 int i;
137 unsigned int size;
139 hashmap_lock(map);
141 size = hashmap_get_size(&map->map);
142 if (size < check->all_attrs_nr)
143 BUG("interned attributes shouldn't be deleted");
146 * If the number of attributes in the global dictionary has increased
147 * (or this attr_check instance doesn't have an initialized all_attrs
148 * field), reallocate the provided attr_check instance's all_attrs
149 * field and fill each entry with its corresponding git_attr.
151 if (size != check->all_attrs_nr) {
152 struct attr_hash_entry *e;
153 struct hashmap_iter iter;
155 REALLOC_ARRAY(check->all_attrs, size);
156 check->all_attrs_nr = size;
158 hashmap_for_each_entry(&map->map, &iter, e,
159 ent /* member name */) {
160 const struct git_attr *a = e->value;
161 check->all_attrs[a->attr_nr].attr = a;
165 hashmap_unlock(map);
168 * Re-initialize every entry in check->all_attrs.
169 * This re-initialization can live outside of the locked region since
170 * the attribute dictionary is no longer being accessed.
172 for (i = 0; i < check->all_attrs_nr; i++) {
173 check->all_attrs[i].value = ATTR__UNKNOWN;
174 check->all_attrs[i].macro = NULL;
178 static int attr_name_valid(const char *name, size_t namelen)
181 * Attribute name cannot begin with '-' and must consist of
182 * characters from [-A-Za-z0-9_.].
184 if (namelen <= 0 || *name == '-')
185 return 0;
186 while (namelen--) {
187 char ch = *name++;
188 if (! (ch == '-' || ch == '.' || ch == '_' ||
189 ('0' <= ch && ch <= '9') ||
190 ('a' <= ch && ch <= 'z') ||
191 ('A' <= ch && ch <= 'Z')) )
192 return 0;
194 return 1;
197 static void report_invalid_attr(const char *name, size_t len,
198 const char *src, int lineno)
200 struct strbuf err = STRBUF_INIT;
201 strbuf_addf(&err, _("%.*s is not a valid attribute name"),
202 (int) len, name);
203 fprintf(stderr, "%s: %s:%d\n", err.buf, src, lineno);
204 strbuf_release(&err);
208 * Given a 'name', lookup and return the corresponding attribute in the global
209 * dictionary. If no entry is found, create a new attribute and store it in
210 * the dictionary.
212 static const struct git_attr *git_attr_internal(const char *name, size_t namelen)
214 struct git_attr *a;
216 if (!attr_name_valid(name, namelen))
217 return NULL;
219 hashmap_lock(&g_attr_hashmap);
221 a = attr_hashmap_get(&g_attr_hashmap, name, namelen);
223 if (!a) {
224 FLEX_ALLOC_MEM(a, name, name, namelen);
225 a->attr_nr = hashmap_get_size(&g_attr_hashmap.map);
227 attr_hashmap_add(&g_attr_hashmap, a->name, namelen, a);
228 if (a->attr_nr != hashmap_get_size(&g_attr_hashmap.map) - 1)
229 die(_("unable to add additional attribute"));
232 hashmap_unlock(&g_attr_hashmap);
234 return a;
237 const struct git_attr *git_attr(const char *name)
239 return git_attr_internal(name, strlen(name));
242 /* What does a matched pattern decide? */
243 struct attr_state {
244 const struct git_attr *attr;
245 const char *setto;
248 struct pattern {
249 const char *pattern;
250 int patternlen;
251 int nowildcardlen;
252 unsigned flags; /* PATTERN_FLAG_* */
256 * One rule, as from a .gitattributes file.
258 * If is_macro is true, then u.attr is a pointer to the git_attr being
259 * defined.
261 * If is_macro is false, then u.pat is the filename pattern to which the
262 * rule applies.
264 * In either case, num_attr is the number of attributes affected by
265 * this rule, and state is an array listing them. The attributes are
266 * listed as they appear in the file (macros unexpanded).
268 struct match_attr {
269 union {
270 struct pattern pat;
271 const struct git_attr *attr;
272 } u;
273 char is_macro;
274 size_t num_attr;
275 struct attr_state state[FLEX_ARRAY];
278 static const char blank[] = " \t\r\n";
280 /* Flags usable in read_attr() and parse_attr_line() family of functions. */
281 #define READ_ATTR_MACRO_OK (1<<0)
282 #define READ_ATTR_NOFOLLOW (1<<1)
285 * Parse a whitespace-delimited attribute state (i.e., "attr",
286 * "-attr", "!attr", or "attr=value") from the string starting at src.
287 * If e is not NULL, write the results to *e. Return a pointer to the
288 * remainder of the string (with leading whitespace removed), or NULL
289 * if there was an error.
291 static const char *parse_attr(const char *src, int lineno, const char *cp,
292 struct attr_state *e)
294 const char *ep, *equals;
295 size_t len;
297 ep = cp + strcspn(cp, blank);
298 equals = strchr(cp, '=');
299 if (equals && ep < equals)
300 equals = NULL;
301 if (equals)
302 len = equals - cp;
303 else
304 len = ep - cp;
305 if (!e) {
306 if (*cp == '-' || *cp == '!') {
307 cp++;
308 len--;
310 if (!attr_name_valid(cp, len)) {
311 report_invalid_attr(cp, len, src, lineno);
312 return NULL;
314 } else {
316 * As this function is always called twice, once with
317 * e == NULL in the first pass and then e != NULL in
318 * the second pass, no need for attr_name_valid()
319 * check here.
321 if (*cp == '-' || *cp == '!') {
322 e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
323 cp++;
324 len--;
326 else if (!equals)
327 e->setto = ATTR__TRUE;
328 else {
329 e->setto = xmemdupz(equals + 1, ep - equals - 1);
331 e->attr = git_attr_internal(cp, len);
333 return ep + strspn(ep, blank);
336 static struct match_attr *parse_attr_line(const char *line, const char *src,
337 int lineno, unsigned flags)
339 size_t namelen, num_attr, i;
340 const char *cp, *name, *states;
341 struct match_attr *res = NULL;
342 int is_macro;
343 struct strbuf pattern = STRBUF_INIT;
345 cp = line + strspn(line, blank);
346 if (!*cp || *cp == '#')
347 return NULL;
348 name = cp;
350 if (strlen(line) >= ATTR_MAX_LINE_LENGTH) {
351 warning(_("ignoring overly long attributes line %d"), lineno);
352 return NULL;
355 if (*cp == '"' && !unquote_c_style(&pattern, name, &states)) {
356 name = pattern.buf;
357 namelen = pattern.len;
358 } else {
359 namelen = strcspn(name, blank);
360 states = name + namelen;
363 if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
364 starts_with(name, ATTRIBUTE_MACRO_PREFIX)) {
365 if (!(flags & READ_ATTR_MACRO_OK)) {
366 fprintf_ln(stderr, _("%s not allowed: %s:%d"),
367 name, src, lineno);
368 goto fail_return;
370 is_macro = 1;
371 name += strlen(ATTRIBUTE_MACRO_PREFIX);
372 name += strspn(name, blank);
373 namelen = strcspn(name, blank);
374 if (!attr_name_valid(name, namelen)) {
375 report_invalid_attr(name, namelen, src, lineno);
376 goto fail_return;
379 else
380 is_macro = 0;
382 states += strspn(states, blank);
384 /* First pass to count the attr_states */
385 for (cp = states, num_attr = 0; *cp; num_attr++) {
386 cp = parse_attr(src, lineno, cp, NULL);
387 if (!cp)
388 goto fail_return;
391 res = xcalloc(1, st_add3(sizeof(*res),
392 st_mult(sizeof(struct attr_state), num_attr),
393 is_macro ? 0 : namelen + 1));
394 if (is_macro) {
395 res->u.attr = git_attr_internal(name, namelen);
396 } else {
397 char *p = (char *)&(res->state[num_attr]);
398 memcpy(p, name, namelen);
399 res->u.pat.pattern = p;
400 parse_path_pattern(&res->u.pat.pattern,
401 &res->u.pat.patternlen,
402 &res->u.pat.flags,
403 &res->u.pat.nowildcardlen);
404 if (res->u.pat.flags & PATTERN_FLAG_NEGATIVE) {
405 warning(_("Negative patterns are ignored in git attributes\n"
406 "Use '\\!' for literal leading exclamation."));
407 goto fail_return;
410 res->is_macro = is_macro;
411 res->num_attr = num_attr;
413 /* Second pass to fill the attr_states */
414 for (cp = states, i = 0; *cp; i++) {
415 cp = parse_attr(src, lineno, cp, &(res->state[i]));
418 strbuf_release(&pattern);
419 return res;
421 fail_return:
422 strbuf_release(&pattern);
423 free(res);
424 return NULL;
428 * Like info/exclude and .gitignore, the attribute information can
429 * come from many places.
431 * (1) .gitattributes file of the same directory;
432 * (2) .gitattributes file of the parent directory if (1) does not have
433 * any match; this goes recursively upwards, just like .gitignore.
434 * (3) $GIT_DIR/info/attributes, which overrides both of the above.
436 * In the same file, later entries override the earlier match, so in the
437 * global list, we would have entries from info/attributes the earliest
438 * (reading the file from top to bottom), .gitattributes of the root
439 * directory (again, reading the file from top to bottom) down to the
440 * current directory, and then scan the list backwards to find the first match.
441 * This is exactly the same as what is_excluded() does in dir.c to deal with
442 * .gitignore file and info/excludes file as a fallback.
445 struct attr_stack {
446 struct attr_stack *prev;
447 char *origin;
448 size_t originlen;
449 unsigned num_matches;
450 unsigned alloc;
451 struct match_attr **attrs;
454 static void attr_stack_free(struct attr_stack *e)
456 unsigned i;
457 free(e->origin);
458 for (i = 0; i < e->num_matches; i++) {
459 struct match_attr *a = e->attrs[i];
460 size_t j;
462 for (j = 0; j < a->num_attr; j++) {
463 const char *setto = a->state[j].setto;
464 if (setto == ATTR__TRUE ||
465 setto == ATTR__FALSE ||
466 setto == ATTR__UNSET ||
467 setto == ATTR__UNKNOWN)
469 else
470 free((char *) setto);
472 free(a);
474 free(e->attrs);
475 free(e);
478 static void drop_attr_stack(struct attr_stack **stack)
480 while (*stack) {
481 struct attr_stack *elem = *stack;
482 *stack = elem->prev;
483 attr_stack_free(elem);
487 /* List of all attr_check structs; access should be surrounded by mutex */
488 static struct check_vector {
489 size_t nr;
490 size_t alloc;
491 struct attr_check **checks;
492 pthread_mutex_t mutex;
493 } check_vector;
495 static inline void vector_lock(void)
497 pthread_mutex_lock(&check_vector.mutex);
500 static inline void vector_unlock(void)
502 pthread_mutex_unlock(&check_vector.mutex);
505 static void check_vector_add(struct attr_check *c)
507 vector_lock();
509 ALLOC_GROW(check_vector.checks,
510 check_vector.nr + 1,
511 check_vector.alloc);
512 check_vector.checks[check_vector.nr++] = c;
514 vector_unlock();
517 static void check_vector_remove(struct attr_check *check)
519 int i;
521 vector_lock();
523 /* Find entry */
524 for (i = 0; i < check_vector.nr; i++)
525 if (check_vector.checks[i] == check)
526 break;
528 if (i >= check_vector.nr)
529 BUG("no entry found");
531 /* shift entries over */
532 for (; i < check_vector.nr - 1; i++)
533 check_vector.checks[i] = check_vector.checks[i + 1];
535 check_vector.nr--;
537 vector_unlock();
540 /* Iterate through all attr_check instances and drop their stacks */
541 static void drop_all_attr_stacks(void)
543 int i;
545 vector_lock();
547 for (i = 0; i < check_vector.nr; i++) {
548 drop_attr_stack(&check_vector.checks[i]->stack);
551 vector_unlock();
554 struct attr_check *attr_check_alloc(void)
556 struct attr_check *c = xcalloc(1, sizeof(struct attr_check));
558 /* save pointer to the check struct */
559 check_vector_add(c);
561 return c;
564 struct attr_check *attr_check_initl(const char *one, ...)
566 struct attr_check *check;
567 int cnt;
568 va_list params;
569 const char *param;
571 va_start(params, one);
572 for (cnt = 1; (param = va_arg(params, const char *)) != NULL; cnt++)
574 va_end(params);
576 check = attr_check_alloc();
577 check->nr = cnt;
578 check->alloc = cnt;
579 CALLOC_ARRAY(check->items, cnt);
581 check->items[0].attr = git_attr(one);
582 va_start(params, one);
583 for (cnt = 1; cnt < check->nr; cnt++) {
584 const struct git_attr *attr;
585 param = va_arg(params, const char *);
586 if (!param)
587 BUG("counted %d != ended at %d",
588 check->nr, cnt);
589 attr = git_attr(param);
590 if (!attr)
591 BUG("%s: not a valid attribute name", param);
592 check->items[cnt].attr = attr;
594 va_end(params);
595 return check;
598 struct attr_check *attr_check_dup(const struct attr_check *check)
600 struct attr_check *ret;
602 if (!check)
603 return NULL;
605 ret = attr_check_alloc();
607 ret->nr = check->nr;
608 ret->alloc = check->alloc;
609 DUP_ARRAY(ret->items, check->items, ret->nr);
611 return ret;
614 struct attr_check_item *attr_check_append(struct attr_check *check,
615 const struct git_attr *attr)
617 struct attr_check_item *item;
619 ALLOC_GROW(check->items, check->nr + 1, check->alloc);
620 item = &check->items[check->nr++];
621 item->attr = attr;
622 return item;
625 void attr_check_reset(struct attr_check *check)
627 check->nr = 0;
630 void attr_check_clear(struct attr_check *check)
632 FREE_AND_NULL(check->items);
633 check->alloc = 0;
634 check->nr = 0;
636 FREE_AND_NULL(check->all_attrs);
637 check->all_attrs_nr = 0;
639 drop_attr_stack(&check->stack);
642 void attr_check_free(struct attr_check *check)
644 if (check) {
645 /* Remove check from the check vector */
646 check_vector_remove(check);
648 attr_check_clear(check);
649 free(check);
653 static const char *builtin_attr[] = {
654 "[attr]binary -diff -merge -text",
655 NULL,
658 static void handle_attr_line(struct attr_stack *res,
659 const char *line,
660 const char *src,
661 int lineno,
662 unsigned flags)
664 struct match_attr *a;
666 a = parse_attr_line(line, src, lineno, flags);
667 if (!a)
668 return;
669 ALLOC_GROW_BY(res->attrs, res->num_matches, 1, res->alloc);
670 res->attrs[res->num_matches - 1] = a;
673 static struct attr_stack *read_attr_from_array(const char **list)
675 struct attr_stack *res;
676 const char *line;
677 int lineno = 0;
679 CALLOC_ARRAY(res, 1);
680 while ((line = *(list++)) != NULL)
681 handle_attr_line(res, line, "[builtin]", ++lineno,
682 READ_ATTR_MACRO_OK);
683 return res;
687 * Callers into the attribute system assume there is a single, system-wide
688 * global state where attributes are read from and when the state is flipped by
689 * calling git_attr_set_direction(), the stack frames that have been
690 * constructed need to be discarded so that subsequent calls into the
691 * attribute system will lazily read from the right place. Since changing
692 * direction causes a global paradigm shift, it should not ever be called while
693 * another thread could potentially be calling into the attribute system.
695 static enum git_attr_direction direction;
697 void git_attr_set_direction(enum git_attr_direction new_direction)
699 if (is_bare_repository() && new_direction != GIT_ATTR_INDEX)
700 BUG("non-INDEX attr direction in a bare repo");
702 if (new_direction != direction)
703 drop_all_attr_stacks();
705 direction = new_direction;
708 static struct attr_stack *read_attr_from_file(const char *path, unsigned flags)
710 struct strbuf buf = STRBUF_INIT;
711 int fd;
712 FILE *fp;
713 struct attr_stack *res;
714 int lineno = 0;
715 struct stat st;
717 if (flags & READ_ATTR_NOFOLLOW)
718 fd = open_nofollow(path, O_RDONLY);
719 else
720 fd = open(path, O_RDONLY);
722 if (fd < 0) {
723 warn_on_fopen_errors(path);
724 return NULL;
726 fp = xfdopen(fd, "r");
727 if (fstat(fd, &st)) {
728 warning_errno(_("cannot fstat gitattributes file '%s'"), path);
729 fclose(fp);
730 return NULL;
732 if (st.st_size >= ATTR_MAX_FILE_SIZE) {
733 warning(_("ignoring overly large gitattributes file '%s'"), path);
734 fclose(fp);
735 return NULL;
738 CALLOC_ARRAY(res, 1);
739 while (strbuf_getline(&buf, fp) != EOF) {
740 if (!lineno && starts_with(buf.buf, utf8_bom))
741 strbuf_remove(&buf, 0, strlen(utf8_bom));
742 handle_attr_line(res, buf.buf, path, ++lineno, flags);
745 fclose(fp);
746 strbuf_release(&buf);
747 return res;
750 static struct attr_stack *read_attr_from_buf(char *buf, const char *path,
751 unsigned flags)
753 struct attr_stack *res;
754 char *sp;
755 int lineno = 0;
757 if (!buf)
758 return NULL;
760 CALLOC_ARRAY(res, 1);
761 for (sp = buf; *sp;) {
762 char *ep;
763 int more;
765 ep = strchrnul(sp, '\n');
766 more = (*ep == '\n');
767 *ep = '\0';
768 handle_attr_line(res, sp, path, ++lineno, flags);
769 sp = ep + more;
771 free(buf);
773 return res;
776 static struct attr_stack *read_attr_from_blob(struct index_state *istate,
777 const struct object_id *tree_oid,
778 const char *path, unsigned flags)
780 struct object_id oid;
781 unsigned long sz;
782 enum object_type type;
783 void *buf;
784 unsigned short mode;
786 if (!tree_oid)
787 return NULL;
789 if (get_tree_entry(istate->repo, tree_oid, path, &oid, &mode))
790 return NULL;
792 buf = repo_read_object_file(istate->repo, &oid, &type, &sz);
793 if (!buf || type != OBJ_BLOB) {
794 free(buf);
795 return NULL;
798 return read_attr_from_buf(buf, path, flags);
801 static struct attr_stack *read_attr_from_index(struct index_state *istate,
802 const char *path, unsigned flags)
804 char *buf;
805 unsigned long size;
807 if (!istate)
808 return NULL;
811 * The .gitattributes file only applies to files within its
812 * parent directory. In the case of cone-mode sparse-checkout,
813 * the .gitattributes file is sparse if and only if all paths
814 * within that directory are also sparse. Thus, don't load the
815 * .gitattributes file since it will not matter.
817 * In the case of a sparse index, it is critical that we don't go
818 * looking for a .gitattributes file, as doing so would cause the
819 * index to expand.
821 if (!path_in_cone_mode_sparse_checkout(path, istate))
822 return NULL;
824 buf = read_blob_data_from_index(istate, path, &size);
825 if (!buf)
826 return NULL;
827 if (size >= ATTR_MAX_FILE_SIZE) {
828 warning(_("ignoring overly large gitattributes blob '%s'"), path);
829 return NULL;
832 return read_attr_from_buf(buf, path, flags);
835 static struct attr_stack *read_attr(struct index_state *istate,
836 const struct object_id *tree_oid,
837 const char *path, unsigned flags)
839 struct attr_stack *res = NULL;
841 if (direction == GIT_ATTR_INDEX) {
842 res = read_attr_from_index(istate, path, flags);
843 } else if (tree_oid) {
844 res = read_attr_from_blob(istate, tree_oid, path, flags);
845 } else if (!is_bare_repository()) {
846 if (direction == GIT_ATTR_CHECKOUT) {
847 res = read_attr_from_index(istate, path, flags);
848 if (!res)
849 res = read_attr_from_file(path, flags);
850 } else if (direction == GIT_ATTR_CHECKIN) {
851 res = read_attr_from_file(path, flags);
852 if (!res)
854 * There is no checked out .gitattributes file
855 * there, but we might have it in the index.
856 * We allow operation in a sparsely checked out
857 * work tree, so read from it.
859 res = read_attr_from_index(istate, path, flags);
863 if (!res)
864 CALLOC_ARRAY(res, 1);
865 return res;
868 static const char *git_etc_gitattributes(void)
870 static const char *system_wide;
871 if (!system_wide)
872 system_wide = system_path(ETC_GITATTRIBUTES);
873 return system_wide;
876 static const char *get_home_gitattributes(void)
878 if (!git_attributes_file)
879 git_attributes_file = xdg_config_home("attributes");
881 return git_attributes_file;
884 static int git_attr_system(void)
886 return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
889 static GIT_PATH_FUNC(git_path_info_attributes, INFOATTRIBUTES_FILE)
891 static void push_stack(struct attr_stack **attr_stack_p,
892 struct attr_stack *elem, char *origin, size_t originlen)
894 if (elem) {
895 elem->origin = origin;
896 if (origin)
897 elem->originlen = originlen;
898 elem->prev = *attr_stack_p;
899 *attr_stack_p = elem;
903 static void bootstrap_attr_stack(struct index_state *istate,
904 const struct object_id *tree_oid,
905 struct attr_stack **stack)
907 struct attr_stack *e;
908 unsigned flags = READ_ATTR_MACRO_OK;
910 if (*stack)
911 return;
913 /* builtin frame */
914 e = read_attr_from_array(builtin_attr);
915 push_stack(stack, e, NULL, 0);
917 /* system-wide frame */
918 if (git_attr_system()) {
919 e = read_attr_from_file(git_etc_gitattributes(), flags);
920 push_stack(stack, e, NULL, 0);
923 /* home directory */
924 if (get_home_gitattributes()) {
925 e = read_attr_from_file(get_home_gitattributes(), flags);
926 push_stack(stack, e, NULL, 0);
929 /* root directory */
930 e = read_attr(istate, tree_oid, GITATTRIBUTES_FILE, flags | READ_ATTR_NOFOLLOW);
931 push_stack(stack, e, xstrdup(""), 0);
933 /* info frame */
934 if (startup_info->have_repository)
935 e = read_attr_from_file(git_path_info_attributes(), flags);
936 else
937 e = NULL;
938 if (!e)
939 CALLOC_ARRAY(e, 1);
940 push_stack(stack, e, NULL, 0);
943 static void prepare_attr_stack(struct index_state *istate,
944 const struct object_id *tree_oid,
945 const char *path, int dirlen,
946 struct attr_stack **stack)
948 struct attr_stack *info;
949 struct strbuf pathbuf = STRBUF_INIT;
952 * At the bottom of the attribute stack is the built-in
953 * set of attribute definitions, followed by the contents
954 * of $(prefix)/etc/gitattributes and a file specified by
955 * core.attributesfile. Then, contents from
956 * .gitattributes files from directories closer to the
957 * root to the ones in deeper directories are pushed
958 * to the stack. Finally, at the very top of the stack
959 * we always keep the contents of $GIT_DIR/info/attributes.
961 * When checking, we use entries from near the top of the
962 * stack, preferring $GIT_DIR/info/attributes, then
963 * .gitattributes in deeper directories to shallower ones,
964 * and finally use the built-in set as the default.
966 bootstrap_attr_stack(istate, tree_oid, stack);
969 * Pop the "info" one that is always at the top of the stack.
971 info = *stack;
972 *stack = info->prev;
975 * Pop the ones from directories that are not the prefix of
976 * the path we are checking. Break out of the loop when we see
977 * the root one (whose origin is an empty string "") or the builtin
978 * one (whose origin is NULL) without popping it.
980 while ((*stack)->origin) {
981 int namelen = (*stack)->originlen;
982 struct attr_stack *elem;
984 elem = *stack;
985 if (namelen <= dirlen &&
986 !strncmp(elem->origin, path, namelen) &&
987 (!namelen || path[namelen] == '/'))
988 break;
990 *stack = elem->prev;
991 attr_stack_free(elem);
995 * bootstrap_attr_stack() should have added, and the
996 * above loop should have stopped before popping, the
997 * root element whose attr_stack->origin is set to an
998 * empty string.
1000 assert((*stack)->origin);
1002 strbuf_addstr(&pathbuf, (*stack)->origin);
1003 /* Build up to the directory 'path' is in */
1004 while (pathbuf.len < dirlen) {
1005 size_t len = pathbuf.len;
1006 struct attr_stack *next;
1007 char *origin;
1009 /* Skip path-separator */
1010 if (len < dirlen && is_dir_sep(path[len]))
1011 len++;
1012 /* Find the end of the next component */
1013 while (len < dirlen && !is_dir_sep(path[len]))
1014 len++;
1016 if (pathbuf.len > 0)
1017 strbuf_addch(&pathbuf, '/');
1018 strbuf_add(&pathbuf, path + pathbuf.len, (len - pathbuf.len));
1019 strbuf_addf(&pathbuf, "/%s", GITATTRIBUTES_FILE);
1021 next = read_attr(istate, tree_oid, pathbuf.buf, READ_ATTR_NOFOLLOW);
1023 /* reset the pathbuf to not include "/.gitattributes" */
1024 strbuf_setlen(&pathbuf, len);
1026 origin = xstrdup(pathbuf.buf);
1027 push_stack(stack, next, origin, len);
1031 * Finally push the "info" one at the top of the stack.
1033 push_stack(stack, info, NULL, 0);
1035 strbuf_release(&pathbuf);
1038 static int path_matches(const char *pathname, int pathlen,
1039 int basename_offset,
1040 const struct pattern *pat,
1041 const char *base, int baselen)
1043 const char *pattern = pat->pattern;
1044 int prefix = pat->nowildcardlen;
1045 int isdir = (pathlen && pathname[pathlen - 1] == '/');
1047 if ((pat->flags & PATTERN_FLAG_MUSTBEDIR) && !isdir)
1048 return 0;
1050 if (pat->flags & PATTERN_FLAG_NODIR) {
1051 return match_basename(pathname + basename_offset,
1052 pathlen - basename_offset - isdir,
1053 pattern, prefix,
1054 pat->patternlen, pat->flags);
1056 return match_pathname(pathname, pathlen - isdir,
1057 base, baselen,
1058 pattern, prefix, pat->patternlen);
1061 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem);
1063 static int fill_one(struct all_attrs_item *all_attrs,
1064 const struct match_attr *a, int rem)
1066 size_t i;
1068 for (i = a->num_attr; rem > 0 && i > 0; i--) {
1069 const struct git_attr *attr = a->state[i - 1].attr;
1070 const char **n = &(all_attrs[attr->attr_nr].value);
1071 const char *v = a->state[i - 1].setto;
1073 if (*n == ATTR__UNKNOWN) {
1074 *n = v;
1075 rem--;
1076 rem = macroexpand_one(all_attrs, attr->attr_nr, rem);
1079 return rem;
1082 static int fill(const char *path, int pathlen, int basename_offset,
1083 const struct attr_stack *stack,
1084 struct all_attrs_item *all_attrs, int rem)
1086 for (; rem > 0 && stack; stack = stack->prev) {
1087 unsigned i;
1088 const char *base = stack->origin ? stack->origin : "";
1090 for (i = stack->num_matches; 0 < rem && 0 < i; i--) {
1091 const struct match_attr *a = stack->attrs[i - 1];
1092 if (a->is_macro)
1093 continue;
1094 if (path_matches(path, pathlen, basename_offset,
1095 &a->u.pat, base, stack->originlen))
1096 rem = fill_one(all_attrs, a, rem);
1100 return rem;
1103 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem)
1105 const struct all_attrs_item *item = &all_attrs[nr];
1107 if (item->macro && item->value == ATTR__TRUE)
1108 return fill_one(all_attrs, item->macro, rem);
1109 else
1110 return rem;
1114 * Marks the attributes which are macros based on the attribute stack.
1115 * This prevents having to search through the attribute stack each time
1116 * a macro needs to be expanded during the fill stage.
1118 static void determine_macros(struct all_attrs_item *all_attrs,
1119 const struct attr_stack *stack)
1121 for (; stack; stack = stack->prev) {
1122 unsigned i;
1123 for (i = stack->num_matches; i > 0; i--) {
1124 const struct match_attr *ma = stack->attrs[i - 1];
1125 if (ma->is_macro) {
1126 unsigned int n = ma->u.attr->attr_nr;
1127 if (!all_attrs[n].macro) {
1128 all_attrs[n].macro = ma;
1136 * Collect attributes for path into the array pointed to by check->all_attrs.
1137 * If check->check_nr is non-zero, only attributes in check[] are collected.
1138 * Otherwise all attributes are collected.
1140 static void collect_some_attrs(struct index_state *istate,
1141 const struct object_id *tree_oid,
1142 const char *path, struct attr_check *check)
1144 int pathlen, rem, dirlen;
1145 const char *cp, *last_slash = NULL;
1146 int basename_offset;
1148 for (cp = path; *cp; cp++) {
1149 if (*cp == '/' && cp[1])
1150 last_slash = cp;
1152 pathlen = cp - path;
1153 if (last_slash) {
1154 basename_offset = last_slash + 1 - path;
1155 dirlen = last_slash - path;
1156 } else {
1157 basename_offset = 0;
1158 dirlen = 0;
1161 prepare_attr_stack(istate, tree_oid, path, dirlen, &check->stack);
1162 all_attrs_init(&g_attr_hashmap, check);
1163 determine_macros(check->all_attrs, check->stack);
1165 rem = check->all_attrs_nr;
1166 fill(path, pathlen, basename_offset, check->stack, check->all_attrs, rem);
1169 void git_check_attr(struct index_state *istate,
1170 const struct object_id *tree_oid, const char *path,
1171 struct attr_check *check)
1173 int i;
1175 collect_some_attrs(istate, tree_oid, path, check);
1177 for (i = 0; i < check->nr; i++) {
1178 unsigned int n = check->items[i].attr->attr_nr;
1179 const char *value = check->all_attrs[n].value;
1180 if (value == ATTR__UNKNOWN)
1181 value = ATTR__UNSET;
1182 check->items[i].value = value;
1186 void git_all_attrs(struct index_state *istate, const struct object_id *tree_oid,
1187 const char *path, struct attr_check *check)
1189 int i;
1191 attr_check_reset(check);
1192 collect_some_attrs(istate, tree_oid, path, check);
1194 for (i = 0; i < check->all_attrs_nr; i++) {
1195 const char *name = check->all_attrs[i].attr->name;
1196 const char *value = check->all_attrs[i].value;
1197 struct attr_check_item *item;
1198 if (value == ATTR__UNSET || value == ATTR__UNKNOWN)
1199 continue;
1200 item = attr_check_append(check, git_attr(name));
1201 item->value = value;
1205 void attr_start(void)
1207 pthread_mutex_init(&g_attr_hashmap.mutex, NULL);
1208 pthread_mutex_init(&check_vector.mutex, NULL);