Blame libkmod/libkmod-file.c

Packit a3a425
/*
Packit a3a425
 * libkmod - interface to kernel module operations
Packit a3a425
 *
Packit a3a425
 * Copyright (C) 2011-2013  ProFUSION embedded systems
Packit a3a425
 *
Packit a3a425
 * This library is free software; you can redistribute it and/or
Packit a3a425
 * modify it under the terms of the GNU Lesser General Public
Packit a3a425
 * License as published by the Free Software Foundation; either
Packit a3a425
 * version 2.1 of the License, or (at your option) any later version.
Packit a3a425
 *
Packit a3a425
 * This library is distributed in the hope that it will be useful,
Packit a3a425
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit a3a425
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit a3a425
 * Lesser General Public License for more details.
Packit a3a425
 *
Packit a3a425
 * You should have received a copy of the GNU Lesser General Public
Packit a3a425
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit a3a425
 */
Packit a3a425
Packit a3a425
#include <errno.h>
Packit a3a425
#include <stdbool.h>
Packit a3a425
#include <stdio.h>
Packit a3a425
#include <stdlib.h>
Packit a3a425
#include <string.h>
Packit a3a425
#include <sys/mman.h>
Packit a3a425
#include <sys/stat.h>
Packit a3a425
#include <sys/types.h>
Packit a3a425
#include <unistd.h>
Packit a3a425
#ifdef ENABLE_XZ
Packit a3a425
#include <lzma.h>
Packit a3a425
#endif
Packit a3a425
#ifdef ENABLE_ZLIB
Packit a3a425
#include <zlib.h>
Packit a3a425
#endif
Packit a3a425
Packit a3a425
#include <shared/util.h>
Packit a3a425
Packit a3a425
#include "libkmod.h"
Packit a3a425
#include "libkmod-internal.h"
Packit a3a425
Packit a3a425
struct kmod_file;
Packit a3a425
struct file_ops {
Packit a3a425
	int (*load)(struct kmod_file *file);
Packit a3a425
	void (*unload)(struct kmod_file *file);
Packit a3a425
};
Packit a3a425
Packit a3a425
struct kmod_file {
Packit a3a425
#ifdef ENABLE_XZ
Packit a3a425
	bool xz_used;
Packit a3a425
#endif
Packit a3a425
#ifdef ENABLE_ZLIB
Packit a3a425
	gzFile gzf;
Packit a3a425
#endif
Packit a3a425
	int fd;
Packit a3a425
	bool direct;
Packit a3a425
	off_t size;
Packit a3a425
	void *memory;
Packit a3a425
	const struct file_ops *ops;
Packit a3a425
	const struct kmod_ctx *ctx;
Packit a3a425
	struct kmod_elf *elf;
Packit a3a425
};
Packit a3a425
Packit a3a425
#ifdef ENABLE_XZ
Packit a3a425
static void xz_uncompress_belch(struct kmod_file *file, lzma_ret ret)
Packit a3a425
{
Packit a3a425
	switch (ret) {
Packit a3a425
	case LZMA_MEM_ERROR:
Packit a3a425
		ERR(file->ctx, "xz: %s\n", strerror(ENOMEM));
Packit a3a425
		break;
Packit a3a425
	case LZMA_FORMAT_ERROR:
Packit a3a425
		ERR(file->ctx, "xz: File format not recognized\n");
Packit a3a425
		break;
Packit a3a425
	case LZMA_OPTIONS_ERROR:
Packit a3a425
		ERR(file->ctx, "xz: Unsupported compression options\n");
Packit a3a425
		break;
Packit a3a425
	case LZMA_DATA_ERROR:
Packit a3a425
		ERR(file->ctx, "xz: File is corrupt\n");
Packit a3a425
		break;
Packit a3a425
	case LZMA_BUF_ERROR:
Packit a3a425
		ERR(file->ctx, "xz: Unexpected end of input\n");
Packit a3a425
		break;
Packit a3a425
	default:
Packit a3a425
		ERR(file->ctx, "xz: Internal error (bug)\n");
Packit a3a425
		break;
Packit a3a425
	}
Packit a3a425
}
Packit a3a425
Packit a3a425
static int xz_uncompress(lzma_stream *strm, struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	uint8_t in_buf[BUFSIZ], out_buf[BUFSIZ];
Packit a3a425
	lzma_action action = LZMA_RUN;
Packit a3a425
	lzma_ret ret;
Packit a3a425
	void *p = NULL;
Packit a3a425
	size_t total = 0;
Packit a3a425
Packit a3a425
	strm->avail_in  = 0;
Packit a3a425
	strm->next_out  = out_buf;
Packit a3a425
	strm->avail_out = sizeof(out_buf);
Packit a3a425
Packit a3a425
	while (true) {
Packit a3a425
		if (strm->avail_in == 0) {
Packit a3a425
			ssize_t rdret = read(file->fd, in_buf, sizeof(in_buf));
Packit a3a425
			if (rdret < 0) {
Packit a3a425
				ret = -errno;
Packit a3a425
				goto out;
Packit a3a425
			}
Packit a3a425
			strm->next_in  = in_buf;
Packit a3a425
			strm->avail_in = rdret;
Packit a3a425
			if (rdret == 0)
Packit a3a425
				action = LZMA_FINISH;
Packit a3a425
		}
Packit a3a425
		ret = lzma_code(strm, action);
Packit a3a425
		if (strm->avail_out == 0 || ret != LZMA_OK) {
Packit a3a425
			size_t write_size = BUFSIZ - strm->avail_out;
Packit a3a425
			char *tmp = realloc(p, total + write_size);
Packit a3a425
			if (tmp == NULL) {
Packit a3a425
				ret = -errno;
Packit a3a425
				goto out;
Packit a3a425
			}
Packit a3a425
			memcpy(tmp + total, out_buf, write_size);
Packit a3a425
			total += write_size;
Packit a3a425
			p = tmp;
Packit a3a425
			strm->next_out = out_buf;
Packit a3a425
			strm->avail_out = BUFSIZ;
Packit a3a425
		}
Packit a3a425
		if (ret == LZMA_STREAM_END)
Packit a3a425
			break;
Packit a3a425
		if (ret != LZMA_OK) {
Packit a3a425
			xz_uncompress_belch(file, ret);
Packit a3a425
			ret = -EINVAL;
Packit a3a425
			goto out;
Packit a3a425
		}
Packit a3a425
	}
Packit a3a425
	file->xz_used = true;
Packit a3a425
	file->memory = p;
Packit a3a425
	file->size = total;
Packit a3a425
	return 0;
Packit a3a425
 out:
Packit a3a425
	free(p);
Packit a3a425
	return ret;
Packit a3a425
}
Packit a3a425
Packit a3a425
static int load_xz(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	lzma_stream strm = LZMA_STREAM_INIT;
Packit a3a425
	lzma_ret lzret;
Packit a3a425
	int ret;
Packit a3a425
Packit a3a425
	lzret = lzma_stream_decoder(&strm, UINT64_MAX, LZMA_CONCATENATED);
Packit a3a425
	if (lzret == LZMA_MEM_ERROR) {
Packit a3a425
		ERR(file->ctx, "xz: %s\n", strerror(ENOMEM));
Packit a3a425
		return -ENOMEM;
Packit a3a425
	} else if (lzret != LZMA_OK) {
Packit a3a425
		ERR(file->ctx, "xz: Internal error (bug)\n");
Packit a3a425
		return -EINVAL;
Packit a3a425
	}
Packit a3a425
	ret = xz_uncompress(&strm, file);
Packit a3a425
	lzma_end(&strm;;
Packit a3a425
	return ret;
Packit a3a425
}
Packit a3a425
Packit a3a425
static void unload_xz(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	if (!file->xz_used)
Packit a3a425
		return;
Packit a3a425
	free(file->memory);
Packit a3a425
}
Packit a3a425
Packit a3a425
static const char magic_xz[] = {0xfd, '7', 'z', 'X', 'Z', 0};
Packit a3a425
#endif
Packit a3a425
Packit a3a425
#ifdef ENABLE_ZLIB
Packit a3a425
#define READ_STEP (4 * 1024 * 1024)
Packit a3a425
static int load_zlib(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	int err = 0;
Packit a3a425
	off_t did = 0, total = 0;
Packit a3a425
	_cleanup_free_ unsigned char *p = NULL;
Packit a3a425
Packit a3a425
	errno = 0;
Packit a3a425
	file->gzf = gzdopen(file->fd, "rb");
Packit a3a425
	if (file->gzf == NULL)
Packit a3a425
		return -errno;
Packit a3a425
	file->fd = -1; /* now owned by gzf due gzdopen() */
Packit a3a425
Packit a3a425
	for (;;) {
Packit a3a425
		int r;
Packit a3a425
Packit a3a425
		if (did == total) {
Packit a3a425
			void *tmp = realloc(p, total + READ_STEP);
Packit a3a425
			if (tmp == NULL) {
Packit a3a425
				err = -errno;
Packit a3a425
				goto error;
Packit a3a425
			}
Packit a3a425
			total += READ_STEP;
Packit a3a425
			p = tmp;
Packit a3a425
		}
Packit a3a425
Packit a3a425
		r = gzread(file->gzf, p + did, total - did);
Packit a3a425
		if (r == 0)
Packit a3a425
			break;
Packit a3a425
		else if (r < 0) {
Packit a3a425
			int gzerr;
Packit a3a425
			const char *gz_errmsg = gzerror(file->gzf, &gzerr);
Packit a3a425
Packit a3a425
			ERR(file->ctx, "gzip: %s\n", gz_errmsg);
Packit a3a425
Packit a3a425
			/* gzip might not set errno here */
Packit a3a425
			err = gzerr == Z_ERRNO ? -errno : -EINVAL;
Packit a3a425
			goto error;
Packit a3a425
		}
Packit a3a425
		did += r;
Packit a3a425
	}
Packit a3a425
Packit a3a425
	file->memory = p;
Packit a3a425
	file->size = did;
Packit a3a425
	p = NULL;
Packit a3a425
	return 0;
Packit a3a425
Packit a3a425
error:
Packit a3a425
	gzclose(file->gzf);
Packit a3a425
	return err;
Packit a3a425
}
Packit a3a425
Packit a3a425
static void unload_zlib(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	if (file->gzf == NULL)
Packit a3a425
		return;
Packit a3a425
	free(file->memory);
Packit a3a425
	gzclose(file->gzf); /* closes file->fd */
Packit a3a425
}
Packit a3a425
Packit a3a425
static const char magic_zlib[] = {0x1f, 0x8b};
Packit a3a425
#endif
Packit a3a425
Packit a3a425
static const struct comp_type {
Packit a3a425
	size_t magic_size;
Packit a3a425
	const char *magic_bytes;
Packit a3a425
	const struct file_ops ops;
Packit a3a425
} comp_types[] = {
Packit a3a425
#ifdef ENABLE_XZ
Packit a3a425
	{sizeof(magic_xz), magic_xz, {load_xz, unload_xz}},
Packit a3a425
#endif
Packit a3a425
#ifdef ENABLE_ZLIB
Packit a3a425
	{sizeof(magic_zlib), magic_zlib, {load_zlib, unload_zlib}},
Packit a3a425
#endif
Packit a3a425
	{0, NULL, {NULL, NULL}}
Packit a3a425
};
Packit a3a425
Packit a3a425
static int load_reg(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	struct stat st;
Packit a3a425
Packit a3a425
	if (fstat(file->fd, &st) < 0)
Packit a3a425
		return -errno;
Packit a3a425
Packit a3a425
	file->size = st.st_size;
Packit a3a425
	file->memory = mmap(NULL, file->size, PROT_READ, MAP_PRIVATE,
Packit a3a425
			    file->fd, 0);
Packit a3a425
	if (file->memory == MAP_FAILED)
Packit a3a425
		return -errno;
Packit a3a425
	file->direct = true;
Packit a3a425
	return 0;
Packit a3a425
}
Packit a3a425
Packit a3a425
static void unload_reg(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	munmap(file->memory, file->size);
Packit a3a425
}
Packit a3a425
Packit a3a425
static const struct file_ops reg_ops = {
Packit a3a425
	load_reg, unload_reg
Packit a3a425
};
Packit a3a425
Packit a3a425
struct kmod_elf *kmod_file_get_elf(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	if (file->elf)
Packit a3a425
		return file->elf;
Packit a3a425
Packit a3a425
	file->elf = kmod_elf_new(file->memory, file->size);
Packit a3a425
	return file->elf;
Packit a3a425
}
Packit a3a425
Packit a3a425
struct kmod_file *kmod_file_open(const struct kmod_ctx *ctx,
Packit a3a425
						const char *filename)
Packit a3a425
{
Packit a3a425
	struct kmod_file *file = calloc(1, sizeof(struct kmod_file));
Packit a3a425
	const struct comp_type *itr;
Packit a3a425
	size_t magic_size_max = 0;
Packit a3a425
	int err;
Packit a3a425
Packit a3a425
	if (file == NULL)
Packit a3a425
		return NULL;
Packit a3a425
Packit a3a425
	file->fd = open(filename, O_RDONLY|O_CLOEXEC);
Packit a3a425
	if (file->fd < 0) {
Packit a3a425
		err = -errno;
Packit a3a425
		goto error;
Packit a3a425
	}
Packit a3a425
Packit a3a425
	for (itr = comp_types; itr->ops.load != NULL; itr++) {
Packit a3a425
		if (magic_size_max < itr->magic_size)
Packit a3a425
			magic_size_max = itr->magic_size;
Packit a3a425
	}
Packit a3a425
Packit a3a425
	file->direct = false;
Packit a3a425
	if (magic_size_max > 0) {
Packit a3a425
		char *buf = alloca(magic_size_max + 1);
Packit a3a425
		ssize_t sz;
Packit a3a425
Packit a3a425
		if (buf == NULL) {
Packit a3a425
			err = -errno;
Packit a3a425
			goto error;
Packit a3a425
		}
Packit a3a425
		sz = read_str_safe(file->fd, buf, magic_size_max + 1);
Packit a3a425
		lseek(file->fd, 0, SEEK_SET);
Packit a3a425
		if (sz != (ssize_t)magic_size_max) {
Packit a3a425
			if (sz < 0)
Packit a3a425
				err = sz;
Packit a3a425
			else
Packit a3a425
				err = -EINVAL;
Packit a3a425
			goto error;
Packit a3a425
		}
Packit a3a425
Packit a3a425
		for (itr = comp_types; itr->ops.load != NULL; itr++) {
Packit a3a425
			if (memcmp(buf, itr->magic_bytes, itr->magic_size) == 0)
Packit a3a425
				break;
Packit a3a425
		}
Packit a3a425
		if (itr->ops.load != NULL)
Packit a3a425
			file->ops = &itr->ops;
Packit a3a425
	}
Packit a3a425
Packit a3a425
	if (file->ops == NULL)
Packit a3a425
		file->ops = &reg_ops;
Packit a3a425
Packit a3a425
	err = file->ops->load(file);
Packit a3a425
	file->ctx = ctx;
Packit a3a425
error:
Packit a3a425
	if (err < 0) {
Packit a3a425
		if (file->fd >= 0)
Packit a3a425
			close(file->fd);
Packit a3a425
		free(file);
Packit a3a425
		errno = -err;
Packit a3a425
		return NULL;
Packit a3a425
	}
Packit a3a425
Packit a3a425
	return file;
Packit a3a425
}
Packit a3a425
Packit a3a425
void *kmod_file_get_contents(const struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	return file->memory;
Packit a3a425
}
Packit a3a425
Packit a3a425
off_t kmod_file_get_size(const struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	return file->size;
Packit a3a425
}
Packit a3a425
Packit a3a425
bool kmod_file_get_direct(const struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	return file->direct;
Packit a3a425
}
Packit a3a425
Packit a3a425
int kmod_file_get_fd(const struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	return file->fd;
Packit a3a425
}
Packit a3a425
Packit a3a425
void kmod_file_unref(struct kmod_file *file)
Packit a3a425
{
Packit a3a425
	if (file->elf)
Packit a3a425
		kmod_elf_unref(file->elf);
Packit a3a425
Packit a3a425
	file->ops->unload(file);
Packit a3a425
	if (file->fd >= 0)
Packit a3a425
		close(file->fd);
Packit a3a425
	free(file);
Packit a3a425
}