2 * Copyright (C) 2015-2020 "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>
32 #include <json-c/json.h>
34 #define AFB_BINDING_VERSION 3
35 #include <afb/afb-binding.h>
38 #include "afb-apiset.h"
39 #include "afb-api-so-v2.h"
41 #include "afb-trace.h"
42 #include "afb-session.h"
44 #include "afb-supervision.h"
45 #include "afs-supervision.h"
46 #include "afb-stub-ws.h"
47 #include "afb-debug.h"
49 #include "afb-error-text.h"
51 #include "wrap-json.h"
54 /* api and apiset name */
55 static const char supervision_apiname[] = AFS_SUPERVISION_APINAME;
57 static const char supervisor_apiname[] = AFS_SUPERVISOR_APINAME;
60 /* path of the supervision socket */
61 static const char supervisor_socket_path[] = AFS_SUPERVISION_SOCKET;
63 /* mutual exclusion */
64 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
66 /* the standard apiset */
68 struct afb_apiset *apiset;
69 struct json_object *config;
72 /* the supervision apiset (not exported) */
73 static struct afb_apiset *supervision_apiset;
75 /* local api implementation */
76 static void on_supervision_call(void *closure, struct afb_xreq *xreq);
77 static struct afb_api_itf supervision_api_itf =
79 .call = on_supervision_call
82 /* the supervisor link */
83 static struct afb_stub_ws *supervisor;
87 static struct afb_trace *trace;
91 static int open_supervisor_socket(const char *path)
94 struct sockaddr_un addr;
97 /* check path length */
98 length = strlen(path);
100 errno = ENAMETOOLONG;
104 /* create the unix socket */
105 fd = socket(AF_UNIX, SOCK_STREAM, 0);
109 /* prepare the connection address */
110 memset(&addr, 0, sizeof addr);
111 addr.sun_family = AF_UNIX;
112 strcpy(addr.sun_path, path);
113 if (addr.sun_path[0] == '@')
114 addr.sun_path[0] = 0; /* implement abstract sockets */
116 /* connect the socket */
117 rc = connect(fd, (struct sockaddr *) &addr, (socklen_t)(sizeof addr));
125 static void disconnect_supervisor()
127 struct afb_stub_ws *s;
129 INFO("Disconnecting supervision");
130 s = __atomic_exchange_n(&supervisor, NULL, __ATOMIC_RELAXED);
132 afb_stub_ws_unref(s);
135 struct afb_trace *t = __atomic_exchange_n(&trace, NULL, __ATOMIC_RELAXED);
141 static void on_supervisor_hangup(struct afb_stub_ws *s)
143 if (s && s == supervisor)
144 disconnect_supervisor();
147 /* try to connect to supervisor */
148 static void try_connect_supervisor()
152 struct afs_supervision_initiator initiator;
156 pthread_mutex_lock(&mutex);
158 /* needs to connect? */
159 if (supervisor || !supervision_apiset)
162 /* check existing path */
163 if (supervisor_socket_path[0] != '@' && access(supervisor_socket_path, F_OK)) {
164 INFO("Can't acces socket path %s: %m", supervisor_socket_path);
168 /* socket connection */
169 fd = open_supervisor_socket(supervisor_socket_path);
171 INFO("Can't connect supervision socket to %s: %m", supervisor_socket_path);
176 do { srd = read(fd, &initiator, sizeof initiator); } while(srd < 0 && errno == EINTR);
178 NOTICE("Can't read supervisor %s: %m", supervisor_socket_path);
181 if ((size_t)srd != sizeof initiator) {
182 ERROR("When reading supervisor %s: %m", supervisor_socket_path);
185 if (strnlen(initiator.interface, sizeof initiator.interface) == sizeof initiator.interface) {
186 ERROR("Bad interface of supervisor %s", supervisor_socket_path);
189 if (strcmp(initiator.interface, AFS_SUPERVISION_INTERFACE_1)) {
190 ERROR("Unknown interface %s for supervisor %s", initiator.interface, supervisor_socket_path);
193 if (strnlen(initiator.extra, sizeof initiator.extra) == sizeof initiator.extra) {
194 ERROR("Bad extra of supervisor %s", supervisor_socket_path);
198 /* interprets extras */
199 if (!strcmp(initiator.extra, "CLOSE")) {
200 INFO("Supervisor asks to CLOSE");
203 if (!strcmp(initiator.extra, "WAIT")) {
204 afb_debug_wait("supervisor");
206 if (!strcmp(initiator.extra, "BREAK")) {
207 afb_debug_break("supervisor");
210 /* make the supervisor link */
211 fdev = afb_fdev_create(fd);
213 ERROR("Creation of fdev failed: %m");
216 supervisor = afb_stub_ws_create_server(fdev, supervision_apiname, supervision_apiset);
218 ERROR("Creation of supervisor failed: %m");
221 afb_stub_ws_set_on_hangup(supervisor, on_supervisor_hangup);
223 /* successful termination */
229 pthread_mutex_unlock(&mutex);
232 static void try_connect_supervisor_job(int signum, void *args)
234 INFO("Try to connect supervisor after SIGHUP");
235 try_connect_supervisor();
238 static void on_sighup(int signum)
240 INFO("Supervision received a SIGHUP");
241 jobs_queue(NULL, 0, try_connect_supervisor_job, NULL);
245 * initialize the supervision
247 int afb_supervision_init(struct afb_apiset *apiset, struct json_object *config)
253 if (supervision_apiset)
256 /* create the apiset */
257 supervision_apiset = afb_apiset_create(supervision_apiname, 0);
258 if (!supervision_apiset) {
259 ERROR("Can't create supervision's apiset");
263 /* init the apiset */
264 rc = afb_apiset_add(supervision_apiset, supervision_apiname,
265 (struct afb_api_item){ .itf = &supervision_api_itf, .closure = NULL});
267 ERROR("Can't create supervision's apiset: %m");
268 afb_apiset_unref(supervision_apiset);
269 supervision_apiset = NULL;
273 /* init the globals */
274 global.apiset = apiset;
275 global.config = config;
278 memset(&sa, 0, sizeof sa);
279 sa.sa_handler = on_sighup;
280 rc = sigaction(SIGHUP, &sa, NULL);
282 ERROR("Can't connect supervision to SIGHUP: %m");
284 /* connect to supervision */
285 try_connect_supervisor();
289 /******************************************************************************
290 **** Implementation monitoring verbs
291 ******************************************************************************/
292 static void slist(void *closure, struct afb_session *session)
294 struct json_object *list = closure;
296 json_object_object_add(list, afb_session_uuid(session), NULL);
299 /******************************************************************************
300 **** Implementation monitoring verbs
301 ******************************************************************************/
303 static const char *verbs[] = {
304 "break", "config", "do", "exit", "sclose", "slist", "trace", "wait" };
305 enum { Break , Config , Do , Exit , Sclose , Slist , Trace , Wait };
307 static void on_supervision_call(void *closure, struct afb_xreq *xreq)
310 struct json_object *args, *sub, *list;
311 const char *api, *verb, *uuid;
312 struct afb_session *session;
313 const struct afb_api_item *xapi;
316 struct json_object *drop, *add;
320 /* search the verb */
321 i = (int)(sizeof verbs / sizeof *verbs);
322 while(--i >= 0 && strcasecmp(verbs[i], xreq->request.called_verb));
324 afb_xreq_reply_unknown_verb(xreq);
329 args = afb_xreq_json(xreq);
333 if (wrap_json_unpack(args, "i", &i))
334 wrap_json_unpack(args, "{si}", "code", &i);
335 ERROR("exiting from supervision with code %d -> %d", i, i & 127);
340 if (wrap_json_unpack(args, "s", &uuid))
341 wrap_json_unpack(args, "{ss}", "uuid", &uuid);
343 afb_xreq_reply(xreq, NULL, afb_error_text_invalid_request, NULL);
345 session = afb_session_search(uuid);
347 afb_xreq_reply(xreq, NULL, afb_error_text_unknown_session, NULL);
349 afb_session_close(session);
350 afb_session_unref(session);
352 afb_xreq_reply(xreq, NULL, NULL, NULL);
357 list = json_object_new_object();
358 afb_session_foreach(slist, list);
359 afb_xreq_reply(xreq, list, NULL, NULL);
362 afb_xreq_reply(xreq, json_object_get(global.config), NULL, NULL);
365 req = xreq_to_req_x2(xreq);
368 trace = afb_trace_create(supervisor_apiname, NULL /* not bound to any session */);
371 wrap_json_unpack(args, "{s?o s?o}", "add", &add, "drop", &drop);
373 rc = afb_trace_add(req, add, trace);
378 rc = afb_trace_drop(req, drop, trace);
382 afb_req_success(req, NULL, NULL);
384 afb_req_reply(req, NULL, afb_error_text_not_available, NULL);
389 if (wrap_json_unpack(args, "{ss ss s?o*}", "api", &api, "verb", &verb, "args", &sub))
390 afb_xreq_reply(xreq, NULL, afb_error_text_invalid_request, NULL);
392 xapi = afb_apiset_lookup_started(global.apiset, api, 1);
394 afb_xreq_reply_unknown_api(xreq);
396 afb_context_change_cred(&xreq->context, NULL);
397 xreq->request.called_api = api;
398 xreq->request.called_verb = verb;
399 xreq->json = json_object_get(sub);
400 xapi->itf->call(xapi->closure, xreq);
401 json_object_put(args);
406 afb_xreq_reply(xreq, NULL, NULL, NULL);
407 afb_debug_wait("supervisor");
410 afb_xreq_reply(xreq, NULL, NULL, NULL);
411 afb_debug_break("supervisor");