1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * linux/fs/hfsplus/bfind.c
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 2001
6*4882a593Smuzhiyun * Brad Boyer (flar@allandria.com)
7*4882a593Smuzhiyun * (C) 2003 Ardis Technologies <roman@ardistech.com>
8*4882a593Smuzhiyun *
9*4882a593Smuzhiyun * Search routines for btrees
10*4882a593Smuzhiyun */
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun #include <linux/slab.h>
13*4882a593Smuzhiyun #include "hfsplus_fs.h"
14*4882a593Smuzhiyun
hfs_find_init(struct hfs_btree * tree,struct hfs_find_data * fd)15*4882a593Smuzhiyun int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd)
16*4882a593Smuzhiyun {
17*4882a593Smuzhiyun void *ptr;
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun fd->tree = tree;
20*4882a593Smuzhiyun fd->bnode = NULL;
21*4882a593Smuzhiyun ptr = kmalloc(tree->max_key_len * 2 + 4, GFP_KERNEL);
22*4882a593Smuzhiyun if (!ptr)
23*4882a593Smuzhiyun return -ENOMEM;
24*4882a593Smuzhiyun fd->search_key = ptr;
25*4882a593Smuzhiyun fd->key = ptr + tree->max_key_len + 2;
26*4882a593Smuzhiyun hfs_dbg(BNODE_REFS, "find_init: %d (%p)\n",
27*4882a593Smuzhiyun tree->cnid, __builtin_return_address(0));
28*4882a593Smuzhiyun switch (tree->cnid) {
29*4882a593Smuzhiyun case HFSPLUS_CAT_CNID:
30*4882a593Smuzhiyun mutex_lock_nested(&tree->tree_lock, CATALOG_BTREE_MUTEX);
31*4882a593Smuzhiyun break;
32*4882a593Smuzhiyun case HFSPLUS_EXT_CNID:
33*4882a593Smuzhiyun mutex_lock_nested(&tree->tree_lock, EXTENTS_BTREE_MUTEX);
34*4882a593Smuzhiyun break;
35*4882a593Smuzhiyun case HFSPLUS_ATTR_CNID:
36*4882a593Smuzhiyun mutex_lock_nested(&tree->tree_lock, ATTR_BTREE_MUTEX);
37*4882a593Smuzhiyun break;
38*4882a593Smuzhiyun default:
39*4882a593Smuzhiyun BUG();
40*4882a593Smuzhiyun }
41*4882a593Smuzhiyun return 0;
42*4882a593Smuzhiyun }
43*4882a593Smuzhiyun
hfs_find_exit(struct hfs_find_data * fd)44*4882a593Smuzhiyun void hfs_find_exit(struct hfs_find_data *fd)
45*4882a593Smuzhiyun {
46*4882a593Smuzhiyun hfs_bnode_put(fd->bnode);
47*4882a593Smuzhiyun kfree(fd->search_key);
48*4882a593Smuzhiyun hfs_dbg(BNODE_REFS, "find_exit: %d (%p)\n",
49*4882a593Smuzhiyun fd->tree->cnid, __builtin_return_address(0));
50*4882a593Smuzhiyun mutex_unlock(&fd->tree->tree_lock);
51*4882a593Smuzhiyun fd->tree = NULL;
52*4882a593Smuzhiyun }
53*4882a593Smuzhiyun
hfs_find_1st_rec_by_cnid(struct hfs_bnode * bnode,struct hfs_find_data * fd,int * begin,int * end,int * cur_rec)54*4882a593Smuzhiyun int hfs_find_1st_rec_by_cnid(struct hfs_bnode *bnode,
55*4882a593Smuzhiyun struct hfs_find_data *fd,
56*4882a593Smuzhiyun int *begin,
57*4882a593Smuzhiyun int *end,
58*4882a593Smuzhiyun int *cur_rec)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun __be32 cur_cnid;
61*4882a593Smuzhiyun __be32 search_cnid;
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun if (bnode->tree->cnid == HFSPLUS_EXT_CNID) {
64*4882a593Smuzhiyun cur_cnid = fd->key->ext.cnid;
65*4882a593Smuzhiyun search_cnid = fd->search_key->ext.cnid;
66*4882a593Smuzhiyun } else if (bnode->tree->cnid == HFSPLUS_CAT_CNID) {
67*4882a593Smuzhiyun cur_cnid = fd->key->cat.parent;
68*4882a593Smuzhiyun search_cnid = fd->search_key->cat.parent;
69*4882a593Smuzhiyun } else if (bnode->tree->cnid == HFSPLUS_ATTR_CNID) {
70*4882a593Smuzhiyun cur_cnid = fd->key->attr.cnid;
71*4882a593Smuzhiyun search_cnid = fd->search_key->attr.cnid;
72*4882a593Smuzhiyun } else {
73*4882a593Smuzhiyun cur_cnid = 0; /* used-uninitialized warning */
74*4882a593Smuzhiyun search_cnid = 0;
75*4882a593Smuzhiyun BUG();
76*4882a593Smuzhiyun }
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun if (cur_cnid == search_cnid) {
79*4882a593Smuzhiyun (*end) = (*cur_rec);
80*4882a593Smuzhiyun if ((*begin) == (*end))
81*4882a593Smuzhiyun return 1;
82*4882a593Smuzhiyun } else {
83*4882a593Smuzhiyun if (be32_to_cpu(cur_cnid) < be32_to_cpu(search_cnid))
84*4882a593Smuzhiyun (*begin) = (*cur_rec) + 1;
85*4882a593Smuzhiyun else
86*4882a593Smuzhiyun (*end) = (*cur_rec) - 1;
87*4882a593Smuzhiyun }
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun return 0;
90*4882a593Smuzhiyun }
91*4882a593Smuzhiyun
hfs_find_rec_by_key(struct hfs_bnode * bnode,struct hfs_find_data * fd,int * begin,int * end,int * cur_rec)92*4882a593Smuzhiyun int hfs_find_rec_by_key(struct hfs_bnode *bnode,
93*4882a593Smuzhiyun struct hfs_find_data *fd,
94*4882a593Smuzhiyun int *begin,
95*4882a593Smuzhiyun int *end,
96*4882a593Smuzhiyun int *cur_rec)
97*4882a593Smuzhiyun {
98*4882a593Smuzhiyun int cmpval;
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun cmpval = bnode->tree->keycmp(fd->key, fd->search_key);
101*4882a593Smuzhiyun if (!cmpval) {
102*4882a593Smuzhiyun (*end) = (*cur_rec);
103*4882a593Smuzhiyun return 1;
104*4882a593Smuzhiyun }
105*4882a593Smuzhiyun if (cmpval < 0)
106*4882a593Smuzhiyun (*begin) = (*cur_rec) + 1;
107*4882a593Smuzhiyun else
108*4882a593Smuzhiyun *(end) = (*cur_rec) - 1;
109*4882a593Smuzhiyun
110*4882a593Smuzhiyun return 0;
111*4882a593Smuzhiyun }
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun /* Find the record in bnode that best matches key (not greater than...)*/
__hfs_brec_find(struct hfs_bnode * bnode,struct hfs_find_data * fd,search_strategy_t rec_found)114*4882a593Smuzhiyun int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd,
115*4882a593Smuzhiyun search_strategy_t rec_found)
116*4882a593Smuzhiyun {
117*4882a593Smuzhiyun u16 off, len, keylen;
118*4882a593Smuzhiyun int rec;
119*4882a593Smuzhiyun int b, e;
120*4882a593Smuzhiyun int res;
121*4882a593Smuzhiyun
122*4882a593Smuzhiyun BUG_ON(!rec_found);
123*4882a593Smuzhiyun b = 0;
124*4882a593Smuzhiyun e = bnode->num_recs - 1;
125*4882a593Smuzhiyun res = -ENOENT;
126*4882a593Smuzhiyun do {
127*4882a593Smuzhiyun rec = (e + b) / 2;
128*4882a593Smuzhiyun len = hfs_brec_lenoff(bnode, rec, &off);
129*4882a593Smuzhiyun keylen = hfs_brec_keylen(bnode, rec);
130*4882a593Smuzhiyun if (keylen == 0) {
131*4882a593Smuzhiyun res = -EINVAL;
132*4882a593Smuzhiyun goto fail;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun hfs_bnode_read(bnode, fd->key, off, keylen);
135*4882a593Smuzhiyun if (rec_found(bnode, fd, &b, &e, &rec)) {
136*4882a593Smuzhiyun res = 0;
137*4882a593Smuzhiyun goto done;
138*4882a593Smuzhiyun }
139*4882a593Smuzhiyun } while (b <= e);
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun if (rec != e && e >= 0) {
142*4882a593Smuzhiyun len = hfs_brec_lenoff(bnode, e, &off);
143*4882a593Smuzhiyun keylen = hfs_brec_keylen(bnode, e);
144*4882a593Smuzhiyun if (keylen == 0) {
145*4882a593Smuzhiyun res = -EINVAL;
146*4882a593Smuzhiyun goto fail;
147*4882a593Smuzhiyun }
148*4882a593Smuzhiyun hfs_bnode_read(bnode, fd->key, off, keylen);
149*4882a593Smuzhiyun }
150*4882a593Smuzhiyun
151*4882a593Smuzhiyun done:
152*4882a593Smuzhiyun fd->record = e;
153*4882a593Smuzhiyun fd->keyoffset = off;
154*4882a593Smuzhiyun fd->keylength = keylen;
155*4882a593Smuzhiyun fd->entryoffset = off + keylen;
156*4882a593Smuzhiyun fd->entrylength = len - keylen;
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun fail:
159*4882a593Smuzhiyun return res;
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun
162*4882a593Smuzhiyun /* Traverse a B*Tree from the root to a leaf finding best fit to key */
163*4882a593Smuzhiyun /* Return allocated copy of node found, set recnum to best record */
hfs_brec_find(struct hfs_find_data * fd,search_strategy_t do_key_compare)164*4882a593Smuzhiyun int hfs_brec_find(struct hfs_find_data *fd, search_strategy_t do_key_compare)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun struct hfs_btree *tree;
167*4882a593Smuzhiyun struct hfs_bnode *bnode;
168*4882a593Smuzhiyun u32 nidx, parent;
169*4882a593Smuzhiyun __be32 data;
170*4882a593Smuzhiyun int height, res;
171*4882a593Smuzhiyun
172*4882a593Smuzhiyun tree = fd->tree;
173*4882a593Smuzhiyun if (fd->bnode)
174*4882a593Smuzhiyun hfs_bnode_put(fd->bnode);
175*4882a593Smuzhiyun fd->bnode = NULL;
176*4882a593Smuzhiyun nidx = tree->root;
177*4882a593Smuzhiyun if (!nidx)
178*4882a593Smuzhiyun return -ENOENT;
179*4882a593Smuzhiyun height = tree->depth;
180*4882a593Smuzhiyun res = 0;
181*4882a593Smuzhiyun parent = 0;
182*4882a593Smuzhiyun for (;;) {
183*4882a593Smuzhiyun bnode = hfs_bnode_find(tree, nidx);
184*4882a593Smuzhiyun if (IS_ERR(bnode)) {
185*4882a593Smuzhiyun res = PTR_ERR(bnode);
186*4882a593Smuzhiyun bnode = NULL;
187*4882a593Smuzhiyun break;
188*4882a593Smuzhiyun }
189*4882a593Smuzhiyun if (bnode->height != height)
190*4882a593Smuzhiyun goto invalid;
191*4882a593Smuzhiyun if (bnode->type != (--height ? HFS_NODE_INDEX : HFS_NODE_LEAF))
192*4882a593Smuzhiyun goto invalid;
193*4882a593Smuzhiyun bnode->parent = parent;
194*4882a593Smuzhiyun
195*4882a593Smuzhiyun res = __hfs_brec_find(bnode, fd, do_key_compare);
196*4882a593Smuzhiyun if (!height)
197*4882a593Smuzhiyun break;
198*4882a593Smuzhiyun if (fd->record < 0)
199*4882a593Smuzhiyun goto release;
200*4882a593Smuzhiyun
201*4882a593Smuzhiyun parent = nidx;
202*4882a593Smuzhiyun hfs_bnode_read(bnode, &data, fd->entryoffset, 4);
203*4882a593Smuzhiyun nidx = be32_to_cpu(data);
204*4882a593Smuzhiyun hfs_bnode_put(bnode);
205*4882a593Smuzhiyun }
206*4882a593Smuzhiyun fd->bnode = bnode;
207*4882a593Smuzhiyun return res;
208*4882a593Smuzhiyun
209*4882a593Smuzhiyun invalid:
210*4882a593Smuzhiyun pr_err("inconsistency in B*Tree (%d,%d,%d,%u,%u)\n",
211*4882a593Smuzhiyun height, bnode->height, bnode->type, nidx, parent);
212*4882a593Smuzhiyun res = -EIO;
213*4882a593Smuzhiyun release:
214*4882a593Smuzhiyun hfs_bnode_put(bnode);
215*4882a593Smuzhiyun return res;
216*4882a593Smuzhiyun }
217*4882a593Smuzhiyun
hfs_brec_read(struct hfs_find_data * fd,void * rec,int rec_len)218*4882a593Smuzhiyun int hfs_brec_read(struct hfs_find_data *fd, void *rec, int rec_len)
219*4882a593Smuzhiyun {
220*4882a593Smuzhiyun int res;
221*4882a593Smuzhiyun
222*4882a593Smuzhiyun res = hfs_brec_find(fd, hfs_find_rec_by_key);
223*4882a593Smuzhiyun if (res)
224*4882a593Smuzhiyun return res;
225*4882a593Smuzhiyun if (fd->entrylength > rec_len)
226*4882a593Smuzhiyun return -EINVAL;
227*4882a593Smuzhiyun hfs_bnode_read(fd->bnode, rec, fd->entryoffset, fd->entrylength);
228*4882a593Smuzhiyun return 0;
229*4882a593Smuzhiyun }
230*4882a593Smuzhiyun
hfs_brec_goto(struct hfs_find_data * fd,int cnt)231*4882a593Smuzhiyun int hfs_brec_goto(struct hfs_find_data *fd, int cnt)
232*4882a593Smuzhiyun {
233*4882a593Smuzhiyun struct hfs_btree *tree;
234*4882a593Smuzhiyun struct hfs_bnode *bnode;
235*4882a593Smuzhiyun int idx, res = 0;
236*4882a593Smuzhiyun u16 off, len, keylen;
237*4882a593Smuzhiyun
238*4882a593Smuzhiyun bnode = fd->bnode;
239*4882a593Smuzhiyun tree = bnode->tree;
240*4882a593Smuzhiyun
241*4882a593Smuzhiyun if (cnt < 0) {
242*4882a593Smuzhiyun cnt = -cnt;
243*4882a593Smuzhiyun while (cnt > fd->record) {
244*4882a593Smuzhiyun cnt -= fd->record + 1;
245*4882a593Smuzhiyun fd->record = bnode->num_recs - 1;
246*4882a593Smuzhiyun idx = bnode->prev;
247*4882a593Smuzhiyun if (!idx) {
248*4882a593Smuzhiyun res = -ENOENT;
249*4882a593Smuzhiyun goto out;
250*4882a593Smuzhiyun }
251*4882a593Smuzhiyun hfs_bnode_put(bnode);
252*4882a593Smuzhiyun bnode = hfs_bnode_find(tree, idx);
253*4882a593Smuzhiyun if (IS_ERR(bnode)) {
254*4882a593Smuzhiyun res = PTR_ERR(bnode);
255*4882a593Smuzhiyun bnode = NULL;
256*4882a593Smuzhiyun goto out;
257*4882a593Smuzhiyun }
258*4882a593Smuzhiyun }
259*4882a593Smuzhiyun fd->record -= cnt;
260*4882a593Smuzhiyun } else {
261*4882a593Smuzhiyun while (cnt >= bnode->num_recs - fd->record) {
262*4882a593Smuzhiyun cnt -= bnode->num_recs - fd->record;
263*4882a593Smuzhiyun fd->record = 0;
264*4882a593Smuzhiyun idx = bnode->next;
265*4882a593Smuzhiyun if (!idx) {
266*4882a593Smuzhiyun res = -ENOENT;
267*4882a593Smuzhiyun goto out;
268*4882a593Smuzhiyun }
269*4882a593Smuzhiyun hfs_bnode_put(bnode);
270*4882a593Smuzhiyun bnode = hfs_bnode_find(tree, idx);
271*4882a593Smuzhiyun if (IS_ERR(bnode)) {
272*4882a593Smuzhiyun res = PTR_ERR(bnode);
273*4882a593Smuzhiyun bnode = NULL;
274*4882a593Smuzhiyun goto out;
275*4882a593Smuzhiyun }
276*4882a593Smuzhiyun }
277*4882a593Smuzhiyun fd->record += cnt;
278*4882a593Smuzhiyun }
279*4882a593Smuzhiyun
280*4882a593Smuzhiyun len = hfs_brec_lenoff(bnode, fd->record, &off);
281*4882a593Smuzhiyun keylen = hfs_brec_keylen(bnode, fd->record);
282*4882a593Smuzhiyun if (keylen == 0) {
283*4882a593Smuzhiyun res = -EINVAL;
284*4882a593Smuzhiyun goto out;
285*4882a593Smuzhiyun }
286*4882a593Smuzhiyun fd->keyoffset = off;
287*4882a593Smuzhiyun fd->keylength = keylen;
288*4882a593Smuzhiyun fd->entryoffset = off + keylen;
289*4882a593Smuzhiyun fd->entrylength = len - keylen;
290*4882a593Smuzhiyun hfs_bnode_read(bnode, fd->key, off, keylen);
291*4882a593Smuzhiyun out:
292*4882a593Smuzhiyun fd->bnode = bnode;
293*4882a593Smuzhiyun return res;
294*4882a593Smuzhiyun }
295