c2bba41904b1403b15aa11f15d6f832384d2a8c4
[asterisk/asterisk.git] / main / datastore.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007 - 2008, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief Asterisk datastore objects
20  */
21
22 /*** MODULEINFO
23         <support_level>core</support_level>
24  ***/
25
26 #include "asterisk.h"
27
28 ASTERISK_REGISTER_FILE()
29
30 #include "asterisk/_private.h"
31
32 #include "asterisk/datastore.h"
33 #include "asterisk/utils.h"
34 #include "asterisk/astobj2.h"
35 #include "asterisk/uuid.h"
36
37 /*! \brief Number of buckets for datastore container */
38 #define DATASTORE_BUCKETS 53
39
40 struct ast_datastore *__ast_datastore_alloc(const struct ast_datastore_info *info, const char *uid,
41                                             const char *file, int line, const char *function)
42 {
43         struct ast_datastore *datastore = NULL;
44
45         /* Make sure we at least have type so we can identify this */
46         if (!info) {
47                 return NULL;
48         }
49
50 #if defined(__AST_DEBUG_MALLOC)
51         if (!(datastore = __ast_calloc(1, sizeof(*datastore), file, line, function))) {
52                 return NULL;
53         }
54 #else
55         if (!(datastore = ast_calloc(1, sizeof(*datastore)))) {
56                 return NULL;
57         }
58 #endif
59
60         datastore->info = info;
61
62         if (!ast_strlen_zero(uid) && !(datastore->uid = ast_strdup(uid))) {
63                 ast_free(datastore);
64                 datastore = NULL;
65         }
66
67         return datastore;
68 }
69
70 int ast_datastore_free(struct ast_datastore *datastore)
71 {
72         int res = 0;
73
74         /* Using the destroy function (if present) destroy the data */
75         if (datastore->info->destroy != NULL && datastore->data != NULL) {
76                 datastore->info->destroy(datastore->data);
77                 datastore->data = NULL;
78         }
79
80         /* Free allocated UID memory */
81         if (datastore->uid != NULL) {
82                 ast_free((void *) datastore->uid);
83                 datastore->uid = NULL;
84         }
85
86         /* Finally free memory used by ourselves */
87         ast_free(datastore);
88
89         return res;
90 }
91
92 AO2_STRING_FIELD_HASH_FN(ast_datastore, uid);
93 AO2_STRING_FIELD_CMP_FN(ast_datastore, uid);
94
95 struct ao2_container *ast_datastores_alloc(void)
96 {
97         return ao2_container_alloc(DATASTORE_BUCKETS, ast_datastore_hash_fn, ast_datastore_cmp_fn);
98 }
99
100 int ast_datastores_add(struct ao2_container *datastores, struct ast_datastore *datastore)
101 {
102         ast_assert(datastore != NULL);
103         ast_assert(datastore->info != NULL);
104         ast_assert(!ast_strlen_zero(datastore->uid));
105
106         if (!ao2_link(datastores, datastore)) {
107                 return -1;
108         }
109
110         return 0;
111 }
112
113 void ast_datastores_remove(struct ao2_container *datastores, const char *name)
114 {
115         ao2_find(datastores, name, OBJ_SEARCH_KEY | OBJ_UNLINK | OBJ_NODATA);
116 }
117
118 struct ast_datastore *ast_datastores_find(struct ao2_container *datastores, const char *name)
119 {
120         return ao2_find(datastores, name, OBJ_SEARCH_KEY);
121 }
122
123 static void datastore_destroy(void *obj)
124 {
125         struct ast_datastore *datastore = obj;
126
127         /* Using the destroy function (if present) destroy the data */
128         if (datastore->info->destroy != NULL && datastore->data != NULL) {
129                 datastore->info->destroy(datastore->data);
130                 datastore->data = NULL;
131         }
132
133         ast_free((void *) datastore->uid);
134         datastore->uid = NULL;
135 }
136
137 struct ast_datastore *ast_datastores_alloc_datastore(const struct ast_datastore_info *info, const char *uid)
138 {
139         struct ast_datastore *datastore;
140         char uuid_buf[AST_UUID_STR_LEN];
141         const char *uid_ptr = uid;
142
143         if (!info) {
144                 return NULL;
145         }
146
147         datastore = ao2_alloc(sizeof(*datastore), datastore_destroy);
148         if (!datastore) {
149                 return NULL;
150         }
151
152         datastore->info = info;
153         if (ast_strlen_zero(uid)) {
154                 /* They didn't provide an ID so we'll provide one ourself */
155                 uid_ptr = ast_uuid_generate_str(uuid_buf, sizeof(uuid_buf));
156         }
157
158         datastore->uid = ast_strdup(uid_ptr);
159         if (!datastore->uid) {
160                 ao2_ref(datastore, -1);
161                 return NULL;
162         }
163
164         return datastore;
165 }