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