Re: [RFC v2][PATCH 2/9] General infrastructure for checkpoint restart

Dave Hansen
2008-08-22T20:02:05Z

On Wed, 2008-08-20 at 23:04 -0400, Oren Laadan wrote:
> index f3e2065..584c8f9 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -619,7 +619,7 @@ export mod_strip_cmd
>
>
> ifeq ($(KBUILD_EXTMOD),)
> -core-y += kernel/ mm/ fs/ ipc/ security/ crypto/ block/
> +core-y += kernel/ mm/ fs/ ipc/ security/ crypto/ block/ checkpoint/
>
> vmlinux-dirs := $(patsubst %/,%,$(filter %/, $(init-y) $(init-m) \
> $(core-y) $(core-m) $(drivers-y) $(drivers-m) \
> diff --git a/checkpoint/Makefile b/checkpoint/Makefile
> new file mode 100644
> index 0000000..d129878
> --- /dev/null
> +++ b/checkpoint/Makefile
> @@ -0,0 +1 @@
> +obj-y += sys.o checkpoint.o restart.o
> diff --git a/checkpoint/checkpoint.c b/checkpoint/checkpoint.c
> new file mode 100644
> index 0000000..25343f5
> --- /dev/null
> +++ b/checkpoint/checkpoint.c
> @@ -0,0 +1,191 @@
> +/*
> + * Checkpoint logic and helpers
> + *
> + * Copyright (C) 2008 Oren Laadan
> + *
> + * This file is subject to the terms and conditions of the GNU General Public
> + * License. See the file COPYING in the main directory of the Linux
> + * distribution for more details.
> + */
> +
> +#include <linux/version.h>
> +#include <linux/sched.h>
> +#include <linux/time.h>
> +#include <linux/fs.h>
> +#include <linux/file.h>
> +#include <linux/dcache.h>
> +#include <linux/mount.h>
> +#include <linux/utsname.h>
> +#include <asm/ptrace.h>
> +
> +#include "ckpt.h"
> +#include "ckpt_hdr.h"
> +
> +/**
> + * cr_fill_fname - return pathname of a given file
> + * @file: file pointer
> + * @buf: buffer for pathname
> + * @n: buffer length (in) and pathname length (out)
> + */
> +char *cr_fill_fname(struct path *path, struct path *root, char *buf, int *n)
> +{
> + char *fname;
> +
> + BUG_ON(!buf);
> + fname = __d_path(path, root, buf, *n);
> + if (!IS_ERR(fname))
> + *n = (buf + (*n) - fname);
> + return fname;
> +}
> +
> +/**
> + * cr_write_obj - write a record described by a cr_hdr
> + * @ctx: checkpoint context
> + * @h: record descriptor
> + * @buf: record buffer
> + */
> +int cr_write_obj(struct cr_ctx *ctx, struct cr_hdr *h, void *buf)
> +{
> + int ret;
> +
> + if ((ret = cr_kwrite(ctx, h, sizeof(*h))) < 0)
> + return ret;

These all need to be fixed up to Linux style:

ret = = cr_kwrite(ctx, h, sizeof(*h)));
if (ret < 0)
...;

You might want to try checkpatch.pl on these. It is pretty good at
finding this stuff.

> +/* write the checkpoint header */
> +static int cr_write_hdr(struct cr_ctx *ctx)
> +{
> + struct cr_hdr h;
> + struct cr_hdr_head *hh = ctx->hbuf;
> + struct new_utsname *uts;
> + struct timeval ktv;
> +
> + h.type = CR_HDR_HEAD;
> + h.len = sizeof(*hh);
> + h.ptag = 0;
> +
> + do_gettimeofday(&ktv);
> +
> + hh->magic = CR_MAGIC_HEAD;
> + hh->major = (LINUX_VERSION_CODE >> 16) & 0xff;
> + hh->minor = (LINUX_VERSION_CODE >> 8) & 0xff;
> + hh->patch = (LINUX_VERSION_CODE) & 0xff;

We at least neex EXTRAVERSION in there if we're going to even pretend
this is useful, right? is this redundant with utsname() below?

> + hh->rev = CR_VERSION;
> +
> + hh->flags = ctx->flags;
> + hh->time = ktv.tv_sec;
> +
> + uts = utsname();
> + memcpy(hh->release, uts->release, __NEW_UTS_LEN);
> + memcpy(hh->version, uts->version, __NEW_UTS_LEN);
> + memcpy(hh->machine, uts->machine, __NEW_UTS_LEN);
> +
> + return cr_write_obj(ctx, &h, hh);
> +}
> +
> +/* write the checkpoint trailer */
> +static int cr_write_tail(struct cr_ctx *ctx)
> +{
> + struct cr_hdr h;
> + struct cr_hdr_tail *hh = ctx->hbuf;
> +
> + h.type = CR_HDR_TAIL;
> + h.len = sizeof(*hh);
> + h.ptag = 0;
> +
> + hh->magic = CR_MAGIC_TAIL;
> + hh->cksum = 1; /* TBD ... */
> +
> + return cr_write_obj(ctx, &h, hh);
> +}
> +
> +/* dump the task_struct of a given task */
> +static int cr_write_task_struct(struct cr_ctx *ctx, struct task_struct *t)
> +{
> + struct cr_hdr h;
> + struct cr_hdr_task *hh = ctx->hbuf;
> +
> + h.type = CR_HDR_TASK;
> + h.len = sizeof(*hh);
> + h.ptag = 0;
> +
> + hh->state = t->state;
> + hh->exit_state = t->exit_state;
> + hh->exit_code = t->exit_code;
> + hh->exit_signal = t->exit_signal;
> +
> + hh->utime = t->utime;
> + hh->stime = t->stime;
> + hh->utimescaled = t->utimescaled;
> + hh->stimescaled = t->stimescaled;
> + hh->gtime = t->gtime;
> + hh->prev_utime = t->prev_utime;
> + hh->prev_stime = t->prev_stime;
> + hh->nvcsw = t->nvcsw;
> + hh->nivcsw = t->nivcsw;
> + hh->start_time_sec = t->start_time.tv_sec;
> + hh->start_time_nsec = t->start_time.tv_nsec;
> + hh->real_start_time_sec = t->real_start_time.tv_sec;
> + hh->real_start_time_nsec = t->real_start_time.tv_nsec;
> + hh->min_flt = t->min_flt;
> + hh->maj_flt = t->maj_flt;
> +
> + hh->task_comm_len = TASK_COMM_LEN;
> + memcpy(hh->comm, t->comm, TASK_COMM_LEN);
> +
> + return cr_write_obj(ctx, &h, hh);
> +}
> +
> +/* dump the entire state of a given task */
> +static int cr_write_task(struct cr_ctx *ctx, struct task_struct *t)
> +{
> + int ret ;
> +
> + if (t->state == TASK_DEAD) {
> + pr_warning("CR: task may not be in state TASK_DEAD\n");
> + return -EAGAIN;
> + }
> +
> + ret = cr_write_task_struct(ctx, t);
> + cr_debug("ret %d\n", ret);
> +
> + return ret;
> +}
> +
> +int do_checkpoint(struct cr_ctx *ctx)
> +{
> + int ret;
> +
> + /* FIX: need to test whether container is checkpointable */
> +
> + ret = cr_write_hdr(ctx);
> + if (!ret)
> + ret = cr_write_task(ctx, current);
> + if (!ret)
> + ret = cr_write_tail(ctx);
> +
> + /* on success, return (unique) checkpoint identifier */
> + if (!ret)
> + ret = ctx->crid;
> +
> + return ret;
> +}
> diff --git a/checkpoint/ckpt.h b/checkpoint/ckpt.h
> new file mode 100644
> index 0000000..7ecafb3
> --- /dev/null
> +++ b/checkpoint/ckpt.h
> @@ -0,0 +1,71 @@
> +#ifndef _CHECKPOINT_CKPT_H_
> +#define _CHECKPOINT_CKPT_H_
> +/*
> + * Generic container checkpoint-restart
> + *
> + * Copyright (C) 2008 Oren Laadan
> + *
> + * This file is subject to the terms and conditions of the GNU General Public
> + * License. See the file COPYING in the main directory of the Linux
> + * distribution for more details.
> + */
> +
> +#include <linux/path.h>
> +#include <linux/fs.h>
> +
> +#define CR_VERSION 1
> +
> +struct cr_ctx {
> + pid_t pid; /* container identifier */
> + int crid; /* unique checkpoint id */
> +
> + unsigned long flags;
> + unsigned long oflags; /* restart: old flags */
> +
> + struct file *file;
> + int total; /* total read/written */
> +
> + void *tbuf; /* temp: to avoid many alloc/dealloc */
> + void *hbuf; /* header: to avoid many alloc/dealloc */
> + int hpos;

alloc/delloc is not a bad thing. :) I think at least a few of these
should be moved over to stack or kmalloc()/kfree().

> + struct path *vfsroot; /* container root */
> +};

Can a container only have one vfsroot?

> +
> +/* cr_ctx: flags */
> +#define CR_CTX_CKPT 0x1
> +#define CR_CTX_RSTR 0x2

enum?

> +/* allocation defaults */
> +#define CR_TBUF_ORDER 1
> +#define CR_TBUF_TOTAL (PAGE_SIZE << CR_TBUF_ORDER)
> +
> +#define CR_HBUF_ORDER 1
> +#define CR_HBUF_TOTAL (PAGE_SIZE << CR_HBUF_ORDER)
> +
> +char *cr_fill_fname(struct path *path, struct path *root, char *buf, int *n);
> +
> +int cr_uwrite(struct cr_ctx *ctx, void *buf, int count);
> +int cr_kwrite(struct cr_ctx *ctx, void *buf, int count);
> +int cr_uread(struct cr_ctx *ctx, void *buf, int count);
> +int cr_kread(struct cr_ctx *ctx, void *buf, int count);
> +
> +void *cr_hbuf_get(struct cr_ctx *ctx, int n);
> +void cr_hbuf_put(struct cr_ctx *ctx, int n);
> +
> +struct cr_hdr;
> +
> +int cr_write_obj(struct cr_ctx *ctx, struct cr_hdr *h, void *buf);
> +int cr_write_str(struct cr_ctx *ctx, char *str, int n);
> +
> +int cr_read_obj(struct cr_ctx *ctx, struct cr_hdr *h, void *buf, int n);
> +int cr_read_obj_type(struct cr_ctx *ctx, void *buf, int n, int type);
> +int cr_read_str(struct cr_ctx *ctx, void *str, int n);
> +
> +int do_checkpoint(struct cr_ctx *ctx);
> +int do_restart(struct cr_ctx *ctx);
> +
> +#define cr_debug(fmt, args...) \
> + pr_debug("[CR:%s] " fmt, __func__, ## args)
> +
> +#endif /* _CHECKPOINT_CKPT_H_ */
> diff --git a/checkpoint/ckpt_hdr.h b/checkpoint/ckpt_hdr.h
> new file mode 100644
> index 0000000..a478b7c
> --- /dev/null
> +++ b/checkpoint/ckpt_hdr.h
> @@ -0,0 +1,86 @@
> +#ifndef _CHECKPOINT_CKPT_HDR_H_
> +#define _CHECKPOINT_CKPT_HDR_H_
> +/*
> + * Generic container checkpoint-restart
> + *
> + * Copyright (C) 2008 Oren Laadan
> + *
> + * This file is subject to the terms and conditions of the GNU General Public
> + * License. See the file COPYING in the main directory of the Linux
> + * distribution for more details.
> + */
> +
> +#include <linux/types.h>
> +#include <linux/utsname.h>
> +
> +#define CR_MAGIC_HEAD 0x00feed0cc0a2d200LL
> +#define CR_MAGIC_TAIL 0x002d2a0cc0deef00LL

What happened to include/linux/magic.h?

> +/*
> + * To maintain compatibility between 32-bit and 64-bit architecture flavors,
> + * keep data 64-bit aligned: use padding for structure members, and use
> + * __attribute__ ((aligned (8))) for the entire structure.
> + */
> +
> +/* records: generic header */
> +
> +struct cr_hdr {
> + __s16 type;
> + __s16 len;
> + __u32 ptag;
> +};
> +
> +enum {
> + CR_HDR_HEAD = 1,
> + CR_HDR_STR,
> +
> + CR_HDR_TASK = 101,
> + CR_HDR_THREAD,
> + CR_HDR_CPU,
> +
> + CR_HDR_MM = 201,
> + CR_HDR_VMA,
> + CR_HDR_MM_CONTEXT,
> +
> + CR_HDR_TAIL = 5001
> +};
> +
> +struct cr_hdr_head {
> + __u64 magic;
> +
> + __u16 major;
> + __u16 minor;
> + __u16 patch;
> + __u16 rev;
> +
> + __u64 time; /* when checkpoint taken */
> + __u64 flags; /* checkpoint options */
> +
> + char release[__NEW_UTS_LEN];
> + char version[__NEW_UTS_LEN];
> + char machine[__NEW_UTS_LEN];
> +} __attribute__ ((aligned (8)));
> +
> +struct cr_hdr_tail {
> + __u64 magic;
> + __u64 cksum;
> +} __attribute__ ((aligned (8)));
> +
> +struct cr_hdr_task {
> + __u64 state;
> + __u32 exit_state;
> + __u32 exit_code, exit_signal;
> +
> + __u64 utime, stime, utimescaled, stimescaled;
> + __u64 gtime;
> + __u64 prev_utime, prev_stime;
> + __u64 nvcsw, nivcsw;
> + __u64 start_time_sec, start_time_nsec;
> + __u64 real_start_time_sec, real_start_time_nsec;
> + __u64 min_flt, maj_flt;
> +
> + __s16 task_comm_len;
> + char comm[TASK_COMM_LEN];
> +} __attribute__ ((aligned (8)));

TASK_COMM_LEN might be subject to changing. Can it be part of the
user<->kernel ABI?

...
> +/*
> + * During restart the code reads in data from the chekcpoint image into a
> + * temporary buffer (ctx->hbuf). Because operations can be nested, one
> + * should call cr_hbuf_get() to reserve space in the buffer, and then
> + * cr_hbuf_put() when it no longer needs that space
> + */
> +
> +#include <linux/version.h>
> +#include <linux/sched.h>
> +#include <linux/file.h>
> +
> +#include "ckpt.h"
> +#include "ckpt_hdr.h"
> +
> +/**
> + * cr_hbuf_get - reserve space on the hbuf
> + * @ctx: checkpoint context
> + * @n: number of bytes to reserve
> + */
> +void *cr_hbuf_get(struct cr_ctx *ctx, int n)
> +{
> + void *ptr;
> +
> + BUG_ON(ctx->hpos + n > CR_HBUF_TOTAL);
> + ptr = (void *) (((char *) ctx->hbuf) + ctx->hpos);
> + ctx->hpos += n;
> + return ptr;
> +}
> +
> +/**
> + * cr_hbuf_put - unreserve space on the hbuf
> + * @ctx: checkpoint context
> + * @n: number of bytes to reserve
> + */
> +void cr_hbuf_put(struct cr_ctx *ctx, int n)
> +{
> + BUG_ON(ctx->hpos < n);
> + ctx->hpos -= n;
> +}

I replaced all of the uses of these with kmalloc()/kfree() and stack
allocations. I'm really not sure what these buy us since our allocators
are already so fast. tbuf, especially, worries me if it gets used in
any kind of nested manner we're going to get some really fun bugs.

> +/**
> + * cr_read_obj_type - read a whole record of expected type
> + * @ctx: checkpoint context
> + * @buf: record buffer
> + * @n: available buffer size
> + * @type: expected record type
> + */
> +int cr_read_obj_type(struct cr_ctx *ctx, void *buf, int n, int type)
> +{
> + struct cr_hdr h;
> + int ret;
> +
> + ret = cr_read_obj(ctx, &h, buf, n);
> + if (!ret)
> + ret = (h.type == type ? h.ptag : -EINVAL);
> + return ret;
> +}

That ( ? : ) needs to get broken out so it is easier to read. This
function is already nice and tight as it is, so saving a line or two
doesn't really do any good.

> +/**
> + * cr_read_str - read a string record
> + * @ctx: checkpoint context
> + * @str: string buffer
> + * @n: string length
> + */
> +int cr_read_str(struct cr_ctx *ctx, void *str, int n)
> +{
> + return cr_read_obj_type(ctx, str, n, CR_HDR_STR);
> +}
> +
> +/* read the checkpoint header */
> +static int cr_read_hdr(struct cr_ctx *ctx)
> +{
> + struct cr_hdr_head *hh = cr_hbuf_get(ctx, sizeof(*hh));
> + int ret;
> +
> + ret = cr_read_obj_type(ctx, hh, sizeof(*hh), CR_HDR_HEAD);
> + if (ret < 0)
> + return ret;
> + else if (ret != 0)
> + return -EINVAL;

How about just making cr_read_obj_type() stop returning positive values?
Is it ever valid for it to return >0?

> + if (hh->magic != CR_MAGIC_HEAD || hh->rev != CR_VERSION ||
> + hh->major != ((LINUX_VERSION_CODE >> 16) & 0xff) ||
> + hh->minor != ((LINUX_VERSION_CODE >> 8) & 0xff) ||
> + hh->patch != ((LINUX_VERSION_CODE) & 0xff))
> + return -EINVAL;
> +
> + if (hh->flags & ~CR_CTX_CKPT)
> + return -EINVAL;
> +
> + ctx->oflags = hh->flags;
> +
> + /* FIX: verify compatibility of release, version and machine */
> +
> + cr_hbuf_put(ctx, sizeof(*hh));
> + return 0;
> +}
> +
> +/* read the checkpoint trailer */
> +static int cr_read_tail(struct cr_ctx *ctx)
> +{
> + struct cr_hdr_tail *hh = cr_hbuf_get(ctx, sizeof(*hh));
> + int ret;
> +
> + ret = cr_read_obj_type(ctx, hh, sizeof(*hh), CR_HDR_TAIL);
> + if (ret < 0)
> + return ret;
> + else if (ret != 0)
> + return -EINVAL;
> +
> + if (hh->magic != CR_MAGIC_TAIL || hh->cksum != 1)
> + return -EINVAL;

If we're not going to use the cksum, can it just be pulled out for now?

> + cr_hbuf_put(ctx, sizeof(*hh));
> + return 0;
> +}
> +
> +/* read the task_struct into the current task */
> +static int cr_read_task_struct(struct cr_ctx *ctx)
> +{
> + struct cr_hdr_task *hh = cr_hbuf_get(ctx, sizeof(*hh));
> + struct task_struct *t = current;
> + int ret;
> +
> + ret = cr_read_obj_type(ctx, hh, sizeof(*hh), CR_HDR_TASK);
> + if (ret < 0)
> + return ret;
> + else if (ret != 0)
> + return -EINVAL;
> +
> + /* for now, only restore t->comm */
> + if (hh->task_comm_len < 0 || hh->task_comm_len > TASK_COMM_LEN)
> + return -EINVAL;

Well, if TASK_COMM_LEN changed, then the size of the structure changed,
and the ABI changed. Uh oh.

> +int cr_uwrite(struct cr_ctx *ctx, void *buf, int count)
> +{
> + struct file *file = ctx->file;
> + ssize_t nwrite;
> + int nleft;
> +
> + for (nleft = count; nleft; nleft -= nwrite) {
> + loff_t pos = file_pos_read(file);
> + nwrite = vfs_write(file, (char __user *) buf, nleft, &pos);
> + file_pos_write(file, pos);
> + if (unlikely(nwrite <= 0)) /* zero tolerance */
> + return (nwrite ? : -EIO);

First of all, the unlikely() needs to die. This isn't
performance-critical code, and I don't see any justification for why it
is needed.

Also, errors like -EAGAIN are just fine and normal to come back from a
write to a file. We shoudn't be erroring out on them. (Note that this
is something that userspace would be handling by itself if we were doing
this in userspace.)

> +int cr_uread(struct cr_ctx *ctx, void *buf, int count)
> +{
> + struct file *file = ctx->file;
> + ssize_t nread;
> + int nleft;
> +
> + for (nleft = count; nleft; nleft -= nread) {
> + loff_t pos = file_pos_read(file);
> + nread = vfs_read(file, (char __user *) buf, nleft, &pos);
> + file_pos_write(file, pos);
> + if (unlikely(nread <= 0)) /* zero tolerance */
> + return (nread ? : -EIO);
> + buf += nread;
> + }
> +
> + ctx->total += count;
> + return 0;
> +}
> +
> +int cr_kread(struct cr_ctx *ctx, void *buf, int count)
> +{
> + mm_segment_t oldfs;
> + int ret;
> +
> + oldfs = get_fs();
> + set_fs(KERNEL_DS);
> + ret = cr_uread(ctx, buf, count);
> + set_fs(oldfs);
> +
> + return ret;
> +}
> +
> +
> +/*
> + * helpers to manage CR contexts: allocated for each checkpoint and/or
> + * restart operation, and persists until the operation is completed.
> + */
> +
> +static atomic_t cr_ctx_count; /* unique checkpoint identifier */
> +
> +void cr_ctx_free(struct cr_ctx *ctx)
> +{
> +
> + if (ctx->file)
> + fput(ctx->file);
> + if (ctx->vfsroot)
> + path_put(ctx->vfsroot);
> +
> + free_pages((unsigned long) ctx->tbuf, CR_TBUF_ORDER);
> + free_pages((unsigned long) ctx->hbuf, CR_HBUF_ORDER);
> +
> + kfree(ctx);
> +}
> +
> +struct cr_ctx *cr_ctx_alloc(pid_t pid, struct file *file, unsigned long flags)
> +{
> + struct cr_ctx *ctx;
> +
> + ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
> + if (!ctx)
> + return NULL;
> +
> + ctx->tbuf = (void *) __get_free_pages(GFP_KERNEL, CR_TBUF_ORDER);
> + ctx->hbuf = (void *) __get_free_pages(GFP_KERNEL, CR_HBUF_ORDER);
> + if (!ctx->tbuf || !ctx->hbuf)
> + goto nomem;

Any particular reason you're using __get_free_pages() here? kmalloc()
would save you a cast, and having to deal with keeping "order" vs. a
plain size. Also, why don't you just stick tbuf and hbuf's allocation
into the ctx structure itself for now? It'll save some of the error
paths. Yeah, it might become an order 2 or 3 allocation, but that
should be OK. We're not in interrupt context or anything.

> +/**
> + * sys_checkpoint - checkpoint a container
> + * @pid: pid of the container init(1) process
> + * @fd: file to which dump the checkpoint image
> + * @flags: checkpoint operation flags
> + */
> +asmlinkage long sys_checkpoint(pid_t pid, int fd, unsigned long flags)
> +{
> + struct cr_ctx *ctx;
> + struct file *file;
> + int fput_needed;
> + int ret;
> +
> + file = fget_light(fd, &fput_needed);
> + if (!file)
> + return -EBADF;
> +
> + /* no flags for now */
> + if (flags)
> + return -EINVAL;
> +
> + ctx = cr_ctx_alloc(pid, file, flags | CR_CTX_CKPT);
> + if (!ctx) {
> + fput_light(file, fput_needed);
> + return -ENOMEM;
> + }
> +
> + ret = do_checkpoint(ctx);
> +
> + cr_ctx_free(ctx);
> + fput_light(file, fput_needed);
> +
> + return ret;
> +}
> +
> +/**
> + * sys_restart - restart a container
> + * @crid: checkpoint image identifier
> + * @fd: file from which read the checkpoint image
> + * @flags: restart operation flags
> + */
> +asmlinkage long sys_restart(int crid, int fd, unsigned long flags)
> +{
> + struct cr_ctx *ctx;
> + struct file *file;
> + int fput_needed;
> + int ret;
> +
> + file = fget_light(fd, &fput_needed);
> + if (!file)
> + return -EBADF;
> +
> + /* no flags for now */
> + if (flags)
> + return -EINVAL;
> +
> + ctx = cr_ctx_alloc(crid, file, flags | CR_CTX_RSTR);
> + if (!ctx) {
> + fput_light(file, fput_needed);
> + return -ENOMEM;
> + }
> +
> + ret = do_restart(ctx);
> +
> + cr_ctx_free(ctx);
> + fput_light(file, fput_needed);
> +
> + return ret;
> +}

Should we just combine most of these two functions? If we passed a fd
into cr_ctx_alloc(), it could do the fget/put_light() bits, and we
wouldn't need the code in both sys_checkpoint() and sys_restart().

-- Dave