2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author "Fulup Ar Foll"
4 * Author José Bollo <jose.bollo@iot.bzh>
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
26 #include "afb-session.h"
29 #include "afb-apiset.h"
30 #include "afb-context.h"
34 #define INCR 8 /* CAUTION: must be a power of 2 */
37 * Internal description of an api
42 const char *name; /**< name of the api */
43 struct afb_api api; /**< handler of the api */
47 * Data structure for apiset
51 struct api_desc *apis; /**< description of apis */
52 struct afb_apiset *subset; /**< subset if any */
53 int count; /**< count of apis in the set */
54 int timeout; /**< the timeout in second for the apiset */
55 int refcount; /**< reference count for freeing resources */
56 char name[1]; /**< name of the apiset */
60 * Search the api of 'name'.
61 * @param set the api set
62 * @param name the api name to search
63 * @return the descriptor if found or NULL otherwise
65 static struct api_desc *search(struct afb_apiset *set, const char *name)
70 /* dichotomic search of the api */
75 /* check remaining slice */
80 /* check the mid of the slice */
83 c = strcasecmp(a->name, name);
88 /* update the slice */
97 * Increases the count of references to the apiset and return its address
98 * @param set the set whose reference count is to be increased
99 * @return the given apiset
101 struct afb_apiset *afb_apiset_addref(struct afb_apiset *set)
104 __atomic_add_fetch(&set->refcount, 1, __ATOMIC_RELAXED);
109 * Decreases the count of references to the apiset and frees its
110 * resources when no more references exists.
111 * @param set the set to unrefrence
113 void afb_apiset_unref(struct afb_apiset *set)
115 if (set && !__atomic_sub_fetch(&set->refcount, 1, __ATOMIC_RELAXED)) {
116 afb_apiset_unref(set->subset);
124 * @param name the name of the apiset
125 * @param timeout the default timeout in seconds for the apiset
126 * @return the created apiset or NULL in case of error
128 struct afb_apiset *afb_apiset_create(const char *name, int timeout)
130 struct afb_apiset *set;
132 set = malloc((name ? strlen(name) : 0) + sizeof *set);
134 set->apis = malloc(INCR * sizeof *set->apis);
136 set->timeout = timeout;
140 strcpy(set->name, name);
148 * the name of the apiset
149 * @param set the api set
150 * @return the name of the set
152 const char *afb_apiset_name(struct afb_apiset *set)
158 * Get the API timeout of the set
159 * @param set the api set
160 * @return the timeout in seconds
162 int afb_apiset_timeout_get(struct afb_apiset *set)
168 * Set the API timeout of the set
169 * @param set the api set
170 * @param to the timeout in seconds
172 void afb_apiset_timeout_set(struct afb_apiset *set, int to)
178 * Get the subset of the set
179 * @param set the api set
180 * @return the subset of set
182 struct afb_apiset *afb_apiset_subset_get(struct afb_apiset *set)
188 * Set the subset of the set
189 * @param set the api set
190 * @param subset the subset to set
192 void afb_apiset_subset_set(struct afb_apiset *set, struct afb_apiset *subset)
194 struct afb_apiset *tmp;
196 /* avoid infinite loop */
200 set->subset = afb_apiset_addref(subset);
201 afb_apiset_unref(tmp);
205 * Adds the api of 'name' described by 'api'.
206 * @param set the api set
207 * @param name the name of the api to add (have to survive, not copied!)
209 * @returns 0 in case of success or -1 in case
210 * of error with errno set:
211 * - EEXIST if name already registered
212 * - ENOMEM when out of memory
214 int afb_apiset_add(struct afb_apiset *set, const char *name, struct afb_api api)
216 struct api_desc *apis;
219 /* check previously existing plugin */
220 for (i = 0 ; i < set->count ; i++) {
221 c = strcasecmp(set->apis[i].name, name);
223 ERROR("api of name %s already exists", name);
231 /* allocates enough memory */
232 c = (set->count + INCR) & ~(INCR - 1);
233 apis = realloc(set->apis, ((unsigned)c) * sizeof * apis);
235 ERROR("out of memory");
241 /* copy higher part of the array */
244 memmove(apis + 1, apis, ((unsigned)(set->count - i)) * sizeof *apis);
246 /* record the plugin */
252 INFO("API %s added", name);
261 * Delete from the 'set' the api of 'name'.
262 * @param set the set to be changed
263 * @param name the name of the API to remove
264 * @return 0 in case of success or -1 in case where the API doesn't exist.
266 int afb_apiset_del(struct afb_apiset *set, const char *name)
271 for (i = 0 ; i < set->count ; i++) {
272 c = strcasecmp(set->apis[i].name, name);
275 while(i < set->count) {
276 set->apis[i] = set->apis[i + 1];
289 * Get from the 'set' the API of 'name' in 'api' with fallback to subset or default api
290 * @param set the set of API
291 * @param name the name of the API to get
292 * @param rec if not zero look also recursively in subsets
293 * @return the api pointer in case of success or NULL in case of error
295 static struct api_desc *lookup(struct afb_apiset *set, const char *name, int rec)
297 struct api_desc *i = search(set, name);
298 return i || !rec || !set->subset ? i : lookup(set->subset, name, rec);
302 * Get from the 'set' the API of 'name' in 'api'
303 * @param set the set of API
304 * @param name the name of the API to get
305 * @param rec if not zero look also recursively in subsets
306 * @return the api pointer in case of success or NULL in case of error
308 const struct afb_api *afb_apiset_lookup(struct afb_apiset *set, const char *name, int rec)
312 i = lookup(set, name, rec);
320 * Starts the service 'api'.
322 * @param share_session if true start the servic"e in a shared session
323 * if false start it in its own session
324 * @param onneed if true start the service if possible, if false the api
326 * @return a positive number on success
328 static int start_api(struct afb_apiset *set, struct api_desc *api, int share_session, int onneed)
332 if (api->status == 0)
334 else if (api->status > 0) {
339 INFO("API %s starting...", api->name);
340 if (api->api.itf->service_start) {
342 rc = api->api.itf->service_start(api->api.closure, share_session, onneed, set);
344 api->status = errno ?: ECANCELED;
345 ERROR("The api %s failed to start (%d)", api->name, rc);
348 } else if (!onneed) {
349 /* already started: it is an error */
350 ERROR("The api %s is not a startable service", api->name);
351 api->status = EINVAL;
354 NOTICE("API %s started", api->name);
360 * Get from the 'set' the API of 'name' in 'api'
361 * @param set the set of API
362 * @param name the name of the API to get
363 * @param rec if not zero look also recursively in subsets
364 * @return 0 in case of success or -1 in case of error
366 const struct afb_api *afb_apiset_lookup_started(struct afb_apiset *set, const char *name, int rec)
370 i = lookup(set, name, rec);
372 return i->status && start_api(set, i, 1, 1) ? NULL : &i->api;
378 * Starts a service by its 'api' name.
379 * @param set the api set
380 * @param name name of the service to start
381 * @param share_session if true start the servic"e in a shared session
382 * if false start it in its own session
383 * @param onneed if true start the service if possible, if false the api
385 * @return a positive number on success
387 int afb_apiset_start_service(struct afb_apiset *set, const char *name, int share_session, int onneed)
391 a = search(set, name);
393 ERROR("can't find service %s", name);
398 return start_api(set, a, share_session, onneed);
402 * Starts all possible services but stops at first error.
403 * @param set the api set
404 * @param share_session if true start the servic"e in a shared session
405 * if false start it in its own session
406 * @return 0 on success or a negative number when an error is found
408 int afb_apiset_start_all_services(struct afb_apiset *set, int share_session)
411 struct api_desc *i, *e;
414 e = &set->apis[set->count];
416 rc = start_api(set, i, share_session, 1);
422 return set->subset ? afb_apiset_start_all_services(set->subset, share_session) : 0;
426 * Ask to update the hook flags of the 'api'
427 * @param set the api set
428 * @param name the api to update (NULL updates all)
430 void afb_apiset_update_hooks(struct afb_apiset *set, const char *name)
432 const struct api_desc *i, *e;
436 e = &set->apis[set->count];
438 i = search(set, name);
442 if (i->api.itf->update_hooks)
443 i->api.itf->update_hooks(i->api.closure);
449 * Set the verbosity level of the 'api'
450 * @param set the api set
451 * @param name the api to set (NULL set all)
453 void afb_apiset_set_verbosity(struct afb_apiset *set, const char *name, int level)
455 const struct api_desc *i, *e;
459 e = &set->apis[set->count];
461 i = search(set, name);
465 if (i->api.itf->set_verbosity)
466 i->api.itf->set_verbosity(i->api.closure, level);
472 * Get the verbosity level of the 'api'
473 * @param set the api set
474 * @param name the api to get
475 * @return the verbosity level or -1 in case of error
477 int afb_apiset_get_verbosity(struct afb_apiset *set, const char *name)
479 const struct api_desc *i;
481 i = name ? search(set, name) : NULL;
487 if (!i->api.itf->get_verbosity)
490 return i->api.itf->get_verbosity(i->api.closure);
494 * Get the description of the API of 'name'
495 * @param set the api set
496 * @param name the api whose description is required
497 * @return the description or NULL
499 struct json_object *afb_apiset_describe(struct afb_apiset *set, const char *name)
501 const struct api_desc *i;
503 i = name ? search(set, name) : NULL;
504 return i && i->api.itf->describe ? i->api.itf->describe(i->api.closure) : NULL;
508 * Get the list of api names
509 * @param set the api set
510 * @return a NULL terminated array of api names. Must be freed.
512 const char **afb_apiset_get_names(struct afb_apiset *set)
519 size = set->count * (1 + sizeof(*names)) + sizeof(*names);
520 for (i = 0 ; i < set->count ; i++)
521 size += strlen(set->apis[i].name);
523 names = malloc(size);
527 dest = (void*)&names[set->count+1];
528 for (i = 0 ; i < set->count ; i++) {
530 dest = stpcpy(dest, set->apis[i].name) + 1;
538 * Enumerate the api names to a callback.
539 * @param set the api set
540 * @param callback the function to call for each name
541 * @param closure the closure for the callback
543 void afb_apiset_enum(struct afb_apiset *set, int rec, void (*callback)(struct afb_apiset *set, const char *name, void *closure), void *closure)
545 struct afb_apiset *iset;
546 struct api_desc *i, *e;
553 if (lookup(set, i->name, 1) == i)
554 callback(iset, i->name, closure);
557 iset = rec ? iset->subset : NULL;