15 static const char reflog_expire_usage
[] =
16 "git reflog expire [--verbose] [--dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
17 static const char reflog_delete_usage
[] =
18 "git reflog delete [--verbose] [--dry-run] [--rewrite] [--updateref] <refs>...";
20 static unsigned long default_reflog_expire
;
21 static unsigned long default_reflog_expire_unreachable
;
23 struct cmd_reflog_expire_cb
{
30 unsigned long expire_total
;
31 unsigned long expire_unreachable
;
35 struct expire_reflog_cb
{
41 } unreachable_expire_kind
;
42 struct commit_list
*mark_list
;
43 unsigned long mark_limit
;
44 struct cmd_reflog_expire_cb
*cmd
;
45 unsigned char last_kept_sha1
[20];
48 struct collected_reflog
{
49 unsigned char sha1
[20];
50 char reflog
[FLEX_ARRAY
];
52 struct collect_reflog_cb
{
53 struct collected_reflog
**e
;
58 #define INCOMPLETE (1u<<10)
59 #define STUDYING (1u<<11)
60 #define REACHABLE (1u<<12)
62 static int tree_is_complete(const unsigned char *sha1
)
64 struct tree_desc desc
;
65 struct name_entry entry
;
69 tree
= lookup_tree(sha1
);
72 if (tree
->object
.flags
& SEEN
)
74 if (tree
->object
.flags
& INCOMPLETE
)
78 enum object_type type
;
80 void *data
= read_sha1_file(sha1
, &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
.sha1
) ||
92 (S_ISDIR(entry
.mode
) && !tree_is_complete(entry
.sha1
))) {
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
*)study
.objects
[--study
.nr
].item
;
133 if (!c
->object
.parsed
&& !parse_object(c
->object
.sha1
))
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(c
->tree
->object
.sha1
)) {
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 */
190 return !is_incomplete
;
193 static int keep_entry(struct commit
**it
, unsigned char *sha1
)
195 struct commit
*commit
;
197 if (is_null_sha1(sha1
))
199 commit
= lookup_commit_reference_gently(sha1
, 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_cb
*cb
)
225 struct commit
*commit
;
226 struct commit_list
*pending
;
227 unsigned long expire_limit
= cb
->mark_limit
;
228 struct commit_list
*leftover
= NULL
;
230 for (pending
= cb
->mark_list
; pending
; pending
= pending
->next
)
231 pending
->item
->object
.flags
&= ~REACHABLE
;
233 pending
= cb
->mark_list
;
235 struct commit_list
*entry
= pending
;
236 struct commit_list
*parent
;
237 pending
= entry
->next
;
238 commit
= entry
->item
;
240 if (commit
->object
.flags
& REACHABLE
)
242 if (parse_commit(commit
))
244 commit
->object
.flags
|= REACHABLE
;
245 if (commit
->date
< expire_limit
) {
246 commit_list_insert(commit
, &leftover
);
249 commit
->object
.flags
|= REACHABLE
;
250 parent
= commit
->parents
;
252 commit
= parent
->item
;
253 parent
= parent
->next
;
254 if (commit
->object
.flags
& REACHABLE
)
256 commit_list_insert(commit
, &pending
);
259 cb
->mark_list
= leftover
;
262 static int unreachable(struct expire_reflog_cb
*cb
, struct commit
*commit
, unsigned char *sha1
)
265 * We may or may not have the commit yet - if not, look it
266 * up using the supplied sha1.
269 if (is_null_sha1(sha1
))
272 commit
= lookup_commit_reference_gently(sha1
, 1);
274 /* Not a commit -- keep it */
279 /* Reachable from the current ref? Don't prune. */
280 if (commit
->object
.flags
& REACHABLE
)
283 if (cb
->mark_list
&& cb
->mark_limit
) {
284 cb
->mark_limit
= 0; /* dig down to the root */
288 return !(commit
->object
.flags
& REACHABLE
);
292 * Return true iff the specified reflog entry should be expired.
294 static int should_expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
295 const char *email
, unsigned long timestamp
, int tz
,
296 const char *message
, void *cb_data
)
298 struct expire_reflog_cb
*cb
= cb_data
;
299 struct commit
*old
, *new;
301 if (timestamp
< cb
->cmd
->expire_total
)
305 if (cb
->cmd
->stalefix
&&
306 (!keep_entry(&old
, osha1
) || !keep_entry(&new, nsha1
)))
309 if (timestamp
< cb
->cmd
->expire_unreachable
) {
310 if (cb
->unreachable_expire_kind
== UE_ALWAYS
)
312 if (unreachable(cb
, old
, osha1
) || unreachable(cb
, new, nsha1
))
316 if (cb
->cmd
->recno
&& --(cb
->cmd
->recno
) == 0)
322 static int expire_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
323 const char *email
, unsigned long timestamp
, int tz
,
324 const char *message
, void *cb_data
)
326 struct expire_reflog_cb
*cb
= cb_data
;
328 if (cb
->cmd
->rewrite
)
329 osha1
= cb
->last_kept_sha1
;
331 if (should_expire_reflog_ent(osha1
, nsha1
, email
, timestamp
, tz
,
334 printf("would prune %s", message
);
335 else if (cb
->cmd
->verbose
)
336 printf("prune %s", message
);
339 char sign
= (tz
< 0) ? '-' : '+';
340 int zone
= (tz
< 0) ? (-tz
) : tz
;
341 fprintf(cb
->newlog
, "%s %s %s %lu %c%04d\t%s",
342 sha1_to_hex(osha1
), sha1_to_hex(nsha1
),
343 email
, timestamp
, sign
, zone
,
345 hashcpy(cb
->last_kept_sha1
, nsha1
);
347 if (cb
->cmd
->verbose
)
348 printf("keep %s", message
);
353 static int push_tip_to_list(const char *refname
, const unsigned char *sha1
, int flags
, void *cb_data
)
355 struct commit_list
**list
= cb_data
;
356 struct commit
*tip_commit
;
357 if (flags
& REF_ISSYMREF
)
359 tip_commit
= lookup_commit_reference_gently(sha1
, 1);
362 commit_list_insert(tip_commit
, list
);
366 static int expire_reflog(const char *refname
, const unsigned char *sha1
,
367 struct cmd_reflog_expire_cb
*cmd
)
369 static struct lock_file reflog_lock
;
370 struct expire_reflog_cb cb
;
371 struct ref_lock
*lock
;
373 struct commit
*tip_commit
;
374 struct commit_list
*tips
;
377 memset(&cb
, 0, sizeof(cb
));
380 * The reflog file is locked by holding the lock on the
381 * reference itself, plus we might need to update the
382 * reference if --updateref was specified:
384 lock
= lock_any_ref_for_update(refname
, sha1
, 0, NULL
);
386 return error("cannot lock ref '%s'", refname
);
387 if (!reflog_exists(refname
)) {
392 log_file
= git_pathdup("logs/%s", refname
);
395 * Even though holding $GIT_DIR/logs/$reflog.lock has
396 * no locking implications, we use the lock_file
397 * machinery here anyway because it does a lot of the
398 * work we need, including cleaning up if the program
399 * exits unexpectedly.
401 if (hold_lock_file_for_update(&reflog_lock
, log_file
, 0) < 0) {
402 struct strbuf err
= STRBUF_INIT
;
403 unable_to_lock_message(log_file
, errno
, &err
);
404 error("%s", err
.buf
);
405 strbuf_release(&err
);
408 cb
.newlog
= fdopen_lock_file(&reflog_lock
, "w");
410 error("cannot fdopen %s (%s)",
411 reflog_lock
.filename
.buf
, strerror(errno
));
418 if (!cmd
->expire_unreachable
|| !strcmp(refname
, "HEAD")) {
420 cb
.unreachable_expire_kind
= UE_HEAD
;
422 tip_commit
= lookup_commit_reference_gently(sha1
, 1);
424 cb
.unreachable_expire_kind
= UE_ALWAYS
;
426 cb
.unreachable_expire_kind
= UE_NORMAL
;
429 if (cmd
->expire_unreachable
<= cmd
->expire_total
)
430 cb
.unreachable_expire_kind
= UE_ALWAYS
;
434 if (cb
.unreachable_expire_kind
!= UE_ALWAYS
) {
435 if (cb
.unreachable_expire_kind
== UE_HEAD
) {
436 struct commit_list
*elem
;
437 for_each_ref(push_tip_to_list
, &tips
);
438 for (elem
= tips
; elem
; elem
= elem
->next
)
439 commit_list_insert(elem
->item
, &cb
.mark_list
);
441 commit_list_insert(tip_commit
, &cb
.mark_list
);
443 cb
.mark_limit
= cmd
->expire_total
;
447 for_each_reflog_ent(refname
, expire_reflog_ent
, &cb
);
449 if (cb
.unreachable_expire_kind
!= UE_ALWAYS
) {
450 if (cb
.unreachable_expire_kind
== UE_HEAD
) {
451 struct commit_list
*elem
;
452 for (elem
= tips
; elem
; elem
= elem
->next
)
453 clear_commit_marks(elem
->item
, REACHABLE
);
454 free_commit_list(tips
);
456 clear_commit_marks(tip_commit
, REACHABLE
);
461 if (close_lock_file(&reflog_lock
)) {
462 status
|= error("couldn't write %s: %s", log_file
,
464 } else if (cmd
->updateref
&&
465 (write_in_full(lock
->lock_fd
,
466 sha1_to_hex(cb
.last_kept_sha1
), 40) != 40 ||
467 write_str_in_full(lock
->lock_fd
, "\n") != 1 ||
468 close_ref(lock
) < 0)) {
469 status
|= error("couldn't write %s",
470 lock
->lk
->filename
.buf
);
471 rollback_lock_file(&reflog_lock
);
472 } else if (commit_lock_file(&reflog_lock
)) {
473 status
|= error("unable to commit reflog '%s' (%s)",
474 log_file
, strerror(errno
));
475 } else if (cmd
->updateref
&& commit_ref(lock
)) {
476 status
|= error("couldn't set %s", lock
->ref_name
);
484 rollback_lock_file(&reflog_lock
);
490 static int collect_reflog(const char *ref
, const unsigned char *sha1
, int unused
, void *cb_data
)
492 struct collected_reflog
*e
;
493 struct collect_reflog_cb
*cb
= cb_data
;
494 size_t namelen
= strlen(ref
);
496 e
= xmalloc(sizeof(*e
) + namelen
+ 1);
497 hashcpy(e
->sha1
, sha1
);
498 memcpy(e
->reflog
, ref
, namelen
+ 1);
499 ALLOC_GROW(cb
->e
, cb
->nr
+ 1, cb
->alloc
);
504 static struct reflog_expire_cfg
{
505 struct reflog_expire_cfg
*next
;
506 unsigned long expire_total
;
507 unsigned long expire_unreachable
;
509 char pattern
[FLEX_ARRAY
];
510 } *reflog_expire_cfg
, **reflog_expire_cfg_tail
;
512 static struct reflog_expire_cfg
*find_cfg_ent(const char *pattern
, size_t len
)
514 struct reflog_expire_cfg
*ent
;
516 if (!reflog_expire_cfg_tail
)
517 reflog_expire_cfg_tail
= &reflog_expire_cfg
;
519 for (ent
= reflog_expire_cfg
; ent
; ent
= ent
->next
)
520 if (ent
->len
== len
&&
521 !memcmp(ent
->pattern
, pattern
, len
))
524 ent
= xcalloc(1, (sizeof(*ent
) + len
));
525 memcpy(ent
->pattern
, pattern
, len
);
527 *reflog_expire_cfg_tail
= ent
;
528 reflog_expire_cfg_tail
= &(ent
->next
);
532 static int parse_expire_cfg_value(const char *var
, const char *value
, unsigned long *expire
)
535 return config_error_nonbool(var
);
536 if (parse_expiry_date(value
, expire
))
537 return error(_("%s' for '%s' is not a valid timestamp"),
542 /* expiry timer slot */
543 #define EXPIRE_TOTAL 01
544 #define EXPIRE_UNREACH 02
546 static int reflog_expire_config(const char *var
, const char *value
, void *cb
)
548 const char *pattern
, *key
;
550 unsigned long expire
;
552 struct reflog_expire_cfg
*ent
;
554 if (parse_config_key(var
, "gc", &pattern
, &pattern_len
, &key
) < 0)
555 return git_default_config(var
, value
, cb
);
557 if (!strcmp(key
, "reflogexpire")) {
559 if (parse_expire_cfg_value(var
, value
, &expire
))
561 } else if (!strcmp(key
, "reflogexpireunreachable")) {
562 slot
= EXPIRE_UNREACH
;
563 if (parse_expire_cfg_value(var
, value
, &expire
))
566 return git_default_config(var
, value
, cb
);
571 default_reflog_expire
= expire
;
574 default_reflog_expire_unreachable
= expire
;
580 ent
= find_cfg_ent(pattern
, pattern_len
);
585 ent
->expire_total
= expire
;
588 ent
->expire_unreachable
= expire
;
594 static void set_reflog_expiry_param(struct cmd_reflog_expire_cb
*cb
, int slot
, const char *ref
)
596 struct reflog_expire_cfg
*ent
;
598 if (slot
== (EXPIRE_TOTAL
|EXPIRE_UNREACH
))
599 return; /* both given explicitly -- nothing to tweak */
601 for (ent
= reflog_expire_cfg
; ent
; ent
= ent
->next
) {
602 if (!wildmatch(ent
->pattern
, ref
, 0, NULL
)) {
603 if (!(slot
& EXPIRE_TOTAL
))
604 cb
->expire_total
= ent
->expire_total
;
605 if (!(slot
& EXPIRE_UNREACH
))
606 cb
->expire_unreachable
= ent
->expire_unreachable
;
612 * If unconfigured, make stash never expire
614 if (!strcmp(ref
, "refs/stash")) {
615 if (!(slot
& EXPIRE_TOTAL
))
616 cb
->expire_total
= 0;
617 if (!(slot
& EXPIRE_UNREACH
))
618 cb
->expire_unreachable
= 0;
622 /* Nothing matched -- use the default value */
623 if (!(slot
& EXPIRE_TOTAL
))
624 cb
->expire_total
= default_reflog_expire
;
625 if (!(slot
& EXPIRE_UNREACH
))
626 cb
->expire_unreachable
= default_reflog_expire_unreachable
;
629 static int cmd_reflog_expire(int argc
, const char **argv
, const char *prefix
)
631 struct cmd_reflog_expire_cb cb
;
632 unsigned long now
= time(NULL
);
633 int i
, status
, do_all
;
634 int explicit_expiry
= 0;
636 default_reflog_expire_unreachable
= now
- 30 * 24 * 3600;
637 default_reflog_expire
= now
- 90 * 24 * 3600;
638 git_config(reflog_expire_config
, NULL
);
640 save_commit_buffer
= 0;
642 memset(&cb
, 0, sizeof(cb
));
644 cb
.expire_total
= default_reflog_expire
;
645 cb
.expire_unreachable
= default_reflog_expire_unreachable
;
647 for (i
= 1; i
< argc
; i
++) {
648 const char *arg
= argv
[i
];
649 if (!strcmp(arg
, "--dry-run") || !strcmp(arg
, "-n"))
651 else if (starts_with(arg
, "--expire=")) {
652 if (parse_expiry_date(arg
+ 9, &cb
.expire_total
))
653 die(_("'%s' is not a valid timestamp"), arg
);
654 explicit_expiry
|= EXPIRE_TOTAL
;
656 else if (starts_with(arg
, "--expire-unreachable=")) {
657 if (parse_expiry_date(arg
+ 21, &cb
.expire_unreachable
))
658 die(_("'%s' is not a valid timestamp"), arg
);
659 explicit_expiry
|= EXPIRE_UNREACH
;
661 else if (!strcmp(arg
, "--stale-fix"))
663 else if (!strcmp(arg
, "--rewrite"))
665 else if (!strcmp(arg
, "--updateref"))
667 else if (!strcmp(arg
, "--all"))
669 else if (!strcmp(arg
, "--verbose"))
671 else if (!strcmp(arg
, "--")) {
675 else if (arg
[0] == '-')
676 usage(reflog_expire_usage
);
682 * We can trust the commits and objects reachable from refs
683 * even in older repository. We cannot trust what's reachable
684 * from reflog if the repository was pruned with older git.
687 init_revisions(&cb
.revs
, prefix
);
689 printf("Marking reachable objects...");
690 mark_reachable_objects(&cb
.revs
, 0, 0, NULL
);
696 struct collect_reflog_cb collected
;
699 memset(&collected
, 0, sizeof(collected
));
700 for_each_reflog(collect_reflog
, &collected
);
701 for (i
= 0; i
< collected
.nr
; i
++) {
702 struct collected_reflog
*e
= collected
.e
[i
];
703 set_reflog_expiry_param(&cb
, explicit_expiry
, e
->reflog
);
704 status
|= expire_reflog(e
->reflog
, e
->sha1
, &cb
);
710 for (; i
< argc
; i
++) {
712 unsigned char sha1
[20];
713 if (!dwim_log(argv
[i
], strlen(argv
[i
]), sha1
, &ref
)) {
714 status
|= error("%s points nowhere!", argv
[i
]);
717 set_reflog_expiry_param(&cb
, explicit_expiry
, ref
);
718 status
|= expire_reflog(ref
, sha1
, &cb
);
723 static int count_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
724 const char *email
, unsigned long timestamp
, int tz
,
725 const char *message
, void *cb_data
)
727 struct cmd_reflog_expire_cb
*cb
= cb_data
;
728 if (!cb
->expire_total
|| timestamp
< cb
->expire_total
)
733 static int cmd_reflog_delete(int argc
, const char **argv
, const char *prefix
)
735 struct cmd_reflog_expire_cb cb
;
738 memset(&cb
, 0, sizeof(cb
));
740 for (i
= 1; i
< argc
; i
++) {
741 const char *arg
= argv
[i
];
742 if (!strcmp(arg
, "--dry-run") || !strcmp(arg
, "-n"))
744 else if (!strcmp(arg
, "--rewrite"))
746 else if (!strcmp(arg
, "--updateref"))
748 else if (!strcmp(arg
, "--verbose"))
750 else if (!strcmp(arg
, "--")) {
754 else if (arg
[0] == '-')
755 usage(reflog_delete_usage
);
761 return error("Nothing to delete?");
763 for ( ; i
< argc
; i
++) {
764 const char *spec
= strstr(argv
[i
], "@{");
765 unsigned char sha1
[20];
770 status
|= error("Not a reflog: %s", argv
[i
]);
774 if (!dwim_log(argv
[i
], spec
- argv
[i
], sha1
, &ref
)) {
775 status
|= error("no reflog for '%s'", argv
[i
]);
779 recno
= strtoul(spec
+ 2, &ep
, 10);
782 for_each_reflog_ent(ref
, count_reflog_ent
, &cb
);
784 cb
.expire_total
= approxidate(spec
+ 2);
785 for_each_reflog_ent(ref
, count_reflog_ent
, &cb
);
789 status
|= expire_reflog(ref
, sha1
, &cb
);
799 static const char reflog_usage
[] =
800 "git reflog [ show | expire | delete ]";
802 int cmd_reflog(int argc
, const char **argv
, const char *prefix
)
804 if (argc
> 1 && !strcmp(argv
[1], "-h"))
807 /* With no command, we default to showing it. */
808 if (argc
< 2 || *argv
[1] == '-')
809 return cmd_log_reflog(argc
, argv
, prefix
);
811 if (!strcmp(argv
[1], "show"))
812 return cmd_log_reflog(argc
- 1, argv
+ 1, prefix
);
814 if (!strcmp(argv
[1], "expire"))
815 return cmd_reflog_expire(argc
- 1, argv
+ 1, prefix
);
817 if (!strcmp(argv
[1], "delete"))
818 return cmd_reflog_delete(argc
- 1, argv
+ 1, prefix
);
820 return cmd_log_reflog(argc
, argv
, prefix
);