#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <yaz/xmalloc.h>
#include <idzebra/util.h>
#include <idzebra/bfile.h>
#include "mfile.h"
#include "cfile.h"

Data Structures
struct	BFile_struct

struct	BFiles_struct

Macros
#define	HEADER_SIZE 256

Functions
BFiles	bfs_create (const char spec, const char base)
	creates a Block files collection

void	bfs_destroy (BFiles bfs)
	destroys a block files handle

static FILE *	open_cache (BFiles bfs, const char *flags)

static void	unlink_cache (BFiles bfs)

ZEBRA_RES	bf_cache (BFiles bfs, const char *spec)
	enables or disables shadow for block files

int	bf_close2 (BFile bf)
	closes a Block file

void	bf_close (BFile bf)
	closes a Block file (may call exit)

BFile	bf_open (BFiles bfs, const char *name, int block_size, int wflag)
	opens and returns a Block file handle

int	bf_read (BFile bf, zint no, int offset, int nbytes, void *buf)
	read from block file (may call exit)

int	bf_read2 (BFile bf, zint no, int offset, int nbytes, void *buf)
	read from block file

int	bf_write (BFile bf, zint no, int offset, int nbytes, const void *buf)
	writes block of bytes to file (may call exit)

int	bf_write2 (BFile bf, zint no, int offset, int nbytes, const void *buf)
	writes block of bytes to file

int	bf_commitExists (BFiles bfs)
	Check if there is content in shadow area (to be committed).

void	bf_reset (BFiles bfs)
	Removes register and shadow completely.

int	bf_commitExec (BFiles bfs)
	Executes commit operation.

void	bf_commitClean (BFiles bfs, const char *spec)
	Cleans shadow files (remove them)

int	bfs_register_directory_stat (BFiles bfs, int no, const char *directory, double used_bytes, double *max_bytes)

int	bfs_shadow_directory_stat (BFiles bfs, int no, const char *directory, double used_bytes, double *max_bytes)

void	bf_xclose (void)

void	bf_xopen (void)

void	bf_alloc (void)

void	bf_free (void)

Macro Definition Documentation

◆ HEADER_SIZE

#define HEADER_SIZE 256

Definition at line 148 of file bfile.c.

Function Documentation

◆ bf_alloc()

void bf_alloc ( void )

Definition at line 358 of file bfile.c.

◆ bf_cache()

ZEBRA_RES bf_cache	(	BFiles	bfs,
		const char *	spec
	)

enables or disables shadow for block files

Parameters

bfs	block files
spec	such as "shadow:100M /other:200M"; or NULL to disable

Return values

ZEBRA_OK	successful. spec is OK
ZEBRA_FAIL	failure.

Definition at line 95 of file bfile.c.

References BFiles_struct::base, BFiles_struct::cache_fname, BFiles_struct::commit_area, MFile_area_struct::dirs, mf_init(), mf_dir::name, ZEBRA_FAIL, and ZEBRA_OK.

Referenced by bf_commitClean(), tst(), zebra_commit_ex(), zebra_init(), and zebra_register_open().

◆ bf_close()

void bf_close ( BFile bf )

closes a Block file (may call exit)

Parameters

bf	block file

Definition at line 139 of file bfile.c.

References bf_close2(), and zebra_exit().

Referenced by bf_open(), dict_bf_close(), isamb_close(), isamc_close(), isams_close(), rec_close(), recindex_close(), tst(), zebra_sort_close(), and zebra_sort_type().

◆ bf_close2()

int bf_close2 ( BFile bf )

closes a Block file

Parameters

bf	block file

Return values

0	success
-1	failure

Definition at line 121 of file bfile.c.

References BFile_struct::cf, cf_close(), BFile_struct::mf, mf_close(), BFile_struct::rdwr_lock, and zebra_lock_rdwr_destroy().

Referenced by bf_close().

◆ bf_commitClean()

void bf_commitClean	(	BFiles	bfs,
		const char *	spec
	)

Cleans shadow files (remove them)

Parameters

bfs	block files
spec	shadow specification

Definition at line 321 of file bfile.c.

References bf_cache(), BFiles_struct::commit_area, mf_reset(), and unlink_cache().

Referenced by zebra_commit_ex(), and zebra_end_transaction().

◆ bf_commitExec()

int bf_commitExec ( BFiles bfs )

Executes commit operation.

Parameters

bfs	block files

Definition at line 277 of file bfile.c.

References cf_close(), cf_commit(), cf_open(), BFiles_struct::commit_area, inf, mf_close(), mf_open(), open_cache(), and BFiles_struct::register_area.

Referenced by zebra_commit_ex().

◆ bf_commitExists()

int bf_commitExists ( BFiles bfs )

Check if there is content in shadow area (to be committed).

Parameters

bfs	block files

Return values

1	there is content in shadow area
0	no content in shadow area

Definition at line 255 of file bfile.c.

References inf, and open_cache().

Referenced by zebra_commit_ex().

◆ bf_free()

void bf_free ( void )

Definition at line 359 of file bfile.c.

◆ bf_open()

BFile bf_open	(	BFiles	bfs,
		const char *	name,
		int	block_size,
		int	wflag
	)

opens and returns a Block file handle

Parameters

bfs	block files
name	filename
block_size	block size in bytes
wflag	1=opened for read&write, 0=read only

Return values

0	success
-1	failure (can never happen as the code is now)

Definition at line 150 of file bfile.c.

References bf_close(), BFile_struct::block_size, BFiles_struct::cache_fname, BFile_struct::cf, cf_open(), BFiles_struct::commit_area, BFile_struct::mf, mf_open(), open_cache(), outf, BFile_struct::rdwr_lock, BFiles_struct::register_area, and zebra_lock_rdwr_init().

Referenced by dict_bf_open(), isamb_open2(), isamc_open(), isams_open(), rec_open(), recindex_open(), tst(), and zebra_sort_type().

◆ bf_read()

int bf_read	(	BFile	bf,
		zint	no,
		int	offset,
		int	nbytes,
		void *	buf
	)

read from block file (may call exit)

Parameters

bf	block file handle
no	block no (first block is 0, second is 1..)
offset	offset within block to be read
nbytes	number of bytes to read (0 for whole block)
buf	raw bytes with content (at least nbytes of size)

Return values

1	whole block could be read
0	whole block could not be read

Definition at line 205 of file bfile.c.

References bf_read2(), and zebra_exit().

Referenced by alloc_block(), cache_block(), dict_bf_readp(), isamb_open2(), isamc_open(), isamc_read_block(), isams_open(), isams_pp_open(), isams_read_item(), new_block(), open_block(), rec_get_int(), rec_prstat(), rec_release_blocks(), rec_write_tmp_buf(), recindex_read_head(), recindex_read_indx(), tst(), zebra_sort_read(), and zebra_sort_type().

◆ bf_read2()

int bf_read2	(	BFile	bf,
		zint	no,
		int	offset,
		int	nbytes,
		void *	buf
	)

read from block file

Parameters

bf	block file handle
no	block no (first block is 0, second is 1..)
offset	offset within block to be read
nbytes	number of bytes to read (0 for whole block)
buf	raw bytes with content (at least nbytes of size)