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