/usr/include/ffindex.h is in libffindex0-dev 0.9.9.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | /*
* Ffindex
* written by Andreas Hauser <andy@splashground.de>.
* Please add your name here if you distribute modified versions.
*
* Ffindex is provided under the Create Commons license "Attribution-ShareAlike
* 3.0", which basically captures the spirit of the Gnu Public License (GPL).
*
* See:
* http://creativecommons.org/licenses/by-sa/3.0/
*
* Ffindex is a very simple database for small files. The files are stored
* concatenated in one big data file, seperated by '\0'. A second file
* contains a plain text index, giving name, offset and length of of the small
* files.
*/
#ifndef _FFINDEX_H
#define _FFINDEX_H 1
#include <stdio.h>
#define FFINDEX_VERSION 0.993
#define FFINDEX_COPYRIGHT "\nDesigned and implemented by Andreas Hauser <andy@splashground.de>.\n"
// lkajan: the below makes a default allocation over 2G. malloc in ffindex.c:225 fails on a machine with 'only' 2G of RAM.
// lkajan: let the default remain 80000000, and let the actual value be controlled by the env var FFINDEX_MAX_INDEX_ENTRIES wherever FFINDEX_MAX_INDEX_ENTRIES_DEFAULT is used.
#define FFINDEX_MAX_INDEX_ENTRIES_DEFAULT 80000000
#define FFINDEX_MAX_ENTRY_NAME_LENTH 63
enum ffindex_type { PLAIN_FILE, SORTED_FILE, SORTED_ARRAY, TREE };
typedef struct ffindex_entry {
size_t offset;
size_t length;
char name[FFINDEX_MAX_ENTRY_NAME_LENTH + 1];
} ffindex_entry_t;
typedef struct ffindex_index {
enum ffindex_type type;
char* filename;
FILE* file;
char* index_data;
size_t index_data_size;
void* tree_root;
size_t num_max_entries;
size_t n_entries;
ffindex_entry_t entries[]; /* This array is as big as the excess memory allocated for this struct. */
} ffindex_index_t;
/* return *out_data_file, *out_index_file, out_offset. */
int ffindex_index_open(char *data_filename, char *index_filename, char* mode, FILE **out_data_file, FILE **out_index_file, size_t *out_offset);
inline size_t ffindex_max_index_entries(){ char *FMIE = getenv("FFINDEX_MAX_INDEX_ENTRIES"); if( FMIE ) { return atol( FMIE ); } else { return FFINDEX_MAX_INDEX_ENTRIES_DEFAULT; } }
int ffindex_insert_memory(FILE *data_file, FILE *index_file, size_t *offset, char *from_start, size_t from_length, char *name);
int ffindex_insert_file(FILE *data_file, FILE *index_file, size_t *offset, const char *path, char *name);
int ffindex_insert_filestream(FILE *data_file, FILE *index_file, size_t *offset, FILE* file, char *name);
int ffindex_insert_list_file(FILE *data_file, FILE *index_file, size_t *start_offset, FILE *list_file);
int ffindex_insert_dir(FILE *data_file, FILE *index_file, size_t *offset, char *input_dir_name);
int ffindex_insert_ffindex(FILE* data_file, FILE* index_file, size_t* offset, char* data_to_add, ffindex_index_t* index_to_add);
FILE* ffindex_fopen_by_entry(char *data, ffindex_entry_t* entry);
FILE* ffindex_fopen_by_name(char *data, ffindex_index_t *index, char *name);
char* ffindex_mmap_data(FILE *file, size_t* size);
char* ffindex_get_data_by_offset(char* data, size_t offset);
char* ffindex_get_data_by_entry(char *data, ffindex_entry_t* entry);
char* ffindex_get_data_by_name(char *data, ffindex_index_t *index, char *name);
char* ffindex_get_data_by_index(char *data, ffindex_index_t *index, size_t entry_index);
ffindex_entry_t* ffindex_get_entry_by_index(ffindex_index_t *index, size_t entry_index);
ffindex_entry_t* ffindex_get_entry_by_name(ffindex_index_t *index, char *name);
ffindex_index_t* ffindex_index_parse(FILE *index_file, size_t num_max_entries);
ffindex_entry_t* ffindex_bsearch_get_entry(ffindex_index_t *index, char *name);
void ffindex_sort_index_file(ffindex_index_t *index);
int ffindex_write(ffindex_index_t* index, FILE* index_file);
ffindex_index_t* ffindex_unlink(ffindex_index_t* index, char *entry_name);
ffindex_index_t* ffindex_index_as_tree(ffindex_index_t* index);
ffindex_index_t* ffindex_tree_unlink(ffindex_index_t* index, char* name_to_unlink);
ffindex_index_t* ffindex_unlink_entries(ffindex_index_t* index, char** sorted_names_to_unlink, int n_names);
int ffindex_tree_write(ffindex_index_t* index, FILE* index_file);
char* ffindex_copyright();
#endif
|