/
index.h
151 lines (141 loc) · 4.83 KB
/
index.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
#ifndef TARANTOOL_BOX_INDEX_H_INCLUDED
#define TARANTOOL_BOX_INDEX_H_INCLUDED
/*
* Copyright (C) 2010 Mail.RU
* Copyright (C) 2010 Yuriy Vostrikov
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#import <objc/Object.h>
#include <stdbool.h>
#include <util.h>
struct box_tuple;
struct space;
struct index;
/*
* Possible field data types. Can't use STRS/ENUM macros for them,
* since there is a mismatch between enum name (STRING) and type
* name literal ("STR"). STR is already used as Objective C type.
*/
enum field_data_type { UNKNOWN = -1, NUM = 0, NUM64, STRING, field_data_type_MAX };
extern const char *field_data_type_strs[];
enum index_type { HASH, TREE, index_type_MAX };
extern const char *index_type_strs[];
enum iterator_type { ITER_FORWARD, ITER_REVERSE };
/** Descriptor of a single part in a multipart key. */
struct key_part {
int fieldno;
enum field_data_type type;
};
/* Descriptor of a multipart key. */
struct key_def {
/* Description of parts of a multipart index. */
struct key_part *parts;
/*
* An array holding field positions in 'parts' array.
* Imagine there is index[1] = { key_field[0].fieldno=5,
* key_field[1].fieldno=3 }.
* 'parts' array for such index contains data from
* key_field[0] and key_field[1] respectively.
* max_fieldno is 5, and cmp_order array holds offsets of
* field 3 and 5 in 'parts' array: -1, -1, 0, -1, 1.
*/
u32 *cmp_order;
/* The size of the 'parts' array. */
int part_count;
/*
* The size of 'cmp_order' array (= max fieldno in 'parts'
* array).
*/
int max_fieldno;
bool is_unique;
};
@interface Index: Object {
@public
/* Index owner space */
struct space *space;
/* Description of a possibly multipart key. */
struct key_def *key_def;
/*
* Pre-allocated iterator to speed up the main case of
* box_process(). Should not be used elsewhere.
*/
struct iterator *position;
};
/**
* Allocate index instance.
*
* @param type index type
* @param key_def key part description
* @param space space the index belongs to
*/
+ (Index *) alloc: (enum index_type) type :(struct key_def *) key_def
:(struct space *) space;
/**
* Initialize index instance.
*
* @param key_def key part description
* @param space space the index belongs to
*/
- (id) init: (struct key_def *) key_def_arg :(struct space *) space_arg;
/** Destroy and free index instance. */
- (void) free;
/**
* Finish index construction.
*/
- (void) enable;
- (void) build: (Index *) pk;
- (size_t) size;
- (struct box_tuple *) min;
- (struct box_tuple *) max;
- (struct box_tuple *) findByKey: (void *) key :(int) part_count;
- (struct box_tuple *) findByTuple: (struct box_tuple *) tuple;
- (void) remove: (struct box_tuple *) tuple;
- (void) replace: (struct box_tuple *) old_tuple :(struct box_tuple *) new_tuple;
/**
* Create a structure to represent an iterator. Must be
* initialized separately.
*/
- (struct iterator *) allocIterator;
- (void) initIterator: (struct iterator *) iterator
:(enum iterator_type) type;
- (void) initIteratorByKey: (struct iterator *) iterator
:(enum iterator_type) type
:(void *) key :(int) part_count;
/**
* Check key part count.
*/
- (void) checkKeyParts: (int) part_count :(bool) partial_key_allowed;
/**
* Unsafe search methods that do not check key part count.
*/
- (struct box_tuple *) findUnsafe: (void *) key :(int) part_count;
- (void) initIteratorUnsafe: (struct iterator *) iterator
:(enum iterator_type) type
:(void *) key :(int) part_count;
@end
struct iterator {
struct box_tuple *(*next)(struct iterator *);
struct box_tuple *(*next_equal)(struct iterator *);
void (*free)(struct iterator *);
};
#endif /* TARANTOOL_BOX_INDEX_H_INCLUDED */