hostprogs_lib.h

/* microfs - Minimally Improved Compressed Read Only File System
 * Copyright (C) 2012, 2013, 2014, 2015, 2016, 2017, ..., +%Y
 * Erik Edlund <erik.edlund@32767.se>
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef HOSTPROGS_LIB_H
#define HOSTPROGS_LIB_H

#include <stdio.h>

#include <asm/byteorder.h>
#include <linux/types.h>

#include "libinfo.h"

struct hostprog_lib {
	/* Library info. */
	const struct libinfo* hl_info;
	/* Library support compiled? */
	const int hl_compiled;
	/* Compression library initialization, if necessary. */
	int (*hl_init)(void** data, __u32 blksz);
	/* Compression library help. */
	void (*hl_mk_usage)(FILE* const dest);
	/* Compression library option. */
	int (*hl_mk_option)(void* data, const char* name, const char* value);
	/* Write "on-disk" decompressor data. */
	__u64 (*hl_mk_dd)(void* data, char* base, __u64 offset);
	/* Check "on-disk" decompressor data. */
	int (*hl_ck_dd)(void* data, char* dd);
	/* Compress data. */
	int (*hl_compress)(void* data, void* destbuf, __u32* destbufsz,
		void* srcbuf, __u32 srcbufsz, int* implerr);
	/* Decompress data. */
	int (*hl_decompress)(void* data, void* destbuf, __u32* destbufsz,
		void* srcbuf, __u32 srcbufsz, int* implerr);
	/* Get the max size that data of size %size can compress to. */
	__u32 (*hl_upperbound)(void* data, __u32 size);
	/* Get a human readable description of the error (maybe). */
	const char* (*hl_strerror)(void* data, int implerr);
};

extern const struct hostprog_lib hostprog_lib_zlib;
extern const struct hostprog_lib hostprog_lib_lz4;
extern const struct hostprog_lib hostprog_lib_lzo;
extern const struct hostprog_lib hostprog_lib_xz;
extern const struct hostprog_lib hostprog_lib_zstd;

const struct hostprog_lib* hostprog_lib_find_any(void);

const struct hostprog_lib* hostprog_lib_find_byid(const int id);
const struct hostprog_lib* hostprog_lib_find_byname(const char* name);

const struct hostprog_lib** hostprog_lib_all(void);

void hostprog_lib_mk_usage(FILE* const dest);
int hostprog_lib_mk_option(void* data, const char* name, const char* value);
__u64 hostprog_lib_mk_dd(void* data, char* base, __u64 offset);
int hostprog_lib_ck_dd(void* data, char* base);

__u32 hostprog_lib_zlib_crc32(char* data, __u64 sz);

#endif