2 * Copyright (C) 2015-2019 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
28 #include <sys/types.h>
29 #include <sys/socket.h>
33 #include <json-c/json.h>
35 #include <afb/afb-event-x2.h>
37 #include "afb-session.h"
40 #include "afb-apiset.h"
41 #include "afb-proto-ws.h"
42 #include "afb-stub-ws.h"
43 #include "afb-context.h"
46 #include "afb-token.h"
47 #include "afb-error-text.h"
56 * structure for a ws request: requests on server side
59 struct afb_xreq xreq; /**< the xreq */
60 struct afb_stub_ws *stubws; /**< the client of the request */
61 struct afb_proto_ws_call *call; /**< the incoming call */
65 * structure for jobs of describing
67 struct server_describe
69 struct afb_stub_ws *stubws;
70 struct afb_proto_ws_describe *describe;
73 /******************* stub description for client or servers ******************/
78 struct afb_proto_ws *proto;
81 struct afb_apiset *apiset;
83 /* on hangup callback */
84 void (*on_hangup)(struct afb_stub_ws *);
89 /* listener for events */
90 struct afb_evt_listener *listener;
93 struct server_session *sessions;
95 /* credentials of the client */
96 struct afb_cred *cred;
98 /* event from server */
99 struct u16id2bool *event_flags;
101 /* transmitted sessions */
102 struct u16id2ptr *session_proxies;
104 /* transmitted tokens */
105 struct u16id2ptr *token_proxies;
110 /* event from server */
111 struct u16id2ptr *event_proxies;
113 /* transmitted sessions */
114 struct u16id2bool *session_flags;
116 /* transmitted tokens */
117 struct u16id2bool *token_flags;
121 struct fdev *(*reopen)(void*);
123 void (*release)(void*);
128 /* count of references */
131 /* type of the stub: 0=server, 1=client */
138 static struct afb_proto_ws *afb_stub_ws_create_proto(struct afb_stub_ws *stubws, struct fdev *fdev, uint8_t server);
140 /******************* ws request part for server *****************/
142 /* decrement the reference count of the request and free/release it on falling to null */
143 static void server_req_destroy_cb(struct afb_xreq *xreq)
145 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
147 afb_context_disconnect(&wreq->xreq.context);
148 afb_cred_unref(wreq->xreq.cred);
149 json_object_put(wreq->xreq.json);
150 afb_proto_ws_call_unref(wreq->call);
151 afb_stub_ws_unref(wreq->stubws);
155 static void server_req_reply_cb(struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info)
158 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
160 rc = afb_proto_ws_call_reply(wreq->call, obj, error, info);
162 ERROR("error while sending reply");
163 json_object_put(obj);
166 static int server_req_subscribe_cb(struct afb_xreq *xreq, struct afb_event_x2 *event)
169 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
171 rc = afb_evt_event_x2_add_watch(wreq->stubws->listener, event);
173 rc = afb_proto_ws_call_subscribe(wreq->call, afb_evt_event_x2_id(event));
175 ERROR("error while subscribing event");
179 static int server_req_unsubscribe_cb(struct afb_xreq *xreq, struct afb_event_x2 *event)
182 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
184 rc = afb_proto_ws_call_unsubscribe(wreq->call, afb_evt_event_x2_id(event));
185 rc2 = afb_evt_event_x2_remove_watch(wreq->stubws->listener, event);
186 if (rc >= 0 && rc2 < 0)
189 ERROR("error while unsubscribing event");
193 static const struct afb_xreq_query_itf server_req_xreq_itf = {
194 .reply = server_req_reply_cb,
195 .unref = server_req_destroy_cb,
196 .subscribe = server_req_subscribe_cb,
197 .unsubscribe = server_req_unsubscribe_cb
200 /******************* client part **********************************/
202 static struct afb_proto_ws *client_get_proto(struct afb_stub_ws *stubws)
205 struct afb_proto_ws *proto;
207 proto = stubws->proto;
208 if (proto == NULL && stubws->robust.reopen) {
209 fdev = stubws->robust.reopen(stubws->robust.closure);
211 proto = afb_stub_ws_create_proto(stubws, fdev, 0);
216 static int client_make_ids(struct afb_stub_ws *stubws, struct afb_proto_ws *proto, struct afb_context *context, uint16_t *sessionid, uint16_t *tokenid)
223 /* get the session */
224 if (!context->session)
227 sid = afb_session_id(context->session);
228 rc2 = u16id2bool_set(&stubws->session_flags, sid, 1);
232 rc = afb_proto_ws_client_session_create(proto, sid, afb_session_uuid(context->session));
239 tid = afb_token_id(context->token);
240 rc2 = u16id2bool_set(&stubws->token_flags, tid, 1);
244 rc2 = afb_proto_ws_client_token_create(proto, tid, afb_token_string(context->token));
255 /* on call, propagate it to the ws service */
256 static void client_api_call_cb(void * closure, struct afb_xreq *xreq)
259 struct afb_stub_ws *stubws = closure;
260 struct afb_proto_ws *proto;
264 proto = client_get_proto(stubws);
266 afb_xreq_reply(xreq, NULL, afb_error_text_disconnected, NULL);
270 rc = client_make_ids(stubws, proto, &xreq->context, &sessionid, &tokenid);
272 afb_xreq_unhooked_addref(xreq);
273 rc = afb_proto_ws_client_call(
275 xreq->request.called_verb,
280 xreq_on_behalf_cred_export(xreq));
283 afb_xreq_reply(xreq, NULL, afb_error_text_internal_error, "can't send message");
284 afb_xreq_unhooked_unref(xreq);
288 /* get the description */
289 static void client_api_describe_cb(void * closure, void (*describecb)(void *, struct json_object *), void *clocb)
291 struct afb_stub_ws *stubws = closure;
292 struct afb_proto_ws *proto;
294 proto = client_get_proto(stubws);
296 afb_proto_ws_client_describe(proto, describecb, clocb);
298 describecb(clocb, NULL);
301 /******************* server part: manage events **********************************/
303 static void server_event_add_cb(void *closure, const char *event, uint16_t eventid)
306 struct afb_stub_ws *stubws = closure;
308 if (stubws->proto != NULL) {
309 rc = u16id2bool_set(&stubws->event_flags, eventid, 1);
311 rc = afb_proto_ws_server_event_create(stubws->proto, eventid, event);
313 u16id2bool_set(&stubws->event_flags, eventid, 0);
318 static void server_event_remove_cb(void *closure, const char *event, uint16_t eventid)
320 struct afb_stub_ws *stubws = closure;
322 if (stubws->proto != NULL) {
323 if (u16id2bool_set(&stubws->event_flags, eventid, 0))
324 afb_proto_ws_server_event_remove(stubws->proto, eventid);
328 static void server_event_push_cb(void *closure, const char *event, uint16_t eventid, struct json_object *object)
330 struct afb_stub_ws *stubws = closure;
332 if (stubws->proto != NULL && u16id2bool_get(stubws->event_flags, eventid))
333 afb_proto_ws_server_event_push(stubws->proto, eventid, object);
334 json_object_put(object);
337 static void server_event_broadcast_cb(void *closure, const char *event, struct json_object *object, const uuid_binary_t uuid, uint8_t hop)
339 struct afb_stub_ws *stubws = closure;
341 if (stubws->proto != NULL)
342 afb_proto_ws_server_event_broadcast(stubws->proto, event, object, uuid, hop);
343 json_object_put(object);
346 /*****************************************************/
348 static void client_on_reply_cb(void *closure, void *request, struct json_object *object, const char *error, const char *info)
350 struct afb_xreq *xreq = request;
352 afb_xreq_reply(xreq, object, error, info);
353 afb_xreq_unhooked_unref(xreq);
356 static void client_on_event_create_cb(void *closure, uint16_t event_id, const char *event_name)
358 struct afb_stub_ws *stubws = closure;
359 struct afb_event_x2 *event;
362 /* check conflicts */
363 event = afb_evt_event_x2_create(event_name);
365 ERROR("can't create event %s, out of memory", event_name);
367 rc = u16id2ptr_add(&stubws->event_proxies, event_id, event);
369 ERROR("can't record event %s", event_name);
370 afb_evt_event_x2_unref(event);
375 static void client_on_event_remove_cb(void *closure, uint16_t event_id)
377 struct afb_stub_ws *stubws = closure;
378 struct afb_event_x2 *event;
381 rc = u16id2ptr_drop(&stubws->event_proxies, event_id, (void**)&event);
382 if (rc == 0 && event)
383 afb_evt_event_x2_unref(event);
386 static void client_on_event_subscribe_cb(void *closure, void *request, uint16_t event_id)
388 struct afb_stub_ws *stubws = closure;
389 struct afb_xreq *xreq = request;
390 struct afb_event_x2 *event;
393 rc = u16id2ptr_get(stubws->event_proxies, event_id, (void**)&event);
394 if (rc < 0 || !event || afb_xreq_subscribe(xreq, event) < 0)
395 ERROR("can't subscribe: %m");
398 static void client_on_event_unsubscribe_cb(void *closure, void *request, uint16_t event_id)
400 struct afb_stub_ws *stubws = closure;
401 struct afb_xreq *xreq = request;
402 struct afb_event_x2 *event;
405 rc = u16id2ptr_get(stubws->event_proxies, event_id, (void**)&event);
406 if (rc < 0 || !event || afb_xreq_unsubscribe(xreq, event) < 0)
407 ERROR("can't unsubscribe: %m");
410 static void client_on_event_push_cb(void *closure, uint16_t event_id, struct json_object *data)
412 struct afb_stub_ws *stubws = closure;
413 struct afb_event_x2 *event;
416 rc = u16id2ptr_get(stubws->event_proxies, event_id, (void**)&event);
417 if (rc >= 0 && event)
418 afb_evt_event_x2_push(event, data);
420 ERROR("unreadable push event");
423 static void client_on_event_broadcast_cb(void *closure, const char *event_name, struct json_object *data, const uuid_binary_t uuid, uint8_t hop)
425 afb_evt_rebroadcast(event_name, data, uuid, hop);
428 /*****************************************************/
430 static struct afb_session *server_add_session(struct afb_stub_ws *stubws, uint16_t sessionid, const char *sessionstr)
432 struct afb_session *session;
435 session = afb_session_get(sessionstr, AFB_SESSION_TIMEOUT_DEFAULT, &created);
437 ERROR("can't create session %s, out of memory", sessionstr);
439 afb_session_set_autoclose(session, 1);
440 rc = u16id2ptr_add(&stubws->session_proxies, sessionid, session);
442 ERROR("can't record session %s", sessionstr);
443 afb_session_unref(session);
450 static void server_on_session_create_cb(void *closure, uint16_t sessionid, const char *sessionstr)
452 struct afb_stub_ws *stubws = closure;
454 server_add_session(stubws, sessionid, sessionstr);
457 static void server_on_session_remove_cb(void *closure, uint16_t sessionid)
459 struct afb_stub_ws *stubws = closure;
460 struct afb_session *session;
463 rc = u16id2ptr_drop(&stubws->event_proxies, sessionid, (void**)&session);
464 if (rc == 0 && session)
465 afb_session_unref(session);
468 static void server_on_token_create_cb(void *closure, uint16_t tokenid, const char *tokenstr)
470 struct afb_stub_ws *stubws = closure;
471 struct afb_token *token;
474 rc = afb_token_get(&token, tokenstr);
476 ERROR("can't create token %s, out of memory", tokenstr);
478 rc = u16id2ptr_add(&stubws->token_proxies, tokenid, token);
480 ERROR("can't record token %s", tokenstr);
481 afb_token_unref(token);
486 static void server_on_token_remove_cb(void *closure, uint16_t tokenid)
488 struct afb_stub_ws *stubws = closure;
489 struct afb_token *token;
492 rc = u16id2ptr_drop(&stubws->event_proxies, tokenid, (void**)&token);
493 if (rc == 0 && token)
494 afb_token_unref(token);
497 static void server_on_call_cb(void *closure, struct afb_proto_ws_call *call, const char *verb, struct json_object *args, uint16_t sessionid, uint16_t tokenid, const char *user_creds)
499 struct afb_stub_ws *stubws = closure;
500 struct server_req *wreq;
501 struct afb_session *session;
502 struct afb_token *token;
505 afb_stub_ws_addref(stubws);
507 /* get tokens and sessions */
508 rc = u16id2ptr_get(stubws->session_proxies, sessionid, (void**)&session);
512 session = server_add_session(stubws, sessionid, NULL);
516 if (!tokenid || u16id2ptr_get(stubws->token_proxies, tokenid, (void**)&token) < 0)
519 /* create the request */
520 wreq = malloc(sizeof *wreq);
524 afb_xreq_init(&wreq->xreq, &server_req_xreq_itf);
525 wreq->stubws = stubws;
528 /* init the context */
529 afb_context_init(&wreq->xreq.context, session, token);
532 wreq->xreq.cred = afb_cred_mixed_on_behalf_import(stubws->cred, &wreq->xreq.context, user_creds);
533 wreq->xreq.request.called_api = stubws->apiname;
534 wreq->xreq.request.called_verb = verb;
535 wreq->xreq.json = args;
536 afb_xreq_process(&wreq->xreq, stubws->apiset);
541 json_object_put(args);
542 afb_stub_ws_unref(stubws);
543 afb_proto_ws_call_reply(call, NULL, afb_error_text_internal_error, NULL);
544 afb_proto_ws_call_unref(call);
547 static void server_on_description_cb(void *closure, struct json_object *description)
549 struct afb_proto_ws_describe *describe = closure;
550 afb_proto_ws_describe_put(describe, description);
551 json_object_put(description);
555 static void server_on_describe_cb(void *closure, struct afb_proto_ws_describe *describe)
557 struct afb_stub_ws *stubws = closure;
559 afb_apiset_describe(stubws->apiset, stubws->apiname, server_on_description_cb, describe);
562 /*****************************************************/
564 static const struct afb_proto_ws_client_itf client_itf =
566 .on_reply = client_on_reply_cb,
567 .on_event_create = client_on_event_create_cb,
568 .on_event_remove = client_on_event_remove_cb,
569 .on_event_subscribe = client_on_event_subscribe_cb,
570 .on_event_unsubscribe = client_on_event_unsubscribe_cb,
571 .on_event_push = client_on_event_push_cb,
572 .on_event_broadcast = client_on_event_broadcast_cb,
575 static struct afb_api_itf client_api_itf = {
576 .call = client_api_call_cb,
577 .describe = client_api_describe_cb
580 static const struct afb_proto_ws_server_itf server_itf =
582 .on_session_create = server_on_session_create_cb,
583 .on_session_remove = server_on_session_remove_cb,
584 .on_token_create = server_on_token_create_cb,
585 .on_token_remove = server_on_token_remove_cb,
586 .on_call = server_on_call_cb,
587 .on_describe = server_on_describe_cb
590 /* the interface for events pushing */
591 static const struct afb_evt_itf server_event_itf = {
592 .broadcast = server_event_broadcast_cb,
593 .push = server_event_push_cb,
594 .add = server_event_add_cb,
595 .remove = server_event_remove_cb
598 /*****************************************************/
599 /*****************************************************/
601 static void release_all_sessions_cb(void*closure, uint16_t id, void *ptr)
603 struct afb_session *session = ptr;
604 afb_session_unref(session);
607 static void release_all_tokens_cb(void*closure, uint16_t id, void *ptr)
609 struct afb_token *token = ptr;
610 afb_token_unref(token);
613 static void release_all_events_cb(void*closure, uint16_t id, void *ptr)
615 struct afb_event_x2 *eventid = ptr;
616 afb_evt_event_x2_unref(eventid);
620 static void disconnect(struct afb_stub_ws *stubws)
622 struct u16id2ptr *i2p;
623 struct u16id2bool *i2b;
625 afb_proto_ws_unref(__atomic_exchange_n(&stubws->proto, NULL, __ATOMIC_RELAXED));
626 if (stubws->is_client) {
627 i2p = __atomic_exchange_n(&stubws->event_proxies, NULL, __ATOMIC_RELAXED);
629 u16id2ptr_forall(i2p, release_all_events_cb, NULL);
630 u16id2ptr_destroy(&i2p);
632 i2b = __atomic_exchange_n(&stubws->session_flags, NULL, __ATOMIC_RELAXED);
633 u16id2bool_destroy(&i2b);
634 i2b = __atomic_exchange_n(&stubws->token_flags, NULL, __ATOMIC_RELAXED);
635 u16id2bool_destroy(&i2b);
637 afb_evt_listener_unref(__atomic_exchange_n(&stubws->listener, NULL, __ATOMIC_RELAXED));
638 afb_cred_unref(__atomic_exchange_n(&stubws->cred, NULL, __ATOMIC_RELAXED));
639 i2b = __atomic_exchange_n(&stubws->event_flags, NULL, __ATOMIC_RELAXED);
640 u16id2bool_destroy(&i2b);
641 i2p = __atomic_exchange_n(&stubws->session_proxies, NULL, __ATOMIC_RELAXED);
643 u16id2ptr_forall(i2p, release_all_sessions_cb, NULL);
644 u16id2ptr_destroy(&i2p);
646 i2p = __atomic_exchange_n(&stubws->token_proxies, NULL, __ATOMIC_RELAXED);
648 u16id2ptr_forall(i2p, release_all_tokens_cb, NULL);
649 u16id2ptr_destroy(&i2p);
654 /* callback when receiving a hangup */
655 static void on_hangup(void *closure)
657 struct afb_stub_ws *stubws = closure;
660 afb_stub_ws_addref(stubws);
662 if (stubws->on_hangup)
663 stubws->on_hangup(stubws);
664 afb_stub_ws_unref(stubws);
668 static int enqueue_processing(struct afb_proto_ws *proto, void (*callback)(int signum, void* arg), void *arg)
670 return jobs_queue(proto, 0, callback, arg);
673 /*****************************************************/
675 static struct afb_proto_ws *afb_stub_ws_create_proto(struct afb_stub_ws *stubws, struct fdev *fdev, uint8_t is_client)
677 struct afb_proto_ws *proto;
679 stubws->proto = proto = is_client
680 ? afb_proto_ws_create_client(fdev, &client_itf, stubws)
681 : afb_proto_ws_create_server(fdev, &server_itf, stubws);
683 afb_proto_ws_on_hangup(proto, on_hangup);
684 afb_proto_ws_set_queuing(proto, enqueue_processing);
690 static struct afb_stub_ws *afb_stub_ws_create(struct fdev *fdev, const char *apiname, struct afb_apiset *apiset, uint8_t is_client)
692 struct afb_stub_ws *stubws;
694 stubws = calloc(1, sizeof *stubws + 1 + strlen(apiname));
698 if (afb_stub_ws_create_proto(stubws, fdev, is_client)) {
699 stubws->refcount = 1;
700 stubws->is_client = is_client;
701 strcpy(stubws->apiname, apiname);
702 stubws->apiset = afb_apiset_addref(apiset);
711 struct afb_stub_ws *afb_stub_ws_create_client(struct fdev *fdev, const char *apiname, struct afb_apiset *apiset)
713 return afb_stub_ws_create(fdev, apiname, apiset, 1);
716 struct afb_stub_ws *afb_stub_ws_create_server(struct fdev *fdev, const char *apiname, struct afb_apiset *apiset)
718 struct afb_stub_ws *stubws;
720 stubws = afb_stub_ws_create(fdev, apiname, apiset, 0);
722 stubws->cred = afb_cred_create_for_socket(fdev_fd(fdev));
723 stubws->listener = afb_evt_listener_create(&server_event_itf, stubws);
724 if (stubws->listener != NULL)
726 afb_stub_ws_unref(stubws);
731 void afb_stub_ws_unref(struct afb_stub_ws *stubws)
733 if (stubws && !__atomic_sub_fetch(&stubws->refcount, 1, __ATOMIC_RELAXED)) {
735 if (stubws->is_client) {
736 stubws->robust.reopen = NULL;
737 if (stubws->robust.release)
738 stubws->robust.release(stubws->robust.closure);
742 afb_apiset_unref(stubws->apiset);
747 void afb_stub_ws_addref(struct afb_stub_ws *stubws)
749 __atomic_add_fetch(&stubws->refcount, 1, __ATOMIC_RELAXED);
752 void afb_stub_ws_set_on_hangup(struct afb_stub_ws *stubws, void (*on_hangup)(struct afb_stub_ws*))
754 stubws->on_hangup = on_hangup;
757 const char *afb_stub_ws_name(struct afb_stub_ws *stubws)
759 return stubws->apiname;
762 struct afb_api_item afb_stub_ws_client_api(struct afb_stub_ws *stubws)
764 struct afb_api_item api;
766 assert(stubws->is_client); /* check client */
767 api.closure = stubws;
768 api.itf = &client_api_itf;
769 api.group = stubws; /* serialize for reconnections */
773 int afb_stub_ws_client_add(struct afb_stub_ws *stubws, struct afb_apiset *apiset)
775 return afb_apiset_add(apiset, stubws->apiname, afb_stub_ws_client_api(stubws));
778 void afb_stub_ws_client_robustify(struct afb_stub_ws *stubws, struct fdev *(*reopen)(void*), void *closure, void (*release)(void*))
780 assert(stubws->is_client); /* check client */
782 if (stubws->robust.release)
783 stubws->robust.release(stubws->robust.closure);
785 stubws->robust.reopen = reopen;
786 stubws->robust.closure = closure;
787 stubws->robust.release = release;