str: change example to match function being explained.
[ccan] / ccan / tdb2 / traverse.c
1  /* 
2    Trivial Database 2: traverse function.
3    Copyright (C) Rusty Russell 2010
4    
5    This library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 3 of the License, or (at your option) any later version.
9
10    This library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 */
18 #include "private.h"
19 #include <ccan/likely/likely.h>
20
21 static int64_t traverse(struct tdb_context *tdb, int ltype,
22                         tdb_traverse_func fn, void *p)
23 {
24         int ret;
25         struct traverse_info tinfo;
26         struct tdb_data k, d;
27         int64_t count = 0;
28
29         for (ret = first_in_hash(tdb, ltype, &tinfo, &k, &d.dsize);
30              ret == 1;
31              ret = next_in_hash(tdb, ltype, &tinfo, &k, &d.dsize)) {
32                 d.dptr = k.dptr + k.dsize;
33                 
34                 count++;
35                 if (fn && fn(tdb, k, d, p))
36                         break;
37         }
38
39         if (ret < 0)
40                 return -1;
41         return count;
42 }
43
44 int64_t tdb_traverse(struct tdb_context *tdb, tdb_traverse_func fn, void *p)
45 {
46         return traverse(tdb, F_WRLCK, fn, p);
47 }
48         
49 int64_t tdb_traverse_read(struct tdb_context *tdb,
50                           tdb_traverse_func fn, void *p)
51 {
52         int64_t ret;
53         bool was_ro = tdb->read_only;
54         tdb->read_only = true;
55         ret = traverse(tdb, F_RDLCK, fn, p);
56         tdb->read_only = was_ro;
57         return ret;
58 }
59
60 TDB_DATA tdb_firstkey(struct tdb_context *tdb)
61 {
62         struct traverse_info tinfo;
63         struct tdb_data k;
64         switch (first_in_hash(tdb, F_RDLCK, &tinfo, &k, NULL)) {
65         case 1:
66                 return k;
67         case 0:
68                 tdb->ecode = TDB_SUCCESS;
69                 /* Fall thru... */
70         default:
71                 return tdb_null;
72         }
73 }               
74
75 /* We lock twice, not very efficient.  We could keep last key & tinfo cached. */
76 TDB_DATA tdb_nextkey(struct tdb_context *tdb, TDB_DATA key)
77 {
78         struct traverse_info tinfo;
79         struct hash_info h;
80         struct tdb_used_record rec;
81
82         tinfo.prev = find_and_lock(tdb, key, F_RDLCK, &h, &rec, &tinfo);
83         if (unlikely(tinfo.prev == TDB_OFF_ERR))
84                 return tdb_null;
85         tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_RDLCK);
86
87         switch (next_in_hash(tdb, F_RDLCK, &tinfo, &key, NULL)) {
88         case 1:
89                 return key;
90         case 0:
91                 tdb->ecode = TDB_SUCCESS;
92                 /* Fall thru... */
93         default:
94                 return tdb_null;
95         }
96 }