/******************************************************
Copyright (c) 2011-2017 Percona LLC and/or its affiliates.

The xbstream format interface.

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; version 2 of the License.

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-1335  USA

*******************************************************/

#ifndef XBSTREAM_H
#define XBSTREAM_H

#include <my_base.h>

/* Magic value in a chunk header */
#define XB_STREAM_CHUNK_MAGIC "XBSTCK01"

/* Chunk flags */
/* Chunk can be ignored if unknown version/format */
#define XB_STREAM_FLAG_IGNORABLE 0x01
#define XB_STREAM_FLAG_REWRITE   0x02

/* Magic + flags + type + path len */
#define CHUNK_HEADER_CONSTANT_LEN ((sizeof(XB_STREAM_CHUNK_MAGIC) - 1) + \
       1 + 1 + 4)
#define CHUNK_TYPE_OFFSET (sizeof(XB_STREAM_CHUNK_MAGIC) - 1 + 1)
#define PATH_LENGTH_OFFSET (sizeof(XB_STREAM_CHUNK_MAGIC) - 1 + 1 + 1)

typedef struct xb_wstream_struct xb_wstream_t;

typedef struct xb_wstream_file_struct xb_wstream_file_t;

typedef enum {
 XB_STREAM_FMT_NONE,
 XB_STREAM_FMT_XBSTREAM
} xb_stream_fmt_t;

/************************************************************************
Write interface. */

typedef ssize_t xb_stream_write_callback(
      void *userdata,
      const void *buf, size_t len);

xb_wstream_t *xb_stream_write_new(
 xb_stream_write_callback *write_callback, void *user_data);
xb_wstream_file_t *xb_stream_write_open(xb_wstream_t *stream, const char *path,
     const MY_STAT *mystat, bool rewrite);

int xb_stream_write_data(xb_wstream_file_t *file, const void *buf, size_t len);
int xb_stream_write_seek_set(xb_wstream_file_t *file, my_off_t offset);
int xb_stream_write_remove(xb_wstream_t *stream, const char *path);
int
xb_stream_write_rename(
 xb_wstream_t *stream, const char *old_path, const char *new_path);
int xb_stream_write_close(xb_wstream_file_t *file);

int xb_stream_write_done(xb_wstream_t *stream);

/************************************************************************
Read interface. */

typedef enum {
 XB_STREAM_READ_CHUNK,
 XB_STREAM_READ_EOF,
 XB_STREAM_READ_ERROR
} xb_rstream_result_t;

typedef enum {
 XB_CHUNK_TYPE_UNKNOWN = '\0',
 XB_CHUNK_TYPE_PAYLOAD = 'P',
 XB_CHUNK_TYPE_RENAME = 'R',
 XB_CHUNK_TYPE_REMOVE = 'D',
 XB_CHUNK_TYPE_SEEK = 'S',
 XB_CHUNK_TYPE_EOF = 'E'
} xb_chunk_type_t;

typedef struct xb_rstream_struct xb_rstream_t;

typedef struct {
 uchar           flags;
 xb_chunk_type_t type;
 uint  pathlen;
 char  path[FN_REFLEN];
 size_t  length;
 my_off_t offset;
 my_off_t checksum_offset;
 void  *data;
 ulong  checksum;
 size_t  buflen;
} xb_rstream_chunk_t;

xb_rstream_t *xb_stream_read_new(void);

xb_rstream_result_t xb_stream_read_chunk(xb_rstream_t *stream,
      xb_rstream_chunk_t *chunk);

int xb_stream_read_done(xb_rstream_t *stream);

xb_rstream_result_t xb_stream_validate_checksum(xb_rstream_chunk_t *chunk);

#endif