libs: introduce lmo - Lua Machine Objects, an implementation of binary hash tables
[project/luci.git] / libs / lmo / src / lmo.h
1 /*
2  * lmo - Lua Machine Objects - General header
3  *
4  *   Copyright (C) 2009 Jo-Philipp Wich <xm@subsignal.org>
5  *
6  *  Licensed under the Apache License, Version 2.0 (the "License");
7  *  you may not use this file except in compliance with the License.
8  *  You may obtain a copy of the License at
9  *
10  *      http://www.apache.org/licenses/LICENSE-2.0
11  *
12  *  Unless required by applicable law or agreed to in writing, software
13  *  distributed under the License is distributed on an "AS IS" BASIS,
14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  *  See the License for the specific language governing permissions and
16  *  limitations under the License.
17  */
18
19 #ifndef _LMO_H_
20 #define _LMO_H_
21
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <stdint.h>
25 #include <string.h>
26 #include <fcntl.h>
27 #include <sys/stat.h>
28 #include <sys/mman.h>
29 #include <arpa/inet.h>
30 #include <unistd.h>
31 #include <errno.h>
32
33
34 #if (defined(__GNUC__) && defined(__i386__))
35 #define sfh_get16(d) (*((const uint16_t *) (d)))
36 #else
37 #define sfh_get16(d) ((((uint32_t)(((const uint8_t *)(d))[1])) << 8)\
38                                            +(uint32_t)(((const uint8_t *)(d))[0]) )
39 #endif
40
41
42 struct lmo_entry {
43         uint32_t key_id;
44         uint32_t val_id;
45         uint32_t offset;
46         uint32_t length;
47         struct lmo_entry *next;
48 } __attribute__((packed));
49
50 typedef struct lmo_entry lmo_entry_t;
51
52
53 struct lmo_archive {
54         int         fd;
55         uint32_t    length;
56         lmo_entry_t *index;
57         char        *mmap;
58 };
59
60 typedef struct lmo_archive lmo_archive_t;
61
62
63 uint32_t sfh_hash(const char * data, int len);
64
65 char _lmo_error[1024];
66 const char * lmo_error(void);
67
68 lmo_archive_t * lmo_open(const char *file);
69 int lmo_lookup(lmo_archive_t *ar, const char *key, char *dest, int len);
70 void lmo_close(lmo_archive_t *ar);
71
72 #endif