2 * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include "window_manager.hpp"
21 #include "json_helper.hpp"
22 #include "applist.hpp"
26 #include <systemd/sd-event.h>
35 static const uint64_t kTimeOut = 3ULL; /* 3s */
37 /* DrawingArea name used by "{layout}.{area}" */
38 const char kNameLayoutNormal[] = "normal";
39 const char kNameLayoutSplit[] = "split";
40 const char kNameAreaFull[] = "full";
41 const char kNameAreaMain[] = "main";
42 const char kNameAreaSub[] = "sub";
44 /* Key for json obejct */
45 const char kKeyDrawingName[] = "drawing_name";
46 const char kKeyDrawingArea[] = "drawing_area";
47 const char kKeyDrawingRect[] = "drawing_rect";
48 const char kKeyX[] = "x";
49 const char kKeyY[] = "y";
50 const char kKeyWidth[] = "width";
51 const char kKeyHeight[] = "height";
52 const char kKeyWidthPixel[] = "width_pixel";
53 const char kKeyHeightPixel[] = "height_pixel";
54 const char kKeyWidthMm[] = "width_mm";
55 const char kKeyHeightMm[] = "height_mm";
56 const char kKeyScale[] = "scale";
57 const char kKeyIds[] = "ids";
59 static const vector<string> kListEventName{
69 static sd_event_source *g_timer_ev_src = nullptr;
70 static AppList g_app_list;
71 static WindowManager *g_context;
76 static int processTimerHandler(sd_event_source *s, uint64_t usec, void *userdata)
78 HMI_NOTICE("Time out occurs because the client replys endDraw slow, so revert the request");
79 reinterpret_cast<wm::WindowManager *>(userdata)->timerHandler();
83 static void onStateTransitioned(vector<WMAction> actions)
85 g_context->startTransitionWrapper(actions);
90 g_context->processError(WMError::LAYOUT_CHANGE_FAIL);
97 WindowManager::WindowManager()
100 const char *path = getenv("AFM_APP_INSTALL_DIR");
103 HMI_ERROR("AFM_APP_INSTALL_DIR is not defined");
107 this->lc = std::make_shared<LayerControl>(root);
109 HMI_DEBUG("Layer Controller initialized");
112 int WindowManager::init()
114 LayerControlCallbacks lmcb;
115 lmcb.surfaceCreated = [&](unsigned pid, unsigned surface){
116 this->surface_created(surface);
118 lmcb.surfaceDestroyed = [&](unsigned surface){
119 this->surface_removed(surface);
122 if(this->lc->init(lmcb) != WMError::SUCCESS)
127 // Store my context for calling callback from PolicyManager
130 // Initialize PMWrapper
131 this->pmw.initialize();
133 // Register callback to PolicyManager
134 this->pmw.registerCallback(onStateTransitioned, onError);
137 for (int i = Event_Val_Min; i <= Event_Val_Max; i++)
139 map_afb_event[kListEventName[i]] = afb_api_make_event(afbBindingV3root, kListEventName[i].c_str());
142 const struct rect css_bg = this->lc->getAreaSize("fullscreen");
143 Screen screen = this->lc->getScreenInfo();
144 rectangle dp_bg(screen.width(), screen.height());
146 dp_bg.set_aspect(static_cast<double>(css_bg.w) / css_bg.h);
147 dp_bg.fit(screen.width(), screen.height());
148 dp_bg.center(screen.width(), screen.height());
149 HMI_DEBUG("SCALING: CSS BG(%dx%d) -> DDP %dx%d,(%dx%d)",
150 css_bg.w, css_bg.h, dp_bg.left(), dp_bg.top(), dp_bg.width(), dp_bg.height());
152 double scale = static_cast<double>(dp_bg.height()) / css_bg.h;
153 this->lc->setupArea(dp_bg, scale);
158 result<int> WindowManager::api_request_surface(char const *appid, char const *drawing_name)
160 string str_id = appid;
161 string role = drawing_name;
164 if(!g_app_list.contains(str_id))
166 lid = this->lc->getNewLayerID(role);
169 // register drawing_name as fallback and make it displayed.
170 lid = this->lc->getNewLayerID(string("fallback"));
171 HMI_DEBUG("%s is not registered in layers.json, then fallback as normal app", role);
174 return Err<int>("Designated role does not match any role, fallback is disabled");
177 this->lc->createNewLayer(lid);
178 // add client into the db
179 g_app_list.addClient(str_id, lid, role);
182 // generate surface ID for ivi-shell application
183 auto rname = this->id_alloc.lookup(role);
186 // name does not exist yet, allocate surface id...
187 auto id = int(this->id_alloc.generate_id(role));
188 this->tmp_surface2app[id] = {str_id, lid};
193 // Check currently registered drawing names if it is already there.
194 return Err<int>("Surface already present");
197 char const *WindowManager::api_request_surface(char const *appid, char const *drawing_name,
200 string str_id = appid;
201 string role = drawing_name;
203 unsigned sid = std::stol(ivi_id);
204 HMI_DEBUG("This API(requestSurfaceXDG) is for XDG Application using runXDG");
206 * IVI-shell doesn't send surface_size event via ivi-wm protocol
207 * if the application is using XDG surface.
208 * So WM has to set surface size with original size here
210 WMError ret = this->lc->setXDGSurfaceOriginSize(sid);
213 HMI_ERROR("%s", errorDescription(ret));
214 HMI_WARNING("The main user of this API is runXDG");
218 if(!g_app_list.contains(str_id))
220 unsigned l_id = this->lc->getNewLayerID(role);
223 // register drawing_name as fallback and make it displayed.
224 l_id = this->lc->getNewLayerID("fallback");
225 HMI_DEBUG("%s is not registered in layers.json, then fallback as normal app", role);
228 return "Designated role does not match any role, fallback is disabled";
231 this->lc->createNewLayer(l_id);
232 // add client into the db
233 g_app_list.addClient(str_id, l_id, role);
236 auto rname = this->id_alloc.lookup(role);
240 return "Surface already present";
243 // register pair drawing_name and ivi_id
244 this->id_alloc.register_name_id(role, sid);
246 auto client = g_app_list.lookUpClient(str_id);
247 client->addSurface(sid);
252 void WindowManager::api_activate_window(char const *appid, char const *drawing_name,
253 char const *drawing_area, const reply_func &reply)
256 string role = drawing_name;
257 string area = drawing_area;
259 if(!g_app_list.contains(id))
261 reply("app doesn't request 'requestSurface' or 'setRole' yet");
264 auto client = g_app_list.lookUpClient(id);
266 Task task = Task::TASK_ALLOCATE;
267 unsigned req_num = 0;
268 WMError ret = WMError::UNKNOWN;
270 ret = this->setRequest(id, role, area, task, &req_num);
272 if(ret != WMError::SUCCESS)
274 HMI_ERROR(errorDescription(ret));
275 reply("Failed to set request");
280 if (req_num != g_app_list.currentRequestNumber())
282 // Add request, then invoked after the previous task is finished
283 HMI_SEQ_DEBUG(req_num, "request is accepted");
289 ret = this->checkPolicy(req_num);
291 if (ret != WMError::SUCCESS)
294 HMI_SEQ_ERROR(req_num, errorDescription(ret));
295 g_app_list.removeRequest(req_num);
296 this->processNextRequest();
300 void WindowManager::api_deactivate_window(char const *appid, char const *drawing_name,
301 const reply_func &reply)
305 string role = drawing_name;
306 string area = ""; //drawing_area;
307 Task task = Task::TASK_RELEASE;
308 unsigned req_num = 0;
309 WMError ret = WMError::UNKNOWN;
311 ret = this->setRequest(id, role, area, task, &req_num);
313 if (ret != WMError::SUCCESS)
315 HMI_ERROR(errorDescription(ret));
316 reply("Failed to set request");
321 if (req_num != g_app_list.currentRequestNumber())
323 // Add request, then invoked after the previous task is finished
324 HMI_SEQ_DEBUG(req_num, "request is accepted");
329 ret = this->checkPolicy(req_num);
331 if (ret != WMError::SUCCESS)
334 HMI_SEQ_ERROR(req_num, errorDescription(ret));
335 g_app_list.removeRequest(req_num);
336 this->processNextRequest();
340 void WindowManager::api_enddraw(char const *appid, char const *drawing_name)
343 string role = drawing_name;
344 unsigned current_req = g_app_list.currentRequestNumber();
345 bool result = g_app_list.setEndDrawFinished(current_req, id, role);
349 HMI_ERROR("%s is not in transition state", id.c_str());
353 if (g_app_list.endDrawFullfilled(current_req))
355 // do task for endDraw
357 WMError ret = this->doEndDraw(current_req);
359 if(ret != WMError::SUCCESS)
361 //this->emit_error();
363 // Undo state of PolicyManager
364 this->pmw.undoState();
365 this->lc->undoUpdate();
367 this->emitScreenUpdated(current_req);
368 HMI_SEQ_INFO(current_req, "Finish request status: %s", errorDescription(ret));
370 g_app_list.removeRequest(current_req);
372 this->processNextRequest();
376 HMI_SEQ_INFO(current_req, "Wait other App call endDraw");
381 int WindowManager::api_subscribe(afb_req_t req, int event_id)
383 afb_event_t event = this->map_afb_event[kListEventName[event_id]];
384 return afb_req_subscribe(req, event);
387 result<json_object *> WindowManager::api_get_display_info()
389 Screen screen = this->lc->getScreenInfo();
391 json_object *object = json_object_new_object();
392 json_object_object_add(object, kKeyWidthPixel, json_object_new_int(screen.width()));
393 json_object_object_add(object, kKeyHeightPixel, json_object_new_int(screen.height()));
395 json_object_object_add(object, kKeyWidthMm, json_object_new_int(0));
396 json_object_object_add(object, kKeyHeightMm, json_object_new_int(0));
397 json_object_object_add(object, kKeyScale, json_object_new_double(this->lc->scale()));
399 return Ok<json_object *>(object);
402 result<json_object *> WindowManager::api_get_area_info(char const *drawing_name)
406 string role = drawing_name;
408 // Check drawing name, surface/layer id
409 auto const &surface_id = this->id_alloc.lookup(role);
412 return Err<json_object *>("Surface does not exist");
415 // Set area rectangle
416 struct rect area_info = this->area_info[*surface_id];
417 json_object *object = json_object_new_object();
418 json_object_object_add(object, kKeyX, json_object_new_int(area_info.x));
419 json_object_object_add(object, kKeyY, json_object_new_int(area_info.y));
420 json_object_object_add(object, kKeyWidth, json_object_new_int(area_info.w));
421 json_object_object_add(object, kKeyHeight, json_object_new_int(area_info.h));
423 return Ok<json_object *>(object);
426 void WindowManager::send_event(const string& evname, const string& role)
428 json_object *j = json_object_new_object();
429 json_object_object_add(j, kKeyDrawingName, json_object_new_string(role.c_str()));
431 int ret = afb_event_push(this->map_afb_event[evname], j);
434 HMI_DEBUG("afb_event_push failed: %m");
438 void WindowManager::send_event(const string& evname, const string& role, const string& area,
439 int x, int y, int w, int h)
441 json_object *j_rect = json_object_new_object();
442 json_object_object_add(j_rect, kKeyX, json_object_new_int(x));
443 json_object_object_add(j_rect, kKeyY, json_object_new_int(y));
444 json_object_object_add(j_rect, kKeyWidth, json_object_new_int(w));
445 json_object_object_add(j_rect, kKeyHeight, json_object_new_int(h));
447 json_object *j = json_object_new_object();
448 json_object_object_add(j, kKeyDrawingName, json_object_new_string(role.c_str()));
449 json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area.c_str()));
450 json_object_object_add(j, kKeyDrawingRect, j_rect);
452 int ret = afb_event_push(this->map_afb_event[evname], j);
455 HMI_DEBUG("afb_event_push failed: %m");
462 void WindowManager::surface_created(unsigned surface_id)
465 if(this->tmp_surface2app.count(surface_id) != 0)
467 string appid = this->tmp_surface2app[surface_id].appid;
468 auto client = g_app_list.lookUpClient(appid);
469 if(client != nullptr)
471 WMError ret = client->addSurface(surface_id);
472 HMI_INFO("Add surface %d to \"%s\"", surface_id, appid.c_str());
473 if(ret != WMError::SUCCESS)
475 HMI_ERROR("Failed to add surface to client %s", client->appID().c_str());
478 this->tmp_surface2app.erase(surface_id);
482 void WindowManager::surface_removed(unsigned surface_id)
484 HMI_DEBUG("Delete surface_id %u", surface_id);
485 this->id_alloc.remove_id(surface_id);
486 g_app_list.removeSurface(surface_id);
489 void WindowManager::removeClient(const string &appid)
491 HMI_DEBUG("Remove clinet %s from list", appid.c_str());
492 auto client = g_app_list.lookUpClient(appid);
493 this->lc->appTerminated(client);
494 g_app_list.removeClient(appid);
497 void WindowManager::exceptionProcessForTransition()
499 unsigned req_num = g_app_list.currentRequestNumber();
500 HMI_SEQ_NOTICE(req_num, "Process exception handling for request. Remove current request %d", req_num);
501 g_app_list.removeRequest(req_num);
502 HMI_SEQ_NOTICE(g_app_list.currentRequestNumber(), "Process next request if exists");
503 this->processNextRequest();
506 void WindowManager::timerHandler()
508 unsigned req_num = g_app_list.currentRequestNumber();
509 HMI_SEQ_DEBUG(req_num, "Timer expired remove Request");
510 g_app_list.reqDump();
511 g_app_list.removeRequest(req_num);
512 this->processNextRequest();
515 void WindowManager::startTransitionWrapper(vector<WMAction> &actions)
518 unsigned req_num = g_app_list.currentRequestNumber();
522 if (g_app_list.haveRequest())
524 HMI_SEQ_DEBUG(req_num, "There is no WMAction for this request");
525 goto proc_remove_request;
529 HMI_SEQ_DEBUG(req_num, "There is no request");
534 for (auto &act : actions)
539 auto const &surface_id = this->id_alloc.lookup(act.role);
540 if(surface_id == nullopt)
542 goto proc_remove_request;
544 string appid = g_app_list.getAppID(*surface_id, &found);
547 if (TaskVisible::INVISIBLE == act.visible)
549 // App is killed, so do not set this action
554 HMI_SEQ_ERROR(req_num, "appid which is visible is not found");
559 auto client = g_app_list.lookUpClient(appid);
560 act.req_num = req_num;
564 ret = g_app_list.setAction(req_num, act);
565 if (ret != WMError::SUCCESS)
567 HMI_SEQ_ERROR(req_num, "Setting action is failed");
572 HMI_SEQ_DEBUG(req_num, "Start transition.");
573 ret = this->startTransition(req_num);
574 if (ret != WMError::SUCCESS)
576 if (ret == WMError::NO_LAYOUT_CHANGE)
578 goto proc_remove_request;
582 HMI_SEQ_ERROR(req_num, "Transition state is failed");
591 HMI_SEQ_ERROR(req_num, errorDescription(ret));
592 this->pmw.undoState();
595 g_app_list.removeRequest(req_num);
596 this->processNextRequest();
599 void WindowManager::processError(WMError error)
601 unsigned req_num = g_app_list.currentRequestNumber();
604 HMI_SEQ_ERROR(req_num, errorDescription(error));
605 g_app_list.removeRequest(req_num);
606 this->processNextRequest();
610 ******* Private Functions *******
613 void WindowManager::emit_activated(const string& role)
615 this->send_event(kListEventName[Event_Active], role);
618 void WindowManager::emit_deactivated(const string& role)
620 this->send_event(kListEventName[Event_Inactive], role);
623 void WindowManager::emit_syncdraw(const string& role, char const *area, int x, int y, int w, int h)
625 this->send_event(kListEventName[Event_SyncDraw], role, area, x, y, w, h);
628 void WindowManager::emit_syncdraw(const string &role, const string &area)
630 struct rect rect = this->lc->getAreaSize(area);
631 this->send_event(kListEventName[Event_SyncDraw],
632 role, area, rect.x, rect.y, rect.w, rect.h);
635 void WindowManager::emit_flushdraw(const string& role)
637 this->send_event(kListEventName[Event_FlushDraw], role);
640 void WindowManager::emit_visible(const string& role, bool is_visible)
642 this->send_event(is_visible ? kListEventName[Event_Visible] : kListEventName[Event_Invisible], role);
645 void WindowManager::emit_invisible(const string& role)
647 return emit_visible(role, false);
650 void WindowManager::emit_visible(const string& role) { return emit_visible(role, true); }
652 WMError WindowManager::setRequest(const string& appid, const string &role, const string &area,
653 Task task, unsigned* req_num)
655 if (!g_app_list.contains(appid))
657 return WMError::NOT_REGISTERED;
660 auto client = g_app_list.lookUpClient(appid);
665 unsigned current = g_app_list.currentRequestNumber();
666 unsigned requested_num = g_app_list.getRequestNumber(appid);
667 if (requested_num != 0)
669 HMI_SEQ_INFO(requested_num,
670 "%s %s %s request is already queued", appid.c_str(), role.c_str(), area.c_str());
674 WMRequest req = WMRequest(appid, role, area, task);
675 unsigned new_req = g_app_list.addRequest(req);
677 g_app_list.reqDump();
679 HMI_SEQ_DEBUG(current, "%s start sequence with %s, %s", appid.c_str(), role.c_str(), area.c_str());
681 return WMError::SUCCESS;
684 WMError WindowManager::checkPolicy(unsigned req_num)
689 // get current trigger
691 WMError ret = WMError::LAYOUT_CHANGE_FAIL;
692 auto trigger = g_app_list.getRequest(req_num, &found);
695 ret = WMError::NO_ENTRY;
698 string req_area = trigger.area;
700 // Input event data to PolicyManager
701 if (0 > this->pmw.setInputEventData(trigger.task, trigger.role, trigger.area))
703 HMI_SEQ_ERROR(req_num, "Failed to set input event data to PolicyManager");
707 // Execute state transition of PolicyManager
708 if (0 > this->pmw.executeStateTransition())
710 HMI_SEQ_ERROR(req_num, "Failed to execute state transition of PolicyManager");
714 ret = WMError::SUCCESS;
716 g_app_list.reqDump();
721 WMError WindowManager::startTransition(unsigned req_num)
723 bool sync_draw_happen = false;
725 WMError ret = WMError::SUCCESS;
726 auto actions = g_app_list.getActions(req_num, &found);
729 ret = WMError::NO_ENTRY;
730 HMI_SEQ_ERROR(req_num,
731 "Window Manager bug :%s : Action is not set", errorDescription(ret));
735 g_app_list.reqDump();
736 for (const auto &action : actions)
738 if (action.visible == TaskVisible::VISIBLE)
740 sync_draw_happen = true;
741 this->emit_syncdraw(action.role, action.area);
742 /* TODO: emit event for app not subscriber
743 if(g_app_list.contains(y.appid))
744 g_app_list.lookUpClient(y.appid)->emit_syncdraw(y.role, y.area); */
748 if (sync_draw_happen)
754 // deactivate only, no syncDraw
755 // Make it deactivate here
756 for (const auto &x : actions)
758 this->lc->visibilityChange(x);
759 emit_deactivated(x.role);
760 /* if (g_app_list.contains(x.client->appID()))
762 auto client = g_app_list.lookUpClient(x.client->appID());
763 this->deactivate(client->surfaceID(x.role));
766 this->lc->renderLayers();
767 ret = WMError::NO_LAYOUT_CHANGE;
772 WMError WindowManager::doEndDraw(unsigned req_num)
776 auto actions = g_app_list.getActions(req_num, &found);
777 WMError ret = WMError::SUCCESS;
780 ret = WMError::NO_ENTRY;
784 HMI_SEQ_INFO(req_num, "do endDraw");
786 // layout change and make it visible
787 for (const auto &act : actions)
789 if(act.visible != TaskVisible::NO_CHANGE)
792 ret = this->lc->layoutChange(act);
793 if(ret != WMError::SUCCESS)
795 HMI_SEQ_WARNING(req_num,
796 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
799 ret = this->lc->visibilityChange(act);
801 if(act.visible == VISIBLE)
803 emit_visible(act.role);
804 emit_activated(act.role);
808 emit_invisible(act.role);
809 emit_deactivated(act.role);
812 if (ret != WMError::SUCCESS)
814 HMI_SEQ_WARNING(req_num,
815 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
818 HMI_SEQ_DEBUG(req_num, "visible %s", act.role.c_str());
821 this->lc->renderLayers();
823 HMI_SEQ_INFO(req_num, "emit flushDraw");
825 for(const auto &act_flush : actions)
827 if(act_flush.visible == TaskVisible::VISIBLE)
829 this->emit_flushdraw(act_flush.role);
836 void WindowManager::emitScreenUpdated(unsigned req_num)
839 HMI_SEQ_DEBUG(req_num, "emit screen updated");
841 auto actions = g_app_list.getActions(req_num, &found);
844 HMI_SEQ_ERROR(req_num,
845 "Window Manager bug :%s : Action is not set",
846 errorDescription(WMError::NO_ENTRY));
850 // create json object
851 json_object *j = json_object_new_object();
852 json_object *jarray = json_object_new_array();
854 for(const auto& action: actions)
856 if(action.visible != TaskVisible::INVISIBLE)
858 json_object_array_add(jarray, json_object_new_string(action.client->appID().c_str()));
861 json_object_object_add(j, kKeyIds, jarray);
862 HMI_SEQ_INFO(req_num, "Visible app: %s", json_object_get_string(j));
864 int ret = afb_event_push(
865 this->map_afb_event[kListEventName[Event_ScreenUpdated]], j);
868 HMI_DEBUG("afb_event_push failed: %m");
872 void WindowManager::setTimer()
875 if (clock_gettime(CLOCK_BOOTTIME, &ts) != 0) {
876 HMI_ERROR("Could't set time (clock_gettime() returns with error");
880 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Timer set activate");
881 if (g_timer_ev_src == nullptr)
883 // firsttime set into sd_event
884 int ret = sd_event_add_time(afb_api_get_event_loop(afbBindingV3root), &g_timer_ev_src,
885 CLOCK_BOOTTIME, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL, 1, processTimerHandler, this);
888 HMI_ERROR("Could't set timer");
893 // update timer limitation after second time
894 sd_event_source_set_time(g_timer_ev_src, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL);
895 sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_ONESHOT);
899 void WindowManager::stopTimer()
901 unsigned req_num = g_app_list.currentRequestNumber();
902 HMI_SEQ_DEBUG(req_num, "Timer stop");
903 int rc = sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_OFF);
906 HMI_SEQ_ERROR(req_num, "Timer stop failed");
910 void WindowManager::processNextRequest()
913 g_app_list.reqDump();
914 unsigned req_num = g_app_list.currentRequestNumber();
915 if (g_app_list.haveRequest())
917 HMI_SEQ_DEBUG(req_num, "Process next request");
918 WMError rc = checkPolicy(req_num);
919 if (rc != WMError::SUCCESS)
921 HMI_SEQ_ERROR(req_num, errorDescription(rc));
926 HMI_SEQ_DEBUG(req_num, "Nothing Request. Waiting Request");