1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
|
/*
Copyright 2015 IoT.bzh
author: José Bollo <jose.bollo@iot.bzh>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include <fcntl.h>
#include <unistd.h>
#include <signal.h>
#include <pwd.h>
#include <sys/types.h>
#include <errno.h>
#include <assert.h>
#include <stdio.h>
#include <limits.h>
#include <string.h>
#include <json.h>
#include "verbose.h"
#include "utils-dir.h"
#include "utils-json.h"
#include "afm-launch-mode.h"
#include "afm-launch.h"
#include "afm-run.h"
/*
* State of a launched/running application
*/
enum appstate {
as_starting, /* start in progress */
as_running, /* started and running */
as_stopped, /* stopped */
as_terminating, /* termination in progress */
as_terminated /* terminated */
};
/*
* Structure for recording a runner
*/
struct apprun {
struct apprun *next_by_runid; /* link for hashing by runid */
struct apprun *next_by_pgid; /* link for hashing by pgid */
int runid; /* runid */
pid_t pids[2]; /* pids (0: group leader, 1: slave) */
enum appstate state; /* current state of the application */
json_object *appli; /* json object describing the application */
};
/*
* Count of item by hash table
*/
#define ROOT_RUNNERS_COUNT 32
/*
* Maximum count of simultaneous running application
*/
#define MAX_RUNNER_COUNT 32767
/*
* Hash tables of runners by runid and by pgid
*/
static struct apprun *runners_by_runid[ROOT_RUNNERS_COUNT];
static struct apprun *runners_by_pgid[ROOT_RUNNERS_COUNT];
/*
* List of terminated runners
*/
static struct apprun *terminated_runners = NULL;
/*
* Count of runners
*/
static int runnercount = 0;
/*
* Last given runid
*/
static int runnerid = 0;
/*
* Path name of the directory for applications in the
* home directory of the user.
*/
static const char fwk_user_app_dir[] = FWK_USER_APP_DIR;
/*
* Path of the root directory for applications of the
* current user
*/
static char *homeappdir;
/****************** manages pids **********************/
/*
* Get a runner by its 'pid' (NULL if not found)
*/
static struct apprun *runner_of_pid(pid_t pid)
{
int i;
struct apprun *result;
for (i = 0 ; i < ROOT_RUNNERS_COUNT ; i++) {
result = runners_by_pgid[i];
while (result != NULL) {
if (result->pids[0] == pid || result->pids[1] == pid)
return result;
result = result->next_by_pgid;
}
}
return NULL;
}
/****************** manages pgids **********************/
/*
* Get a runner by its 'pgid' (NULL if not found)
*/
static struct apprun *runner_of_pgid(pid_t pgid)
{
struct apprun *result;
result = runners_by_pgid[pgid & (ROOT_RUNNERS_COUNT - 1)];
while (result && result->pids[0] != pgid)
result = result->next_by_pgid;
return result;
}
/*
* Insert a 'runner' for its pgid
*/
static void pgid_insert(struct apprun *runner)
{
struct apprun **prev;
prev = &runners_by_pgid[runner->pids[0] & (ROOT_RUNNERS_COUNT - 1)];
runner->next_by_pgid = *prev;
*prev = runner;
}
/*
* Remove a 'runner' for its pgid
*/
static void pgid_remove(struct apprun *runner)
{
struct apprun **prev;
prev = &runners_by_pgid[runner->pids[0] & (ROOT_RUNNERS_COUNT - 1)];
while (*prev) {
if (*prev == runner) {
*prev = runner->next_by_pgid;
break;
}
prev = &(*prev)->next_by_pgid;
}
}
/****************** manages runners (by runid) **********************/
/*
* Get a runner by its 'runid' (NULL if not found)
*/
static struct apprun *getrunner(int runid)
{
struct apprun *result;
result = runners_by_runid[runid & (ROOT_RUNNERS_COUNT - 1)];
while (result && result->runid != runid)
result = result->next_by_runid;
return result;
}
/*
* Free an existing 'runner'
*/
static void freerunner(struct apprun *runner)
{
struct apprun **prev;
/* get previous pointer to runner */
prev = &runners_by_runid[runner->runid & (ROOT_RUNNERS_COUNT - 1)];
assert(*prev);
while(*prev != runner) {
prev = &(*prev)->next_by_runid;
assert(*prev);
}
/* unlink */
*prev = runner->next_by_runid;
runnercount--;
/* release/free */
json_object_put(runner->appli);
free(runner);
}
/*
* Cleans the list of runners from its terminated
*/
static void cleanrunners()
{
struct apprun *runner;
while (terminated_runners) {
runner = terminated_runners;
terminated_runners = runner->next_by_pgid;
freerunner(runner);
}
}
/*
* Create a new runner for the 'appli'
*
* Returns the created runner or NULL
* in case of error.
*/
static struct apprun *createrunner(json_object *appli)
{
struct apprun *result;
struct apprun **prev;
/* cleanup */
cleanrunners();
/* get a runid */
if (runnercount >= MAX_RUNNER_COUNT) {
errno = EAGAIN;
return NULL;
}
do {
runnerid++;
if (runnerid > MAX_RUNNER_COUNT)
runnerid = 1;
} while(getrunner(runnerid));
/* create the structure */
result = calloc(1, sizeof * result);
if (result == NULL)
errno = ENOMEM;
else {
/* initialize it linked to the list */
prev = &runners_by_runid[runnerid & (ROOT_RUNNERS_COUNT - 1)];
result->next_by_runid = *prev;
result->next_by_pgid = NULL;
result->runid = runnerid;
result->pids[0] = result->pids[1] = 0;
result->state = as_starting;
result->appli = json_object_get(appli);
*prev = result;
runnercount++;
}
return result;
}
/**************** signaling ************************/
#if 0
static void started(int runid)
{
}
static void stopped(int runid)
{
}
static void continued(int runid)
{
}
static void terminated(int runid)
{
}
static void removed(int runid)
{
}
#endif
/**************** running ************************/
/*
* Sends (with pgkill) the signal 'sig' to the process group
* for 'runid' and put the runner's state to 'tostate'
* in case of success.
*
* Only processes in the state 'as_running' or 'as_stopped'
* can be signalled.
*
* Returns 0 in case of success or -1 in case of error.
*/
static int killrunner(int runid, int sig, enum appstate tostate)
{
int rc;
struct apprun *runner = getrunner(runid);
if (runner == NULL) {
errno = ENOENT;
rc = -1;
}
else if (runner->state != as_running && runner->state != as_stopped) {
errno = EINVAL;
rc = -1;
}
else if (runner->state == tostate) {
rc = 0;
}
else {
rc = killpg(runner->pids[0], sig);
if (!rc)
runner->state = tostate;
}
return rc;
}
/*
* Signal callback called on SIGCHLD. This is set using sigaction.
*/
static void on_sigchld(int signum, siginfo_t *info, void *uctxt)
{
struct apprun *runner;
/* retrieves the runner */
runner = runner_of_pid(info->si_pid);
if (!runner)
return;
/* known runner, inspect cause of signal */
switch(info->si_code) {
case CLD_EXITED:
case CLD_KILLED:
case CLD_DUMPED:
case CLD_TRAPPED:
/* update the state */
runner->state = as_terminated;
/* remove it from pgid list */
pgid_remove(runner);
runner->next_by_pgid = terminated_runners;
terminated_runners = runner;
/* ensures that all the group stops */
killpg(runner->pids[0], SIGKILL);
break;
case CLD_STOPPED:
/* update the state */
runner->state = as_stopped;
break;
case CLD_CONTINUED:
/* update the state */
runner->state = as_running;
break;
}
}
/**************** handle afm_launch_desc *********************/
/*
* Initialize the data of the launch description 'desc'
* for the application 'appli' and the 'mode'.
*
* Returns 0 in case of success or -1 in case of error.
*/
static int fill_launch_desc(struct json_object *appli,
enum afm_launch_mode mode, struct afm_launch_desc *desc)
{
json_object *pub;
assert(is_valid_launch_mode(mode));
/* main items */
if(!j_read_object_at(appli, "public", &pub)
|| !j_read_string_at(appli, "path", &desc->path)
|| !j_read_string_at(appli, "id", &desc->appid)
|| !j_read_string_at(appli, "content", &desc->content)
|| !j_read_string_at(appli, "type", &desc->type)
|| !j_read_string_at(pub, "name", &desc->name)
|| !j_read_integer_at(pub, "width", &desc->width)
|| !j_read_integer_at(pub, "height", &desc->height)) {
errno = EINVAL;
return -1;
}
/* plugins */
{
/* TODO */
static const char *null = NULL;
desc->plugins = &null;
}
/* finaly */
desc->home = homeappdir;
desc->mode = mode;
return 0;
};
/**************** report state of runner *********************/
/*
* Creates a json object that describes the state of 'runner'.
*
* Returns the created object or NULL in case of error.
*/
static json_object *mkstate(struct apprun *runner)
{
const char *state;
struct json_object *result, *obj;
int rc;
/* the structure */
result = json_object_new_object();
if (result == NULL)
goto error;
/* the runid */
if (!j_add_integer(result, "runid", runner->runid))
goto error2;
/* the state */
switch(runner->state) {
case as_starting:
case as_running:
state = "running";
break;
case as_stopped:
state = "stopped";
break;
default:
state = "terminated";
break;
}
if (!j_add_string(result, "state", state))
goto error2;
/* the application id */
rc = json_object_object_get_ex(runner->appli, "public", &obj);
assert(rc);
rc = json_object_object_get_ex(obj, "id", &obj);
assert(rc);
if (!j_add(result, "id", obj))
goto error2;
json_object_get(obj);
/* done */
return result;
error2:
json_object_put(result);
error:
errno = ENOMEM;
return NULL;
}
/**************** API handling ************************/
/*
* Starts the application described by 'appli' for the 'mode'.
* In case of remote start, it returns in uri the uri to
* connect to.
*
* A reference to 'appli' is kept during the live of the
* runner. This is made using json_object_get. Thus be aware
* that further modifications to 'appli' might create errors.
*
* Returns 0 in case of success or -1 in case of error
*/
int afm_run_start(struct json_object *appli, enum afm_launch_mode mode,
char **uri)
{
static struct apprun *runner;
struct afm_launch_desc desc;
int rc;
sigset_t saved, blocked;
assert(is_valid_launch_mode(mode));
assert(mode == mode_local || uri != NULL);
assert(uri == NULL || *uri == NULL);
/* prepare to launch */
rc = fill_launch_desc(appli, mode, &desc);
if (rc)
return rc;
runner = createrunner(appli);
if (!runner)
return -1;
/* block children signals until launched */
sigemptyset(&blocked);
sigaddset(&blocked, SIGCHLD);
sigprocmask(SIG_BLOCK, &blocked, &saved);
/* launch now */
rc = afm_launch(&desc, runner->pids, uri);
if (rc < 0) {
/* fork failed */
sigprocmask(SIG_SETMASK, &saved, NULL);
ERROR("can't start, afm_launch failed: %m");
freerunner(runner);
return -1;
}
/* insert the pid */
runner->state = as_running;
pgid_insert(runner);
rc = runner->runid;
/* unblock children signal now */
sigprocmask(SIG_SETMASK, &saved, NULL);
return rc;
}
/*
* Terminates the runner of 'runid'
*
* Returns 0 in case of success or -1 in case of error
*/
int afm_run_terminate(int runid)
{
return killrunner(runid, SIGTERM, as_terminating);
}
/*
* Stops (aka pause) the runner of 'runid'
*
* Returns 0 in case of success or -1 in case of error
*/
int afm_run_stop(int runid)
{
return killrunner(runid, SIGSTOP, as_stopped);
}
/*
* Continue (aka resume) the runner of 'runid'
*
* Returns 0 in case of success or -1 in case of error
*/
int afm_run_continue(int runid)
{
return killrunner(runid, SIGCONT, as_running);
}
/*
* Get the list of the runners.
*
* Returns the list or NULL in case of error.
*/
struct json_object *afm_run_list()
{
struct json_object *result, *obj;
struct apprun *runner;
int i;
/* creates the object */
result = json_object_new_array();
if (result == NULL)
goto error;
/* iterate over runners */
for (i = 0 ; i < ROOT_RUNNERS_COUNT ; i++) {
runner = runners_by_runid[i];
while (runner) {
if (runner->state != as_terminating
&& runner->state != as_terminated) {
/* adds the living runner */
obj = mkstate(runner);
if (obj == NULL)
goto error2;
if (json_object_array_add(result, obj) == -1) {
json_object_put(obj);
goto error2;
}
}
runner = runner->next_by_runid;
}
}
return result;
error2:
json_object_put(result);
error:
errno = ENOMEM;
return NULL;
}
/*
* Get the state of the runner of 'runid'.
*
* Returns the state or NULL in case of success
*/
struct json_object *afm_run_state(int runid)
{
struct apprun *runner = getrunner(runid);
if (runner == NULL || runner->state == as_terminating
|| runner->state == as_terminated) {
errno = ENOENT;
return NULL;
}
return mkstate(runner);
}
/**************** INITIALISATION **********************/
/*
* Initialize the module
*/
int afm_run_init()
{
char buf[2048];
char dir[PATH_MAX];
int rc;
uid_t me;
struct passwd passwd, *pw;
struct sigaction siga;
/* init launcher */
rc = afm_launch_initialize();
if (rc)
return rc;
/* computes the 'homeappdir' */
me = geteuid();
rc = getpwuid_r(me, &passwd, buf, sizeof buf, &pw);
if (rc || pw == NULL) {
errno = rc ? errno : ENOENT;
ERROR("getpwuid_r failed for uid=%d: %m",(int)me);
return -1;
}
rc = snprintf(dir, sizeof dir, "%s/%s", passwd.pw_dir,
fwk_user_app_dir);
if (rc >= (int)sizeof dir) {
ERROR("buffer overflow in user_app_dir for uid=%d",(int)me);
return -1;
}
rc = create_directory(dir, 0755, 1);
if (rc && errno != EEXIST) {
ERROR("creation of directory %s failed in user_app_dir: %m",
dir);
return -1;
}
homeappdir = strdup(dir);
if (homeappdir == NULL) {
errno = ENOMEM;
ERROR("out of memory in user_app_dir for %s : %m", dir);
return -1;
}
/* install signal handlers */
siga.sa_flags = SA_SIGINFO | SA_NOCLDWAIT;
sigemptyset(&siga.sa_mask);
sigaddset(&siga.sa_mask, SIGCHLD);
siga.sa_sigaction = on_sigchld;
sigaction(SIGCHLD, &siga, NULL);
return 0;
}
|