4 #include "object-store.h"
5 #include "repository.h"
12 #include "reachable.h"
14 /* NEEDSWORK: switch to using parse_options */
15 static const char reflog_expire_usage
[] =
16 "git reflog expire [--expire=<time>] [--expire-unreachable=<time>] [--rewrite] [--updateref] [--stale-fix] [--dry-run | -n] [--verbose] [--all] <refs>...";
17 static const char reflog_delete_usage
[] =
18 "git reflog delete [--rewrite] [--updateref] [--dry-run | -n] [--verbose] <refs>...";
19 static const char reflog_exists_usage
[] =
20 "git reflog exists <ref>";
22 static timestamp_t default_reflog_expire
;
23 static timestamp_t default_reflog_expire_unreachable
;
25 struct cmd_reflog_expire_cb
{
28 timestamp_t expire_total
;
29 timestamp_t expire_unreachable
;
33 struct expire_reflog_policy_cb
{
38 } unreachable_expire_kind
;
39 struct commit_list
*mark_list
;
40 unsigned long mark_limit
;
41 struct cmd_reflog_expire_cb cmd
;
42 struct commit
*tip_commit
;
43 struct commit_list
*tips
;
46 struct collected_reflog
{
48 char reflog
[FLEX_ARRAY
];
51 struct collect_reflog_cb
{
52 struct collected_reflog
**e
;
57 /* Remember to update object flag allocation in object.h */
58 #define INCOMPLETE (1u<<10)
59 #define STUDYING (1u<<11)
60 #define REACHABLE (1u<<12)
62 static int tree_is_complete(const struct object_id
*oid
)
64 struct tree_desc desc
;
65 struct name_entry entry
;
69 tree
= lookup_tree(the_repository
, oid
);
72 if (tree
->object
.flags
& SEEN
)
74 if (tree
->object
.flags
& INCOMPLETE
)
78 enum object_type type
;
80 void *data
= read_object_file(oid
, &type
, &size
);
82 tree
->object
.flags
|= INCOMPLETE
;
88 init_tree_desc(&desc
, tree
->buffer
, tree
->size
);
90 while (tree_entry(&desc
, &entry
)) {
91 if (!has_sha1_file(entry
.oid
->hash
) ||
92 (S_ISDIR(entry
.mode
) && !tree_is_complete(entry
.oid
))) {
93 tree
->object
.flags
|= INCOMPLETE
;
97 free_tree_buffer(tree
);
100 tree
->object
.flags
|= SEEN
;
104 static int commit_is_complete(struct commit
*commit
)
106 struct object_array study
;
107 struct object_array found
;
108 int is_incomplete
= 0;
112 if (commit
->object
.flags
& SEEN
)
114 if (commit
->object
.flags
& INCOMPLETE
)
117 * Find all commits that are reachable and are not marked as
118 * SEEN. Then make sure the trees and blobs contained are
119 * complete. After that, mark these commits also as SEEN.
120 * If some of the objects that are needed to complete this
121 * commit are missing, mark this commit as INCOMPLETE.
123 memset(&study
, 0, sizeof(study
));
124 memset(&found
, 0, sizeof(found
));
125 add_object_array(&commit
->object
, NULL
, &study
);
126 add_object_array(&commit
->object
, NULL
, &found
);
127 commit
->object
.flags
|= STUDYING
;
130 struct commit_list
*parent
;
132 c
= (struct commit
*)object_array_pop(&study
);
133 if (!c
->object
.parsed
&& !parse_object(the_repository
, &c
->object
.oid
))
134 c
->object
.flags
|= INCOMPLETE
;
136 if (c
->object
.flags
& INCOMPLETE
) {
140 else if (c
->object
.flags
& SEEN
)
142 for (parent
= c
->parents
; parent
; parent
= parent
->next
) {
143 struct commit
*p
= parent
->item
;
144 if (p
->object
.flags
& STUDYING
)
146 p
->object
.flags
|= STUDYING
;
147 add_object_array(&p
->object
, NULL
, &study
);
148 add_object_array(&p
->object
, NULL
, &found
);
151 if (!is_incomplete
) {
153 * make sure all commits in "found" array have all the
156 for (i
= 0; i
< found
.nr
; i
++) {
158 (struct commit
*)found
.objects
[i
].item
;
159 if (!tree_is_complete(get_commit_tree_oid(c
))) {
161 c
->object
.flags
|= INCOMPLETE
;
164 if (!is_incomplete
) {
165 /* mark all found commits as complete, iow SEEN */
166 for (i
= 0; i
< found
.nr
; i
++)
167 found
.objects
[i
].item
->flags
|= SEEN
;
170 /* clear flags from the objects we traversed */
171 for (i
= 0; i
< found
.nr
; i
++)
172 found
.objects
[i
].item
->flags
&= ~STUDYING
;
174 commit
->object
.flags
|= INCOMPLETE
;
177 * If we come here, we have (1) traversed the ancestry chain
178 * from the "commit" until we reach SEEN commits (which are
179 * known to be complete), and (2) made sure that the commits
180 * encountered during the above traversal refer to trees that
181 * are complete. Which means that we know *all* the commits
182 * we have seen during this process are complete.
184 for (i
= 0; i
< found
.nr
; i
++)
185 found
.objects
[i
].item
->flags
|= SEEN
;
187 /* free object arrays */
188 object_array_clear(&study
);
189 object_array_clear(&found
);
190 return !is_incomplete
;
193 static int keep_entry(struct commit
**it
, struct object_id
*oid
)
195 struct commit
*commit
;
197 if (is_null_oid(oid
))
199 commit
= lookup_commit_reference_gently(the_repository
, oid
, 1);
204 * Make sure everything in this commit exists.
206 * We have walked all the objects reachable from the refs
207 * and cache earlier. The commits reachable by this commit
208 * must meet SEEN commits -- and then we should mark them as
211 if (!commit_is_complete(commit
))
218 * Starting from commits in the cb->mark_list, mark commits that are
219 * reachable from them. Stop the traversal at commits older than
220 * the expire_limit and queue them back, so that the caller can call
221 * us again to restart the traversal with longer expire_limit.
223 static void mark_reachable(struct expire_reflog_policy_cb
*cb
)
225 struct commit_list
*pending
;
226 timestamp_t expire_limit
= cb
->mark_limit
;
227 struct commit_list
*leftover
= NULL
;
229 for (pending
= cb
->mark_list
; pending
; pending
= pending
->next
)
230 pending
->item
->object
.flags
&= ~REACHABLE
;
232 pending
= cb
->mark_list
;
234 struct commit_list
*parent
;
235 struct commit
*commit
= pop_commit(&pending
);
236 if (commit
->object
.flags
& REACHABLE
)
238 if (parse_commit(commit
))
240 commit
->object
.flags
|= REACHABLE
;
241 if (commit
->date
< expire_limit
) {
242 commit_list_insert(commit
, &leftover
);
245 commit
->object
.flags
|= REACHABLE
;
246 parent
= commit
->parents
;
248 commit
= parent
->item
;
249 parent
= parent
->next
;
250 if (commit
->object
.flags
& REACHABLE
)
252 commit_list_insert(commit
, &pending
);
255 cb
->mark_list
= leftover
;
258 static int unreachable(struct expire_reflog_policy_cb
*cb
, struct commit
*commit
, struct object_id
*oid
)
261 * We may or may not have the commit yet - if not, look it
262 * up using the supplied sha1.
265 if (is_null_oid(oid
))
268 commit
= lookup_commit_reference_gently(the_repository
, oid
,
271 /* Not a commit -- keep it */
276 /* Reachable from the current ref? Don't prune. */
277 if (commit
->object
.flags
& REACHABLE
)
280 if (cb
->mark_list
&& cb
->mark_limit
) {
281 cb
->mark_limit
= 0; /* dig down to the root */
285 return !(commit
->object
.flags
& REACHABLE
);
289 * Return true iff the specified reflog entry should be expired.
291 static int should_expire_reflog_ent(struct object_id
*ooid
, struct object_id
*noid
,
292 const char *email
, timestamp_t timestamp
, int tz
,
293 const char *message
, void *cb_data
)
295 struct expire_reflog_policy_cb
*cb
= cb_data
;
296 struct commit
*old_commit
, *new_commit
;
298 if (timestamp
< cb
->cmd
.expire_total
)
301 old_commit
= new_commit
= NULL
;
302 if (cb
->cmd
.stalefix
&&
303 (!keep_entry(&old_commit
, ooid
) || !keep_entry(&new_commit
, noid
)))
306 if (timestamp
< cb
->cmd
.expire_unreachable
) {
307 if (cb
->unreachable_expire_kind
== UE_ALWAYS
)
309 if (unreachable(cb
, old_commit
, ooid
) || unreachable(cb
, new_commit
, noid
))
313 if (cb
->cmd
.recno
&& --(cb
->cmd
.recno
) == 0)
319 static int push_tip_to_list(const char *refname
, const struct object_id
*oid
,
320 int flags
, void *cb_data
)
322 struct commit_list
**list
= cb_data
;
323 struct commit
*tip_commit
;
324 if (flags
& REF_ISSYMREF
)
326 tip_commit
= lookup_commit_reference_gently(the_repository
, oid
, 1);
329 commit_list_insert(tip_commit
, list
);
333 static void reflog_expiry_prepare(const char *refname
,
334 const struct object_id
*oid
,
337 struct expire_reflog_policy_cb
*cb
= cb_data
;
339 if (!cb
->cmd
.expire_unreachable
|| !strcmp(refname
, "HEAD")) {
340 cb
->tip_commit
= NULL
;
341 cb
->unreachable_expire_kind
= UE_HEAD
;
343 cb
->tip_commit
= lookup_commit_reference_gently(the_repository
,
346 cb
->unreachable_expire_kind
= UE_ALWAYS
;
348 cb
->unreachable_expire_kind
= UE_NORMAL
;
351 if (cb
->cmd
.expire_unreachable
<= cb
->cmd
.expire_total
)
352 cb
->unreachable_expire_kind
= UE_ALWAYS
;
354 cb
->mark_list
= NULL
;
356 if (cb
->unreachable_expire_kind
!= UE_ALWAYS
) {
357 if (cb
->unreachable_expire_kind
== UE_HEAD
) {
358 struct commit_list
*elem
;
360 for_each_ref(push_tip_to_list
, &cb
->tips
);
361 for (elem
= cb
->tips
; elem
; elem
= elem
->next
)
362 commit_list_insert(elem
->item
, &cb
->mark_list
);
364 commit_list_insert(cb
->tip_commit
, &cb
->mark_list
);
366 cb
->mark_limit
= cb
->cmd
.expire_total
;
371 static void reflog_expiry_cleanup(void *cb_data
)
373 struct expire_reflog_policy_cb
*cb
= cb_data
;
375 if (cb
->unreachable_expire_kind
!= UE_ALWAYS
) {
376 if (cb
->unreachable_expire_kind
== UE_HEAD
) {
377 struct commit_list
*elem
;
378 for (elem
= cb
->tips
; elem
; elem
= elem
->next
)
379 clear_commit_marks(elem
->item
, REACHABLE
);
380 free_commit_list(cb
->tips
);
382 clear_commit_marks(cb
->tip_commit
, REACHABLE
);
387 static int collect_reflog(const char *ref
, const struct object_id
*oid
, int unused
, void *cb_data
)
389 struct collected_reflog
*e
;
390 struct collect_reflog_cb
*cb
= cb_data
;
392 FLEX_ALLOC_STR(e
, reflog
, ref
);
393 oidcpy(&e
->oid
, oid
);
394 ALLOC_GROW(cb
->e
, cb
->nr
+ 1, cb
->alloc
);
399 static struct reflog_expire_cfg
{
400 struct reflog_expire_cfg
*next
;
401 timestamp_t expire_total
;
402 timestamp_t expire_unreachable
;
403 char pattern
[FLEX_ARRAY
];
404 } *reflog_expire_cfg
, **reflog_expire_cfg_tail
;
406 static struct reflog_expire_cfg
*find_cfg_ent(const char *pattern
, size_t len
)
408 struct reflog_expire_cfg
*ent
;
410 if (!reflog_expire_cfg_tail
)
411 reflog_expire_cfg_tail
= &reflog_expire_cfg
;
413 for (ent
= reflog_expire_cfg
; ent
; ent
= ent
->next
)
414 if (!strncmp(ent
->pattern
, pattern
, len
) &&
415 ent
->pattern
[len
] == '\0')
418 FLEX_ALLOC_MEM(ent
, pattern
, pattern
, len
);
419 *reflog_expire_cfg_tail
= ent
;
420 reflog_expire_cfg_tail
= &(ent
->next
);
424 /* expiry timer slot */
425 #define EXPIRE_TOTAL 01
426 #define EXPIRE_UNREACH 02
428 static int reflog_expire_config(const char *var
, const char *value
, void *cb
)
430 const char *pattern
, *key
;
434 struct reflog_expire_cfg
*ent
;
436 if (parse_config_key(var
, "gc", &pattern
, &pattern_len
, &key
) < 0)
437 return git_default_config(var
, value
, cb
);
439 if (!strcmp(key
, "reflogexpire")) {
441 if (git_config_expiry_date(&expire
, var
, value
))
443 } else if (!strcmp(key
, "reflogexpireunreachable")) {
444 slot
= EXPIRE_UNREACH
;
445 if (git_config_expiry_date(&expire
, var
, value
))
448 return git_default_config(var
, value
, cb
);
453 default_reflog_expire
= expire
;
456 default_reflog_expire_unreachable
= expire
;
462 ent
= find_cfg_ent(pattern
, pattern_len
);
467 ent
->expire_total
= expire
;
470 ent
->expire_unreachable
= expire
;
476 static void set_reflog_expiry_param(struct cmd_reflog_expire_cb
*cb
, int slot
, const char *ref
)
478 struct reflog_expire_cfg
*ent
;
480 if (slot
== (EXPIRE_TOTAL
|EXPIRE_UNREACH
))
481 return; /* both given explicitly -- nothing to tweak */
483 for (ent
= reflog_expire_cfg
; ent
; ent
= ent
->next
) {
484 if (!wildmatch(ent
->pattern
, ref
, 0)) {
485 if (!(slot
& EXPIRE_TOTAL
))
486 cb
->expire_total
= ent
->expire_total
;
487 if (!(slot
& EXPIRE_UNREACH
))
488 cb
->expire_unreachable
= ent
->expire_unreachable
;
494 * If unconfigured, make stash never expire
496 if (!strcmp(ref
, "refs/stash")) {
497 if (!(slot
& EXPIRE_TOTAL
))
498 cb
->expire_total
= 0;
499 if (!(slot
& EXPIRE_UNREACH
))
500 cb
->expire_unreachable
= 0;
504 /* Nothing matched -- use the default value */
505 if (!(slot
& EXPIRE_TOTAL
))
506 cb
->expire_total
= default_reflog_expire
;
507 if (!(slot
& EXPIRE_UNREACH
))
508 cb
->expire_unreachable
= default_reflog_expire_unreachable
;
511 static int cmd_reflog_expire(int argc
, const char **argv
, const char *prefix
)
513 struct expire_reflog_policy_cb cb
;
514 timestamp_t now
= time(NULL
);
515 int i
, status
, do_all
;
516 int explicit_expiry
= 0;
517 unsigned int flags
= 0;
519 default_reflog_expire_unreachable
= now
- 30 * 24 * 3600;
520 default_reflog_expire
= now
- 90 * 24 * 3600;
521 git_config(reflog_expire_config
, NULL
);
523 save_commit_buffer
= 0;
525 memset(&cb
, 0, sizeof(cb
));
527 cb
.cmd
.expire_total
= default_reflog_expire
;
528 cb
.cmd
.expire_unreachable
= default_reflog_expire_unreachable
;
530 for (i
= 1; i
< argc
; i
++) {
531 const char *arg
= argv
[i
];
532 if (!strcmp(arg
, "--dry-run") || !strcmp(arg
, "-n"))
533 flags
|= EXPIRE_REFLOGS_DRY_RUN
;
534 else if (starts_with(arg
, "--expire=")) {
535 if (parse_expiry_date(arg
+ 9, &cb
.cmd
.expire_total
))
536 die(_("'%s' is not a valid timestamp"), arg
);
537 explicit_expiry
|= EXPIRE_TOTAL
;
539 else if (starts_with(arg
, "--expire-unreachable=")) {
540 if (parse_expiry_date(arg
+ 21, &cb
.cmd
.expire_unreachable
))
541 die(_("'%s' is not a valid timestamp"), arg
);
542 explicit_expiry
|= EXPIRE_UNREACH
;
544 else if (!strcmp(arg
, "--stale-fix"))
546 else if (!strcmp(arg
, "--rewrite"))
547 flags
|= EXPIRE_REFLOGS_REWRITE
;
548 else if (!strcmp(arg
, "--updateref"))
549 flags
|= EXPIRE_REFLOGS_UPDATE_REF
;
550 else if (!strcmp(arg
, "--all"))
552 else if (!strcmp(arg
, "--verbose"))
553 flags
|= EXPIRE_REFLOGS_VERBOSE
;
554 else if (!strcmp(arg
, "--")) {
558 else if (arg
[0] == '-')
559 usage(reflog_expire_usage
);
565 * We can trust the commits and objects reachable from refs
566 * even in older repository. We cannot trust what's reachable
567 * from reflog if the repository was pruned with older git.
569 if (cb
.cmd
.stalefix
) {
570 init_revisions(&cb
.cmd
.revs
, prefix
);
571 if (flags
& EXPIRE_REFLOGS_VERBOSE
)
572 printf("Marking reachable objects...");
573 mark_reachable_objects(&cb
.cmd
.revs
, 0, 0, NULL
);
574 if (flags
& EXPIRE_REFLOGS_VERBOSE
)
579 struct collect_reflog_cb collected
;
582 memset(&collected
, 0, sizeof(collected
));
583 for_each_reflog(collect_reflog
, &collected
);
584 for (i
= 0; i
< collected
.nr
; i
++) {
585 struct collected_reflog
*e
= collected
.e
[i
];
586 set_reflog_expiry_param(&cb
.cmd
, explicit_expiry
, e
->reflog
);
587 status
|= reflog_expire(e
->reflog
, &e
->oid
, flags
,
588 reflog_expiry_prepare
,
589 should_expire_reflog_ent
,
590 reflog_expiry_cleanup
,
597 for (; i
< argc
; i
++) {
599 struct object_id oid
;
600 if (!dwim_log(argv
[i
], strlen(argv
[i
]), &oid
, &ref
)) {
601 status
|= error("%s points nowhere!", argv
[i
]);
604 set_reflog_expiry_param(&cb
.cmd
, explicit_expiry
, ref
);
605 status
|= reflog_expire(ref
, &oid
, flags
,
606 reflog_expiry_prepare
,
607 should_expire_reflog_ent
,
608 reflog_expiry_cleanup
,
614 static int count_reflog_ent(struct object_id
*ooid
, struct object_id
*noid
,
615 const char *email
, timestamp_t timestamp
, int tz
,
616 const char *message
, void *cb_data
)
618 struct expire_reflog_policy_cb
*cb
= cb_data
;
619 if (!cb
->cmd
.expire_total
|| timestamp
< cb
->cmd
.expire_total
)
624 static int cmd_reflog_delete(int argc
, const char **argv
, const char *prefix
)
626 struct expire_reflog_policy_cb cb
;
628 unsigned int flags
= 0;
630 memset(&cb
, 0, sizeof(cb
));
632 for (i
= 1; i
< argc
; i
++) {
633 const char *arg
= argv
[i
];
634 if (!strcmp(arg
, "--dry-run") || !strcmp(arg
, "-n"))
635 flags
|= EXPIRE_REFLOGS_DRY_RUN
;
636 else if (!strcmp(arg
, "--rewrite"))
637 flags
|= EXPIRE_REFLOGS_REWRITE
;
638 else if (!strcmp(arg
, "--updateref"))
639 flags
|= EXPIRE_REFLOGS_UPDATE_REF
;
640 else if (!strcmp(arg
, "--verbose"))
641 flags
|= EXPIRE_REFLOGS_VERBOSE
;
642 else if (!strcmp(arg
, "--")) {
646 else if (arg
[0] == '-')
647 usage(reflog_delete_usage
);
653 return error("Nothing to delete?");
655 for ( ; i
< argc
; i
++) {
656 const char *spec
= strstr(argv
[i
], "@{");
657 struct object_id oid
;
662 status
|= error("Not a reflog: %s", argv
[i
]);
666 if (!dwim_log(argv
[i
], spec
- argv
[i
], &oid
, &ref
)) {
667 status
|= error("no reflog for '%s'", argv
[i
]);
671 recno
= strtoul(spec
+ 2, &ep
, 10);
673 cb
.cmd
.recno
= -recno
;
674 for_each_reflog_ent(ref
, count_reflog_ent
, &cb
);
676 cb
.cmd
.expire_total
= approxidate(spec
+ 2);
677 for_each_reflog_ent(ref
, count_reflog_ent
, &cb
);
678 cb
.cmd
.expire_total
= 0;
681 status
|= reflog_expire(ref
, &oid
, flags
,
682 reflog_expiry_prepare
,
683 should_expire_reflog_ent
,
684 reflog_expiry_cleanup
,
691 static int cmd_reflog_exists(int argc
, const char **argv
, const char *prefix
)
695 for (i
= 1; i
< argc
; i
++) {
696 const char *arg
= argv
[i
];
697 if (!strcmp(arg
, "--")) {
701 else if (arg
[0] == '-')
702 usage(reflog_exists_usage
);
709 if (argc
- start
!= 1)
710 usage(reflog_exists_usage
);
712 if (check_refname_format(argv
[start
], REFNAME_ALLOW_ONELEVEL
))
713 die("invalid ref format: %s", argv
[start
]);
714 return !reflog_exists(argv
[start
]);
721 static const char reflog_usage
[] =
722 "git reflog [ show | expire | delete | exists ]";
724 int cmd_reflog(int argc
, const char **argv
, const char *prefix
)
726 if (argc
> 1 && !strcmp(argv
[1], "-h"))
729 /* With no command, we default to showing it. */
730 if (argc
< 2 || *argv
[1] == '-')
731 return cmd_log_reflog(argc
, argv
, prefix
);
733 if (!strcmp(argv
[1], "show"))
734 return cmd_log_reflog(argc
- 1, argv
+ 1, prefix
);
736 if (!strcmp(argv
[1], "expire"))
737 return cmd_reflog_expire(argc
- 1, argv
+ 1, prefix
);
739 if (!strcmp(argv
[1], "delete"))
740 return cmd_reflog_delete(argc
- 1, argv
+ 1, prefix
);
742 if (!strcmp(argv
[1], "exists"))
743 return cmd_reflog_exists(argc
- 1, argv
+ 1, prefix
);
745 return cmd_log_reflog(argc
, argv
, prefix
);