criu/include/crtools.h

#ifndef CRTOOLS_H_
#define CRTOOLS_H_

#include <sys/types.h>

#include "types.h"
#include "list.h"

#include "image.h"

extern struct page_entry zero_page_entry;
extern void free_pstree(struct list_head *pstree_list);

#define CR_FD_PERM		(S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH)
#define CR_FD_PERM_DUMP		(S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)

enum {
	/*
	 * Task entries
	 */

	CR_FD_FDINFO,
	CR_FD_PAGES,
	CR_FD_CORE,
	CR_FD_VMAS,
	CR_FD_PIPES,
	CR_FD_SIGACT,
	CR_FD_UNIXSK,
	CR_FD_INETSK,
	CR_FD_ITIMERS,
	CR_FD_CREDS,

	/*
	 * Global entries
	 */

	CR_FD_PSTREE,
	CR_FD_UTSNS,
	CR_FD_IPCNS_VAR,
	CR_FD_IPCNS_SHM,
	CR_FD_IPCNS_MSG,
	CR_FD_IPCNS_SEM,

	CR_FD_SK_QUEUES,

	CR_FD_PID_MAX, /* fmt, pid */

	CR_FD_SHMEM_PAGES,
	CR_FD_REG_FILES,

	CR_FD_MAX
};

struct cr_options {
	int			final_state;
	char			*show_dump_file;
	bool			leader_only;
	bool			show_pages_content;
	bool			restore_detach;
	unsigned int		namespaces_flags;
};

enum {
	LOG_FD_OFF = 1,
	IMG_FD_OFF,
	SELF_EXE_FD_OFF,
};

int get_service_fd(int type);

/* file descriptors template */
struct cr_fd_desc_tmpl {
	const char	*fmt;			/* format for the name */
	u32		magic;			/* magic in the header */
};

extern struct cr_fd_desc_tmpl fdset_template[CR_FD_MAX];

#define FMT_FNAME_FDINFO	"fdinfo-%d.img"
#define FMT_FNAME_PAGES		"pages-%d.img"
#define FMT_FNAME_SHMEM_PAGES	"pages-shmem-%ld.img"
#define FMT_FNAME_REG_FILES	"reg-files.img"
#define FMT_FNAME_CORE		"core-%d.img"
#define FMT_FNAME_VMAS		"vmas-%d.img"
#define FMT_FNAME_PIPES		"pipes-%d.img"
#define FMT_FNAME_PSTREE	"pstree-%d.img"
#define FMT_FNAME_SIGACTS	"sigacts-%d.img"
#define FMT_FNAME_UNIXSK	"unixsk-%d.img"
#define FMT_FNAME_INETSK	"inetsk-%d.img"
#define FMT_FNAME_ITIMERS	"itimers-%d.img"
#define FMT_FNAME_CREDS		"creds-%d.img"
#define FMT_FNAME_UTSNS		"utsns-%d.img"
#define FMT_FNAME_IPCNS_VAR	"ipcns-var-%d.img"
#define FMT_FNAME_IPCNS_SHM	"ipcns-shm-%d.img"
#define FMT_FNAME_IPCNS_MSG	"ipcns-msg-%d.img"
#define FMT_FNAME_IPCNS_SEM	"ipcns-sem-%d.img"
#define FMT_FNAME_SK_QUEUES	"sk-queues-%d.img"

/*
 * FIXME -- this is required for legacy image copy only.
 * Don't use it for other reason and remove the former one.
 */
extern int image_dir_fd;
extern int open_image_dir(void);
extern void close_image_dir(void);

int open_image(int type, unsigned long flags, ...);
#define open_image_ro(type, ...) open_image(type, O_RDONLY, ##__VA_ARGS__)
extern int open_image_ro_nocheck(const char *fmt, ...);

#define LAST_PID_PATH		"/proc/sys/kernel/ns_last_pid"
#define LAST_PID_PERM		0666

struct cr_fdset {
	int fds[CR_FD_PID_MAX];
};

#define CR_FD_DESC_USE(type)		((1 << (type)))
#define CR_FD_DESC_CORE			CR_FD_DESC_USE(CR_FD_CORE)
#define CR_FD_DESC_PSTREE		CR_FD_DESC_USE(CR_FD_PSTREE)
#define CR_FD_DESC_SK_QUEUES		CR_FD_DESC_USE(CR_FD_SK_QUEUES)
#define CR_FD_DESC_TASK				(\
	CR_FD_DESC_USE(CR_FD_FDINFO)		|\
	CR_FD_DESC_USE(CR_FD_PAGES)		|\
	CR_FD_DESC_USE(CR_FD_CORE)		|\
	CR_FD_DESC_USE(CR_FD_VMAS)		|\
	CR_FD_DESC_USE(CR_FD_PIPES)		|\
	CR_FD_DESC_USE(CR_FD_SIGACT)		|\
	CR_FD_DESC_USE(CR_FD_UNIXSK)		|\
	CR_FD_DESC_USE(CR_FD_INETSK)		|\
	CR_FD_DESC_USE(CR_FD_ITIMERS)		|\
	CR_FD_DESC_USE(CR_FD_CREDS)		)
#define CR_FD_DESC_NS				(\
	CR_FD_DESC_USE(CR_FD_UTSNS)		|\
	CR_FD_DESC_USE(CR_FD_IPCNS_VAR)		|\
	CR_FD_DESC_USE(CR_FD_IPCNS_MSG)		|\
	CR_FD_DESC_USE(CR_FD_IPCNS_SEM)		|\
	CR_FD_DESC_USE(CR_FD_IPCNS_SHM)		)
#define CR_FD_DESC_NONE			(0)

int cr_dump_tasks(pid_t pid, const struct cr_options *opts);
int cr_restore_tasks(pid_t pid, struct cr_options *opts);
int cr_show(unsigned long pid, struct cr_options *opts);
int convert_to_elf(char *elf_path, int fd_core);
int cr_check(void);

struct cr_fdset *cr_dump_fdset_open(int pid, unsigned long use_mask, struct cr_fdset *);
struct cr_fdset *cr_show_fdset_open(int pid, unsigned long use_mask);
void close_cr_fdset(struct cr_fdset **cr_fdset);

void free_mappings(struct list_head *vma_area_list);

struct vma_area {
	struct list_head	list;
	struct vma_entry	vma;
	int			vm_file_fd;
};

#define vma_area_is(vma_area, s)	vma_entry_is(&((vma_area)->vma), s)
#define vma_area_len(vma_area)		vma_entry_len(&((vma_area)->vma))

struct pstree_item {
	struct list_head	list;
	pid_t			pid;		/* leader pid */
	pid_t			ppid;
	int			state;		/* TASK_XXX constants */
	int			nr_children;	/* number of children */
	int			nr_threads;	/* number of threads */
	u32			*threads;	/* array of threads */
	u32			*children;	/* array of children */
};

extern pid_t pstree_pid;

static inline int in_vma_area(struct vma_area *vma, unsigned long addr)
{
	return addr >= (unsigned long)vma->vma.start &&
		addr < (unsigned long)vma->vma.end;
}

#endif /* CRTOOLS_H_ */