attr: convert "macro_ok" into a flags field
[git] / attr.c
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.
4  *
5  * One basic design decision here is that we are not going to support
6  * an insanely large number of attributes.
7  */
8
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"
17
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
25
26 #ifndef DEBUG_ATTR
27 #define DEBUG_ATTR 0
28 #endif
29
30 struct git_attr {
31         int attr_nr; /* unique attribute number */
32         char name[FLEX_ARRAY]; /* attribute name */
33 };
34
35 const char *git_attr_name(const struct git_attr *attr)
36 {
37         return attr->name;
38 }
39
40 struct attr_hashmap {
41         struct hashmap map;
42         pthread_mutex_t mutex;
43 };
44
45 static inline void hashmap_lock(struct attr_hashmap *map)
46 {
47         pthread_mutex_lock(&map->mutex);
48 }
49
50 static inline void hashmap_unlock(struct attr_hashmap *map)
51 {
52         pthread_mutex_unlock(&map->mutex);
53 }
54
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 */
61 };
62
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)
68 {
69         const struct attr_hash_entry *a, *b;
70
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);
74 }
75
76 /*
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.
80  */
81 static struct attr_hashmap g_attr_hashmap = {
82         HASHMAP_INIT(attr_hash_entry_cmp, NULL)
83 };
84
85 /*
86  * Retrieve the 'value' stored in a hashmap given the provided 'key'.
87  * If there is no matching entry, return NULL.
88  */
89 static void *attr_hashmap_get(struct attr_hashmap *map,
90                               const char *key, size_t keylen)
91 {
92         struct attr_hash_entry k;
93         struct attr_hash_entry *e;
94
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);
99
100         return e ? e->value : NULL;
101 }
102
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)
107 {
108         struct attr_hash_entry *e;
109
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;
115
116         hashmap_add(&map->map, &e->ent);
117 }
118
119 struct all_attrs_item {
120         const struct git_attr *attr;
121         const char *value;
122         /*
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
126          */
127         const struct match_attr *macro;
128 };
129
130 /*
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.
134  */
135 static void all_attrs_init(struct attr_hashmap *map, struct attr_check *check)
136 {
137         int i;
138         unsigned int size;
139
140         hashmap_lock(map);
141
142         size = hashmap_get_size(&map->map);
143         if (size < check->all_attrs_nr)
144                 BUG("interned attributes shouldn't be deleted");
145
146         /*
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.
151          */
152         if (size != check->all_attrs_nr) {
153                 struct attr_hash_entry *e;
154                 struct hashmap_iter iter;
155
156                 REALLOC_ARRAY(check->all_attrs, size);
157                 check->all_attrs_nr = size;
158
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;
163                 }
164         }
165
166         hashmap_unlock(map);
167
168         /*
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.
172          */
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;
176         }
177 }
178
179 static int attr_name_valid(const char *name, size_t namelen)
180 {
181         /*
182          * Attribute name cannot begin with '-' and must consist of
183          * characters from [-A-Za-z0-9_.].
184          */
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;
194         }
195         return 1;
196 }
197
198 static void report_invalid_attr(const char *name, size_t len,
199                                 const char *src, int lineno)
200 {
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);
206 }
207
208 /*
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.
212  */
213 static const struct git_attr *git_attr_internal(const char *name, int namelen)
214 {
215         struct git_attr *a;
216
217         if (!attr_name_valid(name, namelen))
218                 return NULL;
219
220         hashmap_lock(&g_attr_hashmap);
221
222         a = attr_hashmap_get(&g_attr_hashmap, name, namelen);
223
224         if (!a) {
225                 FLEX_ALLOC_MEM(a, name, name, namelen);
226                 a->attr_nr = hashmap_get_size(&g_attr_hashmap.map);
227
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));
231         }
232
233         hashmap_unlock(&g_attr_hashmap);
234
235         return a;
236 }
237
238 const struct git_attr *git_attr(const char *name)
239 {
240         return git_attr_internal(name, strlen(name));
241 }
242
243 /* What does a matched pattern decide? */
244 struct attr_state {
245         const struct git_attr *attr;
246         const char *setto;
247 };
248
249 struct pattern {
250         const char *pattern;
251         int patternlen;
252         int nowildcardlen;
253         unsigned flags;         /* PATTERN_FLAG_* */
254 };
255
256 /*
257  * One rule, as from a .gitattributes file.
258  *
259  * If is_macro is true, then u.attr is a pointer to the git_attr being
260  * defined.
261  *
262  * If is_macro is false, then u.pat is the filename pattern to which the
263  * rule applies.
264  *
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).
268  */
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];
277 };
278
279 static const char blank[] = " \t\r\n";
280
281 /* Flags usable in read_attr() and parse_attr_line() family of functions. */
282 #define READ_ATTR_MACRO_OK (1<<0)
283
284 /*
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.
290  */
291 static const char *parse_attr(const char *src, int lineno, const char *cp,
292                               struct attr_state *e)
293 {
294         const char *ep, *equals;
295         int len;
296
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--;
309                 }
310                 if (!attr_name_valid(cp, len)) {
311                         report_invalid_attr(cp, len, src, lineno);
312                         return NULL;
313                 }
314         } else {
315                 /*
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.
320                  */
321                 if (*cp == '-' || *cp == '!') {
322                         e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
323                         cp++;
324                         len--;
325                 }
326                 else if (!equals)
327                         e->setto = ATTR__TRUE;
328                 else {
329                         e->setto = xmemdupz(equals + 1, ep - equals - 1);
330                 }
331                 e->attr = git_attr_internal(cp, len);
332         }
333         return ep + strspn(ep, blank);
334 }
335
336 static struct match_attr *parse_attr_line(const char *line, const char *src,
337                                           int lineno, unsigned flags)
338 {
339         int namelen;
340         int num_attr, i;
341         const char *cp, *name, *states;
342         struct match_attr *res = NULL;
343         int is_macro;
344         struct strbuf pattern = STRBUF_INIT;
345
346         cp = line + strspn(line, blank);
347         if (!*cp || *cp == '#')
348                 return NULL;
349         name = cp;
350
351         if (*cp == '"' && !unquote_c_style(&pattern, name, &states)) {
352                 name = pattern.buf;
353                 namelen = pattern.len;
354         } else {
355                 namelen = strcspn(name, blank);
356                 states = name + namelen;
357         }
358
359         if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
360             starts_with(name, ATTRIBUTE_MACRO_PREFIX)) {
361                 if (!(flags & READ_ATTR_MACRO_OK)) {
362                         fprintf_ln(stderr, _("%s not allowed: %s:%d"),
363                                    name, src, lineno);
364                         goto fail_return;
365                 }
366                 is_macro = 1;
367                 name += strlen(ATTRIBUTE_MACRO_PREFIX);
368                 name += strspn(name, blank);
369                 namelen = strcspn(name, blank);
370                 if (!attr_name_valid(name, namelen)) {
371                         report_invalid_attr(name, namelen, src, lineno);
372                         goto fail_return;
373                 }
374         }
375         else
376                 is_macro = 0;
377
378         states += strspn(states, blank);
379
380         /* First pass to count the attr_states */
381         for (cp = states, num_attr = 0; *cp; num_attr++) {
382                 cp = parse_attr(src, lineno, cp, NULL);
383                 if (!cp)
384                         goto fail_return;
385         }
386
387         res = xcalloc(1,
388                       sizeof(*res) +
389                       sizeof(struct attr_state) * num_attr +
390                       (is_macro ? 0 : namelen + 1));
391         if (is_macro) {
392                 res->u.attr = git_attr_internal(name, namelen);
393         } else {
394                 char *p = (char *)&(res->state[num_attr]);
395                 memcpy(p, name, namelen);
396                 res->u.pat.pattern = p;
397                 parse_path_pattern(&res->u.pat.pattern,
398                                       &res->u.pat.patternlen,
399                                       &res->u.pat.flags,
400                                       &res->u.pat.nowildcardlen);
401                 if (res->u.pat.flags & PATTERN_FLAG_NEGATIVE) {
402                         warning(_("Negative patterns are ignored in git attributes\n"
403                                   "Use '\\!' for literal leading exclamation."));
404                         goto fail_return;
405                 }
406         }
407         res->is_macro = is_macro;
408         res->num_attr = num_attr;
409
410         /* Second pass to fill the attr_states */
411         for (cp = states, i = 0; *cp; i++) {
412                 cp = parse_attr(src, lineno, cp, &(res->state[i]));
413         }
414
415         strbuf_release(&pattern);
416         return res;
417
418 fail_return:
419         strbuf_release(&pattern);
420         free(res);
421         return NULL;
422 }
423
424 /*
425  * Like info/exclude and .gitignore, the attribute information can
426  * come from many places.
427  *
428  * (1) .gitattributes file of the same directory;
429  * (2) .gitattributes file of the parent directory if (1) does not have
430  *      any match; this goes recursively upwards, just like .gitignore.
431  * (3) $GIT_DIR/info/attributes, which overrides both of the above.
432  *
433  * In the same file, later entries override the earlier match, so in the
434  * global list, we would have entries from info/attributes the earliest
435  * (reading the file from top to bottom), .gitattributes of the root
436  * directory (again, reading the file from top to bottom) down to the
437  * current directory, and then scan the list backwards to find the first match.
438  * This is exactly the same as what is_excluded() does in dir.c to deal with
439  * .gitignore file and info/excludes file as a fallback.
440  */
441
442 struct attr_stack {
443         struct attr_stack *prev;
444         char *origin;
445         size_t originlen;
446         unsigned num_matches;
447         unsigned alloc;
448         struct match_attr **attrs;
449 };
450
451 static void attr_stack_free(struct attr_stack *e)
452 {
453         int i;
454         free(e->origin);
455         for (i = 0; i < e->num_matches; i++) {
456                 struct match_attr *a = e->attrs[i];
457                 int j;
458                 for (j = 0; j < a->num_attr; j++) {
459                         const char *setto = a->state[j].setto;
460                         if (setto == ATTR__TRUE ||
461                             setto == ATTR__FALSE ||
462                             setto == ATTR__UNSET ||
463                             setto == ATTR__UNKNOWN)
464                                 ;
465                         else
466                                 free((char *) setto);
467                 }
468                 free(a);
469         }
470         free(e->attrs);
471         free(e);
472 }
473
474 static void drop_attr_stack(struct attr_stack **stack)
475 {
476         while (*stack) {
477                 struct attr_stack *elem = *stack;
478                 *stack = elem->prev;
479                 attr_stack_free(elem);
480         }
481 }
482
483 /* List of all attr_check structs; access should be surrounded by mutex */
484 static struct check_vector {
485         size_t nr;
486         size_t alloc;
487         struct attr_check **checks;
488         pthread_mutex_t mutex;
489 } check_vector;
490
491 static inline void vector_lock(void)
492 {
493         pthread_mutex_lock(&check_vector.mutex);
494 }
495
496 static inline void vector_unlock(void)
497 {
498         pthread_mutex_unlock(&check_vector.mutex);
499 }
500
501 static void check_vector_add(struct attr_check *c)
502 {
503         vector_lock();
504
505         ALLOC_GROW(check_vector.checks,
506                    check_vector.nr + 1,
507                    check_vector.alloc);
508         check_vector.checks[check_vector.nr++] = c;
509
510         vector_unlock();
511 }
512
513 static void check_vector_remove(struct attr_check *check)
514 {
515         int i;
516
517         vector_lock();
518
519         /* Find entry */
520         for (i = 0; i < check_vector.nr; i++)
521                 if (check_vector.checks[i] == check)
522                         break;
523
524         if (i >= check_vector.nr)
525                 BUG("no entry found");
526
527         /* shift entries over */
528         for (; i < check_vector.nr - 1; i++)
529                 check_vector.checks[i] = check_vector.checks[i + 1];
530
531         check_vector.nr--;
532
533         vector_unlock();
534 }
535
536 /* Iterate through all attr_check instances and drop their stacks */
537 static void drop_all_attr_stacks(void)
538 {
539         int i;
540
541         vector_lock();
542
543         for (i = 0; i < check_vector.nr; i++) {
544                 drop_attr_stack(&check_vector.checks[i]->stack);
545         }
546
547         vector_unlock();
548 }
549
550 struct attr_check *attr_check_alloc(void)
551 {
552         struct attr_check *c = xcalloc(1, sizeof(struct attr_check));
553
554         /* save pointer to the check struct */
555         check_vector_add(c);
556
557         return c;
558 }
559
560 struct attr_check *attr_check_initl(const char *one, ...)
561 {
562         struct attr_check *check;
563         int cnt;
564         va_list params;
565         const char *param;
566
567         va_start(params, one);
568         for (cnt = 1; (param = va_arg(params, const char *)) != NULL; cnt++)
569                 ;
570         va_end(params);
571
572         check = attr_check_alloc();
573         check->nr = cnt;
574         check->alloc = cnt;
575         check->items = xcalloc(cnt, sizeof(struct attr_check_item));
576
577         check->items[0].attr = git_attr(one);
578         va_start(params, one);
579         for (cnt = 1; cnt < check->nr; cnt++) {
580                 const struct git_attr *attr;
581                 param = va_arg(params, const char *);
582                 if (!param)
583                         BUG("counted %d != ended at %d",
584                             check->nr, cnt);
585                 attr = git_attr(param);
586                 if (!attr)
587                         BUG("%s: not a valid attribute name", param);
588                 check->items[cnt].attr = attr;
589         }
590         va_end(params);
591         return check;
592 }
593
594 struct attr_check *attr_check_dup(const struct attr_check *check)
595 {
596         struct attr_check *ret;
597
598         if (!check)
599                 return NULL;
600
601         ret = attr_check_alloc();
602
603         ret->nr = check->nr;
604         ret->alloc = check->alloc;
605         ALLOC_ARRAY(ret->items, ret->nr);
606         COPY_ARRAY(ret->items, check->items, ret->nr);
607
608         return ret;
609 }
610
611 struct attr_check_item *attr_check_append(struct attr_check *check,
612                                           const struct git_attr *attr)
613 {
614         struct attr_check_item *item;
615
616         ALLOC_GROW(check->items, check->nr + 1, check->alloc);
617         item = &check->items[check->nr++];
618         item->attr = attr;
619         return item;
620 }
621
622 void attr_check_reset(struct attr_check *check)
623 {
624         check->nr = 0;
625 }
626
627 void attr_check_clear(struct attr_check *check)
628 {
629         FREE_AND_NULL(check->items);
630         check->alloc = 0;
631         check->nr = 0;
632
633         FREE_AND_NULL(check->all_attrs);
634         check->all_attrs_nr = 0;
635
636         drop_attr_stack(&check->stack);
637 }
638
639 void attr_check_free(struct attr_check *check)
640 {
641         if (check) {
642                 /* Remove check from the check vector */
643                 check_vector_remove(check);
644
645                 attr_check_clear(check);
646                 free(check);
647         }
648 }
649
650 static const char *builtin_attr[] = {
651         "[attr]binary -diff -merge -text",
652         NULL,
653 };
654
655 static void handle_attr_line(struct attr_stack *res,
656                              const char *line,
657                              const char *src,
658                              int lineno,
659                              unsigned flags)
660 {
661         struct match_attr *a;
662
663         a = parse_attr_line(line, src, lineno, flags);
664         if (!a)
665                 return;
666         ALLOC_GROW(res->attrs, res->num_matches + 1, res->alloc);
667         res->attrs[res->num_matches++] = a;
668 }
669
670 static struct attr_stack *read_attr_from_array(const char **list)
671 {
672         struct attr_stack *res;
673         const char *line;
674         int lineno = 0;
675
676         res = xcalloc(1, sizeof(*res));
677         while ((line = *(list++)) != NULL)
678                 handle_attr_line(res, line, "[builtin]", ++lineno,
679                                  READ_ATTR_MACRO_OK);
680         return res;
681 }
682
683 /*
684  * Callers into the attribute system assume there is a single, system-wide
685  * global state where attributes are read from and when the state is flipped by
686  * calling git_attr_set_direction(), the stack frames that have been
687  * constructed need to be discarded so so that subsequent calls into the
688  * attribute system will lazily read from the right place.  Since changing
689  * direction causes a global paradigm shift, it should not ever be called while
690  * another thread could potentially be calling into the attribute system.
691  */
692 static enum git_attr_direction direction;
693
694 void git_attr_set_direction(enum git_attr_direction new_direction)
695 {
696         if (is_bare_repository() && new_direction != GIT_ATTR_INDEX)
697                 BUG("non-INDEX attr direction in a bare repo");
698
699         if (new_direction != direction)
700                 drop_all_attr_stacks();
701
702         direction = new_direction;
703 }
704
705 static struct attr_stack *read_attr_from_file(const char *path, unsigned flags)
706 {
707         FILE *fp = fopen_or_warn(path, "r");
708         struct attr_stack *res;
709         char buf[2048];
710         int lineno = 0;
711
712         if (!fp)
713                 return NULL;
714         res = xcalloc(1, sizeof(*res));
715         while (fgets(buf, sizeof(buf), fp)) {
716                 char *bufp = buf;
717                 if (!lineno)
718                         skip_utf8_bom(&bufp, strlen(bufp));
719                 handle_attr_line(res, bufp, path, ++lineno, flags);
720         }
721         fclose(fp);
722         return res;
723 }
724
725 static struct attr_stack *read_attr_from_index(const struct index_state *istate,
726                                                const char *path,
727                                                unsigned flags)
728 {
729         struct attr_stack *res;
730         char *buf, *sp;
731         int lineno = 0;
732
733         if (!istate)
734                 return NULL;
735
736         buf = read_blob_data_from_index(istate, path, NULL);
737         if (!buf)
738                 return NULL;
739
740         res = xcalloc(1, sizeof(*res));
741         for (sp = buf; *sp; ) {
742                 char *ep;
743                 int more;
744
745                 ep = strchrnul(sp, '\n');
746                 more = (*ep == '\n');
747                 *ep = '\0';
748                 handle_attr_line(res, sp, path, ++lineno, flags);
749                 sp = ep + more;
750         }
751         free(buf);
752         return res;
753 }
754
755 static struct attr_stack *read_attr(const struct index_state *istate,
756                                     const char *path, unsigned flags)
757 {
758         struct attr_stack *res = NULL;
759
760         if (direction == GIT_ATTR_INDEX) {
761                 res = read_attr_from_index(istate, path, flags);
762         } else if (!is_bare_repository()) {
763                 if (direction == GIT_ATTR_CHECKOUT) {
764                         res = read_attr_from_index(istate, path, flags);
765                         if (!res)
766                                 res = read_attr_from_file(path, flags);
767                 } else if (direction == GIT_ATTR_CHECKIN) {
768                         res = read_attr_from_file(path, flags);
769                         if (!res)
770                                 /*
771                                  * There is no checked out .gitattributes file
772                                  * there, but we might have it in the index.
773                                  * We allow operation in a sparsely checked out
774                                  * work tree, so read from it.
775                                  */
776                                 res = read_attr_from_index(istate, path, flags);
777                 }
778         }
779
780         if (!res)
781                 res = xcalloc(1, sizeof(*res));
782         return res;
783 }
784
785 #if DEBUG_ATTR
786 static void debug_info(const char *what, struct attr_stack *elem)
787 {
788         fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
789 }
790 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
791 {
792         const char *value = v;
793
794         if (ATTR_TRUE(value))
795                 value = "set";
796         else if (ATTR_FALSE(value))
797                 value = "unset";
798         else if (ATTR_UNSET(value))
799                 value = "unspecified";
800
801         fprintf(stderr, "%s: %s => %s (%s)\n",
802                 what, attr->name, (char *) value, match);
803 }
804 #define debug_push(a) debug_info("push", (a))
805 #define debug_pop(a) debug_info("pop", (a))
806 #else
807 #define debug_push(a) do { ; } while (0)
808 #define debug_pop(a) do { ; } while (0)
809 #define debug_set(a,b,c,d) do { ; } while (0)
810 #endif /* DEBUG_ATTR */
811
812 static const char *git_etc_gitattributes(void)
813 {
814         static const char *system_wide;
815         if (!system_wide)
816                 system_wide = system_path(ETC_GITATTRIBUTES);
817         return system_wide;
818 }
819
820 static const char *get_home_gitattributes(void)
821 {
822         if (!git_attributes_file)
823                 git_attributes_file = xdg_config_home("attributes");
824
825         return git_attributes_file;
826 }
827
828 static int git_attr_system(void)
829 {
830         return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
831 }
832
833 static GIT_PATH_FUNC(git_path_info_attributes, INFOATTRIBUTES_FILE)
834
835 static void push_stack(struct attr_stack **attr_stack_p,
836                        struct attr_stack *elem, char *origin, size_t originlen)
837 {
838         if (elem) {
839                 elem->origin = origin;
840                 if (origin)
841                         elem->originlen = originlen;
842                 elem->prev = *attr_stack_p;
843                 *attr_stack_p = elem;
844         }
845 }
846
847 static void bootstrap_attr_stack(const struct index_state *istate,
848                                  struct attr_stack **stack)
849 {
850         struct attr_stack *e;
851         unsigned flags = READ_ATTR_MACRO_OK;
852
853         if (*stack)
854                 return;
855
856         /* builtin frame */
857         e = read_attr_from_array(builtin_attr);
858         push_stack(stack, e, NULL, 0);
859
860         /* system-wide frame */
861         if (git_attr_system()) {
862                 e = read_attr_from_file(git_etc_gitattributes(), flags);
863                 push_stack(stack, e, NULL, 0);
864         }
865
866         /* home directory */
867         if (get_home_gitattributes()) {
868                 e = read_attr_from_file(get_home_gitattributes(), flags);
869                 push_stack(stack, e, NULL, 0);
870         }
871
872         /* root directory */
873         e = read_attr(istate, GITATTRIBUTES_FILE, flags);
874         push_stack(stack, e, xstrdup(""), 0);
875
876         /* info frame */
877         if (startup_info->have_repository)
878                 e = read_attr_from_file(git_path_info_attributes(), flags);
879         else
880                 e = NULL;
881         if (!e)
882                 e = xcalloc(1, sizeof(struct attr_stack));
883         push_stack(stack, e, NULL, 0);
884 }
885
886 static void prepare_attr_stack(const struct index_state *istate,
887                                const char *path, int dirlen,
888                                struct attr_stack **stack)
889 {
890         struct attr_stack *info;
891         struct strbuf pathbuf = STRBUF_INIT;
892
893         /*
894          * At the bottom of the attribute stack is the built-in
895          * set of attribute definitions, followed by the contents
896          * of $(prefix)/etc/gitattributes and a file specified by
897          * core.attributesfile.  Then, contents from
898          * .gitattributes files from directories closer to the
899          * root to the ones in deeper directories are pushed
900          * to the stack.  Finally, at the very top of the stack
901          * we always keep the contents of $GIT_DIR/info/attributes.
902          *
903          * When checking, we use entries from near the top of the
904          * stack, preferring $GIT_DIR/info/attributes, then
905          * .gitattributes in deeper directories to shallower ones,
906          * and finally use the built-in set as the default.
907          */
908         bootstrap_attr_stack(istate, stack);
909
910         /*
911          * Pop the "info" one that is always at the top of the stack.
912          */
913         info = *stack;
914         *stack = info->prev;
915
916         /*
917          * Pop the ones from directories that are not the prefix of
918          * the path we are checking. Break out of the loop when we see
919          * the root one (whose origin is an empty string "") or the builtin
920          * one (whose origin is NULL) without popping it.
921          */
922         while ((*stack)->origin) {
923                 int namelen = (*stack)->originlen;
924                 struct attr_stack *elem;
925
926                 elem = *stack;
927                 if (namelen <= dirlen &&
928                     !strncmp(elem->origin, path, namelen) &&
929                     (!namelen || path[namelen] == '/'))
930                         break;
931
932                 debug_pop(elem);
933                 *stack = elem->prev;
934                 attr_stack_free(elem);
935         }
936
937         /*
938          * bootstrap_attr_stack() should have added, and the
939          * above loop should have stopped before popping, the
940          * root element whose attr_stack->origin is set to an
941          * empty string.
942          */
943         assert((*stack)->origin);
944
945         strbuf_addstr(&pathbuf, (*stack)->origin);
946         /* Build up to the directory 'path' is in */
947         while (pathbuf.len < dirlen) {
948                 size_t len = pathbuf.len;
949                 struct attr_stack *next;
950                 char *origin;
951
952                 /* Skip path-separator */
953                 if (len < dirlen && is_dir_sep(path[len]))
954                         len++;
955                 /* Find the end of the next component */
956                 while (len < dirlen && !is_dir_sep(path[len]))
957                         len++;
958
959                 if (pathbuf.len > 0)
960                         strbuf_addch(&pathbuf, '/');
961                 strbuf_add(&pathbuf, path + pathbuf.len, (len - pathbuf.len));
962                 strbuf_addf(&pathbuf, "/%s", GITATTRIBUTES_FILE);
963
964                 next = read_attr(istate, pathbuf.buf, 0);
965
966                 /* reset the pathbuf to not include "/.gitattributes" */
967                 strbuf_setlen(&pathbuf, len);
968
969                 origin = xstrdup(pathbuf.buf);
970                 push_stack(stack, next, origin, len);
971         }
972
973         /*
974          * Finally push the "info" one at the top of the stack.
975          */
976         push_stack(stack, info, NULL, 0);
977
978         strbuf_release(&pathbuf);
979 }
980
981 static int path_matches(const char *pathname, int pathlen,
982                         int basename_offset,
983                         const struct pattern *pat,
984                         const char *base, int baselen)
985 {
986         const char *pattern = pat->pattern;
987         int prefix = pat->nowildcardlen;
988         int isdir = (pathlen && pathname[pathlen - 1] == '/');
989
990         if ((pat->flags & PATTERN_FLAG_MUSTBEDIR) && !isdir)
991                 return 0;
992
993         if (pat->flags & PATTERN_FLAG_NODIR) {
994                 return match_basename(pathname + basename_offset,
995                                       pathlen - basename_offset - isdir,
996                                       pattern, prefix,
997                                       pat->patternlen, pat->flags);
998         }
999         return match_pathname(pathname, pathlen - isdir,
1000                               base, baselen,
1001                               pattern, prefix, pat->patternlen, pat->flags);
1002 }
1003
1004 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem);
1005
1006 static int fill_one(const char *what, struct all_attrs_item *all_attrs,
1007                     const struct match_attr *a, int rem)
1008 {
1009         int i;
1010
1011         for (i = a->num_attr - 1; rem > 0 && i >= 0; i--) {
1012                 const struct git_attr *attr = a->state[i].attr;
1013                 const char **n = &(all_attrs[attr->attr_nr].value);
1014                 const char *v = a->state[i].setto;
1015
1016                 if (*n == ATTR__UNKNOWN) {
1017                         debug_set(what,
1018                                   a->is_macro ? a->u.attr->name : a->u.pat.pattern,
1019                                   attr, v);
1020                         *n = v;
1021                         rem--;
1022                         rem = macroexpand_one(all_attrs, attr->attr_nr, rem);
1023                 }
1024         }
1025         return rem;
1026 }
1027
1028 static int fill(const char *path, int pathlen, int basename_offset,
1029                 const struct attr_stack *stack,
1030                 struct all_attrs_item *all_attrs, int rem)
1031 {
1032         for (; rem > 0 && stack; stack = stack->prev) {
1033                 int i;
1034                 const char *base = stack->origin ? stack->origin : "";
1035
1036                 for (i = stack->num_matches - 1; 0 < rem && 0 <= i; i--) {
1037                         const struct match_attr *a = stack->attrs[i];
1038                         if (a->is_macro)
1039                                 continue;
1040                         if (path_matches(path, pathlen, basename_offset,
1041                                          &a->u.pat, base, stack->originlen))
1042                                 rem = fill_one("fill", all_attrs, a, rem);
1043                 }
1044         }
1045
1046         return rem;
1047 }
1048
1049 static int macroexpand_one(struct all_attrs_item *all_attrs, int nr, int rem)
1050 {
1051         const struct all_attrs_item *item = &all_attrs[nr];
1052
1053         if (item->macro && item->value == ATTR__TRUE)
1054                 return fill_one("expand", all_attrs, item->macro, rem);
1055         else
1056                 return rem;
1057 }
1058
1059 /*
1060  * Marks the attributes which are macros based on the attribute stack.
1061  * This prevents having to search through the attribute stack each time
1062  * a macro needs to be expanded during the fill stage.
1063  */
1064 static void determine_macros(struct all_attrs_item *all_attrs,
1065                              const struct attr_stack *stack)
1066 {
1067         for (; stack; stack = stack->prev) {
1068                 int i;
1069                 for (i = stack->num_matches - 1; i >= 0; i--) {
1070                         const struct match_attr *ma = stack->attrs[i];
1071                         if (ma->is_macro) {
1072                                 int n = ma->u.attr->attr_nr;
1073                                 if (!all_attrs[n].macro) {
1074                                         all_attrs[n].macro = ma;
1075                                 }
1076                         }
1077                 }
1078         }
1079 }
1080
1081 /*
1082  * Collect attributes for path into the array pointed to by check->all_attrs.
1083  * If check->check_nr is non-zero, only attributes in check[] are collected.
1084  * Otherwise all attributes are collected.
1085  */
1086 static void collect_some_attrs(const struct index_state *istate,
1087                                const char *path,
1088                                struct attr_check *check)
1089 {
1090         int pathlen, rem, dirlen;
1091         const char *cp, *last_slash = NULL;
1092         int basename_offset;
1093
1094         for (cp = path; *cp; cp++) {
1095                 if (*cp == '/' && cp[1])
1096                         last_slash = cp;
1097         }
1098         pathlen = cp - path;
1099         if (last_slash) {
1100                 basename_offset = last_slash + 1 - path;
1101                 dirlen = last_slash - path;
1102         } else {
1103                 basename_offset = 0;
1104                 dirlen = 0;
1105         }
1106
1107         prepare_attr_stack(istate, path, dirlen, &check->stack);
1108         all_attrs_init(&g_attr_hashmap, check);
1109         determine_macros(check->all_attrs, check->stack);
1110
1111         rem = check->all_attrs_nr;
1112         fill(path, pathlen, basename_offset, check->stack, check->all_attrs, rem);
1113 }
1114
1115 void git_check_attr(const struct index_state *istate,
1116                     const char *path,
1117                     struct attr_check *check)
1118 {
1119         int i;
1120
1121         collect_some_attrs(istate, path, check);
1122
1123         for (i = 0; i < check->nr; i++) {
1124                 size_t n = check->items[i].attr->attr_nr;
1125                 const char *value = check->all_attrs[n].value;
1126                 if (value == ATTR__UNKNOWN)
1127                         value = ATTR__UNSET;
1128                 check->items[i].value = value;
1129         }
1130 }
1131
1132 void git_all_attrs(const struct index_state *istate,
1133                    const char *path, struct attr_check *check)
1134 {
1135         int i;
1136
1137         attr_check_reset(check);
1138         collect_some_attrs(istate, path, check);
1139
1140         for (i = 0; i < check->all_attrs_nr; i++) {
1141                 const char *name = check->all_attrs[i].attr->name;
1142                 const char *value = check->all_attrs[i].value;
1143                 struct attr_check_item *item;
1144                 if (value == ATTR__UNSET || value == ATTR__UNKNOWN)
1145                         continue;
1146                 item = attr_check_append(check, git_attr(name));
1147                 item->value = value;
1148         }
1149 }
1150
1151 void attr_start(void)
1152 {
1153         pthread_mutex_init(&g_attr_hashmap.mutex, NULL);
1154         pthread_mutex_init(&check_vector.mutex, NULL);
1155 }