1
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2
// vim: ft=cpp:expandtab:ts=8:sw=4:softtabstop=4:
3
#ifndef TOKU_SUB_BLOCK_H
4
#define TOKU_SUB_BLOCK_H
8
COPYING CONDITIONS NOTICE:
10
This program is free software; you can redistribute it and/or modify
11
it under the terms of version 2 of the GNU General Public License as
12
published by the Free Software Foundation, and provided that the
13
following conditions are met:
15
* Redistributions of source code must retain this COPYING
16
CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
17
DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
18
PATENT MARKING NOTICE (below), and the PATENT RIGHTS
21
* Redistributions in binary form must reproduce this COPYING
22
CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
23
DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
24
PATENT MARKING NOTICE (below), and the PATENT RIGHTS
25
GRANT (below) in the documentation and/or other materials
26
provided with the distribution.
28
You should have received a copy of the GNU General Public License
29
along with this program; if not, write to the Free Software
30
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
35
TokuDB, Tokutek Fractal Tree Indexing Library.
36
Copyright (C) 2007-2013 Tokutek, Inc.
40
This program is distributed in the hope that it will be useful, but
41
WITHOUT ANY WARRANTY; without even the implied warranty of
42
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
43
General Public License for more details.
45
UNIVERSITY PATENT NOTICE:
47
The technology is licensed by the Massachusetts Institute of
48
Technology, Rutgers State University of New Jersey, and the Research
49
Foundation of State University of New York at Stony Brook under
50
United States of America Serial No. 11/760379 and to the patents
51
and/or patent applications resulting from it.
53
PATENT MARKING NOTICE:
55
This software is covered by US Patent No. 8,185,551.
56
This software is covered by US Patent No. 8,489,638.
60
"THIS IMPLEMENTATION" means the copyrightable works distributed by
61
Tokutek as part of the Fractal Tree project.
63
"PATENT CLAIMS" means the claims of patents that are owned or
64
licensable by Tokutek, both currently or in the future; and that in
65
the absence of this license would be infringed by THIS
66
IMPLEMENTATION or by using or running THIS IMPLEMENTATION.
68
"PATENT CHALLENGE" shall mean a challenge to the validity,
69
patentability, enforceability and/or non-infringement of any of the
70
PATENT CLAIMS or otherwise opposing any of the PATENT CLAIMS.
72
Tokutek hereby grants to you, for the term and geographical scope of
73
the PATENT CLAIMS, a non-exclusive, no-charge, royalty-free,
74
irrevocable (except as stated in this section) patent license to
75
make, have made, use, offer to sell, sell, import, transfer, and
76
otherwise run, modify, and propagate the contents of THIS
77
IMPLEMENTATION, where such license applies only to the PATENT
78
CLAIMS. This grant does not include claims that would be infringed
79
only as a consequence of further modifications of THIS
80
IMPLEMENTATION. If you or your agent or licensee institute or order
81
or agree to the institution of patent litigation against any entity
82
(including a cross-claim or counterclaim in a lawsuit) alleging that
83
THIS IMPLEMENTATION constitutes direct or contributory patent
84
infringement, or inducement of patent infringement, then any rights
85
granted to you under this License shall terminate as of the date
86
such litigation is filed. If you or your agent or exclusive
87
licensee institute or order or agree to the institution of a PATENT
88
CHALLENGE, then Tokutek may terminate any rights granted to you
92
#ident "Copyright (c) 2007-2013 Tokutek Inc. All rights reserved."
93
#ident "The technology is licensed by the Massachusetts Institute of Technology, Rutgers State University of New Jersey, and the Research Foundation of State University of New York at Stony Brook under United States of America Serial No. 11/760379 and to the patents and/or patent applications resulting from it."
99
static const int max_sub_blocks = 8;
100
static const int target_sub_block_size = 512*1024;
101
static const int max_basement_nodes = 32;
102
static const int max_basement_node_uncompressed_size = 256*1024;
103
static const int max_basement_node_compressed_size = 64*1024;
106
void *uncompressed_ptr;
107
uint32_t uncompressed_size;
109
void *compressed_ptr;
110
uint32_t compressed_size; // real compressed size
111
uint32_t compressed_size_bound; // estimated compressed size
113
uint32_t xsum; // sub block checksum
116
struct stored_sub_block {
117
uint32_t uncompressed_size;
118
uint32_t compressed_size;
122
void sub_block_init(SUB_BLOCK);
123
SUB_BLOCK sub_block_creat(void);
125
// get the size of the compression header
127
sub_block_header_size(int n_sub_blocks);
130
set_compressed_size_bound(struct sub_block *se, enum toku_compression_method method);
132
// get the sum of the sub block compressed bound sizes
134
get_sum_compressed_size_bound(int n_sub_blocks, struct sub_block sub_block[], enum toku_compression_method method);
136
// get the sum of the sub block uncompressed sizes
138
get_sum_uncompressed_size(int n_sub_blocks, struct sub_block sub_block[]);
140
// Choose n_sub_blocks and sub_block_size such that the product is >= total_size and the sub_block_size is at
141
// least >= the target_sub_block_size.
143
choose_sub_block_size(int total_size, int n_sub_blocks_limit, int *sub_block_size_ret, int *n_sub_blocks_ret);
146
choose_basement_node_size(int total_size, int *sub_block_size_ret, int *n_sub_blocks_ret);
149
set_all_sub_block_sizes(int total_size, int sub_block_size, int n_sub_blocks, struct sub_block sub_block[]);
151
// find the index of the first sub block that contains the offset
152
// Returns the index if found, else returns -1
154
get_sub_block_index(int n_sub_blocks, struct sub_block sub_block[], size_t offset);
158
struct compress_work {
160
enum toku_compression_method method;
161
struct sub_block *sub_block;
165
compress_work_init(struct compress_work *w, enum toku_compression_method method, struct sub_block *sub_block);
168
compress_nocrc_sub_block(
169
struct sub_block *sub_block,
170
void* sb_compressed_ptr,
172
enum toku_compression_method method
176
compress_sub_block(struct sub_block *sub_block, enum toku_compression_method method);
179
compress_worker(void *arg);
182
compress_all_sub_blocks(int n_sub_blocks, struct sub_block sub_block[], char *uncompressed_ptr, char *compressed_ptr, int num_cores, struct toku_thread_pool *pool, enum toku_compression_method method);
184
struct decompress_work {
187
void *uncompress_ptr;
188
uint32_t compress_size;
189
uint32_t uncompress_size;
194
// initialize the decompression work
196
decompress_work_init(struct decompress_work *dw,
197
void *compress_ptr, uint32_t compress_size,
198
void *uncompress_ptr, uint32_t uncompress_size,
201
// decompress one block
203
decompress_sub_block(void *compress_ptr, uint32_t compress_size, void *uncompress_ptr, uint32_t uncompress_size, uint32_t expected_xsum);
205
// decompress blocks until there is no more work to do
207
decompress_worker(void *arg);
209
// decompress all sub blocks from the compressed_data buffer to the uncompressed_data buffer
210
// Returns 0 if success, otherwise an error
212
decompress_all_sub_blocks(int n_sub_blocks, struct sub_block sub_block[], unsigned char *compressed_data, unsigned char *uncompressed_data, int num_cores, struct toku_thread_pool *pool);
214
extern int verbose_decompress_sub_block;