11 #include "sha1-array.h"
13 #include "object-store.h"
14 #include "repository.h"
16 static int get_oid_oneline(const char *, struct object_id
*, struct commit_list
*);
18 typedef int (*disambiguate_hint_fn
)(const struct object_id
*, void *);
20 struct disambiguate_state
{
21 int len
; /* length of prefix in hex chars */
22 char hex_pfx
[GIT_MAX_HEXSZ
+ 1];
23 struct object_id bin_pfx
;
25 disambiguate_hint_fn fn
;
27 struct object_id candidate
;
28 unsigned candidate_exists
:1;
29 unsigned candidate_checked
:1;
30 unsigned candidate_ok
:1;
31 unsigned disambiguate_fn_used
:1;
33 unsigned always_call_fn
:1;
36 static void update_candidates(struct disambiguate_state
*ds
, const struct object_id
*current
)
38 if (ds
->always_call_fn
) {
39 ds
->ambiguous
= ds
->fn(current
, ds
->cb_data
) ? 1 : 0;
42 if (!ds
->candidate_exists
) {
43 /* this is the first candidate */
44 oidcpy(&ds
->candidate
, current
);
45 ds
->candidate_exists
= 1;
47 } else if (!oidcmp(&ds
->candidate
, current
)) {
48 /* the same as what we already have seen */
53 /* cannot disambiguate between ds->candidate and current */
58 if (!ds
->candidate_checked
) {
59 ds
->candidate_ok
= ds
->fn(&ds
->candidate
, ds
->cb_data
);
60 ds
->disambiguate_fn_used
= 1;
61 ds
->candidate_checked
= 1;
64 if (!ds
->candidate_ok
) {
65 /* discard the candidate; we know it does not satisfy fn */
66 oidcpy(&ds
->candidate
, current
);
67 ds
->candidate_checked
= 0;
71 /* if we reach this point, we know ds->candidate satisfies fn */
72 if (ds
->fn(current
, ds
->cb_data
)) {
74 * if both current and candidate satisfy fn, we cannot
81 /* otherwise, current can be discarded and candidate is still good */
84 static int append_loose_object(const struct object_id
*oid
, const char *path
,
87 oid_array_append(data
, oid
);
91 static int match_sha(unsigned, const unsigned char *, const unsigned char *);
93 static void find_short_object_filename(struct disambiguate_state
*ds
)
95 int subdir_nr
= ds
->bin_pfx
.hash
[0];
96 struct alternate_object_database
*alt
;
97 static struct alternate_object_database
*fakeent
;
101 * Create a "fake" alternate object database that
102 * points to our own object database, to make it
103 * easier to get a temporary working space in
104 * alt->name/alt->base while iterating over the
105 * object databases including our own.
107 fakeent
= alloc_alt_odb(get_object_directory());
109 fakeent
->next
= the_repository
->objects
->alt_odb_list
;
111 for (alt
= fakeent
; alt
&& !ds
->ambiguous
; alt
= alt
->next
) {
114 if (!alt
->loose_objects_subdir_seen
[subdir_nr
]) {
115 struct strbuf
*buf
= alt_scratch_buf(alt
);
116 for_each_file_in_obj_subdir(subdir_nr
, buf
,
119 &alt
->loose_objects_cache
);
120 alt
->loose_objects_subdir_seen
[subdir_nr
] = 1;
123 pos
= oid_array_lookup(&alt
->loose_objects_cache
, &ds
->bin_pfx
);
126 while (!ds
->ambiguous
&& pos
< alt
->loose_objects_cache
.nr
) {
127 const struct object_id
*oid
;
128 oid
= alt
->loose_objects_cache
.oid
+ pos
;
129 if (!match_sha(ds
->len
, ds
->bin_pfx
.hash
, oid
->hash
))
131 update_candidates(ds
, oid
);
137 static int match_sha(unsigned len
, const unsigned char *a
, const unsigned char *b
)
147 if ((*a
^ *b
) & 0xf0)
152 static void unique_in_pack(struct packed_git
*p
,
153 struct disambiguate_state
*ds
)
155 uint32_t num
, last
, i
, first
= 0;
156 const struct object_id
*current
= NULL
;
158 if (open_pack_index(p
) || !p
->num_objects
)
161 num
= p
->num_objects
;
163 while (first
< last
) {
164 uint32_t mid
= first
+ (last
- first
) / 2;
165 const unsigned char *current
;
168 current
= nth_packed_object_sha1(p
, mid
);
169 cmp
= hashcmp(ds
->bin_pfx
.hash
, current
);
182 * At this point, "first" is the location of the lowest object
183 * with an object name that could match "bin_pfx". See if we have
184 * 0, 1 or more objects that actually match(es).
186 for (i
= first
; i
< num
&& !ds
->ambiguous
; i
++) {
187 struct object_id oid
;
188 current
= nth_packed_object_oid(&oid
, p
, i
);
189 if (!match_sha(ds
->len
, ds
->bin_pfx
.hash
, current
->hash
))
191 update_candidates(ds
, current
);
195 static void find_short_packed_object(struct disambiguate_state
*ds
)
197 struct packed_git
*p
;
199 for (p
= get_packed_git(the_repository
); p
&& !ds
->ambiguous
;
201 unique_in_pack(p
, ds
);
204 #define SHORT_NAME_NOT_FOUND (-1)
205 #define SHORT_NAME_AMBIGUOUS (-2)
207 static int finish_object_disambiguation(struct disambiguate_state
*ds
,
208 struct object_id
*oid
)
211 return SHORT_NAME_AMBIGUOUS
;
213 if (!ds
->candidate_exists
)
214 return SHORT_NAME_NOT_FOUND
;
216 if (!ds
->candidate_checked
)
218 * If this is the only candidate, there is no point
219 * calling the disambiguation hint callback.
221 * On the other hand, if the current candidate
222 * replaced an earlier candidate that did _not_ pass
223 * the disambiguation hint callback, then we do have
224 * more than one objects that match the short name
225 * given, so we should make sure this one matches;
226 * otherwise, if we discovered this one and the one
227 * that we previously discarded in the reverse order,
228 * we would end up showing different results in the
231 ds
->candidate_ok
= (!ds
->disambiguate_fn_used
||
232 ds
->fn(&ds
->candidate
, ds
->cb_data
));
234 if (!ds
->candidate_ok
)
235 return SHORT_NAME_AMBIGUOUS
;
237 oidcpy(oid
, &ds
->candidate
);
241 static int disambiguate_commit_only(const struct object_id
*oid
, void *cb_data_unused
)
243 int kind
= sha1_object_info(oid
->hash
, NULL
);
244 return kind
== OBJ_COMMIT
;
247 static int disambiguate_committish_only(const struct object_id
*oid
, void *cb_data_unused
)
252 kind
= sha1_object_info(oid
->hash
, NULL
);
253 if (kind
== OBJ_COMMIT
)
258 /* We need to do this the hard way... */
259 obj
= deref_tag(parse_object(oid
), NULL
, 0);
260 if (obj
&& obj
->type
== OBJ_COMMIT
)
265 static int disambiguate_tree_only(const struct object_id
*oid
, void *cb_data_unused
)
267 int kind
= sha1_object_info(oid
->hash
, NULL
);
268 return kind
== OBJ_TREE
;
271 static int disambiguate_treeish_only(const struct object_id
*oid
, void *cb_data_unused
)
276 kind
= sha1_object_info(oid
->hash
, NULL
);
277 if (kind
== OBJ_TREE
|| kind
== OBJ_COMMIT
)
282 /* We need to do this the hard way... */
283 obj
= deref_tag(parse_object(oid
), NULL
, 0);
284 if (obj
&& (obj
->type
== OBJ_TREE
|| obj
->type
== OBJ_COMMIT
))
289 static int disambiguate_blob_only(const struct object_id
*oid
, void *cb_data_unused
)
291 int kind
= sha1_object_info(oid
->hash
, NULL
);
292 return kind
== OBJ_BLOB
;
295 static disambiguate_hint_fn default_disambiguate_hint
;
297 int set_disambiguate_hint_config(const char *var
, const char *value
)
299 static const struct {
301 disambiguate_hint_fn fn
;
304 { "commit", disambiguate_commit_only
},
305 { "committish", disambiguate_committish_only
},
306 { "tree", disambiguate_tree_only
},
307 { "treeish", disambiguate_treeish_only
},
308 { "blob", disambiguate_blob_only
}
313 return config_error_nonbool(var
);
315 for (i
= 0; i
< ARRAY_SIZE(hints
); i
++) {
316 if (!strcasecmp(value
, hints
[i
].name
)) {
317 default_disambiguate_hint
= hints
[i
].fn
;
322 return error("unknown hint type for '%s': %s", var
, value
);
325 static int init_object_disambiguation(const char *name
, int len
,
326 struct disambiguate_state
*ds
)
330 if (len
< MINIMUM_ABBREV
|| len
> GIT_SHA1_HEXSZ
)
333 memset(ds
, 0, sizeof(*ds
));
335 for (i
= 0; i
< len
;i
++) {
336 unsigned char c
= name
[i
];
338 if (c
>= '0' && c
<= '9')
340 else if (c
>= 'a' && c
<= 'f')
342 else if (c
>= 'A' && c
<='F') {
351 ds
->bin_pfx
.hash
[i
>> 1] |= val
;
355 ds
->hex_pfx
[len
] = '\0';
356 prepare_alt_odb(the_repository
);
360 static int show_ambiguous_object(const struct object_id
*oid
, void *data
)
362 const struct disambiguate_state
*ds
= data
;
363 struct strbuf desc
= STRBUF_INIT
;
367 if (ds
->fn
&& !ds
->fn(oid
, ds
->cb_data
))
370 type
= sha1_object_info(oid
->hash
, NULL
);
371 if (type
== OBJ_COMMIT
) {
372 struct commit
*commit
= lookup_commit(oid
);
374 struct pretty_print_context pp
= {0};
375 pp
.date_mode
.type
= DATE_SHORT
;
376 format_commit_message(commit
, " %ad - %s", &desc
, &pp
);
378 } else if (type
== OBJ_TAG
) {
379 struct tag
*tag
= lookup_tag(oid
);
380 if (!parse_tag(tag
) && tag
->tag
)
381 strbuf_addf(&desc
, " %s", tag
->tag
);
385 find_unique_abbrev(oid
->hash
, DEFAULT_ABBREV
),
386 typename(type
) ? typename(type
) : "unknown type",
389 strbuf_release(&desc
);
393 static int get_short_oid(const char *name
, int len
, struct object_id
*oid
,
397 struct disambiguate_state ds
;
398 int quietly
= !!(flags
& GET_OID_QUIETLY
);
400 if (init_object_disambiguation(name
, len
, &ds
) < 0)
403 if (HAS_MULTI_BITS(flags
& GET_OID_DISAMBIGUATORS
))
404 die("BUG: multiple get_short_oid disambiguator flags");
406 if (flags
& GET_OID_COMMIT
)
407 ds
.fn
= disambiguate_commit_only
;
408 else if (flags
& GET_OID_COMMITTISH
)
409 ds
.fn
= disambiguate_committish_only
;
410 else if (flags
& GET_OID_TREE
)
411 ds
.fn
= disambiguate_tree_only
;
412 else if (flags
& GET_OID_TREEISH
)
413 ds
.fn
= disambiguate_treeish_only
;
414 else if (flags
& GET_OID_BLOB
)
415 ds
.fn
= disambiguate_blob_only
;
417 ds
.fn
= default_disambiguate_hint
;
419 find_short_object_filename(&ds
);
420 find_short_packed_object(&ds
);
421 status
= finish_object_disambiguation(&ds
, oid
);
423 if (!quietly
&& (status
== SHORT_NAME_AMBIGUOUS
)) {
424 error(_("short SHA1 %s is ambiguous"), ds
.hex_pfx
);
427 * We may still have ambiguity if we simply saw a series of
428 * candidates that did not satisfy our hint function. In
429 * that case, we still want to show them, so disable the hint
435 advise(_("The candidates are:"));
436 for_each_abbrev(ds
.hex_pfx
, show_ambiguous_object
, &ds
);
442 static int collect_ambiguous(const struct object_id
*oid
, void *data
)
444 oid_array_append(data
, oid
);
448 int for_each_abbrev(const char *prefix
, each_abbrev_fn fn
, void *cb_data
)
450 struct oid_array collect
= OID_ARRAY_INIT
;
451 struct disambiguate_state ds
;
454 if (init_object_disambiguation(prefix
, strlen(prefix
), &ds
) < 0)
457 ds
.always_call_fn
= 1;
458 ds
.fn
= collect_ambiguous
;
459 ds
.cb_data
= &collect
;
460 find_short_object_filename(&ds
);
461 find_short_packed_object(&ds
);
463 ret
= oid_array_for_each_unique(&collect
, fn
, cb_data
);
464 oid_array_clear(&collect
);
469 * Return the slot of the most-significant bit set in "val". There are various
470 * ways to do this quickly with fls() or __builtin_clzl(), but speed is
471 * probably not a big deal here.
473 static unsigned msb(unsigned long val
)
481 struct min_abbrev_data
{
482 unsigned int init_len
;
483 unsigned int cur_len
;
485 const unsigned char *hash
;
488 static inline char get_hex_char_from_oid(const struct object_id
*oid
,
491 static const char hex
[] = "0123456789abcdef";
494 return hex
[oid
->hash
[pos
>> 1] >> 4];
496 return hex
[oid
->hash
[pos
>> 1] & 0xf];
499 static int extend_abbrev_len(const struct object_id
*oid
, void *cb_data
)
501 struct min_abbrev_data
*mad
= cb_data
;
503 unsigned int i
= mad
->init_len
;
504 while (mad
->hex
[i
] && mad
->hex
[i
] == get_hex_char_from_oid(oid
, i
))
507 if (i
< GIT_MAX_RAWSZ
&& i
>= mad
->cur_len
)
508 mad
->cur_len
= i
+ 1;
513 static void find_abbrev_len_for_pack(struct packed_git
*p
,
514 struct min_abbrev_data
*mad
)
517 uint32_t num
, last
, first
= 0;
518 struct object_id oid
;
520 if (open_pack_index(p
) || !p
->num_objects
)
523 num
= p
->num_objects
;
525 while (first
< last
) {
526 uint32_t mid
= first
+ (last
- first
) / 2;
527 const unsigned char *current
;
530 current
= nth_packed_object_sha1(p
, mid
);
531 cmp
= hashcmp(mad
->hash
, current
);
545 * first is now the position in the packfile where we would insert
546 * mad->hash if it does not exist (or the position of mad->hash if
547 * it does exist). Hence, we consider a maximum of three objects
548 * nearby for the abbreviation length.
552 nth_packed_object_oid(&oid
, p
, first
);
553 extend_abbrev_len(&oid
, mad
);
554 } else if (first
< num
- 1) {
555 nth_packed_object_oid(&oid
, p
, first
+ 1);
556 extend_abbrev_len(&oid
, mad
);
559 nth_packed_object_oid(&oid
, p
, first
- 1);
560 extend_abbrev_len(&oid
, mad
);
562 mad
->init_len
= mad
->cur_len
;
565 static void find_abbrev_len_packed(struct min_abbrev_data
*mad
)
567 struct packed_git
*p
;
569 for (p
= get_packed_git(the_repository
); p
; p
= p
->next
)
570 find_abbrev_len_for_pack(p
, mad
);
573 int find_unique_abbrev_r(char *hex
, const unsigned char *sha1
, int len
)
575 struct disambiguate_state ds
;
576 struct min_abbrev_data mad
;
577 struct object_id oid_ret
;
579 unsigned long count
= approximate_object_count();
581 * Add one because the MSB only tells us the highest bit set,
582 * not including the value of all the _other_ bits (so "15"
583 * is only one off of 2^4, but the MSB is the 3rd bit.
585 len
= msb(count
) + 1;
587 * We now know we have on the order of 2^len objects, which
588 * expects a collision at 2^(len/2). But we also care about hex
589 * chars, not bits, and there are 4 bits per hex. So all
590 * together we need to divide by 2 and round up.
592 len
= DIV_ROUND_UP(len
, 2);
594 * For very small repos, we stick with our regular fallback.
596 if (len
< FALLBACK_DEFAULT_ABBREV
)
597 len
= FALLBACK_DEFAULT_ABBREV
;
600 sha1_to_hex_r(hex
, sha1
);
601 if (len
== GIT_SHA1_HEXSZ
|| !len
)
602 return GIT_SHA1_HEXSZ
;
609 find_abbrev_len_packed(&mad
);
611 if (init_object_disambiguation(hex
, mad
.cur_len
, &ds
) < 0)
614 ds
.fn
= extend_abbrev_len
;
615 ds
.always_call_fn
= 1;
616 ds
.cb_data
= (void *)&mad
;
618 find_short_object_filename(&ds
);
619 (void)finish_object_disambiguation(&ds
, &oid_ret
);
621 hex
[mad
.cur_len
] = 0;
625 const char *find_unique_abbrev(const unsigned char *sha1
, int len
)
628 static char hexbuffer
[4][GIT_MAX_HEXSZ
+ 1];
629 char *hex
= hexbuffer
[bufno
];
630 bufno
= (bufno
+ 1) % ARRAY_SIZE(hexbuffer
);
631 find_unique_abbrev_r(hex
, sha1
, len
);
635 static int ambiguous_path(const char *path
, int len
)
640 for (cnt
= 0; cnt
< len
; cnt
++) {
660 static inline int at_mark(const char *string
, int len
,
661 const char **suffix
, int nr
)
665 for (i
= 0; i
< nr
; i
++) {
666 int suffix_len
= strlen(suffix
[i
]);
667 if (suffix_len
<= len
668 && !strncasecmp(string
, suffix
[i
], suffix_len
))
674 static inline int upstream_mark(const char *string
, int len
)
676 const char *suffix
[] = { "@{upstream}", "@{u}" };
677 return at_mark(string
, len
, suffix
, ARRAY_SIZE(suffix
));
680 static inline int push_mark(const char *string
, int len
)
682 const char *suffix
[] = { "@{push}" };
683 return at_mark(string
, len
, suffix
, ARRAY_SIZE(suffix
));
686 static int get_oid_1(const char *name
, int len
, struct object_id
*oid
, unsigned lookup_flags
);
687 static int interpret_nth_prior_checkout(const char *name
, int namelen
, struct strbuf
*buf
);
689 static int get_oid_basic(const char *str
, int len
, struct object_id
*oid
,
692 static const char *warn_msg
= "refname '%.*s' is ambiguous.";
693 static const char *object_name_msg
= N_(
694 "Git normally never creates a ref that ends with 40 hex characters\n"
695 "because it will be ignored when you just specify 40-hex. These refs\n"
696 "may be created by mistake. For example,\n"
698 " git checkout -b $br $(git rev-parse ...)\n"
700 "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
701 "examine these refs and maybe delete them. Turn this message off by\n"
702 "running \"git config advice.objectNameWarning false\"");
703 struct object_id tmp_oid
;
704 char *real_ref
= NULL
;
706 int at
, reflog_len
, nth_prior
= 0;
708 if (len
== GIT_SHA1_HEXSZ
&& !get_oid_hex(str
, oid
)) {
709 if (warn_ambiguous_refs
&& warn_on_object_refname_ambiguity
) {
710 refs_found
= dwim_ref(str
, len
, &tmp_oid
, &real_ref
);
711 if (refs_found
> 0) {
712 warning(warn_msg
, len
, str
);
713 if (advice_object_name_warning
)
714 fprintf(stderr
, "%s\n", _(object_name_msg
));
721 /* basic@{time or number or -number} format to query ref-log */
723 if (len
&& str
[len
-1] == '}') {
724 for (at
= len
-4; at
>= 0; at
--) {
725 if (str
[at
] == '@' && str
[at
+1] == '{') {
726 if (str
[at
+2] == '-') {
728 /* @{-N} not at start */
733 if (!upstream_mark(str
+ at
, len
- at
) &&
734 !push_mark(str
+ at
, len
- at
)) {
735 reflog_len
= (len
-1) - (at
+2);
743 /* Accept only unambiguous ref paths. */
744 if (len
&& ambiguous_path(str
, len
))
748 struct strbuf buf
= STRBUF_INIT
;
751 if (interpret_nth_prior_checkout(str
, len
, &buf
) > 0) {
752 detached
= (buf
.len
== GIT_SHA1_HEXSZ
&& !get_oid_hex(buf
.buf
, oid
));
753 strbuf_release(&buf
);
759 if (!len
&& reflog_len
)
760 /* allow "@{...}" to mean the current branch reflog */
761 refs_found
= dwim_ref("HEAD", 4, oid
, &real_ref
);
763 refs_found
= dwim_log(str
, len
, oid
, &real_ref
);
765 refs_found
= dwim_ref(str
, len
, oid
, &real_ref
);
770 if (warn_ambiguous_refs
&& !(flags
& GET_OID_QUIETLY
) &&
772 !get_short_oid(str
, len
, &tmp_oid
, GET_OID_QUIETLY
)))
773 warning(warn_msg
, len
, str
);
781 /* Is it asking for N-th entry, or approxidate? */
782 for (i
= nth
= 0; 0 <= nth
&& i
< reflog_len
; i
++) {
783 char ch
= str
[at
+2+i
];
784 if ('0' <= ch
&& ch
<= '9')
785 nth
= nth
* 10 + ch
- '0';
789 if (100000000 <= nth
) {
796 char *tmp
= xstrndup(str
+ at
+ 2, reflog_len
);
797 at_time
= approxidate_careful(tmp
, &errors
);
804 if (read_ref_at(real_ref
, flags
, at_time
, nth
, oid
, NULL
,
805 &co_time
, &co_tz
, &co_cnt
)) {
807 if (starts_with(real_ref
, "refs/heads/")) {
809 len
= strlen(real_ref
+ 11);
817 if (!(flags
& GET_OID_QUIETLY
)) {
818 warning("Log for '%.*s' only goes "
819 "back to %s.", len
, str
,
820 show_date(co_time
, co_tz
, DATE_MODE(RFC2822
)));
823 if (flags
& GET_OID_QUIETLY
) {
826 die("Log for '%.*s' only has %d entries.",
836 static int get_parent(const char *name
, int len
,
837 struct object_id
*result
, int idx
)
839 struct object_id oid
;
840 int ret
= get_oid_1(name
, len
, &oid
, GET_OID_COMMITTISH
);
841 struct commit
*commit
;
842 struct commit_list
*p
;
846 commit
= lookup_commit_reference(&oid
);
847 if (parse_commit(commit
))
850 oidcpy(result
, &commit
->object
.oid
);
856 oidcpy(result
, &p
->item
->object
.oid
);
864 static int get_nth_ancestor(const char *name
, int len
,
865 struct object_id
*result
, int generation
)
867 struct object_id oid
;
868 struct commit
*commit
;
871 ret
= get_oid_1(name
, len
, &oid
, GET_OID_COMMITTISH
);
874 commit
= lookup_commit_reference(&oid
);
878 while (generation
--) {
879 if (parse_commit(commit
) || !commit
->parents
)
881 commit
= commit
->parents
->item
;
883 oidcpy(result
, &commit
->object
.oid
);
887 struct object
*peel_to_type(const char *name
, int namelen
,
888 struct object
*o
, enum object_type expected_type
)
890 if (name
&& !namelen
)
891 namelen
= strlen(name
);
893 if (!o
|| (!o
->parsed
&& !parse_object(&o
->oid
)))
895 if (expected_type
== OBJ_ANY
|| o
->type
== expected_type
)
897 if (o
->type
== OBJ_TAG
)
898 o
= ((struct tag
*) o
)->tagged
;
899 else if (o
->type
== OBJ_COMMIT
)
900 o
= &(((struct commit
*) o
)->tree
->object
);
903 error("%.*s: expected %s type, but the object "
904 "dereferences to %s type",
905 namelen
, name
, typename(expected_type
),
912 static int peel_onion(const char *name
, int len
, struct object_id
*oid
,
913 unsigned lookup_flags
)
915 struct object_id outer
;
917 unsigned int expected_type
= 0;
921 * "ref^{type}" dereferences ref repeatedly until you cannot
922 * dereference anymore, or you get an object of given type,
923 * whichever comes first. "ref^{}" means just dereference
924 * tags until you get a non-tag. "ref^0" is a shorthand for
925 * "ref^{commit}". "commit^{tree}" could be used to find the
926 * top-level tree of the given commit.
928 if (len
< 4 || name
[len
-1] != '}')
931 for (sp
= name
+ len
- 1; name
<= sp
; sp
--) {
933 if (ch
== '{' && name
< sp
&& sp
[-1] == '^')
939 sp
++; /* beginning of type name, or closing brace for empty */
940 if (starts_with(sp
, "commit}"))
941 expected_type
= OBJ_COMMIT
;
942 else if (starts_with(sp
, "tag}"))
943 expected_type
= OBJ_TAG
;
944 else if (starts_with(sp
, "tree}"))
945 expected_type
= OBJ_TREE
;
946 else if (starts_with(sp
, "blob}"))
947 expected_type
= OBJ_BLOB
;
948 else if (starts_with(sp
, "object}"))
949 expected_type
= OBJ_ANY
;
950 else if (sp
[0] == '}')
951 expected_type
= OBJ_NONE
;
952 else if (sp
[0] == '/')
953 expected_type
= OBJ_COMMIT
;
957 lookup_flags
&= ~GET_OID_DISAMBIGUATORS
;
958 if (expected_type
== OBJ_COMMIT
)
959 lookup_flags
|= GET_OID_COMMITTISH
;
960 else if (expected_type
== OBJ_TREE
)
961 lookup_flags
|= GET_OID_TREEISH
;
963 if (get_oid_1(name
, sp
- name
- 2, &outer
, lookup_flags
))
966 o
= parse_object(&outer
);
969 if (!expected_type
) {
970 o
= deref_tag(o
, name
, sp
- name
- 2);
971 if (!o
|| (!o
->parsed
&& !parse_object(&o
->oid
)))
973 oidcpy(oid
, &o
->oid
);
978 * At this point, the syntax look correct, so
979 * if we do not get the needed object, we should
982 o
= peel_to_type(name
, len
, o
, expected_type
);
986 oidcpy(oid
, &o
->oid
);
988 /* "$commit^{/foo}" */
991 struct commit_list
*list
= NULL
;
994 * $commit^{/}. Some regex implementation may reject.
995 * We don't need regex anyway. '' pattern always matches.
1000 prefix
= xstrndup(sp
+ 1, name
+ len
- 1 - (sp
+ 1));
1001 commit_list_insert((struct commit
*)o
, &list
);
1002 ret
= get_oid_oneline(prefix
, oid
, list
);
1009 static int get_describe_name(const char *name
, int len
, struct object_id
*oid
)
1012 unsigned flags
= GET_OID_QUIETLY
| GET_OID_COMMIT
;
1014 for (cp
= name
+ len
- 1; name
+ 2 <= cp
; cp
--) {
1016 if (!isxdigit(ch
)) {
1017 /* We must be looking at g in "SOMETHING-g"
1018 * for it to be describe output.
1020 if (ch
== 'g' && cp
[-1] == '-') {
1023 return get_short_oid(cp
, len
, oid
, flags
);
1030 static int get_oid_1(const char *name
, int len
, struct object_id
*oid
, unsigned lookup_flags
)
1032 int ret
, has_suffix
;
1036 * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
1039 for (cp
= name
+ len
- 1; name
<= cp
; cp
--) {
1041 if ('0' <= ch
&& ch
<= '9')
1043 if (ch
== '~' || ch
== '^')
1050 int len1
= cp
- name
;
1052 while (cp
< name
+ len
)
1053 num
= num
* 10 + *cp
++ - '0';
1054 if (!num
&& len1
== len
- 1)
1056 if (has_suffix
== '^')
1057 return get_parent(name
, len1
, oid
, num
);
1058 /* else if (has_suffix == '~') -- goes without saying */
1059 return get_nth_ancestor(name
, len1
, oid
, num
);
1062 ret
= peel_onion(name
, len
, oid
, lookup_flags
);
1066 ret
= get_oid_basic(name
, len
, oid
, lookup_flags
);
1070 /* It could be describe output that is "SOMETHING-gXXXX" */
1071 ret
= get_describe_name(name
, len
, oid
);
1075 return get_short_oid(name
, len
, oid
, lookup_flags
);
1079 * This interprets names like ':/Initial revision of "git"' by searching
1080 * through history and returning the first commit whose message starts
1081 * the given regular expression.
1083 * For negative-matching, prefix the pattern-part with '!-', like: ':/!-WIP'.
1085 * For a literal '!' character at the beginning of a pattern, you have to repeat
1086 * that, like: ':/!!foo'
1088 * For future extension, all other sequences beginning with ':/!' are reserved.
1091 /* Remember to update object flag allocation in object.h */
1092 #define ONELINE_SEEN (1u<<20)
1094 static int handle_one_ref(const char *path
, const struct object_id
*oid
,
1095 int flag
, void *cb_data
)
1097 struct commit_list
**list
= cb_data
;
1098 struct object
*object
= parse_object(oid
);
1101 if (object
->type
== OBJ_TAG
) {
1102 object
= deref_tag(object
, path
, strlen(path
));
1106 if (object
->type
!= OBJ_COMMIT
)
1108 commit_list_insert((struct commit
*)object
, list
);
1112 static int get_oid_oneline(const char *prefix
, struct object_id
*oid
,
1113 struct commit_list
*list
)
1115 struct commit_list
*backup
= NULL
, *l
;
1120 if (prefix
[0] == '!') {
1123 if (prefix
[0] == '-') {
1126 } else if (prefix
[0] != '!') {
1131 if (regcomp(®ex
, prefix
, REG_EXTENDED
))
1134 for (l
= list
; l
; l
= l
->next
) {
1135 l
->item
->object
.flags
|= ONELINE_SEEN
;
1136 commit_list_insert(l
->item
, &backup
);
1139 const char *p
, *buf
;
1140 struct commit
*commit
;
1143 commit
= pop_most_recent_commit(&list
, ONELINE_SEEN
);
1144 if (!parse_object(&commit
->object
.oid
))
1146 buf
= get_commit_buffer(commit
, NULL
);
1147 p
= strstr(buf
, "\n\n");
1148 matches
= negative
^ (p
&& !regexec(®ex
, p
+ 2, 0, NULL
, 0));
1149 unuse_commit_buffer(commit
, buf
);
1152 oidcpy(oid
, &commit
->object
.oid
);
1158 free_commit_list(list
);
1159 for (l
= backup
; l
; l
= l
->next
)
1160 clear_commit_marks(l
->item
, ONELINE_SEEN
);
1161 free_commit_list(backup
);
1162 return found
? 0 : -1;
1165 struct grab_nth_branch_switch_cbdata
{
1170 static int grab_nth_branch_switch(struct object_id
*ooid
, struct object_id
*noid
,
1171 const char *email
, timestamp_t timestamp
, int tz
,
1172 const char *message
, void *cb_data
)
1174 struct grab_nth_branch_switch_cbdata
*cb
= cb_data
;
1175 const char *match
= NULL
, *target
= NULL
;
1178 if (skip_prefix(message
, "checkout: moving from ", &match
))
1179 target
= strstr(match
, " to ");
1181 if (!match
|| !target
)
1183 if (--(cb
->remaining
) == 0) {
1184 len
= target
- match
;
1185 strbuf_reset(&cb
->buf
);
1186 strbuf_add(&cb
->buf
, match
, len
);
1187 return 1; /* we are done */
1193 * Parse @{-N} syntax, return the number of characters parsed
1194 * if successful; otherwise signal an error with negative value.
1196 static int interpret_nth_prior_checkout(const char *name
, int namelen
,
1201 struct grab_nth_branch_switch_cbdata cb
;
1207 if (name
[0] != '@' || name
[1] != '{' || name
[2] != '-')
1209 brace
= memchr(name
, '}', namelen
);
1212 nth
= strtol(name
+ 3, &num_end
, 10);
1213 if (num_end
!= brace
)
1218 strbuf_init(&cb
.buf
, 20);
1221 if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch
, &cb
)) {
1223 strbuf_addbuf(buf
, &cb
.buf
);
1224 retval
= brace
- name
+ 1;
1227 strbuf_release(&cb
.buf
);
1231 int get_oid_mb(const char *name
, struct object_id
*oid
)
1233 struct commit
*one
, *two
;
1234 struct commit_list
*mbs
;
1235 struct object_id oid_tmp
;
1239 dots
= strstr(name
, "...");
1241 return get_oid(name
, oid
);
1243 st
= get_oid("HEAD", &oid_tmp
);
1246 strbuf_init(&sb
, dots
- name
);
1247 strbuf_add(&sb
, name
, dots
- name
);
1248 st
= get_oid_committish(sb
.buf
, &oid_tmp
);
1249 strbuf_release(&sb
);
1253 one
= lookup_commit_reference_gently(&oid_tmp
, 0);
1257 if (get_oid_committish(dots
[3] ? (dots
+ 3) : "HEAD", &oid_tmp
))
1259 two
= lookup_commit_reference_gently(&oid_tmp
, 0);
1262 mbs
= get_merge_bases(one
, two
);
1263 if (!mbs
|| mbs
->next
)
1267 oidcpy(oid
, &mbs
->item
->object
.oid
);
1269 free_commit_list(mbs
);
1273 /* parse @something syntax, when 'something' is not {.*} */
1274 static int interpret_empty_at(const char *name
, int namelen
, int len
, struct strbuf
*buf
)
1278 if (len
|| name
[1] == '{')
1281 /* make sure it's a single @, or @@{.*}, not @foo */
1282 next
= memchr(name
+ len
+ 1, '@', namelen
- len
- 1);
1283 if (next
&& next
[1] != '{')
1286 next
= name
+ namelen
;
1287 if (next
!= name
+ 1)
1291 strbuf_add(buf
, "HEAD", 4);
1295 static int reinterpret(const char *name
, int namelen
, int len
,
1296 struct strbuf
*buf
, unsigned allowed
)
1298 /* we have extra data, which might need further processing */
1299 struct strbuf tmp
= STRBUF_INIT
;
1300 int used
= buf
->len
;
1303 strbuf_add(buf
, name
+ len
, namelen
- len
);
1304 ret
= interpret_branch_name(buf
->buf
, buf
->len
, &tmp
, allowed
);
1305 /* that data was not interpreted, remove our cruft */
1307 strbuf_setlen(buf
, used
);
1311 strbuf_addbuf(buf
, &tmp
);
1312 strbuf_release(&tmp
);
1313 /* tweak for size of {-N} versus expanded ref name */
1314 return ret
- used
+ len
;
1317 static void set_shortened_ref(struct strbuf
*buf
, const char *ref
)
1319 char *s
= shorten_unambiguous_ref(ref
, 0);
1321 strbuf_addstr(buf
, s
);
1325 static int branch_interpret_allowed(const char *refname
, unsigned allowed
)
1330 if ((allowed
& INTERPRET_BRANCH_LOCAL
) &&
1331 starts_with(refname
, "refs/heads/"))
1333 if ((allowed
& INTERPRET_BRANCH_REMOTE
) &&
1334 starts_with(refname
, "refs/remotes/"))
1340 static int interpret_branch_mark(const char *name
, int namelen
,
1341 int at
, struct strbuf
*buf
,
1342 int (*get_mark
)(const char *, int),
1343 const char *(*get_data
)(struct branch
*,
1348 struct branch
*branch
;
1349 struct strbuf err
= STRBUF_INIT
;
1352 len
= get_mark(name
+ at
, namelen
- at
);
1356 if (memchr(name
, ':', at
))
1360 char *name_str
= xmemdupz(name
, at
);
1361 branch
= branch_get(name_str
);
1364 branch
= branch_get(NULL
);
1366 value
= get_data(branch
, &err
);
1370 if (!branch_interpret_allowed(value
, allowed
))
1373 set_shortened_ref(buf
, value
);
1377 int interpret_branch_name(const char *name
, int namelen
, struct strbuf
*buf
,
1385 namelen
= strlen(name
);
1387 if (!allowed
|| (allowed
& INTERPRET_BRANCH_LOCAL
)) {
1388 len
= interpret_nth_prior_checkout(name
, namelen
, buf
);
1390 return len
; /* syntax Ok, not enough switches */
1391 } else if (len
> 0) {
1393 return len
; /* consumed all */
1395 return reinterpret(name
, namelen
, len
, buf
, allowed
);
1400 (at
= memchr(start
, '@', namelen
- (start
- name
)));
1403 if (!allowed
|| (allowed
& INTERPRET_BRANCH_HEAD
)) {
1404 len
= interpret_empty_at(name
, namelen
, at
- name
, buf
);
1406 return reinterpret(name
, namelen
, len
, buf
,
1410 len
= interpret_branch_mark(name
, namelen
, at
- name
, buf
,
1411 upstream_mark
, branch_get_upstream
,
1416 len
= interpret_branch_mark(name
, namelen
, at
- name
, buf
,
1417 push_mark
, branch_get_push
,
1426 void strbuf_branchname(struct strbuf
*sb
, const char *name
, unsigned allowed
)
1428 int len
= strlen(name
);
1429 int used
= interpret_branch_name(name
, len
, sb
, allowed
);
1433 strbuf_add(sb
, name
+ used
, len
- used
);
1436 int strbuf_check_branch_ref(struct strbuf
*sb
, const char *name
)
1438 if (startup_info
->have_repository
)
1439 strbuf_branchname(sb
, name
, INTERPRET_BRANCH_LOCAL
);
1441 strbuf_addstr(sb
, name
);
1444 * This splice must be done even if we end up rejecting the
1445 * name; builtin/branch.c::copy_or_rename_branch() still wants
1446 * to see what the name expanded to so that "branch -m" can be
1447 * used as a tool to correct earlier mistakes.
1449 strbuf_splice(sb
, 0, 0, "refs/heads/", 11);
1452 !strcmp(sb
->buf
, "refs/heads/HEAD"))
1455 return check_refname_format(sb
->buf
, 0);
1459 * This is like "get_oid_basic()", except it allows "object ID expressions",
1460 * notably "xyz^" for "parent of xyz"
1462 int get_oid(const char *name
, struct object_id
*oid
)
1464 struct object_context unused
;
1465 return get_oid_with_context(name
, 0, oid
, &unused
);
1470 * Many callers know that the user meant to name a commit-ish by
1471 * syntactical positions where the object name appears. Calling this
1472 * function allows the machinery to disambiguate shorter-than-unique
1473 * abbreviated object names between commit-ish and others.
1475 * Note that this does NOT error out when the named object is not a
1476 * commit-ish. It is merely to give a hint to the disambiguation
1479 int get_oid_committish(const char *name
, struct object_id
*oid
)
1481 struct object_context unused
;
1482 return get_oid_with_context(name
, GET_OID_COMMITTISH
,
1486 int get_oid_treeish(const char *name
, struct object_id
*oid
)
1488 struct object_context unused
;
1489 return get_oid_with_context(name
, GET_OID_TREEISH
,
1493 int get_oid_commit(const char *name
, struct object_id
*oid
)
1495 struct object_context unused
;
1496 return get_oid_with_context(name
, GET_OID_COMMIT
,
1500 int get_oid_tree(const char *name
, struct object_id
*oid
)
1502 struct object_context unused
;
1503 return get_oid_with_context(name
, GET_OID_TREE
,
1507 int get_oid_blob(const char *name
, struct object_id
*oid
)
1509 struct object_context unused
;
1510 return get_oid_with_context(name
, GET_OID_BLOB
,
1514 /* Must be called only when object_name:filename doesn't exist. */
1515 static void diagnose_invalid_oid_path(const char *prefix
,
1516 const char *filename
,
1517 const struct object_id
*tree_oid
,
1518 const char *object_name
,
1519 int object_name_len
)
1521 struct object_id oid
;
1527 if (file_exists(filename
))
1528 die("Path '%s' exists on disk, but not in '%.*s'.",
1529 filename
, object_name_len
, object_name
);
1530 if (is_missing_file_error(errno
)) {
1531 char *fullname
= xstrfmt("%s%s", prefix
, filename
);
1533 if (!get_tree_entry(tree_oid
->hash
, fullname
,
1535 die("Path '%s' exists, but not '%s'.\n"
1536 "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1539 object_name_len
, object_name
,
1541 object_name_len
, object_name
,
1544 die("Path '%s' does not exist in '%.*s'",
1545 filename
, object_name_len
, object_name
);
1549 /* Must be called only when :stage:filename doesn't exist. */
1550 static void diagnose_invalid_index_path(int stage
,
1552 const char *filename
)
1554 const struct cache_entry
*ce
;
1556 unsigned namelen
= strlen(filename
);
1557 struct strbuf fullname
= STRBUF_INIT
;
1562 /* Wrong stage number? */
1563 pos
= cache_name_pos(filename
, namelen
);
1566 if (pos
< active_nr
) {
1567 ce
= active_cache
[pos
];
1568 if (ce_namelen(ce
) == namelen
&&
1569 !memcmp(ce
->name
, filename
, namelen
))
1570 die("Path '%s' is in the index, but not at stage %d.\n"
1571 "Did you mean ':%d:%s'?",
1573 ce_stage(ce
), filename
);
1576 /* Confusion between relative and absolute filenames? */
1577 strbuf_addstr(&fullname
, prefix
);
1578 strbuf_addstr(&fullname
, filename
);
1579 pos
= cache_name_pos(fullname
.buf
, fullname
.len
);
1582 if (pos
< active_nr
) {
1583 ce
= active_cache
[pos
];
1584 if (ce_namelen(ce
) == fullname
.len
&&
1585 !memcmp(ce
->name
, fullname
.buf
, fullname
.len
))
1586 die("Path '%s' is in the index, but not '%s'.\n"
1587 "Did you mean ':%d:%s' aka ':%d:./%s'?",
1588 fullname
.buf
, filename
,
1589 ce_stage(ce
), fullname
.buf
,
1590 ce_stage(ce
), filename
);
1593 if (file_exists(filename
))
1594 die("Path '%s' exists on disk, but not in the index.", filename
);
1595 if (is_missing_file_error(errno
))
1596 die("Path '%s' does not exist (neither on disk nor in the index).",
1599 strbuf_release(&fullname
);
1603 static char *resolve_relative_path(const char *rel
)
1605 if (!starts_with(rel
, "./") && !starts_with(rel
, "../"))
1608 if (!is_inside_work_tree())
1609 die("relative path syntax can't be used outside working tree.");
1611 /* die() inside prefix_path() if resolved path is outside worktree */
1612 return prefix_path(startup_info
->prefix
,
1613 startup_info
->prefix
? strlen(startup_info
->prefix
) : 0,
1617 static int get_oid_with_context_1(const char *name
,
1620 struct object_id
*oid
,
1621 struct object_context
*oc
)
1623 int ret
, bracket_depth
;
1624 int namelen
= strlen(name
);
1626 int only_to_die
= flags
& GET_OID_ONLY_TO_DIE
;
1629 flags
|= GET_OID_QUIETLY
;
1631 memset(oc
, 0, sizeof(*oc
));
1632 oc
->mode
= S_IFINVALID
;
1633 strbuf_init(&oc
->symlink_path
, 0);
1634 ret
= get_oid_1(name
, namelen
, oid
, flags
);
1638 * sha1:path --> object name of path in ent sha1
1639 * :path -> object name of absolute path in index
1640 * :./path -> object name of path relative to cwd in index
1641 * :[0-3]:path -> object name of path in index at stage
1642 * :/foo -> recent commit matching foo
1644 if (name
[0] == ':') {
1646 const struct cache_entry
*ce
;
1647 char *new_path
= NULL
;
1649 if (!only_to_die
&& namelen
> 2 && name
[1] == '/') {
1650 struct commit_list
*list
= NULL
;
1652 for_each_ref(handle_one_ref
, &list
);
1653 commit_list_sort_by_date(&list
);
1654 return get_oid_oneline(name
+ 2, oid
, list
);
1658 name
[1] < '0' || '3' < name
[1])
1661 stage
= name
[1] - '0';
1664 new_path
= resolve_relative_path(cp
);
1666 namelen
= namelen
- (cp
- name
);
1669 namelen
= strlen(cp
);
1672 if (flags
& GET_OID_RECORD_PATH
)
1673 oc
->path
= xstrdup(cp
);
1677 pos
= cache_name_pos(cp
, namelen
);
1680 while (pos
< active_nr
) {
1681 ce
= active_cache
[pos
];
1682 if (ce_namelen(ce
) != namelen
||
1683 memcmp(ce
->name
, cp
, namelen
))
1685 if (ce_stage(ce
) == stage
) {
1686 oidcpy(oid
, &ce
->oid
);
1687 oc
->mode
= ce
->ce_mode
;
1693 if (only_to_die
&& name
[1] && name
[1] != '/')
1694 diagnose_invalid_index_path(stage
, prefix
, cp
);
1698 for (cp
= name
, bracket_depth
= 0; *cp
; cp
++) {
1701 else if (bracket_depth
&& *cp
== '}')
1703 else if (!bracket_depth
&& *cp
== ':')
1707 struct object_id tree_oid
;
1708 int len
= cp
- name
;
1709 unsigned sub_flags
= flags
;
1711 sub_flags
&= ~GET_OID_DISAMBIGUATORS
;
1712 sub_flags
|= GET_OID_TREEISH
;
1714 if (!get_oid_1(name
, len
, &tree_oid
, sub_flags
)) {
1715 const char *filename
= cp
+1;
1716 char *new_filename
= NULL
;
1718 new_filename
= resolve_relative_path(filename
);
1720 filename
= new_filename
;
1721 if (flags
& GET_OID_FOLLOW_SYMLINKS
) {
1722 ret
= get_tree_entry_follow_symlinks(tree_oid
.hash
,
1723 filename
, oid
->hash
, &oc
->symlink_path
,
1726 ret
= get_tree_entry(tree_oid
.hash
, filename
,
1727 oid
->hash
, &oc
->mode
);
1728 if (ret
&& only_to_die
) {
1729 diagnose_invalid_oid_path(prefix
,
1735 hashcpy(oc
->tree
, tree_oid
.hash
);
1736 if (flags
& GET_OID_RECORD_PATH
)
1737 oc
->path
= xstrdup(filename
);
1743 die("Invalid object name '%.*s'.", len
, name
);
1750 * Call this function when you know "name" given by the end user must
1751 * name an object but it doesn't; the function _may_ die with a better
1752 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1753 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1754 * you have a chance to diagnose the error further.
1756 void maybe_die_on_misspelt_object_name(const char *name
, const char *prefix
)
1758 struct object_context oc
;
1759 struct object_id oid
;
1760 get_oid_with_context_1(name
, GET_OID_ONLY_TO_DIE
, prefix
, &oid
, &oc
);
1763 int get_oid_with_context(const char *str
, unsigned flags
, struct object_id
*oid
, struct object_context
*oc
)
1765 if (flags
& GET_OID_FOLLOW_SYMLINKS
&& flags
& GET_OID_ONLY_TO_DIE
)
1766 die("BUG: incompatible flags for get_sha1_with_context");
1767 return get_oid_with_context_1(str
, flags
, NULL
, oid
, oc
);