use pop_commit() for consuming the first entry of a struct commit_list
[git/debian.git] / builtin / reflog.c
blobfa841b500bcb006265c72b5f6a553b3ac24fa980
1 #include "builtin.h"
2 #include "lockfile.h"
3 #include "commit.h"
4 #include "refs.h"
5 #include "dir.h"
6 #include "tree-walk.h"
7 #include "diff.h"
8 #include "revision.h"
9 #include "reachable.h"
11 /* NEEDSWORK: switch to using parse_options */
12 static const char reflog_expire_usage[] =
13 "git reflog expire [--expire=<time>] [--expire-unreachable=<time>] [--rewrite] [--updateref] [--stale-fix] [--dry-run | -n] [--verbose] [--all] <refs>...";
14 static const char reflog_delete_usage[] =
15 "git reflog delete [--rewrite] [--updateref] [--dry-run | -n] [--verbose] <refs>...";
17 static unsigned long default_reflog_expire;
18 static unsigned long default_reflog_expire_unreachable;
20 struct cmd_reflog_expire_cb {
21 struct rev_info revs;
22 int stalefix;
23 unsigned long expire_total;
24 unsigned long expire_unreachable;
25 int recno;
28 struct expire_reflog_policy_cb {
29 enum {
30 UE_NORMAL,
31 UE_ALWAYS,
32 UE_HEAD
33 } unreachable_expire_kind;
34 struct commit_list *mark_list;
35 unsigned long mark_limit;
36 struct cmd_reflog_expire_cb cmd;
37 struct commit *tip_commit;
38 struct commit_list *tips;
41 struct collected_reflog {
42 unsigned char sha1[20];
43 char reflog[FLEX_ARRAY];
46 struct collect_reflog_cb {
47 struct collected_reflog **e;
48 int alloc;
49 int nr;
52 #define INCOMPLETE (1u<<10)
53 #define STUDYING (1u<<11)
54 #define REACHABLE (1u<<12)
56 static int tree_is_complete(const unsigned char *sha1)
58 struct tree_desc desc;
59 struct name_entry entry;
60 int complete;
61 struct tree *tree;
63 tree = lookup_tree(sha1);
64 if (!tree)
65 return 0;
66 if (tree->object.flags & SEEN)
67 return 1;
68 if (tree->object.flags & INCOMPLETE)
69 return 0;
71 if (!tree->buffer) {
72 enum object_type type;
73 unsigned long size;
74 void *data = read_sha1_file(sha1, &type, &size);
75 if (!data) {
76 tree->object.flags |= INCOMPLETE;
77 return 0;
79 tree->buffer = data;
80 tree->size = size;
82 init_tree_desc(&desc, tree->buffer, tree->size);
83 complete = 1;
84 while (tree_entry(&desc, &entry)) {
85 if (!has_sha1_file(entry.sha1) ||
86 (S_ISDIR(entry.mode) && !tree_is_complete(entry.sha1))) {
87 tree->object.flags |= INCOMPLETE;
88 complete = 0;
91 free_tree_buffer(tree);
93 if (complete)
94 tree->object.flags |= SEEN;
95 return complete;
98 static int commit_is_complete(struct commit *commit)
100 struct object_array study;
101 struct object_array found;
102 int is_incomplete = 0;
103 int i;
105 /* early return */
106 if (commit->object.flags & SEEN)
107 return 1;
108 if (commit->object.flags & INCOMPLETE)
109 return 0;
111 * Find all commits that are reachable and are not marked as
112 * SEEN. Then make sure the trees and blobs contained are
113 * complete. After that, mark these commits also as SEEN.
114 * If some of the objects that are needed to complete this
115 * commit are missing, mark this commit as INCOMPLETE.
117 memset(&study, 0, sizeof(study));
118 memset(&found, 0, sizeof(found));
119 add_object_array(&commit->object, NULL, &study);
120 add_object_array(&commit->object, NULL, &found);
121 commit->object.flags |= STUDYING;
122 while (study.nr) {
123 struct commit *c;
124 struct commit_list *parent;
126 c = (struct commit *)study.objects[--study.nr].item;
127 if (!c->object.parsed && !parse_object(c->object.sha1))
128 c->object.flags |= INCOMPLETE;
130 if (c->object.flags & INCOMPLETE) {
131 is_incomplete = 1;
132 break;
134 else if (c->object.flags & SEEN)
135 continue;
136 for (parent = c->parents; parent; parent = parent->next) {
137 struct commit *p = parent->item;
138 if (p->object.flags & STUDYING)
139 continue;
140 p->object.flags |= STUDYING;
141 add_object_array(&p->object, NULL, &study);
142 add_object_array(&p->object, NULL, &found);
145 if (!is_incomplete) {
147 * make sure all commits in "found" array have all the
148 * necessary objects.
150 for (i = 0; i < found.nr; i++) {
151 struct commit *c =
152 (struct commit *)found.objects[i].item;
153 if (!tree_is_complete(c->tree->object.sha1)) {
154 is_incomplete = 1;
155 c->object.flags |= INCOMPLETE;
158 if (!is_incomplete) {
159 /* mark all found commits as complete, iow SEEN */
160 for (i = 0; i < found.nr; i++)
161 found.objects[i].item->flags |= SEEN;
164 /* clear flags from the objects we traversed */
165 for (i = 0; i < found.nr; i++)
166 found.objects[i].item->flags &= ~STUDYING;
167 if (is_incomplete)
168 commit->object.flags |= INCOMPLETE;
169 else {
171 * If we come here, we have (1) traversed the ancestry chain
172 * from the "commit" until we reach SEEN commits (which are
173 * known to be complete), and (2) made sure that the commits
174 * encountered during the above traversal refer to trees that
175 * are complete. Which means that we know *all* the commits
176 * we have seen during this process are complete.
178 for (i = 0; i < found.nr; i++)
179 found.objects[i].item->flags |= SEEN;
181 /* free object arrays */
182 free(study.objects);
183 free(found.objects);
184 return !is_incomplete;
187 static int keep_entry(struct commit **it, unsigned char *sha1)
189 struct commit *commit;
191 if (is_null_sha1(sha1))
192 return 1;
193 commit = lookup_commit_reference_gently(sha1, 1);
194 if (!commit)
195 return 0;
198 * Make sure everything in this commit exists.
200 * We have walked all the objects reachable from the refs
201 * and cache earlier. The commits reachable by this commit
202 * must meet SEEN commits -- and then we should mark them as
203 * SEEN as well.
205 if (!commit_is_complete(commit))
206 return 0;
207 *it = commit;
208 return 1;
212 * Starting from commits in the cb->mark_list, mark commits that are
213 * reachable from them. Stop the traversal at commits older than
214 * the expire_limit and queue them back, so that the caller can call
215 * us again to restart the traversal with longer expire_limit.
217 static void mark_reachable(struct expire_reflog_policy_cb *cb)
219 struct commit_list *pending;
220 unsigned long expire_limit = cb->mark_limit;
221 struct commit_list *leftover = NULL;
223 for (pending = cb->mark_list; pending; pending = pending->next)
224 pending->item->object.flags &= ~REACHABLE;
226 pending = cb->mark_list;
227 while (pending) {
228 struct commit_list *parent;
229 struct commit *commit = pop_commit(&pending);
230 if (commit->object.flags & REACHABLE)
231 continue;
232 if (parse_commit(commit))
233 continue;
234 commit->object.flags |= REACHABLE;
235 if (commit->date < expire_limit) {
236 commit_list_insert(commit, &leftover);
237 continue;
239 commit->object.flags |= REACHABLE;
240 parent = commit->parents;
241 while (parent) {
242 commit = parent->item;
243 parent = parent->next;
244 if (commit->object.flags & REACHABLE)
245 continue;
246 commit_list_insert(commit, &pending);
249 cb->mark_list = leftover;
252 static int unreachable(struct expire_reflog_policy_cb *cb, struct commit *commit, unsigned char *sha1)
255 * We may or may not have the commit yet - if not, look it
256 * up using the supplied sha1.
258 if (!commit) {
259 if (is_null_sha1(sha1))
260 return 0;
262 commit = lookup_commit_reference_gently(sha1, 1);
264 /* Not a commit -- keep it */
265 if (!commit)
266 return 0;
269 /* Reachable from the current ref? Don't prune. */
270 if (commit->object.flags & REACHABLE)
271 return 0;
273 if (cb->mark_list && cb->mark_limit) {
274 cb->mark_limit = 0; /* dig down to the root */
275 mark_reachable(cb);
278 return !(commit->object.flags & REACHABLE);
282 * Return true iff the specified reflog entry should be expired.
284 static int should_expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
285 const char *email, unsigned long timestamp, int tz,
286 const char *message, void *cb_data)
288 struct expire_reflog_policy_cb *cb = cb_data;
289 struct commit *old, *new;
291 if (timestamp < cb->cmd.expire_total)
292 return 1;
294 old = new = NULL;
295 if (cb->cmd.stalefix &&
296 (!keep_entry(&old, osha1) || !keep_entry(&new, nsha1)))
297 return 1;
299 if (timestamp < cb->cmd.expire_unreachable) {
300 if (cb->unreachable_expire_kind == UE_ALWAYS)
301 return 1;
302 if (unreachable(cb, old, osha1) || unreachable(cb, new, nsha1))
303 return 1;
306 if (cb->cmd.recno && --(cb->cmd.recno) == 0)
307 return 1;
309 return 0;
312 static int push_tip_to_list(const char *refname, const struct object_id *oid,
313 int flags, void *cb_data)
315 struct commit_list **list = cb_data;
316 struct commit *tip_commit;
317 if (flags & REF_ISSYMREF)
318 return 0;
319 tip_commit = lookup_commit_reference_gently(oid->hash, 1);
320 if (!tip_commit)
321 return 0;
322 commit_list_insert(tip_commit, list);
323 return 0;
326 static void reflog_expiry_prepare(const char *refname,
327 const unsigned char *sha1,
328 void *cb_data)
330 struct expire_reflog_policy_cb *cb = cb_data;
332 if (!cb->cmd.expire_unreachable || !strcmp(refname, "HEAD")) {
333 cb->tip_commit = NULL;
334 cb->unreachable_expire_kind = UE_HEAD;
335 } else {
336 cb->tip_commit = lookup_commit_reference_gently(sha1, 1);
337 if (!cb->tip_commit)
338 cb->unreachable_expire_kind = UE_ALWAYS;
339 else
340 cb->unreachable_expire_kind = UE_NORMAL;
343 if (cb->cmd.expire_unreachable <= cb->cmd.expire_total)
344 cb->unreachable_expire_kind = UE_ALWAYS;
346 cb->mark_list = NULL;
347 cb->tips = NULL;
348 if (cb->unreachable_expire_kind != UE_ALWAYS) {
349 if (cb->unreachable_expire_kind == UE_HEAD) {
350 struct commit_list *elem;
352 for_each_ref(push_tip_to_list, &cb->tips);
353 for (elem = cb->tips; elem; elem = elem->next)
354 commit_list_insert(elem->item, &cb->mark_list);
355 } else {
356 commit_list_insert(cb->tip_commit, &cb->mark_list);
358 cb->mark_limit = cb->cmd.expire_total;
359 mark_reachable(cb);
363 static void reflog_expiry_cleanup(void *cb_data)
365 struct expire_reflog_policy_cb *cb = cb_data;
367 if (cb->unreachable_expire_kind != UE_ALWAYS) {
368 if (cb->unreachable_expire_kind == UE_HEAD) {
369 struct commit_list *elem;
370 for (elem = cb->tips; elem; elem = elem->next)
371 clear_commit_marks(elem->item, REACHABLE);
372 free_commit_list(cb->tips);
373 } else {
374 clear_commit_marks(cb->tip_commit, REACHABLE);
379 static int collect_reflog(const char *ref, const struct object_id *oid, int unused, void *cb_data)
381 struct collected_reflog *e;
382 struct collect_reflog_cb *cb = cb_data;
383 size_t namelen = strlen(ref);
385 e = xmalloc(sizeof(*e) + namelen + 1);
386 hashcpy(e->sha1, oid->hash);
387 memcpy(e->reflog, ref, namelen + 1);
388 ALLOC_GROW(cb->e, cb->nr + 1, cb->alloc);
389 cb->e[cb->nr++] = e;
390 return 0;
393 static struct reflog_expire_cfg {
394 struct reflog_expire_cfg *next;
395 unsigned long expire_total;
396 unsigned long expire_unreachable;
397 size_t len;
398 char pattern[FLEX_ARRAY];
399 } *reflog_expire_cfg, **reflog_expire_cfg_tail;
401 static struct reflog_expire_cfg *find_cfg_ent(const char *pattern, size_t len)
403 struct reflog_expire_cfg *ent;
405 if (!reflog_expire_cfg_tail)
406 reflog_expire_cfg_tail = &reflog_expire_cfg;
408 for (ent = reflog_expire_cfg; ent; ent = ent->next)
409 if (ent->len == len &&
410 !memcmp(ent->pattern, pattern, len))
411 return ent;
413 ent = xcalloc(1, (sizeof(*ent) + len));
414 memcpy(ent->pattern, pattern, len);
415 ent->len = len;
416 *reflog_expire_cfg_tail = ent;
417 reflog_expire_cfg_tail = &(ent->next);
418 return ent;
421 static int parse_expire_cfg_value(const char *var, const char *value, unsigned long *expire)
423 if (!value)
424 return config_error_nonbool(var);
425 if (parse_expiry_date(value, expire))
426 return error(_("%s' for '%s' is not a valid timestamp"),
427 value, var);
428 return 0;
431 /* expiry timer slot */
432 #define EXPIRE_TOTAL 01
433 #define EXPIRE_UNREACH 02
435 static int reflog_expire_config(const char *var, const char *value, void *cb)
437 const char *pattern, *key;
438 int pattern_len;
439 unsigned long expire;
440 int slot;
441 struct reflog_expire_cfg *ent;
443 if (parse_config_key(var, "gc", &pattern, &pattern_len, &key) < 0)
444 return git_default_config(var, value, cb);
446 if (!strcmp(key, "reflogexpire")) {
447 slot = EXPIRE_TOTAL;
448 if (parse_expire_cfg_value(var, value, &expire))
449 return -1;
450 } else if (!strcmp(key, "reflogexpireunreachable")) {
451 slot = EXPIRE_UNREACH;
452 if (parse_expire_cfg_value(var, value, &expire))
453 return -1;
454 } else
455 return git_default_config(var, value, cb);
457 if (!pattern) {
458 switch (slot) {
459 case EXPIRE_TOTAL:
460 default_reflog_expire = expire;
461 break;
462 case EXPIRE_UNREACH:
463 default_reflog_expire_unreachable = expire;
464 break;
466 return 0;
469 ent = find_cfg_ent(pattern, pattern_len);
470 if (!ent)
471 return -1;
472 switch (slot) {
473 case EXPIRE_TOTAL:
474 ent->expire_total = expire;
475 break;
476 case EXPIRE_UNREACH:
477 ent->expire_unreachable = expire;
478 break;
480 return 0;
483 static void set_reflog_expiry_param(struct cmd_reflog_expire_cb *cb, int slot, const char *ref)
485 struct reflog_expire_cfg *ent;
487 if (slot == (EXPIRE_TOTAL|EXPIRE_UNREACH))
488 return; /* both given explicitly -- nothing to tweak */
490 for (ent = reflog_expire_cfg; ent; ent = ent->next) {
491 if (!wildmatch(ent->pattern, ref, 0, NULL)) {
492 if (!(slot & EXPIRE_TOTAL))
493 cb->expire_total = ent->expire_total;
494 if (!(slot & EXPIRE_UNREACH))
495 cb->expire_unreachable = ent->expire_unreachable;
496 return;
501 * If unconfigured, make stash never expire
503 if (!strcmp(ref, "refs/stash")) {
504 if (!(slot & EXPIRE_TOTAL))
505 cb->expire_total = 0;
506 if (!(slot & EXPIRE_UNREACH))
507 cb->expire_unreachable = 0;
508 return;
511 /* Nothing matched -- use the default value */
512 if (!(slot & EXPIRE_TOTAL))
513 cb->expire_total = default_reflog_expire;
514 if (!(slot & EXPIRE_UNREACH))
515 cb->expire_unreachable = default_reflog_expire_unreachable;
518 static int cmd_reflog_expire(int argc, const char **argv, const char *prefix)
520 struct expire_reflog_policy_cb cb;
521 unsigned long now = time(NULL);
522 int i, status, do_all;
523 int explicit_expiry = 0;
524 unsigned int flags = 0;
526 default_reflog_expire_unreachable = now - 30 * 24 * 3600;
527 default_reflog_expire = now - 90 * 24 * 3600;
528 git_config(reflog_expire_config, NULL);
530 save_commit_buffer = 0;
531 do_all = status = 0;
532 memset(&cb, 0, sizeof(cb));
534 cb.cmd.expire_total = default_reflog_expire;
535 cb.cmd.expire_unreachable = default_reflog_expire_unreachable;
537 for (i = 1; i < argc; i++) {
538 const char *arg = argv[i];
539 if (!strcmp(arg, "--dry-run") || !strcmp(arg, "-n"))
540 flags |= EXPIRE_REFLOGS_DRY_RUN;
541 else if (starts_with(arg, "--expire=")) {
542 if (parse_expiry_date(arg + 9, &cb.cmd.expire_total))
543 die(_("'%s' is not a valid timestamp"), arg);
544 explicit_expiry |= EXPIRE_TOTAL;
546 else if (starts_with(arg, "--expire-unreachable=")) {
547 if (parse_expiry_date(arg + 21, &cb.cmd.expire_unreachable))
548 die(_("'%s' is not a valid timestamp"), arg);
549 explicit_expiry |= EXPIRE_UNREACH;
551 else if (!strcmp(arg, "--stale-fix"))
552 cb.cmd.stalefix = 1;
553 else if (!strcmp(arg, "--rewrite"))
554 flags |= EXPIRE_REFLOGS_REWRITE;
555 else if (!strcmp(arg, "--updateref"))
556 flags |= EXPIRE_REFLOGS_UPDATE_REF;
557 else if (!strcmp(arg, "--all"))
558 do_all = 1;
559 else if (!strcmp(arg, "--verbose"))
560 flags |= EXPIRE_REFLOGS_VERBOSE;
561 else if (!strcmp(arg, "--")) {
562 i++;
563 break;
565 else if (arg[0] == '-')
566 usage(reflog_expire_usage);
567 else
568 break;
572 * We can trust the commits and objects reachable from refs
573 * even in older repository. We cannot trust what's reachable
574 * from reflog if the repository was pruned with older git.
576 if (cb.cmd.stalefix) {
577 init_revisions(&cb.cmd.revs, prefix);
578 if (flags & EXPIRE_REFLOGS_VERBOSE)
579 printf("Marking reachable objects...");
580 mark_reachable_objects(&cb.cmd.revs, 0, 0, NULL);
581 if (flags & EXPIRE_REFLOGS_VERBOSE)
582 putchar('\n');
585 if (do_all) {
586 struct collect_reflog_cb collected;
587 int i;
589 memset(&collected, 0, sizeof(collected));
590 for_each_reflog(collect_reflog, &collected);
591 for (i = 0; i < collected.nr; i++) {
592 struct collected_reflog *e = collected.e[i];
593 set_reflog_expiry_param(&cb.cmd, explicit_expiry, e->reflog);
594 status |= reflog_expire(e->reflog, e->sha1, flags,
595 reflog_expiry_prepare,
596 should_expire_reflog_ent,
597 reflog_expiry_cleanup,
598 &cb);
599 free(e);
601 free(collected.e);
604 for (; i < argc; i++) {
605 char *ref;
606 unsigned char sha1[20];
607 if (!dwim_log(argv[i], strlen(argv[i]), sha1, &ref)) {
608 status |= error("%s points nowhere!", argv[i]);
609 continue;
611 set_reflog_expiry_param(&cb.cmd, explicit_expiry, ref);
612 status |= reflog_expire(ref, sha1, flags,
613 reflog_expiry_prepare,
614 should_expire_reflog_ent,
615 reflog_expiry_cleanup,
616 &cb);
618 return status;
621 static int count_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
622 const char *email, unsigned long timestamp, int tz,
623 const char *message, void *cb_data)
625 struct expire_reflog_policy_cb *cb = cb_data;
626 if (!cb->cmd.expire_total || timestamp < cb->cmd.expire_total)
627 cb->cmd.recno++;
628 return 0;
631 static int cmd_reflog_delete(int argc, const char **argv, const char *prefix)
633 struct expire_reflog_policy_cb cb;
634 int i, status = 0;
635 unsigned int flags = 0;
637 memset(&cb, 0, sizeof(cb));
639 for (i = 1; i < argc; i++) {
640 const char *arg = argv[i];
641 if (!strcmp(arg, "--dry-run") || !strcmp(arg, "-n"))
642 flags |= EXPIRE_REFLOGS_DRY_RUN;
643 else if (!strcmp(arg, "--rewrite"))
644 flags |= EXPIRE_REFLOGS_REWRITE;
645 else if (!strcmp(arg, "--updateref"))
646 flags |= EXPIRE_REFLOGS_UPDATE_REF;
647 else if (!strcmp(arg, "--verbose"))
648 flags |= EXPIRE_REFLOGS_VERBOSE;
649 else if (!strcmp(arg, "--")) {
650 i++;
651 break;
653 else if (arg[0] == '-')
654 usage(reflog_delete_usage);
655 else
656 break;
659 if (argc - i < 1)
660 return error("Nothing to delete?");
662 for ( ; i < argc; i++) {
663 const char *spec = strstr(argv[i], "@{");
664 unsigned char sha1[20];
665 char *ep, *ref;
666 int recno;
668 if (!spec) {
669 status |= error("Not a reflog: %s", argv[i]);
670 continue;
673 if (!dwim_log(argv[i], spec - argv[i], sha1, &ref)) {
674 status |= error("no reflog for '%s'", argv[i]);
675 continue;
678 recno = strtoul(spec + 2, &ep, 10);
679 if (*ep == '}') {
680 cb.cmd.recno = -recno;
681 for_each_reflog_ent(ref, count_reflog_ent, &cb);
682 } else {
683 cb.cmd.expire_total = approxidate(spec + 2);
684 for_each_reflog_ent(ref, count_reflog_ent, &cb);
685 cb.cmd.expire_total = 0;
688 status |= reflog_expire(ref, sha1, flags,
689 reflog_expiry_prepare,
690 should_expire_reflog_ent,
691 reflog_expiry_cleanup,
692 &cb);
693 free(ref);
695 return status;
699 * main "reflog"
702 static const char reflog_usage[] =
703 "git reflog [ show | expire | delete ]";
705 int cmd_reflog(int argc, const char **argv, const char *prefix)
707 if (argc > 1 && !strcmp(argv[1], "-h"))
708 usage(reflog_usage);
710 /* With no command, we default to showing it. */
711 if (argc < 2 || *argv[1] == '-')
712 return cmd_log_reflog(argc, argv, prefix);
714 if (!strcmp(argv[1], "show"))
715 return cmd_log_reflog(argc - 1, argv + 1, prefix);
717 if (!strcmp(argv[1], "expire"))
718 return cmd_reflog_expire(argc - 1, argv + 1, prefix);
720 if (!strcmp(argv[1], "delete"))
721 return cmd_reflog_delete(argc - 1, argv + 1, prefix);
723 return cmd_log_reflog(argc, argv, prefix);