pcompress/utils/utils.h

/*
 * This file is a part of Pcompress, a chunked parallel multi-
 * algorithm lossless compression and decompression program.
 *
 * Copyright (C) 2012-2013 Moinak Ghosh. All rights reserved.
 * Use is subject to license terms.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * moinakg@belenix.org, http://moinakg.wordpress.com/
 *      
 */

#ifndef	_UTILS_H
#define	_UTILS_H

#include <arpa/nameser_compat.h>
#include <arpa/inet.h>
#include <sys/types.h>

#ifndef __STDC_FORMAT_MACROS
#define	__STDC_FORMAT_MACROS	1
#endif

#include <inttypes.h>
#include <sys/param.h>
#include <stdint.h>
#include <assert.h>
#include <string.h>
#include <sys/time.h>
#include <pthread.h>
#include <semaphore.h>
#include <cpuid.h>
#if defined(sun) || defined(__sun)
#include <sys/byteorder.h>
#elif defined(__APPLE__)
#include <libkern/OSByteOrder.h>
#else
#include <byteswap.h>
#endif

#ifdef	__cplusplus
extern "C" {
#endif

#define	DATA_TEXT	1
#define	DATA_BINARY	2
#define	EIGHTM		(8UL * 1024UL * 1024UL)
#define	FOURM		(4UL * 1024UL * 1024UL)

#define	ONE_PB (1125899906842624ULL)
#define	ONE_TB (1099511627776ULL)
#define ONE_GB (1024UL * 1024UL * 1024UL)
#define	TWO_MB (2UL * 1024UL * 1024UL)
#define	FOUR_MB FOURM
#define	EIGHT_MB EIGHTM
#define	EIGHT_GB (8589934592ULL)
#define	SIXTEEN_GB (EIGHT_GB * 2)

#if !defined(sun) && !defined(__sun)
typedef unsigned char uchar_t ;
#endif

#if ULONG_MAX == 4294967295UL
#       ifndef UINT64_C
#               define UINT64_C(n) n ## ULL
#       endif
#else
#       ifndef UINT64_C
#               define UINT64_C(n) n ## UL
#       endif
#endif

#ifndef UINT64_MAX
#define	UINT64_MAX (18446744073709551615ULL)
#endif

typedef unsigned long uintptr_t;
typedef int32_t bsize_t;

#undef WORDS_BIGENDIAN
#if BYTE_ORDER == BIG_ENDIAN
#	define WORDS_BIGENDIAN
#	ifndef htonll
#		define htonll(x) (x)
#	endif
#	ifndef ntonll
#		define ntohll(x) (x)
#	endif
#	if !defined(sun) && !defined (__sun)
#		if defined(__APPLE__)
#			define LE64(x) OSSwapInt64(x)
#			define LE32(x) OSSwapInt32(x)
#			define LE16(x) OSSwapInt16(x)
#		else
#			define LE64(x) __bswap_64(x)
#			define LE32(x) __bswap_32(x)
#			define LE16(x) __bswap_16(x)
#		endif
#	else
#		define LE64(x) BSWAP_64(x)
#		define LE32(x) BSWAP_32(x)
#		define LE16(x) BSWAP_16(x)
#	endif
#else
#	if !defined(sun) && !defined (__sun)
#		if defined(__APPLE__)
#			ifndef htonll
#				define htonll(x) OSSwapInt64(x)
#			endif
#			ifndef ntohll
#				define ntohll(x) OSSwapInt64(x)
#			endif
#		else
#			ifndef htonll
#				define htonll(x) __bswap_64(x)
#			endif
#			ifndef ntohll
#				define ntohll(x) __bswap_64(x)
#			endif
#		endif
#	endif
#	define LE64(x) (x)
#	define LE32(x) (x)
#	define LE16(x) (x)
#endif


// These allow helping the compiler in some often-executed branches, whose
// result is almost always the same.
#ifdef __GNUC__
#	define	likely(expr) __builtin_expect(expr, 1)
#	define	unlikely(expr) __builtin_expect(expr, 0)
#	define	ATOMIC_ADD(var, val) __sync_fetch_and_add(&var, val)
#	define	ATOMIC_SUB(var, val) __sync_fetch_and_sub(&var, val)
#	define	PREFETCH_WRITE(x, n) __builtin_prefetch((x), 1, (n))
#	define	PREFETCH_READ(x, n)  __builtin_prefetch((x), 0, (n))
#	define	NOINLINE_ATTR __attribute__((noinline))
#else
#       define likely(expr) (expr)
#       define unlikely(expr) (expr)
#	define	PREFETCH_WRITE(x, n)
#	define	PREFETCH_READ(x, n)
#	define	NOINLINE_ATTR
#	if defined(sun) || defined (__sun)
#		include <atomic.h>
#		define ATOMIC_ADD(var, val) atomic_add_int(&var, val)
#		define ATOMIC_SUB(var, val) atomic_add_int(&var, -val)
#	else
// Dunno what to do
#		define ATOMIC_ADD(var, val) var += val
#		define ATOMIC_SUB(var, val) var -= val
#	endif
#endif

#ifdef __GNUC__
#define DLL_EXPORT __attribute__ ((visibility ("default")))
#define DLL_LOCAL  __attribute__ ((visibility ("hidden")))
#else
#define DLL_EXPORT
#define DLL_LOCAL
#endif

#define ISP2(x) ((x != 0) && ((x & (~x + 1)) == x))

#ifdef	DEBUG_STATS
#define	DEBUG_STAT_EN(...) __VA_ARGS__;
#else
#define	DEBUG_STAT_EN(...)
#endif

#define	PATHSEP_CHAR	'/'
#define	BYTES_TO_MB(x) ((x) / (1024 * 1024))
#define	U64_P(x) *((uint64_t *)(x))
#define	U32_P(x) *((uint32_t *)(x))
#define	U16_P(x) *((uint16_t *)(x))
#define	I64_P(x) *((int64_t *)(x))
#define	I32_P(x) *((int32_t *)(x))
#define	I16_P(x) *((int16_t *)(x))

#ifdef __APPLE__
#define	CLOCK_MONOTONIC 0
#define CLOCK_REALTIME  1
#endif

/*
 * Public checksum properties. CKSUM_MAX_BYTES must be updated if a
 * newer larger checksum is added to the list.
 */
typedef enum {
	CKSUM_CRC64 = 0x100,
	CKSUM_BLAKE256 = 0x200,
	CKSUM_BLAKE512 = 0x300,
	CKSUM_SHA256 = 0x400,
	CKSUM_SHA512 = 0x500,
	CKSUM_KECCAK256 = 0x600,
	CKSUM_KECCAK512 = 0x700,
/*
 * Backwards compatibility options. SKEIN in release 1.2 was replaced with
 * Blake2 from 1.3 onwards (for sheer speed of Blake2). We want to be able
 * to decode archives created with 1.2. New archives do not use SKEIN.
 * 
 * However SKEIN can be used as a chunk/block hash for Global Deduplication.
 * So it will not be removed.
 */
	CKSUM_SKEIN256 = 0x800,
	CKSUM_SKEIN512 = 0x900,
	CKSUM_INVALID = 0
} cksum_t;

typedef enum {
	COMPRESS_NONE = 0,
	COMPRESS_LZFX,
	COMPRESS_LZ4,
	COMPRESS_ZLIB,
	COMPRESS_BZIP2,
	COMPRESS_LZMA,
	COMPRESS_INVALID
} compress_algo_t;

typedef struct {
	uint32_t buf_extra;
	int compress_mt_capable;
	int decompress_mt_capable;
	int single_chunk_mt_capable;
	int is_single_chunk;
	int nthreads;
	int c_max_threads;
	int d_max_threads;
	int delta2_span;
	int deltac_min_distance;
	cksum_t cksum;
} algo_props_t;

typedef enum {
	COMPRESS_THREADS = 1,
	DECOMPRESS_THREADS
} algo_threads_type_t;

typedef struct{
	int64_t totalram;
	int64_t freeram;
	int64_t totalswap;
	int64_t freeswap;
	int64_t mem_unit;
	int64_t sharedram;
} my_sysinfo;

struct fn_list {
	char *filename;
	struct fn_list *next;
};

/*
 * Enumerated type constants for file type identification in pc_archive.
 */
typedef enum {
	/*
	 * Primary Types.
	 */
	TYPE_UNKNOWN = 0,
	TYPE_TEXT = 1,
	TYPE_BINARY = 2,
	TYPE_COMPRESSED = 4,
	/*
	 * Sub-types.
	 */
#define	NUM_SUB_TYPES	28
	TYPE_EXE32 = 8,
	TYPE_JPEG = 16,
	TYPE_MARKUP = 24,
	TYPE_COMPRESSED_GZ = 32,
	TYPE_COMPRESSED_LZW = 40,
	TYPE_COMPRESSED_BZ2 = 48,
	TYPE_COMPRESSED_ZIP = 56,
	TYPE_COMPRESSED_ARJ = 64,
	TYPE_COMPRESSED_ARC = 72,
	TYPE_ARCHIVE_AR = 80,
	TYPE_COMPRESSED_LZMA = 88,
	TYPE_COMPRESSED_LZO = 96,
	TYPE_AVI = 104,
	TYPE_MP4 = 112,
	TYPE_FLAC = 120,
	TYPE_COMPRESSED_RAR = 128,
	TYPE_COMPRESSED_LZ = 136,
	TYPE_COMPRESSED_PPMD = 144,
	TYPE_COMPRESSED_ZPAQ = 152,
	TYPE_PACKJPG = 160,
	TYPE_DNA_SEQ = 168,
	TYPE_MJPEG = 176,
	TYPE_AUDIO_COMPRESSED = 184,
	TYPE_EXE64 = 192,
	TYPE_BMP = 200,
	TYPE_TIFF = 208,
	TYPE_PDF = 216,
	TYPE_ARCHIVE_TAR = 224,
	TYPE_DICOM = 232
} data_type_t;

/*
 * Type identifier is an int with the following format.
 *
 *                Sub Type            Primary Type
 *            (Numeric Value)    (Bit Positions - Flags)
 *      _____________|_____________     ___|___
 *     |                           |   |       |
 *     .---------------------------------------.
 *     |   |   |   |   |   |   |   |   |   |   |
 * Bit 10                                         Bit 0
 */
#define	PC_TYPE_MASK	0x7
#define	PC_SUBTYPE_MASK	0x7f8
#define	PC_SUBTYPE(x)	((x) & PC_SUBTYPE_MASK)
#define	PC_TYPE(x)	((x) & PC_TYPE_MASK)

#ifndef _IN_UTILS_
extern processor_cap_t proc_info;
#endif

extern void err_exit(int show_errno, const char *format, ...);
extern void err_print(int show_errno, const char *format, ...);
extern const char *get_execname(const char *);
extern int parse_numeric(int64_t *val, const char *str);
extern char *bytes_to_size(uint64_t bytes);
extern int64_t Read(int fd, void *buf, uint64_t count);
extern int64_t Read_Adjusted(int fd, uchar_t *buf, uint64_t count,
	int64_t *rabin_count, void *ctx, void *pctx);
extern int64_t Write(int fd, const void *buf, uint64_t count);
extern void set_threadcounts(algo_props_t *props, int *nthreads, int nprocs,
	algo_threads_type_t typ);
extern uint64_t get_total_ram();
extern double get_wtime_millis(void);
extern double get_mb_s(uint64_t bytes, double strt, double en);
extern void get_sys_limits(my_sysinfo *msys_info);
extern int chk_dir(char *dir);
extern void init_algo_props(algo_props_t *props);
extern void init_pcompress();
extern char *get_temp_dir();
extern int file_exists(char *path);

/* Pointer type for compress and decompress functions. */
typedef int (*compress_func_ptr)(void *src, uint64_t srclen, void *dst,
	uint64_t *destlen, int level, uchar_t chdr, int btype, void *data);

typedef enum {
	COMPRESS,
	DECOMPRESS
} compress_op_t;

/* Pointer type for algo specific init/deinit/stats functions. */
typedef int (*init_func_ptr)(void **data, int *level, int nthreads, uint64_t chunksize,
			     int file_version, compress_op_t op);
typedef int (*deinit_func_ptr)(void **data);
typedef void (*stats_func_ptr)(int show);
typedef void (*props_func_ptr)(algo_props_t *data, int level, uint64_t chunksize);

/*
 * Logging definitions.
 */
typedef enum {
	LOG_OUTPUT,
	LOG_FILE,
	LOG_CALLBACK
} log_dest_type_t;

typedef enum {
	LOG_ERR,
	LOG_WARN,
	LOG_INFO
} log_level_t;	

typedef void (*log_callback_ptr)(char *msg);

typedef struct {
	log_dest_type_t type;
	int fd;
	log_callback_ptr cb;
} log_dest_t;

void set_log_dest(log_dest_t *dest);
void set_log_level(int level);
void log_msg(log_level_t log_level, int show_errno, const char *format, ...);

/*
 * Tempfile cleanup handlers and tempfile registration routines.
 */
void Int_Handler(int signo);
void handle_signals();
void add_fname(char *fn);
void rm_fname(char *fn);

/*
 * Some types (like Jpeg) are totally incompressible.
 */
int is_incompressible(int type);

#ifdef __APPLE__
int clock_gettime(int clk_id, struct timespec *ts);
#endif

/*
 * Routines to handle compatibility.
 */
typedef struct _compat_sem {
	char name[15];
	sem_t sem, *sem1;
} Sem_t;

int Sem_Init(Sem_t *sem, int pshared, int value);
int Sem_Destroy(Sem_t *sem);
int Sem_Post(Sem_t *sem);
int Sem_Wait(Sem_t *sem);


/*
 * Roundup v to the nearest power of 2. From Bit Twiddling Hacks:
 * http://graphics.stanford.edu/~seander/bithacks.html
 */
static inline unsigned int
roundup_pow_two(unsigned int v) {
	v--;
	v |= v >> 1;
	v |= v >> 2;
	v |= v >> 4;
	v |= v >> 8;
	v |= v >> 16;
	v++;
	return (v);
}

static inline int
endswith(char *haystack, char *needle) {
	size_t len = strlen(haystack);
	size_t nlen = strlen(needle);
	if (nlen > len)
		return (0);
	size_t pos = len - nlen;
	if (memcmp(&haystack[pos], needle, nlen) != 0)
		return (0);
	return (1);
}

#ifdef	__cplusplus
}
#endif

#endif