builtin-bundle.con commit git-bundle: various fixups (c2dea5a)
   1#include "cache.h"
   2#include "object.h"
   3#include "commit.h"
   4#include "diff.h"
   5#include "revision.h"
   6#include "list-objects.h"
   7#include "exec_cmd.h"
   8
   9/*
  10 * Basic handler for bundle files to connect repositories via sneakernet.
  11 * Invocation must include action.
  12 * This function can create a bundle or provide information on an existing
  13 * bundle supporting git-fetch, git-pull, and git-ls-remote
  14 */
  15
  16static const char *bundle_usage="git-bundle (create <bundle> <git-rev-list args> | verify <bundle> | list-heads <bundle> [refname]... | unbundle <bundle> [refname]... )";
  17
  18static const char bundle_signature[] = "# v2 git bundle\n";
  19
  20struct ref_list {
  21        unsigned int nr, alloc;
  22        struct ref_list_entry {
  23                unsigned char sha1[20];
  24                char *name;
  25        } *list;
  26};
  27
  28static void add_to_ref_list(const unsigned char *sha1, const char *name,
  29                struct ref_list *list)
  30{
  31        if (list->nr + 1 >= list->alloc) {
  32                list->alloc = alloc_nr(list->nr + 1);
  33                list->list = xrealloc(list->list,
  34                                list->alloc * sizeof(list->list[0]));
  35        }
  36        memcpy(list->list[list->nr].sha1, sha1, 20);
  37        list->list[list->nr].name = xstrdup(name);
  38        list->nr++;
  39}
  40
  41struct bundle_header {
  42        struct ref_list prerequisites;
  43        struct ref_list references;
  44};
  45
  46/* this function returns the length of the string */
  47static int read_string(int fd, char *buffer, int size)
  48{
  49        int i;
  50        for (i = 0; i < size - 1; i++) {
  51                int count = xread(fd, buffer + i, 1);
  52                if (count < 0)
  53                        return error("Read error: %s", strerror(errno));
  54                if (count == 0) {
  55                        i--;
  56                        break;
  57                }
  58                if (buffer[i] == '\n')
  59                        break;
  60        }
  61        buffer[i + 1] = '\0';
  62        return i + 1;
  63}
  64
  65/* returns an fd */
  66static int read_header(const char *path, struct bundle_header *header) {
  67        char buffer[1024];
  68        int fd = open(path, O_RDONLY);
  69
  70        if (fd < 0)
  71                return error("could not open '%s'", path);
  72        if (read_string(fd, buffer, sizeof(buffer)) < 0 ||
  73                        strcmp(buffer, bundle_signature)) {
  74                close(fd);
  75                return error("'%s' does not look like a v2 bundle file", path);
  76        }
  77        while (read_string(fd, buffer, sizeof(buffer)) > 0
  78                        && buffer[0] != '\n') {
  79                int is_prereq = buffer[0] == '-';
  80                int offset = is_prereq ? 1 : 0;
  81                int len = strlen(buffer);
  82                unsigned char sha1[20];
  83                struct ref_list *list = is_prereq ? &header->prerequisites
  84                        : &header->references;
  85                char delim;
  86
  87                if (buffer[len - 1] == '\n')
  88                        buffer[len - 1] = '\0';
  89                if (get_sha1_hex(buffer + offset, sha1)) {
  90                        warn("unrecognized header: %s", buffer);
  91                        continue;
  92                }
  93                delim = buffer[40 + offset];
  94                if (!isspace(delim) && (delim != '\0' || !is_prereq))
  95                        die ("invalid header: %s", buffer);
  96                add_to_ref_list(sha1, isspace(delim) ?
  97                                buffer + 41 + offset : "", list);
  98        }
  99        return fd;
 100}
 101
 102/* if in && *in >= 0, take that as input file descriptor instead */
 103static int fork_with_pipe(const char **argv, int *in, int *out)
 104{
 105        int needs_in, needs_out;
 106        int fdin[2], fdout[2], pid;
 107
 108        needs_in = in && *in < 0;
 109        if (needs_in) {
 110                if (pipe(fdin) < 0)
 111                        return error("could not setup pipe");
 112                *in = fdin[1];
 113        }
 114
 115        needs_out = out && *out < 0;
 116        if (needs_out) {
 117                if (pipe(fdout) < 0)
 118                        return error("could not setup pipe");
 119                *out = fdout[0];
 120        }
 121
 122        if ((pid = fork()) < 0) {
 123                if (needs_in) {
 124                        close(fdin[0]);
 125                        close(fdin[1]);
 126                }
 127                if (needs_out) {
 128                        close(fdout[0]);
 129                        close(fdout[1]);
 130                }
 131                return error("could not fork");
 132        }
 133        if (!pid) {
 134                if (needs_in) {
 135                        dup2(fdin[0], 0);
 136                        close(fdin[0]);
 137                        close(fdin[1]);
 138                } else if (in) {
 139                        dup2(*in, 0);
 140                        close(*in);
 141                }
 142                if (needs_out) {
 143                        dup2(fdout[1], 1);
 144                        close(fdout[0]);
 145                        close(fdout[1]);
 146                } else if (out) {
 147                        dup2(*out, 1);
 148                        close(*out);
 149                }
 150                exit(execv_git_cmd(argv));
 151        }
 152        if (needs_in)
 153                close(fdin[0]);
 154        else if (in)
 155                close(*in);
 156        if (needs_out)
 157                close(fdout[1]);
 158        else if (out)
 159                close(*out);
 160        return pid;
 161}
 162
 163#define PREREQ_MARK (1u<<16)
 164
 165static int verify_bundle(struct bundle_header *header)
 166{
 167        /*
 168         * Do fast check, then if any prereqs are missing then go line by line
 169         * to be verbose about the errors
 170         */
 171        struct ref_list *p = &header->prerequisites;
 172        struct rev_info revs;
 173        const char *argv[] = {NULL, "--all"};
 174        struct object_array refs;
 175        struct commit *commit;
 176        int i, ret = 0, req_nr;
 177        const char *message = "Repository lacks these prerequisite commits:";
 178
 179        init_revisions(&revs, NULL);
 180        for (i = 0; i < p->nr; i++) {
 181                struct ref_list_entry *e = p->list + i;
 182                struct object *o = parse_object(e->sha1);
 183                if (o) {
 184                        o->flags |= PREREQ_MARK;
 185                        add_pending_object(&revs, o, e->name);
 186                        continue;
 187                }
 188                if (++ret == 1)
 189                        error(message);
 190                error("%s %s", sha1_to_hex(e->sha1), e->name);
 191        }
 192        if (revs.pending.nr != p->nr)
 193                return ret;
 194        req_nr = revs.pending.nr;
 195        setup_revisions(2, argv, &revs, NULL);
 196
 197        memset(&refs, 0, sizeof(struct object_array));
 198        for (i = 0; i < revs.pending.nr; i++) {
 199                struct object_array_entry *e = revs.pending.objects + i;
 200                add_object_array(e->item, e->name, &refs);
 201        }
 202
 203        prepare_revision_walk(&revs);
 204
 205        i = req_nr;
 206        while (i && (commit = get_revision(&revs)))
 207                if (commit->object.flags & PREREQ_MARK)
 208                        i--;
 209
 210        for (i = 0; i < req_nr; i++)
 211                if (!(refs.objects[i].item->flags & SHOWN)) {
 212                        if (++ret == 1)
 213                                error(message);
 214                        error("%s %s", sha1_to_hex(refs.objects[i].item->sha1),
 215                                refs.objects[i].name);
 216                }
 217
 218        for (i = 0; i < refs.nr; i++)
 219                clear_commit_marks((struct commit *)refs.objects[i].item, -1);
 220
 221        return ret;
 222}
 223
 224static int list_heads(struct bundle_header *header, int argc, const char **argv)
 225{
 226        int i;
 227        struct ref_list *r = &header->references;
 228
 229        for (i = 0; i < r->nr; i++) {
 230                if (argc > 1) {
 231                        int j;
 232                        for (j = 1; j < argc; j++)
 233                                if (!strcmp(r->list[i].name, argv[j]))
 234                                        break;
 235                        if (j == argc)
 236                                continue;
 237                }
 238                printf("%s %s\n", sha1_to_hex(r->list[i].sha1),
 239                                r->list[i].name);
 240        }
 241        return 0;
 242}
 243
 244static void show_commit(struct commit *commit)
 245{
 246        write_or_die(1, sha1_to_hex(commit->object.sha1), 40);
 247        write_or_die(1, "\n", 1);
 248        if (commit->parents) {
 249                free_commit_list(commit->parents);
 250                commit->parents = NULL;
 251        }
 252}
 253
 254static void show_object(struct object_array_entry *p)
 255{
 256        /* An object with name "foo\n0000000..." can be used to
 257         * confuse downstream git-pack-objects very badly.
 258         */
 259        const char *ep = strchr(p->name, '\n');
 260        int len = ep ? ep - p->name : strlen(p->name);
 261        write_or_die(1, sha1_to_hex(p->item->sha1), 40);
 262        write_or_die(1, " ", 1);
 263        if (len)
 264                write_or_die(1, p->name, len);
 265        write_or_die(1, "\n", 1);
 266}
 267
 268static void show_edge(struct commit *commit)
 269{
 270        ; /* nothing to do */
 271}
 272
 273static int create_bundle(struct bundle_header *header, const char *path,
 274                int argc, const char **argv)
 275{
 276        int bundle_fd = -1;
 277        const char **argv_boundary = xmalloc((argc + 4) * sizeof(const char *));
 278        const char **argv_pack = xmalloc(4 * sizeof(const char *));
 279        int pid, in, out, i, status;
 280        char buffer[1024];
 281        struct rev_info revs;
 282        struct object_array tips;
 283
 284        bundle_fd = (!strcmp(path, "-") ? 1 :
 285                        open(path, O_CREAT | O_WRONLY, 0666));
 286        if (bundle_fd < 0)
 287                return error("Could not write to '%s'", path);
 288
 289        /* write signature */
 290        write_or_die(bundle_fd, bundle_signature, strlen(bundle_signature));
 291
 292        /* write prerequisites */
 293        memcpy(argv_boundary + 3, argv + 1, argc * sizeof(const char *));
 294        argv_boundary[0] = "rev-list";
 295        argv_boundary[1] = "--boundary";
 296        argv_boundary[2] = "--pretty=oneline";
 297        argv_boundary[argc + 2] = NULL;
 298        out = -1;
 299        pid = fork_with_pipe(argv_boundary, NULL, &out);
 300        if (pid < 0)
 301                return -1;
 302        while ((i = read_string(out, buffer, sizeof(buffer))) > 0)
 303                if (buffer[0] == '-')
 304                        write_or_die(bundle_fd, buffer, i);
 305        while ((i = waitpid(pid, &status, 0)) < 0)
 306                if (errno != EINTR)
 307                        return error("rev-list died");
 308        if (!WIFEXITED(status) || WEXITSTATUS(status))
 309                return error("rev-list died %d", WEXITSTATUS(status));
 310
 311        /* write references */
 312        save_commit_buffer = 0;
 313        init_revisions(&revs, NULL);
 314        revs.tag_objects = 1;
 315        revs.tree_objects = 1;
 316        revs.blob_objects = 1;
 317        argc = setup_revisions(argc, argv, &revs, NULL);
 318        if (argc > 1)
 319                return error("unrecognized argument: %s'", argv[1]);
 320
 321        memset(&tips, 0, sizeof(tips));
 322        for (i = 0; i < revs.pending.nr; i++) {
 323                struct object_array_entry *e = revs.pending.objects + i;
 324                unsigned char sha1[20];
 325                char *ref;
 326
 327                if (e->item->flags & UNINTERESTING)
 328                        continue;
 329                if (dwim_ref(e->name, strlen(e->name), sha1, &ref) != 1)
 330                        continue;
 331                write_or_die(bundle_fd, sha1_to_hex(e->item->sha1), 40);
 332                write_or_die(bundle_fd, " ", 1);
 333                write_or_die(bundle_fd, ref, strlen(ref));
 334                write_or_die(bundle_fd, "\n", 1);
 335                add_object_array(e->item, e->name, &tips);
 336                free(ref);
 337        }
 338
 339        /* end header */
 340        write_or_die(bundle_fd, "\n", 1);
 341
 342        /* write pack */
 343        argv_pack[0] = "pack-objects";
 344        argv_pack[1] = "--all-progress";
 345        argv_pack[2] = "--stdout";
 346        argv_pack[3] = NULL;
 347        in = -1;
 348        out = bundle_fd;
 349        pid = fork_with_pipe(argv_pack, &in, &out);
 350        if (pid < 0)
 351                return error("Could not spawn pack-objects");
 352        close(1);
 353        dup2(in, 1);
 354        close(in);
 355        prepare_revision_walk(&revs);
 356        mark_edges_uninteresting(revs.commits, &revs, show_edge);
 357        traverse_commit_list(&revs, show_commit, show_object);
 358        close(1);
 359        while (waitpid(pid, &status, 0) < 0)
 360                if (errno != EINTR)
 361                        return -1;
 362        if (!WIFEXITED(status) || WEXITSTATUS(status))
 363                return error ("pack-objects died");
 364
 365        /*
 366         * Make sure the refs we wrote out is correct; --max-count and
 367         * other limiting options could have prevented all the tips
 368         * from getting output.
 369         */
 370        status = 0;
 371        for (i = 0; i < tips.nr; i++) {
 372                if (!(tips.objects[i].item->flags & SHOWN)) {
 373                        status = 1;
 374                        error("%s: not included in the resulting pack",
 375                              tips.objects[i].name);
 376                }
 377        }
 378
 379        return status;
 380}
 381
 382static int unbundle(struct bundle_header *header, int bundle_fd,
 383                int argc, const char **argv)
 384{
 385        const char *argv_index_pack[] = {"index-pack", "--stdin", NULL};
 386        int pid, status, dev_null;
 387
 388        if (verify_bundle(header))
 389                return -1;
 390        dev_null = open("/dev/null", O_WRONLY);
 391        pid = fork_with_pipe(argv_index_pack, &bundle_fd, &dev_null);
 392        if (pid < 0)
 393                return error("Could not spawn index-pack");
 394        while (waitpid(pid, &status, 0) < 0)
 395                if (errno != EINTR)
 396                        return error("index-pack died");
 397        if (!WIFEXITED(status) || WEXITSTATUS(status))
 398                return error("index-pack exited with status %d",
 399                                WEXITSTATUS(status));
 400        return list_heads(header, argc, argv);
 401}
 402
 403int cmd_bundle(int argc, const char **argv, const char *prefix)
 404{
 405        struct bundle_header header;
 406        int nongit = 0;
 407        const char *cmd, *bundle_file;
 408        int bundle_fd = -1;
 409        char buffer[PATH_MAX];
 410
 411        if (argc < 3)
 412                usage(bundle_usage);
 413
 414        cmd = argv[1];
 415        bundle_file = argv[2];
 416        argc -= 2;
 417        argv += 2;
 418
 419        prefix = setup_git_directory_gently(&nongit);
 420        if (prefix && bundle_file[0] != '/') {
 421                snprintf(buffer, sizeof(buffer), "%s/%s", prefix, bundle_file);
 422                bundle_file = buffer;
 423        }
 424
 425        memset(&header, 0, sizeof(header));
 426        if (strcmp(cmd, "create") &&
 427                        !(bundle_fd = read_header(bundle_file, &header)))
 428                return 1;
 429
 430        if (!strcmp(cmd, "verify")) {
 431                close(bundle_fd);
 432                if (verify_bundle(&header))
 433                        return 1;
 434                fprintf(stderr, "%s is okay\n", bundle_file);
 435                return 0;
 436        }
 437        if (!strcmp(cmd, "list-heads")) {
 438                close(bundle_fd);
 439                return !!list_heads(&header, argc, argv);
 440        }
 441        if (!strcmp(cmd, "create")) {
 442                if (nongit)
 443                        die("Need a repository to create a bundle.");
 444                return !!create_bundle(&header, bundle_file, argc, argv);
 445        } else if (!strcmp(cmd, "unbundle")) {
 446                if (nongit)
 447                        die("Need a repository to unbundle.");
 448                return !!unbundle(&header, bundle_fd, argc, argv);
 449        } else
 450                usage(bundle_usage);
 451}
 452