aboutsummaryrefslogtreecommitdiffstats
path: root/src/anydb.h
blob: 843ef292bee6e597c39d8e957558e762dfc2a79a (plain)
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/*
 * Copyright (C) 2018 "IoT.bzh"
 * Author José Bollo <jose.bollo@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

/**
 * An index is an integer
 */
typedef uint32_t anydb_idx_t;

/*
 * Definition of some predefined indexes
 */

/** The invalid index */
#define AnyIdx_Invalid	((anydb_idx_t)0xffffffffu)

/**  */
#define AnyIdx_Any	((anydb_idx_t)0xfffffffeu)
#define AnyIdx_Wide	((anydb_idx_t)0xfffffffdu)
#define AnyIdx_None	((anydb_idx_t)0xfffffffcu)
#define AnyIdx_Max	((anydb_idx_t)0xfffffff7u)

/**
 * A key is a set of index
 */
struct anydb_key {
	/** client string id */
	anydb_idx_t client;

	/** session string id */
	anydb_idx_t session;

	/** user string id */
	anydb_idx_t user;

	/** permission string id */
	anydb_idx_t permission;
};
typedef struct anydb_key anydb_key_t;

/**
 * A rule is a set of 32 bits integers
 */
struct anydb_value
{
	/** value string id */
	anydb_idx_t value;

	/**  expiration */
	time_t expire;
};
typedef struct anydb_value anydb_value_t;

/**
 */
enum anydb_action
{
	Anydb_Action_Stop,
	Anydb_Action_Continue,
	Anydb_Action_Update_And_Stop,
	Anydb_Action_Remove_And_Continue
};
typedef enum anydb_action anydb_action_t;

enum anydb_transaction
{
	Anydb_Transaction_Start = 0,
	Anydb_Transaction_Commit = 1,
	Anydb_Transaction_Cancel = 2
};
typedef enum anydb_transaction anydb_transaction_t;

struct anydb_itf
{
	int (*index)(void *clodb, anydb_idx_t *idx, const char *name, bool create);
	const char *(*string)(void *clodb, anydb_idx_t idx);
	int (*transaction)(void *clodb, anydb_transaction_t atomic_op);
	void (*apply)(void *clodb, anydb_action_t (*oper)(void *closure, const anydb_key_t *key, anydb_value_t *value), void *closure);
	int (*add)(void *clodb, const anydb_key_t *key, const anydb_value_t *value);
	void (*gc)(void *clodb);
	int (*sync)(void *clodb);
	void (*destroy)(void *clodb);
};
typedef struct anydb_itf anydb_itf_t;

struct anydb
{
	void *clodb;
	anydb_itf_t itf;
};
typedef struct anydb anydb_t;

/** manage atomicity of operations */
extern
int
anydb_transaction(
	anydb_t *db,
	anydb_transaction_t oper
);

/** enumerate */
extern
void
anydb_for_all(
	anydb_t *db,
	void *closure,
	void (*callback)(
		void *closure,
		const data_key_t *key,
		const data_value_t *value),
	const data_key_t *key
);

/** drop rules */
extern
int
anydb_drop(
	anydb_t *db,
	const data_key_t *key
);

/** set a rules */
extern
int
anydb_set(
	anydb_t *db,
	const data_key_t *key,
	const data_value_t *value
);

/** test a rule, returns 0 or the score: count of exact keys */
extern
int
anydb_test(
	anydb_t *db,
	const data_key_t *key,
	data_value_t *value
);

/** drop rules */
extern
void
anydb_cleanup(
	anydb_t *db
);

/** is the database empty? */
extern
bool
anydb_is_empty(
	anydb_t *db
);

/** destroy the database */
extern
void
anydb_destroy(
	anydb_t *db
);

/** synchronize database */
extern
int
anydb_sync(
	anydb_t *db
);