vector: Additional string vector definitions.
[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 #include "asterisk/_private.h"
29
30 #include "asterisk/datastore.h"
31 #include "asterisk/utils.h"
32 #include "asterisk/astobj2.h"
33 #include "asterisk/uuid.h"
34 #include "asterisk/module.h"
35
36 /*! \brief Number of buckets for datastore container */
37 #define DATASTORE_BUCKETS 53
38
39 struct ast_datastore *__ast_datastore_alloc(
40         const struct ast_datastore_info *info, const char *uid, struct ast_module *mod,
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 (!(datastore = __ast_calloc(1, sizeof(*datastore), file, line, function))) {
51                 return NULL;
52         }
53
54         datastore->info = info;
55         datastore->mod = mod;
56
57         if (!ast_strlen_zero(uid) && !(datastore->uid = ast_strdup(uid))) {
58                 ast_free(datastore);
59                 datastore = NULL;
60         }
61
62         ast_module_ref(mod);
63
64         return datastore;
65 }
66
67 int ast_datastore_free(struct ast_datastore *datastore)
68 {
69         int res = 0;
70
71         /* Using the destroy function (if present) destroy the data */
72         if (datastore->info->destroy != NULL && datastore->data != NULL) {
73                 datastore->info->destroy(datastore->data);
74                 datastore->data = NULL;
75         }
76
77         /* Free allocated UID memory */
78         if (datastore->uid != NULL) {
79                 ast_free((void *) datastore->uid);
80                 datastore->uid = NULL;
81         }
82
83         ast_module_unref(datastore->mod);
84
85         /* Finally free memory used by ourselves */
86         ast_free(datastore);
87
88         return res;
89 }
90
91 AO2_STRING_FIELD_HASH_FN(ast_datastore, uid);
92 AO2_STRING_FIELD_CMP_FN(ast_datastore, uid);
93
94 struct ao2_container *ast_datastores_alloc(void)
95 {
96         return ao2_container_alloc(DATASTORE_BUCKETS, ast_datastore_hash_fn, ast_datastore_cmp_fn);
97 }
98
99 int ast_datastores_add(struct ao2_container *datastores, struct ast_datastore *datastore)
100 {
101         ast_assert(datastore != NULL);
102         ast_assert(datastore->info != NULL);
103         ast_assert(!ast_strlen_zero(datastore->uid));
104
105         if (!ao2_link(datastores, datastore)) {
106                 return -1;
107         }
108
109         return 0;
110 }
111
112 void ast_datastores_remove(struct ao2_container *datastores, const char *name)
113 {
114         ao2_find(datastores, name, OBJ_SEARCH_KEY | OBJ_UNLINK | OBJ_NODATA);
115 }
116
117 struct ast_datastore *ast_datastores_find(struct ao2_container *datastores, const char *name)
118 {
119         return ao2_find(datastores, name, OBJ_SEARCH_KEY);
120 }
121
122 static void datastore_destroy(void *obj)
123 {
124         struct ast_datastore *datastore = obj;
125
126         /* Using the destroy function (if present) destroy the data */
127         if (datastore->info->destroy != NULL && datastore->data != NULL) {
128                 datastore->info->destroy(datastore->data);
129                 datastore->data = NULL;
130         }
131
132         ast_free((void *) datastore->uid);
133         datastore->uid = NULL;
134 }
135
136 struct ast_datastore *ast_datastores_alloc_datastore(const struct ast_datastore_info *info, const char *uid)
137 {
138         struct ast_datastore *datastore;
139         char uuid_buf[AST_UUID_STR_LEN];
140         const char *uid_ptr = uid;
141
142         if (!info) {
143                 return NULL;
144         }
145
146         datastore = ao2_alloc(sizeof(*datastore), datastore_destroy);
147         if (!datastore) {
148                 return NULL;
149         }
150
151         datastore->info = info;
152         if (ast_strlen_zero(uid)) {
153                 /* They didn't provide an ID so we'll provide one ourself */
154                 uid_ptr = ast_uuid_generate_str(uuid_buf, sizeof(uuid_buf));
155         }
156
157         datastore->uid = ast_strdup(uid_ptr);
158         if (!datastore->uid) {
159                 ao2_ref(datastore, -1);
160                 return NULL;
161         }
162
163         return datastore;
164 }