blob: 1b7e0f7128d6daa1ba009a9a7868fbb81ec5b039 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/befs/btree.c
3 *
4 * Copyright (C) 2001-2002 Will Dyson <will_dyson@pobox.com>
5 *
6 * Licensed under the GNU GPL. See the file COPYING for details.
7 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03008 * 2002-02-05: Sergey S. Kostyliov added binary search within
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * btree nodes.
10 *
11 * Many thanks to:
12 *
13 * Dominic Giampaolo, author of "Practical File System
14 * Design with the Be File System", for such a helpful book.
Luis de Bethencourte60f7492016-11-10 11:25:36 +000015 *
16 * Marcus J. Ranum, author of the b+tree package in
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 * comp.sources.misc volume 10. This code is not copied from that
18 * work, but it is partially based on it.
19 *
20 * Makoto Kato, author of the original BeFS for linux filesystem
21 * driver.
22 */
23
24#include <linux/kernel.h>
25#include <linux/string.h>
26#include <linux/slab.h>
27#include <linux/mm.h>
28#include <linux/buffer_head.h>
29
30#include "befs.h"
31#include "btree.h"
32#include "datastream.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34/*
35 * The btree functions in this file are built on top of the
36 * datastream.c interface, which is in turn built on top of the
37 * io.c interface.
38 */
39
40/* Befs B+tree structure:
Luis de Bethencourte60f7492016-11-10 11:25:36 +000041 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 * The first thing in the tree is the tree superblock. It tells you
43 * all kinds of useful things about the tree, like where the rootnode
44 * is located, and the size of the nodes (always 1024 with current version
45 * of BeOS).
46 *
47 * The rest of the tree consists of a series of nodes. Nodes contain a header
Luis de Bethencourte60f7492016-11-10 11:25:36 +000048 * (struct befs_btree_nodehead), the packed key data, an array of shorts
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 * containing the ending offsets for each of the keys, and an array of
Luis de Bethencourte60f7492016-11-10 11:25:36 +000050 * befs_off_t values. In interior nodes, the keys are the ending keys for
51 * the childnode they point to, and the values are offsets into the
52 * datastream containing the tree.
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 */
54
55/* Note:
Luis de Bethencourte60f7492016-11-10 11:25:36 +000056 *
57 * The book states 2 confusing things about befs b+trees. First,
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 * it states that the overflow field of node headers is used by internal nodes
59 * to point to another node that "effectively continues this one". Here is what
60 * I believe that means. Each key in internal nodes points to another node that
Luis de Bethencourte60f7492016-11-10 11:25:36 +000061 * contains key values less than itself. Inspection reveals that the last key
62 * in the internal node is not the last key in the index. Keys that are
63 * greater than the last key in the internal node go into the overflow node.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * I imagine there is a performance reason for this.
65 *
Luis de Bethencourte60f7492016-11-10 11:25:36 +000066 * Second, it states that the header of a btree node is sufficient to
67 * distinguish internal nodes from leaf nodes. Without saying exactly how.
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 * After figuring out the first, it becomes obvious that internal nodes have
69 * overflow nodes and leafnodes do not.
70 */
71
Luis de Bethencourte60f7492016-11-10 11:25:36 +000072/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * Currently, this code is only good for directory B+trees.
74 * In order to be used for other BFS indexes, it needs to be extended to handle
75 * duplicate keys and non-string keytypes (int32, int64, float, double).
76 */
77
78/*
79 * In memory structure of each btree node
80 */
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -070081struct befs_btree_node {
Al Viroa9721f32005-12-24 14:28:55 -050082 befs_host_btree_nodehead head; /* head of node converted to cpu byteorder */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 struct buffer_head *bh;
84 befs_btree_nodehead *od_node; /* on disk node */
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -070085};
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87/* local constants */
Salah Triki4bb59432016-07-27 04:11:53 +010088static const befs_off_t BEFS_BT_INVAL = 0xffffffffffffffffULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90/* local functions */
Al Viro22341d82016-05-10 14:24:06 -040091static int befs_btree_seekleaf(struct super_block *sb, const befs_data_stream *ds,
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 befs_btree_super * bt_super,
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -070093 struct befs_btree_node *this_node,
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 befs_off_t * node_off);
95
Al Viro22341d82016-05-10 14:24:06 -040096static int befs_bt_read_super(struct super_block *sb, const befs_data_stream *ds,
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 befs_btree_super * sup);
98
Al Viro22341d82016-05-10 14:24:06 -040099static int befs_bt_read_node(struct super_block *sb, const befs_data_stream *ds,
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700100 struct befs_btree_node *node,
101 befs_off_t node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700103static int befs_leafnode(struct befs_btree_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700105static fs16 *befs_bt_keylen_index(struct befs_btree_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700107static fs64 *befs_bt_valarray(struct befs_btree_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700109static char *befs_bt_keydata(struct befs_btree_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700111static int befs_find_key(struct super_block *sb,
112 struct befs_btree_node *node,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 const char *findkey, befs_off_t * value);
114
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700115static char *befs_bt_get_key(struct super_block *sb,
116 struct befs_btree_node *node,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 int index, u16 * keylen);
118
119static int befs_compare_strings(const void *key1, int keylen1,
120 const void *key2, int keylen2);
121
122/**
Tommy Nguyen799ce1dbb2017-07-09 10:25:43 +0100123 * befs_bt_read_super() - read in btree superblock convert to cpu byteorder
124 * @sb: Filesystem superblock
125 * @ds: Datastream to read from
126 * @sup: Buffer in which to place the btree superblock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 *
128 * Calls befs_read_datastream to read in the btree superblock and
129 * makes sure it is in cpu byteorder, byteswapping if necessary.
Tommy Nguyen799ce1dbb2017-07-09 10:25:43 +0100130 * Return: BEFS_OK on success and if *@sup contains the btree superblock in cpu
131 * byte order. Otherwise return BEFS_ERR on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 */
133static int
Al Viro22341d82016-05-10 14:24:06 -0400134befs_bt_read_super(struct super_block *sb, const befs_data_stream *ds,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 befs_btree_super * sup)
136{
Fabian Frederick9f0f5642015-06-25 15:03:43 -0700137 struct buffer_head *bh;
138 befs_disk_btree_super *od_sup;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700140 befs_debug(sb, "---> %s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 bh = befs_read_datastream(sb, ds, 0, NULL);
143
144 if (!bh) {
145 befs_error(sb, "Couldn't read index header.");
146 goto error;
147 }
Al Viroa9721f32005-12-24 14:28:55 -0500148 od_sup = (befs_disk_btree_super *) bh->b_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 befs_dump_index_entry(sb, od_sup);
150
151 sup->magic = fs32_to_cpu(sb, od_sup->magic);
152 sup->node_size = fs32_to_cpu(sb, od_sup->node_size);
153 sup->max_depth = fs32_to_cpu(sb, od_sup->max_depth);
154 sup->data_type = fs32_to_cpu(sb, od_sup->data_type);
155 sup->root_node_ptr = fs64_to_cpu(sb, od_sup->root_node_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 brelse(bh);
158 if (sup->magic != BEFS_BTREE_MAGIC) {
159 befs_error(sb, "Index header has bad magic.");
160 goto error;
161 }
162
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700163 befs_debug(sb, "<--- %s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 return BEFS_OK;
165
166 error:
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700167 befs_debug(sb, "<--- %s ERROR", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 return BEFS_ERR;
169}
170
171/**
172 * befs_bt_read_node - read in btree node and convert to cpu byteorder
173 * @sb: Filesystem superblock
174 * @ds: Datastream to read from
175 * @node: Buffer in which to place the btree node
176 * @node_off: Starting offset (in bytes) of the node in @ds
177 *
178 * Calls befs_read_datastream to read in the indicated btree node and
179 * makes sure its header fields are in cpu byteorder, byteswapping if
180 * necessary.
Luis de Bethencourt2dfa8a62016-07-12 00:02:50 +0100181 * Note: node->bh must be NULL when this function is called the first time.
182 * Don't forget brelse(node->bh) after last call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 *
184 * On success, returns BEFS_OK and *@node contains the btree node that
185 * starts at @node_off, with the node->head fields in cpu byte order.
186 *
187 * On failure, BEFS_ERR is returned.
188 */
189
190static int
Al Viro22341d82016-05-10 14:24:06 -0400191befs_bt_read_node(struct super_block *sb, const befs_data_stream *ds,
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700192 struct befs_btree_node *node, befs_off_t node_off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
194 uint off = 0;
195
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700196 befs_debug(sb, "---> %s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 if (node->bh)
199 brelse(node->bh);
200
201 node->bh = befs_read_datastream(sb, ds, node_off, &off);
202 if (!node->bh) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700203 befs_error(sb, "%s failed to read "
204 "node at %llu", __func__, node_off);
205 befs_debug(sb, "<--- %s ERROR", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207 return BEFS_ERR;
208 }
209 node->od_node =
210 (befs_btree_nodehead *) ((void *) node->bh->b_data + off);
211
212 befs_dump_index_node(sb, node->od_node);
213
214 node->head.left = fs64_to_cpu(sb, node->od_node->left);
215 node->head.right = fs64_to_cpu(sb, node->od_node->right);
216 node->head.overflow = fs64_to_cpu(sb, node->od_node->overflow);
217 node->head.all_key_count =
218 fs16_to_cpu(sb, node->od_node->all_key_count);
219 node->head.all_key_length =
220 fs16_to_cpu(sb, node->od_node->all_key_length);
221
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700222 befs_debug(sb, "<--- %s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 return BEFS_OK;
224}
225
226/**
227 * befs_btree_find - Find a key in a befs B+tree
228 * @sb: Filesystem superblock
229 * @ds: Datastream containing btree
230 * @key: Key string to lookup in btree
231 * @value: Value stored with @key
232 *
Joe Perchesc78bad12008-02-03 17:33:42 +0200233 * On success, returns BEFS_OK and sets *@value to the value stored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 * with @key (usually the disk block number of an inode).
235 *
236 * On failure, returns BEFS_ERR or BEFS_BT_NOT_FOUND.
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000237 *
238 * Algorithm:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 * Read the superblock and rootnode of the b+tree.
240 * Drill down through the interior nodes using befs_find_key().
241 * Once at the correct leaf node, use befs_find_key() again to get the
Luis de Bethencourt02d91f92016-08-11 22:15:16 +0100242 * actual value stored with the key.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 */
244int
Al Viro22341d82016-05-10 14:24:06 -0400245befs_btree_find(struct super_block *sb, const befs_data_stream *ds,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 const char *key, befs_off_t * value)
247{
Fabian Frederick9f0f5642015-06-25 15:03:43 -0700248 struct befs_btree_node *this_node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 befs_btree_super bt_super;
250 befs_off_t node_off;
251 int res;
252
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700253 befs_debug(sb, "---> %s Key: %s", __func__, key);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255 if (befs_bt_read_super(sb, ds, &bt_super) != BEFS_OK) {
256 befs_error(sb,
257 "befs_btree_find() failed to read index superblock");
258 goto error;
259 }
260
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700261 this_node = kmalloc(sizeof(struct befs_btree_node),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 GFP_NOFS);
263 if (!this_node) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700264 befs_error(sb, "befs_btree_find() failed to allocate %zu "
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700265 "bytes of memory", sizeof(struct befs_btree_node));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 goto error;
267 }
268
269 this_node->bh = NULL;
270
271 /* read in root node */
272 node_off = bt_super.root_node_ptr;
273 if (befs_bt_read_node(sb, ds, this_node, node_off) != BEFS_OK) {
274 befs_error(sb, "befs_btree_find() failed to read "
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700275 "node at %llu", node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 goto error_alloc;
277 }
278
279 while (!befs_leafnode(this_node)) {
280 res = befs_find_key(sb, this_node, key, &node_off);
Luis de Bethencourt672a8512016-08-08 15:21:20 +0100281 /* if no key set, try the overflow node */
282 if (res == BEFS_BT_OVERFLOW)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 node_off = this_node->head.overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 if (befs_bt_read_node(sb, ds, this_node, node_off) != BEFS_OK) {
285 befs_error(sb, "befs_btree_find() failed to read "
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700286 "node at %llu", node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 goto error_alloc;
288 }
289 }
290
Luis de Bethencourt672a8512016-08-08 15:21:20 +0100291 /* at a leaf node now, check if it is correct */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 res = befs_find_key(sb, this_node, key, value);
293
294 brelse(this_node->bh);
295 kfree(this_node);
296
297 if (res != BEFS_BT_MATCH) {
Luis de Bethencourt4c3897c2016-07-03 16:29:44 +0100298 befs_error(sb, "<--- %s Key %s not found", __func__, key);
299 befs_debug(sb, "<--- %s ERROR", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 *value = 0;
301 return BEFS_BT_NOT_FOUND;
302 }
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700303 befs_debug(sb, "<--- %s Found key %s, value %llu", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 key, *value);
305 return BEFS_OK;
306
307 error_alloc:
308 kfree(this_node);
309 error:
310 *value = 0;
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700311 befs_debug(sb, "<--- %s ERROR", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 return BEFS_ERR;
313}
314
315/**
316 * befs_find_key - Search for a key within a node
317 * @sb: Filesystem superblock
318 * @node: Node to find the key within
Fabian Frederick817e1d92014-06-06 14:36:17 -0700319 * @findkey: Keystring to search for
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 * @value: If key is found, the value stored with the key is put here
321 *
Luis de Bethencourt672a8512016-08-08 15:21:20 +0100322 * Finds exact match if one exists, and returns BEFS_BT_MATCH.
323 * If there is no match and node's value array is too small for key, return
324 * BEFS_BT_OVERFLOW.
325 * If no match and node should countain this key, return BEFS_BT_NOT_FOUND.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 *
Luis de Bethencourt672a8512016-08-08 15:21:20 +0100327 * Uses binary search instead of a linear.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
329static int
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700330befs_find_key(struct super_block *sb, struct befs_btree_node *node,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 const char *findkey, befs_off_t * value)
332{
333 int first, last, mid;
334 int eq;
335 u16 keylen;
336 int findkey_len;
337 char *thiskey;
Al Viroa9721f32005-12-24 14:28:55 -0500338 fs64 *valarray;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700340 befs_debug(sb, "---> %s %s", __func__, findkey);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 findkey_len = strlen(findkey);
343
Luis de Bethencourtbb75e662016-08-08 15:21:21 +0100344 /* if node can not contain key, just skip this node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 last = node->head.all_key_count - 1;
346 thiskey = befs_bt_get_key(sb, node, last, &keylen);
347
348 eq = befs_compare_strings(thiskey, keylen, findkey, findkey_len);
349 if (eq < 0) {
Luis de Bethencourt672a8512016-08-08 15:21:20 +0100350 befs_debug(sb, "<--- node can't contain %s", findkey);
351 return BEFS_BT_OVERFLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 }
353
354 valarray = befs_bt_valarray(node);
355
356 /* simple binary search */
357 first = 0;
358 mid = 0;
359 while (last >= first) {
360 mid = (last + first) / 2;
361 befs_debug(sb, "first: %d, last: %d, mid: %d", first, last,
362 mid);
363 thiskey = befs_bt_get_key(sb, node, mid, &keylen);
364 eq = befs_compare_strings(thiskey, keylen, findkey,
365 findkey_len);
366
367 if (eq == 0) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700368 befs_debug(sb, "<--- %s found %s at %d",
369 __func__, thiskey, mid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371 *value = fs64_to_cpu(sb, valarray[mid]);
372 return BEFS_BT_MATCH;
373 }
374 if (eq > 0)
375 last = mid - 1;
376 else
377 first = mid + 1;
378 }
Luis de Bethencourt672a8512016-08-08 15:21:20 +0100379
380 /* return an existing value so caller can arrive to a leaf node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 if (eq < 0)
382 *value = fs64_to_cpu(sb, valarray[mid + 1]);
383 else
384 *value = fs64_to_cpu(sb, valarray[mid]);
Luis de Bethencourt672a8512016-08-08 15:21:20 +0100385 befs_error(sb, "<--- %s %s not found", __func__, findkey);
386 befs_debug(sb, "<--- %s ERROR", __func__);
387 return BEFS_BT_NOT_FOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388}
389
390/**
391 * befs_btree_read - Traverse leafnodes of a btree
392 * @sb: Filesystem superblock
393 * @ds: Datastream containing btree
394 * @key_no: Key number (alphabetical order) of key to read
395 * @bufsize: Size of the buffer to return key in
396 * @keybuf: Pointer to a buffer to put the key in
397 * @keysize: Length of the returned key
398 * @value: Value stored with the returned key
399 *
Luis de Bethencourt02d91f92016-08-11 22:15:16 +0100400 * Here's how it works: Key_no is the index of the key/value pair to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * return in keybuf/value.
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000402 * Bufsize is the size of keybuf (BEFS_NAME_LEN+1 is a good size). Keysize is
Fabian Frederick6cb103b2014-06-06 14:36:15 -0700403 * the number of characters in the key (just a convenience).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 *
405 * Algorithm:
406 * Get the first leafnode of the tree. See if the requested key is in that
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000407 * node. If not, follow the node->right link to the next leafnode. Repeat
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 * until the (key_no)th key is found or the tree is out of keys.
409 */
410int
Al Viro22341d82016-05-10 14:24:06 -0400411befs_btree_read(struct super_block *sb, const befs_data_stream *ds,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 loff_t key_no, size_t bufsize, char *keybuf, size_t * keysize,
413 befs_off_t * value)
414{
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700415 struct befs_btree_node *this_node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 befs_btree_super bt_super;
Salah Triki143d2a62016-07-31 21:34:28 +0100417 befs_off_t node_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 int cur_key;
Al Viroa9721f32005-12-24 14:28:55 -0500419 fs64 *valarray;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 char *keystart;
421 u16 keylen;
422 int res;
423
424 uint key_sum = 0;
425
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700426 befs_debug(sb, "---> %s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
428 if (befs_bt_read_super(sb, ds, &bt_super) != BEFS_OK) {
429 befs_error(sb,
430 "befs_btree_read() failed to read index superblock");
431 goto error;
432 }
433
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700434 this_node = kmalloc(sizeof(struct befs_btree_node), GFP_NOFS);
435 if (this_node == NULL) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700436 befs_error(sb, "befs_btree_read() failed to allocate %zu "
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700437 "bytes of memory", sizeof(struct befs_btree_node));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 goto error;
439 }
440
441 node_off = bt_super.root_node_ptr;
442 this_node->bh = NULL;
443
444 /* seeks down to first leafnode, reads it into this_node */
445 res = befs_btree_seekleaf(sb, ds, &bt_super, this_node, &node_off);
446 if (res == BEFS_BT_EMPTY) {
447 brelse(this_node->bh);
448 kfree(this_node);
449 *value = 0;
450 *keysize = 0;
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700451 befs_debug(sb, "<--- %s Tree is EMPTY", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 return BEFS_BT_EMPTY;
453 } else if (res == BEFS_ERR) {
454 goto error_alloc;
455 }
456
457 /* find the leaf node containing the key_no key */
458
459 while (key_sum + this_node->head.all_key_count <= key_no) {
460
461 /* no more nodes to look in: key_no is too large */
Salah Triki4bb59432016-07-27 04:11:53 +0100462 if (this_node->head.right == BEFS_BT_INVAL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 *keysize = 0;
464 *value = 0;
465 befs_debug(sb,
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700466 "<--- %s END of keys at %llu", __func__,
467 (unsigned long long)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 key_sum + this_node->head.all_key_count);
469 brelse(this_node->bh);
470 kfree(this_node);
471 return BEFS_BT_END;
472 }
473
474 key_sum += this_node->head.all_key_count;
475 node_off = this_node->head.right;
476
477 if (befs_bt_read_node(sb, ds, this_node, node_off) != BEFS_OK) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700478 befs_error(sb, "%s failed to read node at %llu",
479 __func__, (unsigned long long)node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 goto error_alloc;
481 }
482 }
483
484 /* how many keys into this_node is key_no */
485 cur_key = key_no - key_sum;
486
487 /* get pointers to datastructures within the node body */
488 valarray = befs_bt_valarray(this_node);
489
490 keystart = befs_bt_get_key(sb, this_node, cur_key, &keylen);
491
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700492 befs_debug(sb, "Read [%llu,%d]: keysize %d",
493 (long long unsigned int)node_off, (int)cur_key,
494 (int)keylen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
496 if (bufsize < keylen + 1) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700497 befs_error(sb, "%s keybuf too small (%zu) "
498 "for key of size %d", __func__, bufsize, keylen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 brelse(this_node->bh);
500 goto error_alloc;
Fabian Frederick6cb103b2014-06-06 14:36:15 -0700501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Fabian Frederick6cb103b2014-06-06 14:36:15 -0700503 strlcpy(keybuf, keystart, keylen + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 *value = fs64_to_cpu(sb, valarray[cur_key]);
505 *keysize = keylen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700507 befs_debug(sb, "Read [%llu,%d]: Key \"%.*s\", Value %llu", node_off,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 cur_key, keylen, keybuf, *value);
509
510 brelse(this_node->bh);
511 kfree(this_node);
512
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700513 befs_debug(sb, "<--- %s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
515 return BEFS_OK;
516
517 error_alloc:
518 kfree(this_node);
519
520 error:
521 *keysize = 0;
522 *value = 0;
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700523 befs_debug(sb, "<--- %s ERROR", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 return BEFS_ERR;
525}
526
527/**
528 * befs_btree_seekleaf - Find the first leafnode in the btree
529 * @sb: Filesystem superblock
530 * @ds: Datastream containing btree
531 * @bt_super: Pointer to the superblock of the btree
532 * @this_node: Buffer to return the leafnode in
533 * @node_off: Pointer to offset of current node within datastream. Modified
534 * by the function.
535 *
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000536 * Helper function for btree traverse. Moves the current position to the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 * start of the first leaf node.
538 *
539 * Also checks for an empty tree. If there are no keys, returns BEFS_BT_EMPTY.
540 */
541static int
Al Viro22341d82016-05-10 14:24:06 -0400542befs_btree_seekleaf(struct super_block *sb, const befs_data_stream *ds,
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700543 befs_btree_super *bt_super,
544 struct befs_btree_node *this_node,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 befs_off_t * node_off)
546{
547
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700548 befs_debug(sb, "---> %s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550 if (befs_bt_read_node(sb, ds, this_node, *node_off) != BEFS_OK) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700551 befs_error(sb, "%s failed to read "
552 "node at %llu", __func__, *node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 goto error;
554 }
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700555 befs_debug(sb, "Seekleaf to root node %llu", *node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
557 if (this_node->head.all_key_count == 0 && befs_leafnode(this_node)) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700558 befs_debug(sb, "<--- %s Tree is EMPTY", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 return BEFS_BT_EMPTY;
560 }
561
562 while (!befs_leafnode(this_node)) {
563
564 if (this_node->head.all_key_count == 0) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700565 befs_debug(sb, "%s encountered "
566 "an empty interior node: %llu. Using Overflow "
567 "node: %llu", __func__, *node_off,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 this_node->head.overflow);
569 *node_off = this_node->head.overflow;
570 } else {
Al Viroa9721f32005-12-24 14:28:55 -0500571 fs64 *valarray = befs_bt_valarray(this_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 *node_off = fs64_to_cpu(sb, valarray[0]);
573 }
574 if (befs_bt_read_node(sb, ds, this_node, *node_off) != BEFS_OK) {
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700575 befs_error(sb, "%s failed to read "
576 "node at %llu", __func__, *node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 goto error;
578 }
579
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700580 befs_debug(sb, "Seekleaf to child node %llu", *node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 }
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700582 befs_debug(sb, "Node %llu is a leaf node", *node_off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
584 return BEFS_OK;
585
586 error:
Fabian Frederickdac52fc2014-04-03 14:50:23 -0700587 befs_debug(sb, "<--- %s ERROR", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 return BEFS_ERR;
589}
590
591/**
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000592 * befs_leafnode - Determine if the btree node is a leaf node or an
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 * interior node
594 * @node: Pointer to node structure to test
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000595 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 * Return 1 if leaf, 0 if interior
597 */
598static int
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700599befs_leafnode(struct befs_btree_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600{
601 /* all interior nodes (and only interior nodes) have an overflow node */
Salah Triki4bb59432016-07-27 04:11:53 +0100602 if (node->head.overflow == BEFS_BT_INVAL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 return 1;
604 else
605 return 0;
606}
607
608/**
609 * befs_bt_keylen_index - Finds start of keylen index in a node
610 * @node: Pointer to the node structure to find the keylen index within
611 *
612 * Returns a pointer to the start of the key length index array
613 * of the B+tree node *@node
614 *
615 * "The length of all the keys in the node is added to the size of the
616 * header and then rounded up to a multiple of four to get the beginning
617 * of the key length index" (p.88, practical filesystem design).
618 *
619 * Except that rounding up to 8 works, and rounding up to 4 doesn't.
620 */
Al Viroa9721f32005-12-24 14:28:55 -0500621static fs16 *
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700622befs_bt_keylen_index(struct befs_btree_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623{
624 const int keylen_align = 8;
625 unsigned long int off =
626 (sizeof (befs_btree_nodehead) + node->head.all_key_length);
627 ulong tmp = off % keylen_align;
628
629 if (tmp)
630 off += keylen_align - tmp;
631
Al Viroa9721f32005-12-24 14:28:55 -0500632 return (fs16 *) ((void *) node->od_node + off);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
634
635/**
636 * befs_bt_valarray - Finds the start of value array in a node
637 * @node: Pointer to the node structure to find the value array within
638 *
639 * Returns a pointer to the start of the value array
640 * of the node pointed to by the node header
641 */
Al Viroa9721f32005-12-24 14:28:55 -0500642static fs64 *
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700643befs_bt_valarray(struct befs_btree_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644{
645 void *keylen_index_start = (void *) befs_bt_keylen_index(node);
Al Viroa9721f32005-12-24 14:28:55 -0500646 size_t keylen_index_size = node->head.all_key_count * sizeof (fs16);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Al Viroa9721f32005-12-24 14:28:55 -0500648 return (fs64 *) (keylen_index_start + keylen_index_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
650
651/**
652 * befs_bt_keydata - Finds start of keydata array in a node
653 * @node: Pointer to the node structure to find the keydata array within
654 *
655 * Returns a pointer to the start of the keydata array
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000656 * of the node pointed to by the node header
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 */
658static char *
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700659befs_bt_keydata(struct befs_btree_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
661 return (char *) ((void *) node->od_node + sizeof (befs_btree_nodehead));
662}
663
664/**
665 * befs_bt_get_key - returns a pointer to the start of a key
666 * @sb: filesystem superblock
667 * @node: node in which to look for the key
668 * @index: the index of the key to get
669 * @keylen: modified to be the length of the key at @index
670 *
671 * Returns a valid pointer into @node on success.
672 * Returns NULL on failure (bad input) and sets *@keylen = 0
673 */
674static char *
Himangi Saraogi0f2a84f2014-10-13 15:53:18 -0700675befs_bt_get_key(struct super_block *sb, struct befs_btree_node *node,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 int index, u16 * keylen)
677{
678 int prev_key_end;
679 char *keystart;
Al Viroa9721f32005-12-24 14:28:55 -0500680 fs16 *keylen_index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
682 if (index < 0 || index > node->head.all_key_count) {
683 *keylen = 0;
684 return NULL;
685 }
686
687 keystart = befs_bt_keydata(node);
688 keylen_index = befs_bt_keylen_index(node);
689
690 if (index == 0)
691 prev_key_end = 0;
692 else
693 prev_key_end = fs16_to_cpu(sb, keylen_index[index - 1]);
694
695 *keylen = fs16_to_cpu(sb, keylen_index[index]) - prev_key_end;
696
697 return keystart + prev_key_end;
698}
699
700/**
701 * befs_compare_strings - compare two strings
Luis de Bethencourte60f7492016-11-10 11:25:36 +0000702 * @key1: pointer to the first key to be compared
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 * @keylen1: length in bytes of key1
704 * @key2: pointer to the second key to be compared
Fabian Frederick817e1d92014-06-06 14:36:17 -0700705 * @keylen2: length in bytes of key2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 *
707 * Returns 0 if @key1 and @key2 are equal.
708 * Returns >0 if @key1 is greater.
Luis de Bethencourt02d91f92016-08-11 22:15:16 +0100709 * Returns <0 if @key2 is greater.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 */
711static int
712befs_compare_strings(const void *key1, int keylen1,
713 const void *key2, int keylen2)
714{
715 int len = min_t(int, keylen1, keylen2);
716 int result = strncmp(key1, key2, len);
717 if (result == 0)
718 result = keylen1 - keylen2;
719 return result;
720}
721
722/* These will be used for non-string keyed btrees */
723#if 0
724static int
725btree_compare_int32(cont void *key1, int keylen1, const void *key2, int keylen2)
726{
727 return *(int32_t *) key1 - *(int32_t *) key2;
728}
729
730static int
731btree_compare_uint32(cont void *key1, int keylen1,
732 const void *key2, int keylen2)
733{
734 if (*(u_int32_t *) key1 == *(u_int32_t *) key2)
735 return 0;
736 else if (*(u_int32_t *) key1 > *(u_int32_t *) key2)
737 return 1;
738
739 return -1;
740}
741static int
742btree_compare_int64(cont void *key1, int keylen1, const void *key2, int keylen2)
743{
744 if (*(int64_t *) key1 == *(int64_t *) key2)
745 return 0;
746 else if (*(int64_t *) key1 > *(int64_t *) key2)
747 return 1;
748
749 return -1;
750}
751
752static int
753btree_compare_uint64(cont void *key1, int keylen1,
754 const void *key2, int keylen2)
755{
756 if (*(u_int64_t *) key1 == *(u_int64_t *) key2)
757 return 0;
758 else if (*(u_int64_t *) key1 > *(u_int64_t *) key2)
759 return 1;
760
761 return -1;
762}
763
764static int
765btree_compare_float(cont void *key1, int keylen1, const void *key2, int keylen2)
766{
767 float result = *(float *) key1 - *(float *) key2;
768 if (result == 0.0f)
769 return 0;
770
771 return (result < 0.0f) ? -1 : 1;
772}
773
774static int
775btree_compare_double(cont void *key1, int keylen1,
776 const void *key2, int keylen2)
777{
778 double result = *(double *) key1 - *(double *) key2;
779 if (result == 0.0)
780 return 0;
781
782 return (result < 0.0) ? -1 : 1;
783}
784#endif //0