b39a47cd31f8361a00303e979f92e406121358ba
[oweals/gnunet.git] / src / fs / fs_tree.h
1 /*
2      This file is part of GNUnet.
3      (C) 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file fs/fs_tree.h
23  * @brief Merkle-tree-ish-CHK file encoding for GNUnet
24  * @see https://gnunet.org/encoding
25  * @author Krista Bennett
26  * @author Christian Grothoff
27  *
28  * TODO:
29  * - decide if this API should be made public (gnunet_fs_service.h)
30  *   or remain "internal" (but with exported symbols?)
31  */
32 #ifndef GNUNET_FS_TREE_H
33 #define GNUNET_FS_TREE_H
34
35 #include "fs.h"
36
37 /**
38  * Compute the depth of the CHK tree.  
39  *
40  * @param flen file length for which to compute the depth
41  * @return depth of the tree, always > 0.  A depth of 1 means only a DBLOCK.
42  */
43 unsigned int
44 GNUNET_FS_compute_depth (uint64_t flen);
45
46
47 /**
48  * Calculate how many bytes of payload a block tree of the given
49  * depth MAY correspond to at most (this function ignores the fact that
50  * some blocks will only be present partially due to the total file
51  * size cutting some blocks off at the end).
52  *
53  * @param depth depth of the block.  depth==0 is a DBLOCK.
54  * @return number of bytes of payload a subtree of this depth may correspond to
55  */
56 uint64_t
57 GNUNET_FS_tree_compute_tree_size (unsigned int depth);
58
59
60 /**
61  * Compute how many bytes of data should be stored in
62  * the specified block.
63  *
64  * @param fsize overall file size, must be > 0.
65  * @param offset offset in the original data corresponding
66  *         to the beginning of the tree induced by the block;
67  *         must be < fsize
68  * @param depth depth of the node in the tree, 0 for DBLOCK
69  * @return number of bytes stored in this node
70  */
71 size_t
72 GNUNET_FS_tree_calculate_block_size (uint64_t fsize, uint64_t offset,
73                                      unsigned int depth);
74
75
76 /**
77  * Context for an ECRS-based file encoder that computes
78  * the Merkle-ish-CHK tree.
79  */
80 struct GNUNET_FS_TreeEncoder;
81
82
83 /**
84  * Function called asking for the current (encoded)
85  * block to be processed.  After processing the
86  * client should either call "GNUNET_FS_tree_encode_next"
87  * or (on error) "GNUNET_FS_tree_encode_finish".
88  *
89  * @param cls closure
90  * @param chk content hash key for the block
91  * @param offset offset of the block
92  * @param depth depth of the block, 0 for DBLOCKs
93  * @param type type of the block (IBLOCK or DBLOCK)
94  * @param block the (encrypted) block
95  * @param block_size size of block (in bytes)
96  */
97 typedef void (*GNUNET_FS_TreeBlockProcessor) (void *cls,
98                                               const struct ContentHashKey * chk,
99                                               uint64_t offset,
100                                               unsigned int depth,
101                                               enum GNUNET_BLOCK_Type type,
102                                               const void *block,
103                                               uint16_t block_size);
104
105
106 /**
107  * Function called with information about our
108  * progress in computing the tree encoding.
109  *
110  * @param cls closure
111  * @param offset where are we in the file
112  * @param pt_block plaintext of the currently processed block
113  * @param pt_size size of pt_block
114  * @param depth depth of the block in the tree, 0 for DBLOCKS
115  */
116 typedef void (*GNUNET_FS_TreeProgressCallback) (void *cls, uint64_t offset,
117                                                 const void *pt_block,
118                                                 size_t pt_size,
119                                                 unsigned int depth);
120
121
122 /**
123  * Initialize a tree encoder.  This function will call "proc" and
124  * "progress" on each block in the tree.  Once all blocks have been
125  * processed, "cont" will be scheduled.  The "reader" will be called
126  * to obtain the (plaintext) blocks for the file.  Note that this
127  * function will actually never call "proc"; the "proc" function must
128  * be triggered by calling "GNUNET_FS_tree_encoder_next" to trigger
129  * encryption (and calling of "proc") for each block.
130  *
131  * @param h the global FS context
132  * @param size overall size of the file to encode
133  * @param cls closure for reader, proc, progress and cont
134  * @param reader function to call to read plaintext data
135  * @param proc function to call on each encrypted block
136  * @param progress function to call with progress information 
137  * @param cont function to call when done
138  * @return tree encoder context
139  */
140 struct GNUNET_FS_TreeEncoder *
141 GNUNET_FS_tree_encoder_create (struct GNUNET_FS_Handle *h, uint64_t size,
142                                void *cls, GNUNET_FS_DataReader reader,
143                                GNUNET_FS_TreeBlockProcessor proc,
144                                GNUNET_FS_TreeProgressCallback progress,
145                                GNUNET_SCHEDULER_Task cont);
146
147
148 /**
149  * Encrypt the next block of the file (and 
150  * call proc and progress accordingly; or 
151  * of course "cont" if we have already completed
152  * encoding of the entire file).
153  *
154  * @param te tree encoder to use
155  */
156 void
157 GNUNET_FS_tree_encoder_next (struct GNUNET_FS_TreeEncoder *te);
158
159
160 /**
161  * Clean up a tree encoder and return information
162  * about the resulting URI or an error message.
163  * 
164  * @param te the tree encoder to clean up
165  * @param uri set to the resulting URI (if encoding finished)
166  * @param emsg set to an error message (if an error occured
167  *        within the tree encoder; if this function is called
168  *        prior to completion and prior to an internal error,
169  *        both "*uri" and "*emsg" will be set to NULL).
170  */
171 void
172 GNUNET_FS_tree_encoder_finish (struct GNUNET_FS_TreeEncoder *te,
173                                struct GNUNET_FS_Uri **uri, char **emsg);
174
175
176 #if 0
177 /* the functions below will be needed for persistence
178    but are not yet implemented -- FIXME... */
179 /**
180  * Get data that would be needed to resume
181  * the encoding later.
182  * 
183  * @param te encoding to resume
184  * @param data set to the resume data
185  * @param size set to the size of the resume data
186  */
187 void
188 GNUNET_FS_tree_encoder_resume_get_data (const struct GNUNET_FS_TreeEncoder *te,
189                                         void **data, size_t * size);
190
191
192 /**
193  * Reset tree encoder to point previously
194  * obtained for resuming.
195  * 
196  * @param te encoding to resume
197  * @param data the resume data
198  * @param size the size of the resume data
199  */
200 void
201 GNUNET_FS_tree_encoder_resume (struct GNUNET_FS_TreeEncoder *te,
202                                const void *data, size_t size);
203 #endif
204
205 #endif
206
207 /* end of fs_tree.h */