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
|
/*
* Copyright (c) 2017 TOYOTA MOTOR CORPORATION
*
* 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 "libwindowmanager.h"
#include "hmi-debug.h"
#include <cassert>
#include <cctype>
#include <cerrno>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <atomic>
#include <map>
#include <mutex>
#include <set>
#include <queue>
#include <unistd.h>
#include <systemd/sd-event.h>
#include <pthread.h>
extern "C" {
#include <afb/afb-ws-client.h>
#include <afb/afb-wsj1.h>
}
#define UNUSED(x) (void)(x)
/**
* @class LibWindowmanager::Impl
*/
class LibWindowmanager::Impl {
friend class LibWindowmanager;
const std::vector<std::string> kListEventName{
std::string("active"),
std::string("inactive"),
std::string("visible"),
std::string("invisible"),
std::string("syncdraw"),
std::string("flushdraw")
};
/* Key for json obejct */
const char *kKeyDrawingName = "drawing_name";
const char *kKeyDrawingArea = "drawing_area";
// This is the LibWindowmanager interface impl
int init(int port, char const *token);
// WM API
int requestSurface(json_object *object);
int requestSurfaceXDG(json_object *object);
int activateSurface(json_object *object);
int deactivateSurface(json_object *object);
int endDraw(json_object *object);
void set_event_handler(enum EventType et, handler_fun func);
Impl();
~Impl();
struct afb_wsj1 *wsj1;
struct sd_event *loop;
std::set<std::string> labels;
std::map<EventType, handler_fun> handlers;
std::queue<std::pair<handler_fun, std::string>> handler_queue;
int api_call(const char *verb, json_object *object,
const std::function<void(bool, json_object *)> &onReply);
public:
void event(char const *et, json_object *object);
private:
int runEventLoop();
};
namespace {
constexpr const int token_maxlen = 20;
constexpr const char *const wmAPI = "windowmanager";
#define CONCAT_(X, Y) X##Y
#define CONCAT(X, Y) CONCAT_(X, Y)
#ifndef SCOPE_TRACING
#define TRACE()
#define TRACEN(N)
#else
#define TRACE() \
ScopeTrace __attribute__((unused)) CONCAT(trace_scope_, __LINE__)(__func__)
#define TRACEN(N) \
ScopeTrace __attribute__((unused)) CONCAT(named_trace_scope_, __LINE__)(#N)
struct ScopeTrace {
thread_local static int indent;
char const *f{};
explicit ScopeTrace(char const *func) : f(func) {
fprintf(stderr, "%*s%s -->\n", 2 * indent++, "", this->f);
}
~ScopeTrace() { fprintf(stderr, "%*s%s <--\n", 2 * --indent, "", this->f); }
};
thread_local int ScopeTrace::indent = 0;
#endif
/* called when wsj1 receives a method invocation */
void onCall(void *closure, const char *api, const char *verb,
struct afb_wsj1_msg *msg) {
TRACE();
UNUSED(closure);
UNUSED(verb);
UNUSED(api);
UNUSED(msg);
}
/* called when wsj1 receives an event */
void onEvent(void *closure, const char *event, afb_wsj1_msg *msg) {
TRACE();
// check API name in event
if (0 != strncmp(wmAPI, event, strlen(wmAPI))) {
HMI_ERROR("libwm", "Unknown event: %s", event);
return;
}
json_object *val;
if (json_object_object_get_ex(afb_wsj1_msg_object_j(msg), "data", &val)) {
reinterpret_cast<LibWindowmanager::Impl *>(closure)->event(event, val);
}
else {
HMI_ERROR("libwm", "Not found key \"data\"");
}
}
/* called when wsj1 hangsup */
void onHangup(void *closure, afb_wsj1 *wsj1) {
TRACE();
UNUSED(closure);
UNUSED(wsj1);
HMI_ERROR("libwm", "Hangup, the WindowManager vanished");
}
constexpr struct afb_wsj1_itf itf = {
onHangup, onCall, onEvent,
};
} // namespace
/**
* @class LibWindowmanager::Impl::Impl
*/
LibWindowmanager::Impl::Impl() : wsj1{}, loop{}, labels(), handlers() { TRACE(); }
LibWindowmanager::Impl::~Impl() {
TRACE();
afb_wsj1_unref(wsj1);
sd_event_unref(loop);
}
int LibWindowmanager::Impl::init(int port, char const *token) {
TRACE();
HMI_DEBUG("libwm", "called");
char *uribuf = nullptr;
int rc = -1;
if (this->loop != nullptr && this->wsj1 != nullptr) {
HMI_ERROR("libwm", "LibWindowmanager instance is already initialized!");
rc = -EALREADY;
goto fail;
}
if (token == nullptr) {
HMI_ERROR("libwm", "Token is invalid");
rc = -EINVAL;
goto fail;
}
if (port < 1 || port > 0xffff) {
HMI_ERROR("libwm", "Port is invalid");
rc = -EINVAL;
goto fail;
}
/* get the default event loop */
rc = sd_event_default(&this->loop);
if (rc < 0) {
HMI_ERROR("libwm", "Connection to default event loop failed: %s",
strerror(-rc));
goto fail;
}
asprintf(&uribuf, "ws://localhost:%d/api?token=%s", port, token);
/* connect the websocket wsj1 to the uri given by the first argument */
this->wsj1 = afb_ws_client_connect_wsj1(
this->loop, uribuf, const_cast<struct afb_wsj1_itf *>(&itf), this);
if (this->wsj1 == nullptr) {
sd_event_unref(this->loop);
this->loop = nullptr;
HMI_ERROR("libwm", "Connection to %s failed: %m", uribuf);
rc = -errno;
goto fail;
}
this->runEventLoop();
return 0;
fail:
return rc;
}
int LibWindowmanager::Impl::requestSurface(json_object *object) {
TRACE();
HMI_DEBUG("libwm", "called");
json_object *val;
const char *tmp_label;
if (json_object_object_get_ex(object, this->kKeyDrawingName, &val)) {
tmp_label = json_object_get_string(val);
}
else {
HMI_DEBUG("libwm", "Not found key \"%s\"", this->kKeyDrawingName);
return -EINVAL;
}
// DrawingName in "object" is overwrited in api_call("RequestSurface")
// So it is neccesary to copy it.
const char *label = std::string(tmp_label).c_str();
if (this->labels.find(label) != this->labels.end()) {
HMI_ERROR("libwm", "Surface label already known!");
return -EINVAL;
}
// Store application name first
// because it may not return from setenv
HMI_DEBUG("libwm", "Insert application name: %s\n", label);
this->labels.insert(this->labels.end(), label);
int rc = -1;
/* send the request */
int rc2 =
this->api_call("RequestSurface", object, [&rc](bool ok, json_object *j) {
if (ok) {
json_object *val;
if (json_object_object_get_ex(j, "response", &val)) {
rc = json_object_get_int(val);
}
else {
HMI_ERROR("libwm", "Not found key \"response\"");
rc = -EINVAL;
return;
}
}
});
if (rc2 < 0) {
rc = rc2;
}
if (rc < 0) {
HMI_ERROR("libwm", "Erase application name: %s", label);
this->labels.erase(label);
}
return rc;
}
int LibWindowmanager::Impl::requestSurfaceXDG(json_object *object) {
TRACE();
HMI_DEBUG("libwm", "called");
json_object *val;
const char *tmp_label;
if (json_object_object_get_ex(object, this->kKeyDrawingName, &val)) {
tmp_label = json_object_get_string(val);
}
else {
HMI_DEBUG("libwm", "Not found key \"%s\"", this->kKeyDrawingName);
return -EINVAL;
}
// DrawingName in "object" is overwrited in api_call("RequestSurface")
// So it is neccesary to copy it.
const char *label = std::string(tmp_label).c_str();
if (this->labels.find(label) != this->labels.end()) {
HMI_ERROR("libwm", "Surface label already known!");
return -EINVAL;
}
// Store application name first
// because it may not return from setenv
HMI_DEBUG("libwm", "Insert application name: %s\n", label);
this->labels.insert(this->labels.end(), label);
/* send the request */
int rc = this->api_call("RequestSurfaceXDG", object, [](bool ok, json_object *j) {
if (!ok) {
HMI_ERROR("libwm", "Could not get surface ID from WM: %s",
j != nullptr ? json_object_to_json_string_ext(
j, JSON_C_TO_STRING_PRETTY)
: "no-info");
}
});
if (rc != 0) {
HMI_ERROR("libwm", "Erase application name: %s", label);
this->labels.erase(label);
}
return rc;
}
int LibWindowmanager::Impl::activateSurface(json_object *object) {
TRACE();
HMI_DEBUG("libwm", "called");
return this->api_call("ActivateSurface", object, [](bool ok, json_object *j) {
if (!ok) {
HMI_ERROR("libwm", "API Call activate_surface() failed: %s",
j != nullptr ? json_object_to_json_string_ext(
j, JSON_C_TO_STRING_PRETTY)
: "no-info");
}
});
}
int LibWindowmanager::Impl::deactivateSurface(json_object *object) {
TRACE();
HMI_DEBUG("libwm", "called");
return this->api_call("DeactivateSurface", object, [](bool ok, json_object *j) {
if (!ok) {
HMI_ERROR("libwm", "API Call deactivate_surface() failed: %s",
j != nullptr ? json_object_to_json_string_ext(
j, JSON_C_TO_STRING_PRETTY)
: "no-info");
}
});
}
int LibWindowmanager::Impl::endDraw(json_object *object) {
TRACE();
HMI_DEBUG("libwm", "called");
return this->api_call("EndDraw", object, [](bool ok, json_object *j) {
if (!ok) {
HMI_ERROR("libwm", "API Call endDraw() failed: %s",
j != nullptr ? json_object_to_json_string_ext(
j, JSON_C_TO_STRING_PRETTY)
: "no-info");
}
});
}
static void _on_reply_static(void *closure, struct afb_wsj1_msg *msg)
{
}
void LibWindowmanager::Impl::set_event_handler(enum EventType et, handler_fun func) {
TRACE();
HMI_DEBUG("libwm", "called");
// Subscribe event
struct json_object* j = json_object_new_object();
json_object_object_add(j, "event", json_object_new_int(et));
int ret = afb_wsj1_call_j(this->wsj1, wmAPI, "wm_subscribe", j, _on_reply_static, this);
if (0 > ret) {
HMI_ERROR("libwm", "Failed to subscribe event: %s", kListEventName[et].c_str());
}
// Set event handler
if (et >= Event_Active && et <= Event_FlushDraw) {
this->handlers[et] = std::move(func);
}
}
namespace {
std::pair<bool, LibWindowmanager::EventType> make_event_type(char const *et) {
// Event have the form "$API/$EVENT", just try to find the first / and
// get on with it.
char const *et2 = strchr(et, '/');
if (et2 != nullptr) {
et = et2 + 1;
}
#define ET(N, A) \
do { \
if (strcasecmp(et, N) == 0) \
return std::pair<bool, LibWindowmanager::EventType>( \
true, CONCAT(LibWindowmanager::Event_, A)); \
} while (false)
ET("active", Active);
ET("inactive", Inactive);
ET("visible", Visible);
ET("invisible", Invisible);
ET("syncdraw", SyncDraw);
ET("flushdraw", FlushDraw);
#undef ET
return std::pair<bool, LibWindowmanager::EventType>(false,
LibWindowmanager::Event_Active);
}
} // namespace
/// object will be json_object_put
int LibWindowmanager::Impl::api_call(
const char *verb, json_object *object,
const std::function<void(bool, json_object *)> &onReply) {
TRACE();
int rc = 0;
if (0 == strcmp("RequestSurface", verb)) {
// We need to wrap the actual onReply call once in order to
// *look* like a normal functions pointer (std::functions<>
// with captures cannot convert to function pointers).
// Alternatively we could setup a local struct and use it as
// closure, but I think it is cleaner this way.
int call_rc = 0;
std::atomic<bool> returned{};
returned.store(false, std::memory_order_relaxed);
std::function<void(bool, json_object *)> wrappedOnReply =
[&returned, &call_rc, &onReply](bool ok, json_object *j) {
TRACEN(wrappedOnReply);
call_rc = ok ? 0 : -EINVAL;
// We know it failed, but there may be an explanation in the
// json object.
{
TRACEN(onReply);
onReply(ok, j);
}
returned.store(true, std::memory_order_release);
};
// make the actual call, use wrappedOnReply as closure
rc = afb_wsj1_call_j(
this->wsj1, wmAPI, verb, object,
[](void *closure, afb_wsj1_msg *msg) {
TRACEN(callClosure);
auto *onReply =
reinterpret_cast<std::function<void(bool, json_object *)> *>(
closure);
(*onReply)(!(afb_wsj1_msg_is_reply_ok(msg) == 0),
afb_wsj1_msg_object_j(msg));
},
&wrappedOnReply);
if (0 == rc) {
// We need to wait until "returned" got set, this is necessary
// if events get triggered by the call (and would be dispatched before
// the actual call-reply).
while (!returned.load(std::memory_order_consume)) {
sd_event_run(loop, 16);
}
// return the actual API call result
rc = call_rc;
}
}
else {
rc = afb_wsj1_call_j(this->wsj1, wmAPI, verb, object, _on_reply_static, this);
}
if (rc < 0) {
HMI_ERROR("libwm", "calling %s/%s failed: %m", wmAPI, verb);
}
return rc;
}
void LibWindowmanager::Impl::event(char const *et, json_object *object) {
TRACE();
auto oet = make_event_type(et);
if (!oet.first) {
HMI_ERROR("libwm", "Unknown event type string '%s'", et);
return;
}
auto i = this->handlers.find(oet.second);
if (i != this->handlers.end()) {
json_object *val;
const char *label;
if (json_object_object_get_ex(object, this->kKeyDrawingName, &val)) {
label = json_object_get_string(val);
}
else {
HMI_ERROR("libwm", "Not found key \"%s\"\n", this->kKeyDrawingName);
return;
}
if (this->labels.find(label) != this->labels.end()) {
i->second(object);
}
}
}
static void *event_loop_run(void *args){
struct sd_event* loop = (struct sd_event*)(args);
for(;;)
sd_event_run(loop, 30000000);
}
int LibWindowmanager::Impl::runEventLoop() {
if(this->wsj1 && this->loop)
{
pthread_t thread_id;
int ret = pthread_create(&thread_id, NULL, event_loop_run, this->loop);
if(ret != 0)
{
printf("Cannot run eventloop due to error:%d", errno);
return -1;
}
else
return thread_id;
}
else
{
printf("Connecting is not established yet");
return -1;
}
}
/**
* @class LibWindowmanager
*/
int LibWindowmanager::init(int port, char const *token) {
return this->d->init(port, token);
}
int LibWindowmanager::requestSurface(json_object *object) {
return this->d->requestSurface(object);
}
int LibWindowmanager::requestSurfaceXDG(json_object *object) {
return this->d->requestSurfaceXDG(object);
}
int LibWindowmanager::activateSurface(json_object *object) {
return this->d->activateSurface(object);
}
int LibWindowmanager::deactivateSurface(json_object *object) {
return this->d->deactivateSurface(object);
}
int LibWindowmanager::endDraw(json_object *object) {
return this->d->endDraw(object);
}
void LibWindowmanager::set_event_handler(enum EventType et, handler_fun f) {
return this->d->set_event_handler(et, std::move(f));
}
LibWindowmanager::LibWindowmanager() : d(new Impl) {}
LibWindowmanager::~LibWindowmanager() { delete d; }
|