reflog.c

   1 #include "cache.h"
   2 #include "object-store.h"
   3 #include "reflog.h"
   4 #include "refs.h"
   5 #include "revision.h"
   6 #include "worktree.h"
   7
   8 /* Remember to update object flag allocation in object.h */
   9 #define INCOMPLETE      (1u<<10)
  10 #define STUDYING        (1u<<11)
  11 #define REACHABLE       (1u<<12)
  12
  13 static int tree_is_complete(const struct object_id *oid)
  14 {
  15         struct tree_desc desc;
  16         struct name_entry entry;
  17         int complete;
  18         struct tree *tree;
  19
  20         tree = lookup_tree(the_repository, oid);
  21         if (!tree)
  22                 return 0;
  23         if (tree->object.flags & SEEN)
  24                 return 1;
  25         if (tree->object.flags & INCOMPLETE)
  26                 return 0;
  27
  28         if (!tree->buffer) {
  29                 enum object_type type;
  30                 unsigned long size;
  31                 void *data = read_object_file(oid, &type, &size);
  32                 if (!data) {
  33                         tree->object.flags |= INCOMPLETE;
  34                         return 0;
  35                 }
  36                 tree->buffer = data;
  37                 tree->size = size;
  38         }
  39         init_tree_desc(&desc, tree->buffer, tree->size);
  40         complete = 1;
  41         while (tree_entry(&desc, &entry)) {
  42                 if (!has_object_file(&entry.oid) ||
  43                     (S_ISDIR(entry.mode) && !tree_is_complete(&entry.oid))) {
  44                         tree->object.flags |= INCOMPLETE;
  45                         complete = 0;
  46                 }
  47         }
  48         free_tree_buffer(tree);
  49
  50         if (complete)
  51                 tree->object.flags |= SEEN;
  52         return complete;
  53 }
  54
  55 static int commit_is_complete(struct commit *commit)
  56 {
  57         struct object_array study;
  58         struct object_array found;
  59         int is_incomplete = 0;
  60         int i;
  61
  62         /* early return */
  63         if (commit->object.flags & SEEN)
  64                 return 1;
  65         if (commit->object.flags & INCOMPLETE)
  66                 return 0;
  67         /*
  68          * Find all commits that are reachable and are not marked as
  69          * SEEN.  Then make sure the trees and blobs contained are
  70          * complete.  After that, mark these commits also as SEEN.
  71          * If some of the objects that are needed to complete this
  72          * commit are missing, mark this commit as INCOMPLETE.
  73          */
  74         memset(&study, 0, sizeof(study));
  75         memset(&found, 0, sizeof(found));
  76         add_object_array(&commit->object, NULL, &study);
  77         add_object_array(&commit->object, NULL, &found);
  78         commit->object.flags |= STUDYING;
  79         while (study.nr) {
  80                 struct commit *c;
  81                 struct commit_list *parent;
  82
  83                 c = (struct commit *)object_array_pop(&study);
  84                 if (!c->object.parsed && !parse_object(the_repository, &c->object.oid))
  85                         c->object.flags |= INCOMPLETE;
  86
  87                 if (c->object.flags & INCOMPLETE) {
  88                         is_incomplete = 1;
  89                         break;
  90                 }
  91                 else if (c->object.flags & SEEN)
  92                         continue;
  93                 for (parent = c->parents; parent; parent = parent->next) {
  94                         struct commit *p = parent->item;
  95                         if (p->object.flags & STUDYING)
  96                                 continue;
  97                         p->object.flags |= STUDYING;
  98                         add_object_array(&p->object, NULL, &study);
  99                         add_object_array(&p->object, NULL, &found);
 100                 }
 101         }
 102         if (!is_incomplete) {
 103                 /*
 104                  * make sure all commits in "found" array have all the
 105                  * necessary objects.
 106                  */
 107                 for (i = 0; i < found.nr; i++) {
 108                         struct commit *c =
 109                                 (struct commit *)found.objects[i].item;
 110                         if (!tree_is_complete(get_commit_tree_oid(c))) {
 111                                 is_incomplete = 1;
 112                                 c->object.flags |= INCOMPLETE;
 113                         }
 114                 }
 115                 if (!is_incomplete) {
 116                         /* mark all found commits as complete, iow SEEN */
 117                         for (i = 0; i < found.nr; i++)
 118                                 found.objects[i].item->flags |= SEEN;
 119                 }
 120         }
 121         /* clear flags from the objects we traversed */
 122         for (i = 0; i < found.nr; i++)
 123                 found.objects[i].item->flags &= ~STUDYING;
 124         if (is_incomplete)
 125                 commit->object.flags |= INCOMPLETE;
 126         else {
 127                 /*
 128                  * If we come here, we have (1) traversed the ancestry chain
 129                  * from the "commit" until we reach SEEN commits (which are
 130                  * known to be complete), and (2) made sure that the commits
 131                  * encountered during the above traversal refer to trees that
 132                  * are complete.  Which means that we know *all* the commits
 133                  * we have seen during this process are complete.
 134                  */
 135                 for (i = 0; i < found.nr; i++)
 136                         found.objects[i].item->flags |= SEEN;
 137         }
 138         /* free object arrays */
 139         object_array_clear(&study);
 140         object_array_clear(&found);
 141         return !is_incomplete;
 142 }
 143
 144 static int keep_entry(struct commit **it, struct object_id *oid)
 145 {
 146         struct commit *commit;
 147
 148         if (is_null_oid(oid))
 149                 return 1;
 150         commit = lookup_commit_reference_gently(the_repository, oid, 1);
 151         if (!commit)
 152                 return 0;
 153
 154         /*
 155          * Make sure everything in this commit exists.
 156          *
 157          * We have walked all the objects reachable from the refs
 158          * and cache earlier.  The commits reachable by this commit
 159          * must meet SEEN commits -- and then we should mark them as
 160          * SEEN as well.
 161          */
 162         if (!commit_is_complete(commit))
 163                 return 0;
 164         *it = commit;
 165         return 1;
 166 }
 167
 168 /*
 169  * Starting from commits in the cb->mark_list, mark commits that are
 170  * reachable from them.  Stop the traversal at commits older than
 171  * the expire_limit and queue them back, so that the caller can call
 172  * us again to restart the traversal with longer expire_limit.
 173  */
 174 static void mark_reachable(struct expire_reflog_policy_cb *cb)
 175 {
 176         struct commit_list *pending;
 177         timestamp_t expire_limit = cb->mark_limit;
 178         struct commit_list *leftover = NULL;
 179
 180         for (pending = cb->mark_list; pending; pending = pending->next)
 181                 pending->item->object.flags &= ~REACHABLE;
 182
 183         pending = cb->mark_list;
 184         while (pending) {
 185                 struct commit_list *parent;
 186                 struct commit *commit = pop_commit(&pending);
 187                 if (commit->object.flags & REACHABLE)
 188                         continue;
 189                 if (parse_commit(commit))
 190                         continue;
 191                 commit->object.flags |= REACHABLE;
 192                 if (commit->date < expire_limit) {
 193                         commit_list_insert(commit, &leftover);
 194                         continue;
 195                 }
 196                 commit->object.flags |= REACHABLE;
 197                 parent = commit->parents;
 198                 while (parent) {
 199                         commit = parent->item;
 200                         parent = parent->next;
 201                         if (commit->object.flags & REACHABLE)
 202                                 continue;
 203                         commit_list_insert(commit, &pending);
 204                 }
 205         }
 206         cb->mark_list = leftover;
 207 }
 208
 209 static int unreachable(struct expire_reflog_policy_cb *cb, struct commit *commit, struct object_id *oid)
 210 {
 211         /*
 212          * We may or may not have the commit yet - if not, look it
 213          * up using the supplied sha1.
 214          */
 215         if (!commit) {
 216                 if (is_null_oid(oid))
 217                         return 0;
 218
 219                 commit = lookup_commit_reference_gently(the_repository, oid,
 220                                                         1);
 221
 222                 /* Not a commit -- keep it */
 223                 if (!commit)
 224                         return 0;
 225         }
 226
 227         /* Reachable from the current ref?  Don't prune. */
 228         if (commit->object.flags & REACHABLE)
 229                 return 0;
 230
 231         if (cb->mark_list && cb->mark_limit) {
 232                 cb->mark_limit = 0; /* dig down to the root */
 233                 mark_reachable(cb);
 234         }
 235
 236         return !(commit->object.flags & REACHABLE);
 237 }
 238
 239 /*
 240  * Return true iff the specified reflog entry should be expired.
 241  */
 242 int should_expire_reflog_ent(struct object_id *ooid, struct object_id *noid,
 243                              const char *email UNUSED,
 244                              timestamp_t timestamp, int tz UNUSED,
 245                              const char *message UNUSED, void *cb_data)
 246 {
 247         struct expire_reflog_policy_cb *cb = cb_data;
 248         struct commit *old_commit, *new_commit;
 249
 250         if (timestamp < cb->cmd.expire_total)
 251                 return 1;
 252
 253         old_commit = new_commit = NULL;
 254         if (cb->cmd.stalefix &&
 255             (!keep_entry(&old_commit, ooid) || !keep_entry(&new_commit, noid)))
 256                 return 1;
 257
 258         if (timestamp < cb->cmd.expire_unreachable) {
 259                 switch (cb->unreachable_expire_kind) {
 260                 case UE_ALWAYS:
 261                         return 1;
 262                 case UE_NORMAL:
 263                 case UE_HEAD:
 264                         if (unreachable(cb, old_commit, ooid) || unreachable(cb, new_commit, noid))
 265                                 return 1;
 266                         break;
 267                 }
 268         }
 269
 270         if (cb->cmd.recno && --(cb->cmd.recno) == 0)
 271                 return 1;
 272
 273         return 0;
 274 }
 275
 276 int should_expire_reflog_ent_verbose(struct object_id *ooid,
 277                                      struct object_id *noid,
 278                                      const char *email,
 279                                      timestamp_t timestamp, int tz,
 280                                      const char *message, void *cb_data)
 281 {
 282         struct expire_reflog_policy_cb *cb = cb_data;
 283         int expire;
 284
 285         expire = should_expire_reflog_ent(ooid, noid, email, timestamp, tz,
 286                                           message, cb);
 287
 288         if (!expire)
 289                 printf("keep %s", message);
 290         else if (cb->dry_run)
 291                 printf("would prune %s", message);
 292         else
 293                 printf("prune %s", message);
 294
 295         return expire;
 296 }
 297
 298 static int push_tip_to_list(const char *refname UNUSED,
 299                             const struct object_id *oid,
 300                             int flags, void *cb_data)
 301 {
 302         struct commit_list **list = cb_data;
 303         struct commit *tip_commit;
 304         if (flags & REF_ISSYMREF)
 305                 return 0;
 306         tip_commit = lookup_commit_reference_gently(the_repository, oid, 1);
 307         if (!tip_commit)
 308                 return 0;
 309         commit_list_insert(tip_commit, list);
 310         return 0;
 311 }
 312
 313 static int is_head(const char *refname)
 314 {
 315         const char *stripped_refname;
 316         parse_worktree_ref(refname, NULL, NULL, &stripped_refname);
 317         return !strcmp(stripped_refname, "HEAD");
 318 }
 319
 320 void reflog_expiry_prepare(const char *refname,
 321                            const struct object_id *oid,
 322                            void *cb_data)
 323 {
 324         struct expire_reflog_policy_cb *cb = cb_data;
 325         struct commit_list *elem;
 326         struct commit *commit = NULL;
 327
 328         if (!cb->cmd.expire_unreachable || is_head(refname)) {
 329                 cb->unreachable_expire_kind = UE_HEAD;
 330         } else {
 331                 commit = lookup_commit(the_repository, oid);
 332                 if (commit && is_null_oid(&commit->object.oid))
 333                         commit = NULL;
 334                 cb->unreachable_expire_kind = commit ? UE_NORMAL : UE_ALWAYS;
 335         }
 336
 337         if (cb->cmd.expire_unreachable <= cb->cmd.expire_total)
 338                 cb->unreachable_expire_kind = UE_ALWAYS;
 339
 340         switch (cb->unreachable_expire_kind) {
 341         case UE_ALWAYS:
 342                 return;
 343         case UE_HEAD:
 344                 for_each_ref(push_tip_to_list, &cb->tips);
 345                 for (elem = cb->tips; elem; elem = elem->next)
 346                         commit_list_insert(elem->item, &cb->mark_list);
 347                 break;
 348         case UE_NORMAL:
 349                 commit_list_insert(commit, &cb->mark_list);
 350                 /* For reflog_expiry_cleanup() below */
 351                 cb->tip_commit = commit;
 352         }
 353         cb->mark_limit = cb->cmd.expire_total;
 354         mark_reachable(cb);
 355 }
 356
 357 void reflog_expiry_cleanup(void *cb_data)
 358 {
 359         struct expire_reflog_policy_cb *cb = cb_data;
 360         struct commit_list *elem;
 361
 362         switch (cb->unreachable_expire_kind) {
 363         case UE_ALWAYS:
 364                 return;
 365         case UE_HEAD:
 366                 for (elem = cb->tips; elem; elem = elem->next)
 367                         clear_commit_marks(elem->item, REACHABLE);
 368                 free_commit_list(cb->tips);
 369                 break;
 370         case UE_NORMAL:
 371                 clear_commit_marks(cb->tip_commit, REACHABLE);
 372                 break;
 373         }
 374 }
 375
 376 int count_reflog_ent(struct object_id *ooid UNUSED,
 377                      struct object_id *noid UNUSED,
 378                      const char *email UNUSED,
 379                      timestamp_t timestamp, int tz UNUSED,
 380                      const char *message UNUSED, void *cb_data)
 381 {
 382         struct cmd_reflog_expire_cb *cb = cb_data;
 383         if (!cb->expire_total || timestamp < cb->expire_total)
 384                 cb->recno++;
 385         return 0;
 386 }
 387
 388 int reflog_delete(const char *rev, enum expire_reflog_flags flags, int verbose)
 389 {
 390         struct cmd_reflog_expire_cb cmd = { 0 };
 391         int status = 0;
 392         reflog_expiry_should_prune_fn *should_prune_fn = should_expire_reflog_ent;
 393         const char *spec = strstr(rev, "@{");
 394         char *ep, *ref;
 395         int recno;
 396         struct expire_reflog_policy_cb cb = {
 397                 .dry_run = !!(flags & EXPIRE_REFLOGS_DRY_RUN),
 398         };
 399
 400         if (verbose)
 401                 should_prune_fn = should_expire_reflog_ent_verbose;
 402
 403         if (!spec)
 404                 return error(_("not a reflog: %s"), rev);
 405
 406         if (!dwim_log(rev, spec - rev, NULL, &ref)) {
 407                 status |= error(_("no reflog for '%s'"), rev);
 408                 goto cleanup;
 409         }
 410
 411         recno = strtoul(spec + 2, &ep, 10);
 412         if (*ep == '}') {
 413                 cmd.recno = -recno;
 414                 for_each_reflog_ent(ref, count_reflog_ent, &cmd);
 415         } else {
 416                 cmd.expire_total = approxidate(spec + 2);
 417                 for_each_reflog_ent(ref, count_reflog_ent, &cmd);
 418                 cmd.expire_total = 0;
 419         }
 420
 421         cb.cmd = cmd;
 422         status |= reflog_expire(ref, flags,
 423                                 reflog_expiry_prepare,
 424                                 should_prune_fn,
 425                                 reflog_expiry_cleanup,
 426                                 &cb);
 427
 428  cleanup:
 429         free(ref);
 430         return status;
 431 }