bmz.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable 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; version 3 of the
 * License, or any later version.
 *
 * Hypertable 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 Hypertable. If not, see <http://www.gnu.org/licenses/>
 */

#ifndef HYPERTABLE_BMZ_H
#define HYPERTABLE_BMZ_H

#include "Common/compat-c.h"

#define BMZ_VER_NUM             0x0110
#define BMZ_VER_MAJOR           (BMZ_VER_NUM >> 12)
#define BMZ_VER_MINOR           ((BMZ_VER_NUM >> 8) & 0xf)
#define BMZ_VER_RELEASE         ((BMZ_VER_NUM >> 4) & 0xf)
#define BMZ_VER_PATCH           (BMZ_VER_NUM & 0xf)

/* Error codes */
#define BMZ_E_OK                0
#define BMZ_E_ERROR           (-1)
#define BMZ_E_INPUT_OVERRUN   (-4)
#define BMZ_E_OUTPUT_OVERRUN  (-5)


/* APIs */

HT_EXTERN(int)
bmz_init();

HT_EXTERN(int)
bmz_pack(const void *in, size_t in_len, void *out, size_t *out_len_p,
         size_t offset, size_t fp_len, unsigned flags, void *work_mem);

HT_EXTERN(int)
bmz_unpack(const void *in, size_t in_len, void *out, size_t *out_len_p,
           void *work_mem);

HT_EXTERN(size_t)
bmz_pack_buflen(size_t in_len);

HT_EXTERN(size_t)
bmz_pack_worklen(size_t in_len, size_t fp_len);

HT_EXTERN(size_t)
bmz_unpack_worklen(size_t out_len);

HT_EXTERN(int)
bmz_set_verbosity(int verbosity);

typedef void (*BmzOutProc)(const char *msg, size_t len);

typedef void (*BmzDieProc)(const char *msg) HT_NORETURN;

HT_EXTERN(BmzOutProc)
bmz_set_out_proc(BmzOutProc proc);

HT_EXTERN(BmzDieProc)
bmz_set_die_proc(BmzDieProc proc);

HT_EXTERN(unsigned)
bmz_checksum(const void *in, size_t in_len);

HT_EXTERN(unsigned)
bmz_update_checksum(unsigned s, const void *in, size_t in_len);

#endif /* HYPERTABLE_BMZ_H */
/* vim: et sw=2
 */