app: emit_syncdraw() only after layout commit to compositor
[staging/windowmanager.git] / src / app.cpp
1 /*
2  * Copyright (C) 2017 Mentor Graphics Development (Deutschland) GmbH
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include "app.hpp"
18 #include "json_helper.hpp"
19 #include "layers.hpp"
20 #include "layout.hpp"
21 #include "util.hpp"
22 #include "wayland.hpp"
23
24 #include <cstdio>
25 #include <memory>
26
27 #include <cassert>
28
29 #include <json-c/json.h>
30
31 #include <algorithm>
32 #include <bits/signum.h>
33 #include <csignal>
34 #include <fstream>
35 #include <json.hpp>
36 #include <regex>
37 #include <thread>
38
39 namespace wm {
40
41 namespace {
42 App *g_app;
43
44 using nlohmann::json;
45
46 result<json> file_to_json(char const *filename) {
47    std::ifstream i(filename);
48    if (i.fail()) {
49       return Err<json>("Could not open config file");
50    }
51    json j;
52    i >> j;
53    return Ok(j);
54 }
55
56 struct result<layer_map> load_layer_map(char const *filename) {
57    logdebug("loading IDs from %s", filename);
58
59    auto j = file_to_json(filename);
60    if (j.is_err()) {
61       return Err<layer_map>(j.unwrap_err());
62    }
63    json jids = j.unwrap();
64
65    return to_layer_map(jids);
66 }
67
68 }  // namespace
69
70 //       _                    _                  _                 _
71 //   ___| | __ _ ___ ___     / \   _ __  _ __   (_)_ __ ___  _ __ | |
72 //  / __| |/ _` / __/ __|   / _ \ | '_ \| '_ \  | | '_ ` _ \| '_ \| |
73 // | (__| | (_| \__ \__ \  / ___ \| |_) | |_) | | | | | | | | |_) | |
74 //  \___|_|\__,_|___/___/ /_/   \_\ .__/| .__/  |_|_| |_| |_| .__/|_|
75 //                                |_|   |_|                 |_|
76 App::App(wl::display *d)
77    : api{this},
78      chooks{this},
79      display{d},
80      controller{},
81      outputs(),
82      config(),
83      layouts(),
84      layers(),
85      id_alloc{},
86      pending_events(false) {
87    assert(g_app == nullptr);
88    g_app = this;
89
90    try {
91       {
92          auto l = load_layer_map(
93             this->config.get_string("layers.json").value().c_str());
94          if (l.is_ok()) {
95             this->layers = l.unwrap();
96          } else {
97             logerror("%s", l.err().value());
98          }
99       }
100    } catch (std::exception &e) {
101       logerror("Loading of configuration failed: %s", e.what());
102    }
103 }
104
105 App::~App() { g_app = nullptr; }
106
107 int App::init() {
108    if (!this->display->ok()) {
109       return -1;
110    }
111
112    if (this->layers.mapping.empty()) {
113       logerror("No surface -> layer mapping loaded");
114       return -1;
115    }
116
117    this->display->add_global_handler(
118       "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
119          this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
120       });
121
122    this->display->add_global_handler(
123       "ivi_controller", [this](wl_registry *r, uint32_t name, uint32_t v) {
124          this->controller =
125             std::make_unique<struct genivi::controller>(r, name, v);
126
127          // Init controller hooks
128          this->controller->chooks = &this->chooks;
129
130          // XXX: This protocol needs the output, so lets just add our mapping
131          // here...
132          this->controller->add_proxy_to_id_mapping(
133             this->outputs.back()->proxy.get(),
134             wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
135                this->outputs.back()->proxy.get())));
136       });
137
138    // First level objects
139    this->display->roundtrip();
140    // Second level objects
141    this->display->roundtrip();
142    // Third level objects
143    this->display->roundtrip();
144
145    return init_layers();
146 }
147
148 int App::dispatch_events() {
149    if (this->dispatch_events() == 0) {
150       return 0;
151    }
152
153    int ret = this->display->dispatch();
154    if (ret == -1) {
155       logerror("wl_display_dipatch() returned error %d",
156                this->display->get_error());
157       return -1;
158    }
159    this->display->flush();
160
161    return 0;
162 }
163
164 int App::dispatch_pending_events() {
165    if (this->pop_pending_events()) {
166       this->display->dispatch_pending();
167       return 0;
168    }
169    return -1;
170 }
171
172 bool App::pop_pending_events() {
173    bool x{true};
174    return this->pending_events.compare_exchange_strong(
175       x, false, std::memory_order_consume);
176 }
177
178 void App::set_pending_events() {
179    this->pending_events.store(true, std::memory_order_release);
180 }
181
182 optional<int> App::lookup_id(char const *name) {
183    return this->id_alloc.lookup(std::string(name));
184 }
185 optional<std::string> App::lookup_name(int id) {
186    return this->id_alloc.lookup(id);
187 }
188
189 //  _       _ _       _                         _    ____
190 // (_)_ __ (_) |_    | | __ _ _   _  ___  _   _| |_ / /\ \
191 // | | '_ \| | __|   | |/ _` | | | |/ _ \| | | | __| |  | |
192 // | | | | | | |_    | | (_| | |_| | (_) | |_| | |_| |  | |
193 // |_|_| |_|_|\__|___|_|\__,_|\__, |\___/ \__,_|\__| |  | |
194 //              |_____|       |___/                 \_\/_/
195 int App::init_layers() {
196    if (!this->controller) {
197       logerror("ivi_controller global not available");
198       return -1;
199    }
200
201    if (this->outputs.empty()) {
202       logerror("no output was set up!");
203       return -1;
204    }
205
206    auto &c = this->controller;
207
208    auto &o = this->outputs.front();
209    auto &s = c->screens.begin()->second;
210    auto &layers = c->layers;
211
212    // XXX: Write output dimensions to ivi controller...
213    c->output_size = genivi::size{uint32_t(o->width), uint32_t(o->height)};
214
215    // Clear scene
216    layers.clear();
217
218    // Clear screen
219    s->clear();
220
221    // Quick and dirty setup of layers
222    // XXX: This likely needs to be sorted by order (note, we don't (yet?)
223    // do any zorder arrangement).
224    for (auto const &i : this->layers.mapping) {
225       c->layer_create(i.layer_id, o->width, o->height);
226       auto &l = layers[i.layer_id];
227       l->set_destination_rectangle(0, 0, o->width, o->height);
228       l->set_visibility(1);
229       logdebug(
230          "Setting up layer %s (%d) for surfaces %d-%d and role match \"%s\"",
231          i.name.c_str(), i.layer_id, i.id_min, i.id_max, i.role.c_str());
232       this->layouts[l->id] = LayoutState{};
233    }
234
235    // Add layers to screen (XXX: are they sorted correctly?)
236    s->set_render_order(this->layers.layers);
237
238    this->layout_commit();
239
240    return 0;
241 }
242
243 namespace {
244
245 #ifdef WE_LIKE_NOT_TO_USE_THIS
246 // This can fix the HomeScreen...
247 void redraw_fix(App *app, std::unique_ptr<genivi::surface> &s, int x, int y,
248                 int w, int h) {
249    {  // XXX: Work around weston redraw issues
250       // trigger an update by changing the source dimensions!
251       s->set_configuration(w + 1, h);
252       s->set_source_rectangle(0, 0, w + 1, h);
253       s->set_destination_rectangle(x, y, w + 1, h);
254       app->controller->commit_changes();
255       app->display->roundtrip();
256
257       // wait some time, for the process to do its thing...
258       using namespace std::chrono_literals;
259       std::this_thread::sleep_for(100ms);
260
261       // Set a different size then what we actually want.
262       s->set_configuration(w, h);
263       s->set_source_rectangle(0, 0, w, h);
264       s->set_destination_rectangle(x, y, w, h);
265       app->controller->commit_changes();
266       app->display->roundtrip();
267    }
268 }
269 #endif
270
271 }  // namespace
272
273 void App::surface_set_layout(int surface_id, optional<int> sub_surface_id) {
274    if (!this->controller->surface_exists(surface_id)) {
275       logerror("Surface %d does not exist", surface_id);
276       return;
277    }
278
279    auto o_layer_id = this->layers.get_layer_id(surface_id);
280
281    if (!o_layer_id) {
282       logerror("Surface %d is not associated with any layer!", surface_id);
283       return;
284    }
285
286    uint32_t layer_id = *o_layer_id;
287
288    auto const &layer = this->layers.get_layer(layer_id);
289    auto rect = layer.value().rect;
290    auto &s = this->controller->surfaces[surface_id];
291
292    int x = rect.x;
293    int y = rect.y;
294    int w = rect.w;
295    int h = rect.h;
296
297    // less-than-0 values refer to MAX + 1 - $VALUE
298    // e.g. MAX is either screen width or height
299    if (w < 0) {
300       w = this->controller->output_size.w + 1 + w;
301    }
302    if (h < 0) {
303       h = this->controller->output_size.h + 1 + h;
304    }
305
306    if (sub_surface_id) {
307       if (o_layer_id != this->layers.get_layer_id(*sub_surface_id)) {
308          logerror("surface_set_layout: layers of surfaces (%d and %d) don't match!", surface_id, *sub_surface_id);
309          return;
310       }
311
312       int x_off = 0;
313       int y_off = 0;
314
315       // split along major axis
316       if (w > h) {
317          w /= 2;
318          x_off = w;
319       } else {
320          h /= 2;
321          y_off = h;
322       }
323
324       auto &ss = this->controller->surfaces[*sub_surface_id];
325
326       logdebug("surface_set_layout for sub surface %u on layer %u", *sub_surface_id,
327                layer_id);
328
329       // configure surface to wxh dimensions
330       ss->set_configuration(w, h);
331       // set source reactangle, even if we should not need to set it.
332       ss->set_source_rectangle(0, 0, w, h);
333       // set destination to the display rectangle
334       ss->set_destination_rectangle(x + x_off, y + y_off, w, h);
335    }
336
337    logdebug("surface_set_layout for surface %u on layer %u", surface_id,
338             layer_id);
339
340    // configure surface to wxh dimensions
341    s->set_configuration(w, h);
342    // set source reactangle, even if we should not need to set it.
343    s->set_source_rectangle(0, 0, w, h);
344    // set destination to the display rectangle
345    s->set_destination_rectangle(x, y, w, h);
346
347    // redraw_fix(this, s, x, y, w, h);
348    // redraw_fix(this, ss, x+x_off, y+y_off, w, h);
349
350    logdebug("Surface %u now on layer %u with rect { %d, %d, %d, %d }",
351             surface_id, layer_id, x, y, w, h);
352 }
353
354 void App::layout_commit() {
355    this->controller->commit_changes();
356    this->display->flush();
357 }
358
359 char const *App::api_activate_surface(char const *drawing_name) {
360    ST();
361    auto const &surface_id = this->lookup_id(drawing_name);
362
363    if (!surface_id) {
364       return "Surface does not exist";
365    }
366
367    if (!this->controller->surface_exists(*surface_id)) {
368       return "Surface does not exist in controller!";
369    }
370
371    auto layer_id = this->layers.get_layer_id(*surface_id);
372
373    if (!layer_id) {
374       return "Surface is not on any layer!";
375    }
376
377    auto o_state = *this->layers.get_layout_state(*surface_id);
378
379    if (!o_state) {
380       return "Could not find layer for surface";
381    }
382
383    struct LayoutState &state = *o_state;
384
385    // disable layers that are above our current layer
386    for (auto const &l : this->layers.mapping) {
387       if (l.layer_id <= *layer_id) {
388          continue;
389       }
390
391       bool flush = false;
392       if (l.state.main != -1) {
393          this->deactivate(l.state.main);
394          l.state.main = -1;
395          flush = true;
396       }
397
398       if (l.state.sub != -1) {
399          this->deactivate(l.state.sub);
400          l.state.sub = -1;
401          flush = true;
402       }
403
404       l.state.s = LayoutState::Single;
405
406       if (flush) {
407          this->layout_commit();
408       }
409    }
410
411    if (state.main == *surface_id || state.sub == *surface_id) {
412       return "Surface already active";
413    }
414
415    // This should involve a policy check, but as we do not (yet) have
416    // such a thing, we will just switch to this surface.
417    // XXX: input focus missing!!1
418
419    if (state.main == -1) {
420       this->surface_set_layout(*surface_id);
421       this->activate(*surface_id);  // XXX do we need to activate after enddraw?
422       state.main = *surface_id;
423       state.sub = -1;
424       state.s = LayoutState::Single;
425
426       this->layout_commit();
427       this->emit_syncdraw(drawing_name);
428       this->enqueue_flushdraw(state.main);
429    } else {
430       bool can_split = this->can_split(state, *surface_id);
431
432       if (state.sub == -1) {
433          if (can_split) {
434             if (state.main != *surface_id) {
435                std::string main = std::move(*this->lookup_name(state.main));
436
437                this->surface_set_layout(state.main, surface_id);
438                this->activate(*surface_id);
439                state.sub = *surface_id;
440
441                this->layout_commit();
442                this->emit_syncdraw(drawing_name);
443                this->emit_syncdraw(main.c_str());
444                this->enqueue_flushdraw(state.main);
445                this->enqueue_flushdraw(state.sub);
446             }
447          } else {
448             this->surface_set_layout(*surface_id);
449             this->deactivate(state.main);
450             this->activate(*surface_id);
451             this->deactivate(state.sub);
452             state.main = *surface_id;
453             state.sub = -1;
454             state.s = LayoutState::Single;
455
456             this->layout_commit();
457             this->emit_syncdraw(drawing_name);
458             this->enqueue_flushdraw(state.main);
459          }
460       }
461    }
462
463    // no error
464    return nullptr;
465 }
466
467 char const *App::api_deactivate_surface(char const *drawing_name) {
468    ST();
469    auto const &surface_id = this->lookup_id(drawing_name);
470
471    if (!surface_id) {
472       return "Surface does not exist";
473    }
474
475    if (*surface_id == this->layers.main_surface) {
476       return "Cannot deactivate main_surface";
477    }
478
479    auto o_state = *this->layers.get_layout_state(*surface_id);
480
481    if (!o_state) {
482       return "Could not find layer for surface";
483    }
484
485    struct LayoutState &state = *o_state;
486
487    if (state.main == -1) {
488       return "No surface active";
489    }
490
491    // XXX: check against main_surface, main_surface_name is the configuration item.
492    if (*surface_id == this->layers.main_surface) {
493       logdebug("Refusing to deactivate main_surface %d", *surface_id);
494       return nullptr;
495    }
496
497    if (state.main == *surface_id) {
498       if (state.sub != -1) {
499          std::string sub = std::move(*this->lookup_name(state.sub));
500
501          this->deactivate(*surface_id);
502          this->surface_set_layout(state.sub);
503          state.main = state.sub;
504          state.sub = -1;
505          state.s = LayoutState::Single;
506
507          this->layout_commit();
508          this->emit_syncdraw(sub.c_str());
509          this->enqueue_flushdraw(state.sub);
510       } else {
511          this->deactivate(*surface_id);
512          state.main = -1;
513       }
514    } else if (state.sub == *surface_id) {
515       std::string main = std::move(*this->lookup_name(state.main));
516
517       this->deactivate(*surface_id);
518       this->deactivate(*surface_id);
519       this->surface_set_layout(state.main);
520       state.sub = -1;
521       state.s = LayoutState::Single;
522
523       this->layout_commit();
524       this->emit_syncdraw(main.c_str());
525       this->enqueue_flushdraw(state.main);
526    } else {
527       return "Surface is not active";
528    }
529
530    return nullptr;
531 }
532
533 void App::enqueue_flushdraw(int surface_id) {
534    this->check_flushdraw(surface_id);
535    logdebug("Enqueuing EndDraw for surface_id %d", surface_id);
536    this->pending_end_draw.push_back(surface_id);
537 }
538
539 void App::check_flushdraw(int surface_id) {
540    auto i = std::find(std::begin(this->pending_end_draw),
541                       std::end(this->pending_end_draw), surface_id);
542    if (i != std::end(this->pending_end_draw)) {
543       auto n = this->lookup_name(surface_id);
544       logerror("Application %s (%d) has pending EndDraw call(s)!",
545                n ? n->c_str() : "unknown-name", surface_id);
546       std::swap(this->pending_end_draw[std::distance(
547          std::begin(this->pending_end_draw), i)],
548                 this->pending_end_draw.back());
549       this->pending_end_draw.resize(this->pending_end_draw.size() - 1);
550    }
551 }
552
553 char const *App::api_enddraw(char const *drawing_name) {
554    for (unsigned i = 0, iend = this->pending_end_draw.size(); i < iend; i++) {
555       auto n = this->lookup_name(this->pending_end_draw[i]);
556       if (n && *n == drawing_name) {
557          std::swap(this->pending_end_draw[i], this->pending_end_draw[iend - 1]);
558          this->pending_end_draw.resize(iend - 1);
559          // XXX: Please tell the compositor to thaw the surface...
560          this->emit_flushdraw(drawing_name);
561          return nullptr;
562       }
563    }
564    return "No EndDraw pending for surface";
565 }
566
567 void App::api_ping() {
568    this->dispatch_pending_events();
569 }
570
571 void App::deactivate_main_surface() {
572    this->layers.main_surface = -1;
573    this->api_deactivate_surface(this->layers.main_surface_name.c_str());
574 }
575
576 //                      _          _   _____                 _
577 //  _ __  _ __ _____  _(_) ___  __| | | ____|_   _____ _ __ | |_ ___
578 // | '_ \| '__/ _ \ \/ / |/ _ \/ _` | |  _| \ \ / / _ \ '_ \| __/ __|
579 // | |_) | | | (_) >  <| |  __/ (_| | | |___ \ V /  __/ | | | |_\__ \
580 // | .__/|_|  \___/_/\_\_|\___|\__,_| |_____| \_/ \___|_| |_|\__|___/
581 // |_|
582 void App::surface_created(uint32_t surface_id) {
583    auto layer_id = this->layers.get_layer_id(surface_id);
584    if (!layer_id) {
585       logdebug("Newly created surfce %d is not associated with any layer!",
586                surface_id);
587       return;
588    }
589
590    logdebug("surface_id is %u, layer_id is %u", surface_id, *layer_id);
591
592    this->controller->layers[*layer_id]->add_surface(
593       this->controller->surfaces[surface_id].get());
594
595    // activate the main_surface right away
596    if (surface_id == static_cast<unsigned>(this->layers.main_surface)) {
597       logdebug("Activating main_surface (%d)", surface_id);
598
599       this->api_activate_surface(
600          this->lookup_name(surface_id).value_or("unknown-name").c_str());
601    }
602 }
603
604 void App::surface_removed(uint32_t surface_id) {
605    logdebug("surface_id is %u", surface_id);
606
607    // We cannot normally deactivate the main_surface, so be explicit
608    // about it:
609    if (int(surface_id) == this->layers.main_surface) {
610       this->deactivate_main_surface();
611    } else {
612       auto drawing_name = this->lookup_name(surface_id);
613       if (drawing_name) {
614          this->api_deactivate_surface(drawing_name->c_str());
615       }
616    }
617
618    this->id_alloc.remove_id(surface_id);
619    this->layers.remove_surface(surface_id);
620 }
621
622 void App::emit_activated(char const *label) {
623    this->api.send_event("activated", label);
624 }
625
626 void App::emit_deactivated(char const *label) {
627    this->api.send_event("deactivated", label);
628 }
629
630 void App::emit_syncdraw(char const *label) {
631    this->api.send_event("syncdraw", label);
632 }
633
634 void App::emit_flushdraw(char const *label) {
635    this->api.send_event("flushdraw", label);
636 }
637
638 void App::emit_visible(char const *label, bool is_visible) {
639    this->api.send_event(is_visible ? "visible" : "invisible", label);
640 }
641
642 void App::emit_invisible(char const *label) {
643    return emit_visible(label, false);
644 }
645
646 void App::emit_visible(char const *label) { return emit_visible(label, true); }
647
648 result<int> App::api_request_surface(char const *drawing_name) {
649    auto lid = this->layers.get_layer_id(std::string(drawing_name));
650    if (!lid) {
651       // XXX: to we need to put these applications on the App layer?
652       return Err<int>("Drawing name does not match any role");
653    }
654
655    auto rname = this->lookup_id(drawing_name);
656    if (!rname) {
657       // name does not exist yet, allocate surface id...
658       auto id = int(this->id_alloc.generate_id(drawing_name));
659       this->layers.add_surface(id, *lid);
660
661       // XXX: we set the main_surface[_name] here and now,
662       // not sure if we want this, but it worked so far.
663       if (!this->layers.main_surface_name.empty() &&
664           this->layers.main_surface_name == drawing_name) {
665          this->layers.main_surface = id;
666          logdebug("Set main_surface id to %u", id);
667       }
668
669       return Ok<int>(id);
670    }
671
672    // Check currently registered drawing names if it is already there.
673    return Err<int>("Surface already present");
674 }
675
676 void App::activate(int id) {
677    if (this->controller->sprops[id].visibility == 0) {
678       this->controller->surfaces[id]->set_visibility(1);
679       char const *label =
680          this->lookup_name(id).value_or("unknown-name").c_str();
681       this->emit_activated(label);
682       this->emit_visible(label);
683    }
684 }
685
686 void App::deactivate(int id) {
687    if (this->controller->sprops[id].visibility != 0) {
688       this->controller->surfaces[id]->set_visibility(0);
689       char const *label =
690          this->lookup_name(id).value_or("unknown-name").c_str();
691       this->emit_deactivated(label);
692       this->emit_invisible(label);
693    }
694 }
695
696 bool App::can_split(struct LayoutState const &state, int new_id) {
697    if (state.main != -1 && state.main != new_id) {
698       auto new_id_layer = this->layers.get_layer_id(new_id).value();
699       auto current_id_layer = this->layers.get_layer_id(state.main).value();
700
701       // surfaces are on separate layers, don't bother.
702       if (new_id_layer != current_id_layer) {
703          return false;
704       }
705
706       std::string const &new_id_str = this->lookup_name(new_id).value();
707       std::string const &cur_id_str = this->lookup_name(state.main).value();
708
709       auto const &layer = this->layers.get_layer(new_id_layer);
710
711       logdebug("layer info name: %s", layer->name.c_str());
712
713       if (layer->layouts.empty()) {
714          return false;
715       }
716
717       for (auto i = layer->layouts.cbegin(); i != layer->layouts.cend(); i++) {
718          logdebug("%d main_match '%s'", new_id_layer, i->main_match.c_str());
719          auto rem = std::regex(i->main_match);
720          if (std::regex_match(cur_id_str, rem)) {
721             // build the second one only if the first already matched
722             logdebug("%d sub_match '%s'", new_id_layer, i->sub_match.c_str());
723             auto res = std::regex(i->sub_match);
724             if (std::regex_match(new_id_str, res)) {
725                logdebug("layout matched!");
726                return true;
727             }
728          }
729       }
730    }
731
732    return false;
733 }
734
735 //                  _             _ _            _                 _
736 //   ___ ___  _ __ | |_ _ __ ___ | | | ___ _ __ | |__   ___   ___ | | _____
737 //  / __/ _ \| '_ \| __| '__/ _ \| | |/ _ \ '__|| '_ \ / _ \ / _ \| |/ / __|
738 // | (_| (_) | | | | |_| | | (_) | | |  __/ |   | | | | (_) | (_) |   <\__ \
739 //  \___\___/|_| |_|\__|_|  \___/|_|_|\___|_|___|_| |_|\___/ \___/|_|\_\___/
740 //                                         |_____|
741 void controller_hooks::surface_created(uint32_t surface_id) {
742    this->app->surface_created(surface_id);
743 }
744
745 void controller_hooks::surface_removed(uint32_t surface_id) {
746    this->app->surface_removed(surface_id);
747 }
748
749 }  // namespace wm