[thirdparty/systemd.git] / src / import / import-tar.c

/* SPDX-License-Identifier: LGPL-2.1-or-later */

#include <linux/fs.h>

#include "sd-daemon.h"
#include "sd-event.h"

#include "alloc-util.h"
#include "btrfs-util.h"
#include "copy.h"
#include "fd-util.h"
#include "fileio.h"
#include "fs-util.h"
#include "hostname-util.h"
#include "import-common.h"
#include "import-compress.h"
#include "import-tar.h"
#include "io-util.h"
#include "machine-pool.h"
#include "mkdir.h"
#include "path-util.h"
#include "process-util.h"
#include "qcow2-util.h"
#include "ratelimit.h"
#include "rm-rf.h"
#include "string-util.h"
#include "tmpfile-util.h"
#include "util.h"

struct TarImport {
        sd_event *event;

        char *image_root;

        TarImportFinished on_finished;
        void *userdata;

        char *local;
        bool force_local;
        bool read_only;

        char *temp_path;
        char *final_path;

        int input_fd;
        int tar_fd;

        ImportCompress compress;

        sd_event_source *input_event_source;

        uint8_t buffer[16*1024];
        size_t buffer_size;

        uint64_t written_compressed;
        uint64_t written_uncompressed;

        struct stat st;

        pid_t tar_pid;

        unsigned last_percent;
        RateLimit progress_ratelimit;
};

TarImport* tar_import_unref(TarImport *i) {
        if (!i)
                return NULL;

        sd_event_source_unref(i->input_event_source);

        if (i->tar_pid > 1) {
                (void) kill_and_sigcont(i->tar_pid, SIGKILL);
                (void) wait_for_terminate(i->tar_pid, NULL);
        }

        if (i->temp_path) {
                (void) rm_rf(i->temp_path, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_SUBVOLUME);
                free(i->temp_path);
        }

        import_compress_free(&i->compress);

        sd_event_unref(i->event);

        safe_close(i->tar_fd);

        free(i->final_path);
        free(i->image_root);
        free(i->local);
        return mfree(i);
}

int tar_import_new(
                TarImport **ret,
                sd_event *event,
                const char *image_root,
                TarImportFinished on_finished,
                void *userdata) {

        _cleanup_(tar_import_unrefp) TarImport *i = NULL;
        _cleanup_free_ char *root = NULL;
        int r;

        assert(ret);

        root = strdup(image_root ?: "/var/lib/machines");
        if (!root)
                return -ENOMEM;

        i = new(TarImport, 1);
        if (!i)
                return -ENOMEM;

        *i = (TarImport) {
                .input_fd = -1,
                .tar_fd = -1,
                .on_finished = on_finished,
                .userdata = userdata,
                .last_percent = (unsigned) -1,
                .image_root = TAKE_PTR(root),
                .progress_ratelimit = { 100 * USEC_PER_MSEC, 1 },
        };

        if (event)
                i->event = sd_event_ref(event);
        else {
                r = sd_event_default(&i->event);
                if (r < 0)
                        return r;
        }

        *ret = TAKE_PTR(i);

        return 0;
}

static void tar_import_report_progress(TarImport *i) {
        unsigned percent;
        assert(i);

        /* We have no size information, unless the source is a regular file */
        if (!S_ISREG(i->st.st_mode))
                return;

        if (i->written_compressed >= (uint64_t) i->st.st_size)
                percent = 100;
        else
                percent = (unsigned) ((i->written_compressed * UINT64_C(100)) / (uint64_t) i->st.st_size);

        if (percent == i->last_percent)
                return;

        if (!ratelimit_below(&i->progress_ratelimit))
                return;

        sd_notifyf(false, "X_IMPORT_PROGRESS=%u", percent);
        log_info("Imported %u%%.", percent);

        i->last_percent = percent;
}

static int tar_import_finish(TarImport *i) {
        int r;

        assert(i);
        assert(i->tar_fd >= 0);
        assert(i->temp_path);
        assert(i->final_path);

        i->tar_fd = safe_close(i->tar_fd);

        if (i->tar_pid > 0) {
                r = wait_for_terminate_and_check("tar", i->tar_pid, WAIT_LOG);
                i->tar_pid = 0;
                if (r < 0)
                        return r;
                if (r != EXIT_SUCCESS)
                        return -EPROTO;
        }

        r = import_mangle_os_tree(i->temp_path);
        if (r < 0)
                return r;

        if (i->read_only) {
                r = import_make_read_only(i->temp_path);
                if (r < 0)
                        return r;
        }

        if (i->force_local)
                (void) rm_rf(i->final_path, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_SUBVOLUME);

        r = rename_noreplace(AT_FDCWD, i->temp_path, AT_FDCWD, i->final_path);
        if (r < 0)
                return log_error_errno(r, "Failed to move image into place: %m");

        i->temp_path = mfree(i->temp_path);

        return 0;
}

static int tar_import_fork_tar(TarImport *i) {
        int r;

        assert(i);

        assert(!i->final_path);
        assert(!i->temp_path);
        assert(i->tar_fd < 0);

        i->final_path = path_join(i->image_root, i->local);
        if (!i->final_path)
                return log_oom();

        r = tempfn_random(i->final_path, NULL, &i->temp_path);
        if (r < 0)
                return log_oom();

        (void) mkdir_parents_label(i->temp_path, 0700);

        r = btrfs_subvol_make_fallback(i->temp_path, 0755);
        if (r < 0)
                return log_error_errno(r, "Failed to create directory/subvolume %s: %m", i->temp_path);
        if (r > 0) /* actually btrfs subvol */
                (void) import_assign_pool_quota_and_warn(i->temp_path);

        i->tar_fd = import_fork_tar_x(i->temp_path, &i->tar_pid);
        if (i->tar_fd < 0)
                return i->tar_fd;

        return 0;
}

static int tar_import_write(const void *p, size_t sz, void *userdata) {
        TarImport *i = userdata;
        int r;

        r = loop_write(i->tar_fd, p, sz, false);
        if (r < 0)
                return r;

        i->written_uncompressed += sz;

        return 0;
}

static int tar_import_process(TarImport *i) {
        ssize_t l;
        int r;

        assert(i);
        assert(i->buffer_size < sizeof(i->buffer));

        l = read(i->input_fd, i->buffer + i->buffer_size, sizeof(i->buffer) - i->buffer_size);
        if (l < 0) {
                if (errno == EAGAIN)
                        return 0;

                r = log_error_errno(errno, "Failed to read input file: %m");
                goto finish;
        }
        if (l == 0) {
                if (i->compress.type == IMPORT_COMPRESS_UNKNOWN) {
                        log_error("Premature end of file.");
                        r = -EIO;
                        goto finish;
                }

                r = tar_import_finish(i);
                goto finish;
        }

        i->buffer_size += l;

        if (i->compress.type == IMPORT_COMPRESS_UNKNOWN) {
                r = import_uncompress_detect(&i->compress, i->buffer, i->buffer_size);
                if (r < 0) {
                        log_error_errno(r, "Failed to detect file compression: %m");
                        goto finish;
                }
                if (r == 0) /* Need more data */
                        return 0;

                r = tar_import_fork_tar(i);
                if (r < 0)
                        goto finish;
        }

        r = import_uncompress(&i->compress, i->buffer, i->buffer_size, tar_import_write, i);
        if (r < 0) {
                log_error_errno(r, "Failed to decode and write: %m");
                goto finish;
        }

        i->written_compressed += i->buffer_size;
        i->buffer_size = 0;

        tar_import_report_progress(i);

        return 0;

finish:
        if (i->on_finished)
                i->on_finished(i, r, i->userdata);
        else
                sd_event_exit(i->event, r);

        return 0;
}

static int tar_import_on_input(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
        TarImport *i = userdata;

        return tar_import_process(i);
}

static int tar_import_on_defer(sd_event_source *s, void *userdata) {
        TarImport *i = userdata;

        return tar_import_process(i);
}

int tar_import_start(TarImport *i, int fd, const char *local, bool force_local, bool read_only) {
        int r;

        assert(i);
        assert(fd >= 0);
        assert(local);

        if (!hostname_is_valid(local, 0))
                return -EINVAL;

        if (i->input_fd >= 0)
                return -EBUSY;

        r = fd_nonblock(fd, true);
        if (r < 0)
                return r;

        r = free_and_strdup(&i->local, local);
        if (r < 0)
                return r;
        i->force_local = force_local;
        i->read_only = read_only;

        if (fstat(fd, &i->st) < 0)
                return -errno;

        r = sd_event_add_io(i->event, &i->input_event_source, fd, EPOLLIN, tar_import_on_input, i);
        if (r == -EPERM) {
                /* This fd does not support epoll, for example because it is a regular file. Busy read in that case */
                r = sd_event_add_defer(i->event, &i->input_event_source, tar_import_on_defer, i);
                if (r < 0)
                        return r;

                r = sd_event_source_set_enabled(i->input_event_source, SD_EVENT_ON);
        }
        if (r < 0)
                return r;

        i->input_fd = fd;
        return r;
}
Commit	Line	Data
db9ecf05	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
b6e676ce LP	2
	3	#include <linux/fs.h>
	4
	5	#include "sd-daemon.h"
	6	#include "sd-event.h"
07630cea	7
b5efdb8a	8	#include "alloc-util.h"
b6e676ce LP	9	#include "btrfs-util.h"
b6e676ce LP	10	#include "copy.h"
3ffd4af2	11	#include "fd-util.h"
0d39fa9c	12	#include "fileio.h"
f4f15635	13	#include "fs-util.h"
07630cea LP	14	#include "hostname-util.h"
	15	#include "import-common.h"
	16	#include "import-compress.h"
3ffd4af2	17	#include "import-tar.h"
c004493c	18	#include "io-util.h"
b6e676ce	19	#include "machine-pool.h"
07630cea LP	20	#include "mkdir.h"
	21	#include "path-util.h"
	22	#include "process-util.h"
b6e676ce	23	#include "qcow2-util.h"
07630cea LP	24	#include "ratelimit.h"
	25	#include "rm-rf.h"
	26	#include "string-util.h"
e4de7287	27	#include "tmpfile-util.h"
07630cea	28	#include "util.h"
b6e676ce LP	29
	30	struct TarImport {
	31	sd_event *event;
	32
	33	char *image_root;
	34
	35	TarImportFinished on_finished;
	36	void *userdata;
	37
	38	char *local;
	39	bool force_local;
	40	bool read_only;
b6e676ce LP	41
	42	char *temp_path;
	43	char *final_path;
	44
	45	int input_fd;
	46	int tar_fd;
	47
	48	ImportCompress compress;
	49
b6e676ce LP	50	sd_event_source *input_event_source;
	51
	52	uint8_t buffer[16*1024];
	53	size_t buffer_size;
	54
	55	uint64_t written_compressed;
	56	uint64_t written_uncompressed;
	57
	58	struct stat st;
	59
	60	pid_t tar_pid;
	61
	62	unsigned last_percent;
5ac1530e	63	RateLimit progress_ratelimit;
b6e676ce LP	64	};
	65
	66	TarImport* tar_import_unref(TarImport *i) {
	67	if (!i)
	68	return NULL;
	69
587fec42	70	sd_event_source_unref(i->input_event_source);
b6e676ce LP	71
	72	if (i->tar_pid > 1) {
	73	(void) kill_and_sigcont(i->tar_pid, SIGKILL);
	74	(void) wait_for_terminate(i->tar_pid, NULL);
	75	}
	76
	77	if (i->temp_path) {
d9e2daaf	78	(void) rm_rf(i->temp_path, REMOVE_ROOT\|REMOVE_PHYSICAL\|REMOVE_SUBVOLUME);
b6e676ce LP	79	free(i->temp_path);
	80	}
	81
	82	import_compress_free(&i->compress);
	83
587fec42	84	sd_event_unref(i->event);
b6e676ce LP	85
	86	safe_close(i->tar_fd);
	87
	88	free(i->final_path);
	89	free(i->image_root);
	90	free(i->local);
6b430fdb	91	return mfree(i);
b6e676ce LP	92	}
	93
	94	int tar_import_new(
	95	TarImport **ret,
	96	sd_event *event,
	97	const char *image_root,
	98	TarImportFinished on_finished,
	99	void *userdata) {
	100
	101	_cleanup_(tar_import_unrefp) TarImport *i = NULL;
0d94088e	102	_cleanup_free_ char *root = NULL;
b6e676ce LP	103	int r;
	104
	105	assert(ret);
	106
0d94088e YW	107	root = strdup(image_root ?: "/var/lib/machines");
0d94088e YW	108	if (!root)
b6e676ce LP	109	return -ENOMEM;
b6e676ce LP	110
0d94088e YW	111	i = new(TarImport, 1);
0d94088e YW	112	if (!i)
b6e676ce LP	113	return -ENOMEM;
b6e676ce LP	114
0d94088e YW	115	*i = (TarImport) {
	116	.input_fd = -1,
	117	.tar_fd = -1,
	118	.on_finished = on_finished,
	119	.userdata = userdata,
	120	.last_percent = (unsigned) -1,
	121	.image_root = TAKE_PTR(root),
5ac1530e	122	.progress_ratelimit = { 100 * USEC_PER_MSEC, 1 },
0d94088e YW	123	};
0d94088e YW	124
b6e676ce LP	125	if (event)
	126	i->event = sd_event_ref(event);
	127	else {
	128	r = sd_event_default(&i->event);
	129	if (r < 0)
	130	return r;
	131	}
	132
1cc6c93a	133	*ret = TAKE_PTR(i);
b6e676ce LP	134
	135	return 0;
	136	}
	137
	138	static void tar_import_report_progress(TarImport *i) {
	139	unsigned percent;
	140	assert(i);
	141
	142	/* We have no size information, unless the source is a regular file */
	143	if (!S_ISREG(i->st.st_mode))
	144	return;
	145
	146	if (i->written_compressed >= (uint64_t) i->st.st_size)
	147	percent = 100;
	148	else
	149	percent = (unsigned) ((i->written_compressed * UINT64_C(100)) / (uint64_t) i->st.st_size);
	150
	151	if (percent == i->last_percent)
	152	return;
	153
5ac1530e	154	if (!ratelimit_below(&i->progress_ratelimit))
b6e676ce LP	155	return;
	156
	157	sd_notifyf(false, "X_IMPORT_PROGRESS=%u", percent);
	158	log_info("Imported %u%%.", percent);
	159
	160	i->last_percent = percent;
	161	}
	162
	163	static int tar_import_finish(TarImport *i) {
	164	int r;
	165
	166	assert(i);
	167	assert(i->tar_fd >= 0);
	168	assert(i->temp_path);
	169	assert(i->final_path);
	170
	171	i->tar_fd = safe_close(i->tar_fd);
	172
	173	if (i->tar_pid > 0) {
7d4904fe	174	r = wait_for_terminate_and_check("tar", i->tar_pid, WAIT_LOG);
b6e676ce LP	175	i->tar_pid = 0;
	176	if (r < 0)
	177	return r;
d02bfa50 LP	178	if (r != EXIT_SUCCESS)
d02bfa50 LP	179	return -EPROTO;
b6e676ce LP	180	}
b6e676ce LP	181
e21b7229 LP	182	r = import_mangle_os_tree(i->temp_path);
	183	if (r < 0)
	184	return r;
	185
b6e676ce LP	186	if (i->read_only) {
	187	r = import_make_read_only(i->temp_path);
	188	if (r < 0)
	189	return r;
	190	}
	191
d9e2daaf LP	192	if (i->force_local)
d9e2daaf LP	193	(void) rm_rf(i->final_path, REMOVE_ROOT\|REMOVE_PHYSICAL\|REMOVE_SUBVOLUME);
b6e676ce	194
f85ef957 AC	195	r = rename_noreplace(AT_FDCWD, i->temp_path, AT_FDCWD, i->final_path);
	196	if (r < 0)
	197	return log_error_errno(r, "Failed to move image into place: %m");
b6e676ce	198
a1e58e8e	199	i->temp_path = mfree(i->temp_path);
b6e676ce LP	200
	201	return 0;
	202	}
	203
	204	static int tar_import_fork_tar(TarImport *i) {
	205	int r;
	206
	207	assert(i);
	208
	209	assert(!i->final_path);
	210	assert(!i->temp_path);
	211	assert(i->tar_fd < 0);
	212
657ee2d8	213	i->final_path = path_join(i->image_root, i->local);
b6e676ce LP	214	if (!i->final_path)
	215	return log_oom();
	216
14bcf25c	217	r = tempfn_random(i->final_path, NULL, &i->temp_path);
b6e676ce LP	218	if (r < 0)
	219	return log_oom();
	220
	221	(void) mkdir_parents_label(i->temp_path, 0700);
	222
82c4440d LP	223	r = btrfs_subvol_make_fallback(i->temp_path, 0755);
	224	if (r < 0)
	225	return log_error_errno(r, "Failed to create directory/subvolume %s: %m", i->temp_path);
	226	if (r > 0) /* actually btrfs subvol */
8c9cfc28	227	(void) import_assign_pool_quota_and_warn(i->temp_path);
b6e676ce	228
587fec42	229	i->tar_fd = import_fork_tar_x(i->temp_path, &i->tar_pid);
b6e676ce LP	230	if (i->tar_fd < 0)
	231	return i->tar_fd;
	232
	233	return 0;
	234	}
	235
	236	static int tar_import_write(const void p, size_t sz, void userdata) {
	237	TarImport *i = userdata;
	238	int r;
	239
b6e676ce LP	240	r = loop_write(i->tar_fd, p, sz, false);
	241	if (r < 0)
	242	return r;
	243
	244	i->written_uncompressed += sz;
b6e676ce LP	245
	246	return 0;
	247	}
	248
	249	static int tar_import_process(TarImport *i) {
	250	ssize_t l;
	251	int r;
	252
	253	assert(i);
	254	assert(i->buffer_size < sizeof(i->buffer));
	255
	256	l = read(i->input_fd, i->buffer + i->buffer_size, sizeof(i->buffer) - i->buffer_size);
	257	if (l < 0) {
587fec42 LP	258	if (errno == EAGAIN)
	259	return 0;
	260
b6e676ce LP	261	r = log_error_errno(errno, "Failed to read input file: %m");
	262	goto finish;
	263	}
	264	if (l == 0) {
	265	if (i->compress.type == IMPORT_COMPRESS_UNKNOWN) {
35bca925	266	log_error("Premature end of file.");
b6e676ce LP	267	r = -EIO;
	268	goto finish;
	269	}
	270
	271	r = tar_import_finish(i);
	272	goto finish;
	273	}
	274
	275	i->buffer_size += l;
	276
	277	if (i->compress.type == IMPORT_COMPRESS_UNKNOWN) {
	278	r = import_uncompress_detect(&i->compress, i->buffer, i->buffer_size);
	279	if (r < 0) {
35bca925	280	log_error_errno(r, "Failed to detect file compression: %m");
b6e676ce LP	281	goto finish;
	282	}
	283	if (r == 0) /* Need more data */
	284	return 0;
	285
	286	r = tar_import_fork_tar(i);
	287	if (r < 0)
	288	goto finish;
	289	}
	290
	291	r = import_uncompress(&i->compress, i->buffer, i->buffer_size, tar_import_write, i);
	292	if (r < 0) {
	293	log_error_errno(r, "Failed to decode and write: %m");
	294	goto finish;
	295	}
	296
	297	i->written_compressed += i->buffer_size;
	298	i->buffer_size = 0;
	299
	300	tar_import_report_progress(i);
	301
	302	return 0;
	303
	304	finish:
	305	if (i->on_finished)
	306	i->on_finished(i, r, i->userdata);
	307	else
	308	sd_event_exit(i->event, r);
	309
	310	return 0;
	311	}
	312
	313	static int tar_import_on_input(sd_event_source s, int fd, uint32_t revents, void userdata) {
	314	TarImport *i = userdata;
	315
	316	return tar_import_process(i);
	317	}
	318
	319	static int tar_import_on_defer(sd_event_source s, void userdata) {
	320	TarImport *i = userdata;
	321
	322	return tar_import_process(i);
	323	}
	324
	325	int tar_import_start(TarImport i, int fd, const char local, bool force_local, bool read_only) {
	326	int r;
	327
	328	assert(i);
	329	assert(fd >= 0);
	330	assert(local);
	331
52ef5dd7	332	if (!hostname_is_valid(local, 0))
b6e676ce LP	333	return -EINVAL;
	334
	335	if (i->input_fd >= 0)
	336	return -EBUSY;
	337
587fec42 LP	338	r = fd_nonblock(fd, true);
	339	if (r < 0)
	340	return r;
	341
b6e676ce LP	342	r = free_and_strdup(&i->local, local);
	343	if (r < 0)
	344	return r;
	345	i->force_local = force_local;
	346	i->read_only = read_only;
	347
	348	if (fstat(fd, &i->st) < 0)
	349	return -errno;
	350
	351	r = sd_event_add_io(i->event, &i->input_event_source, fd, EPOLLIN, tar_import_on_input, i);
	352	if (r == -EPERM) {
	353	/* This fd does not support epoll, for example because it is a regular file. Busy read in that case */
	354	r = sd_event_add_defer(i->event, &i->input_event_source, tar_import_on_defer, i);
	355	if (r < 0)
	356	return r;
	357
	358	r = sd_event_source_set_enabled(i->input_event_source, SD_EVENT_ON);
	359	}
	360	if (r < 0)
	361	return r;
	362
	363	i->input_fd = fd;
	364	return r;
	365	}