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