4307e74aa278e31e5f707f98889067131180b121
[AGL/documentation.git] / docs / 06_Component_Documentation / 02_agl_compositor.md
1 ---
2 title: agl-compositor
3 ---
4
5 # Wayland compositor
6
7 When the AGL project was started, weston was chosen as the compositor, which is
8 the reference implementation of a Wayland compositor, while for window management
9 functionality it relied on *ivi-shell* (In-Vehicle Infotainment) together
10 with an extension, called [wayland-ivi-exension](https://github.com/GENIVI/wayland-ivi-extension).
11
12 A demo platform image of AGL comes with a handful of demo applications, done
13 with the Qt, which abstracts the protocol communication between the client and
14 the compositor. Additional functionality was in place under the form of
15 library, to control and signal back to the compositor when applications were
16 started, among other things.
17
18 Management of applications, starting, running and stopping them is done in AGL
19 with AppFW [Application Framework Management](Application_Framework/01_Introduction.md),
20 which is an umbrella name to denote the suite of tools and daemons that handle
21 all of that. It is integrated with systemd and with the current security model.
22 Applications can use AppFW to hang off data, and to pass it down to
23 other services. Together with AppFW, applications could tell the compositor
24 which application to activate or to switch to.
25
26
27 ## Simplifying the graphical stack
28
29 Trimming down these abstractions, simplifying the way clients interact with the
30 compositor, and avoid using modules that aren't really maintained upstream were
31 the reasons behind looking at alternatives to ivi-shell. On the desktop,
32 [xdg-shell](https://gitlab.freedesktop.org/wayland/wayland-protocols/-/raw/master/stable/xdg-shell/xdg-shell.xml)
33 is currently de-facto protocol for handling all window management related
34 functionality.
35
36 Wayland protocol has a window-like interface embedded into its protocol (called
37 wl_shell), but *xdg-shell* has long time ago deprecated it and instead
38 of adding it in the wayland protocol namespace, it was integrated
39 together with some other useful protocols, into
40 [wayland-protocols](https://gitlab.freedesktop.org/wayland/wayland-protocols)
41 project.  The whole purpose of wayland-protocols is to enhance the Wayland
42 protocol with new functionality and bring new extensions entirely.  Compositors
43 are free to implement, modify, enhance, and add new extensions to
44 wayland-protocols but they need to do so in consensus.
45
46 Besides the core wayland protocol and extended functionality from
47 wayland-protocols, a compositor can provide and implement additional protocol
48 extensions (custom to that compositor). By using such private extensions we
49 align with the AGL project and its requirements, without compromising specific
50 functionality and allows to add or improve the current ones. With that in mind,
51 the approach was to create a new compositor, called
52 [agl-compositor](https://gerrit.automotivelinux.org/gerrit/admin/repos/src/agl-compositor)
53 and implement dedicated private extensions, rather than trying to modify weston
54 itself, which AGL project would have been required to keep and maintain for
55 itself, as a fork.
56
57 ## A compositor based on libweston
58
59 The compositor used currently in AGL, just like weston, is built on top of
60 *libweston* and *libweston-desktop*. The latter, among other things, is required
61 as it provides the server side implementation of the xdg-shell protocol which
62 underlying toolkits (like Qt/Chromium project) makes use of to deliver
63 desktop-like functionality. The former is used to provide back-ends and
64 rendering support, effectively managing the HW, besides implementing the
65 wayland protocol.
66
67 The high-level goal of [libweston](https://wayland.pages.freedesktop.org/weston/toc/libweston.html) is
68 to decouple the compositor from the shell implementation.
69
70 Traditionally, clients were entirely separated from the window manager, the
71 desktop environment and the display server. In wayland all these are
72 conceptually under the same entity though they are implemented as different
73 (UNIX) processes, or as a different namespaces with front and back-end APIs,
74 exposed by libraries. The compositor and the shell driving the UI should be
75 seen as one and the same, and in practice, this happens on desktop
76 environments. For AGL, the shell client can be represented under different
77 forms, as well as the fact that the process management has another layer
78 baked-in to handle MAC (Mandatory Access Control) labels and use the
79 above-mentioned Application Framework. These are all tightly
80 integrated and therefore, the AGL compositor will not automatically start the
81 shell client, although there's code to handle that.
82
83 ## Specifying a shell client to be started by the compositor
84
85 Nevertheless, one can modify the configuration file, add the shell client path, and the
86 compositor will attempt to start it.
87
88 ```
89 [shell-client]
90 command=/path/to/your/client/shell
91 ```
92
93
94
95 ## Private extensions
96
97 Compositors can define and implement custom extensions to further control
98 application behaviour. For AGL, we have two private extensions defined.
99 One targeted at defining surface roles commonly found in desktop environments
100 (like panels, and backgrounds), which a shell client would bind to, and one
101 targeted at regular application(s) that might require additional functionality:
102 being able to display/activate its own surface or other's application surface,
103 implement some kind of split screen management of windows, or
104 dialog/pop-ups that exhibit always-on-top property even if the active
105 surface has been changed.
106
107 ![Layers_And_Extensions](images/agl-compositor/drawing_shell.png)
108
109 Clients can make use of these private extensions to define other kind of roles
110 for instance dialog/pop-ups or full-screen roles, and split windows vertically or
111 horizontally. It includes the ability to activate other applications, assuming
112 that the surfaces have been created, and the capability of delaying
113 presentation for the client shell. Doing so, all the information is displayed
114 at once, rather than waiting for the toolkit to map/show the surface.
115
116 An application identification mechanism was required to be able to activate
117 other clients windows/surfaces. A string-based identifier name was chosen
118 which can be used by the client to set an application-based identifier using
119 the xdg-shell protocol. While there's nothing stopping the client to avoid
120 doing that, specifically, to avoid assigning an application identifier,
121 the compositor won't be able to find which surfaces matches to a particular
122 client, if one would want to activate/display it at some time in the future.
123
124 ### agl-shell
125
126 Client shellls can make use of this protocol to define panels and background
127 roles for different surfaces. It includes to ability to activate other
128 applications, assuming that those are already running. Activation happens by
129 using using the app_id, respectively using set_app_id request as defined by the
130 xdg-shell protocol. Established client-side implementation of the xdg-shelll
131 protocol will have a function exposed which can be used to set an application
132 identifier.  Further more, the compositor will not present/display anything to
133 the user as long the `ready()` is not requested. So, after creating the surfaces
134 assigning them panel and/or background roles, and they're fully loaded,
135 the client can then issue `ready()` request and the compositor will start
136 presenting.
137
138 Please consult the [protocol file](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-compositor.git;a=blob_plain;f=protocol/agl-shell.xml;hb=refs/heads/master)
139 as that is the authoritative way of getting the latest version.
140
141 #### V2 updates
142
143 Version 2 of the agl-shell protocol, while it is is not obligatory to be
144 supported by the shell client, it adds two new events: bound_ok and bound_fail
145 events.
146
147 It has been observed that in some cases where we do not explicitly have a knob
148 in the toolkit to tell whether the application is a regular one (which doesn't
149 need to bind to the agl-shell protocol) or a one that needs to implement
150 agl-shell protocol might result in terminating the wayland connection.
151
152 That happens because we can't have multiple clients bind to the agl-shell
153 protocol interface and was particularly visible when using regular
154 flutter applications with other shell clients (Qt homescreen, or WAM/chromum),
155 basically mashing together different kind of toolkits in the same image. Once
156 a client has already bound to the agl-shell protocol interface any other client
157 that attempts to do same will get its wayland connection severed and the
158 application will be terminated.
159
160 These two events provide a race-free method in which the clients can tell if
161 they're in charge (of being the shell client) or their just regular
162 applications. Explicitly implementing this protocol if you have other means to
163 specify which type of application it is running wouldn't be required nor
164 necessary. But by using the protocol we can provide the same thing,
165 programmatically, without fearing that the wayland connection might be
166 severed, and implicitly taking down the application.
167
168 #### V3 updates
169
170 Version 3 of the agl-shell protocol adds 4 more events to signal out when the
171 application state was changed: started, activated, deactivated and terminated.
172
173 Version 3 update was mostly prompted by an issue with start-up of applications
174 but also is part of the first steps to reduce and simplify a bit more
175 activation handling in the compositor.  Specifically with this protocol update,
176 we can correctly orchestrate start-up and activation of applications.
177
178 At the moment of adding this protocol update, the default compositor behaviour
179 is to display/activate applications as soon they're started, a feature which
180 we've called activate-by-default (and which is turned on by default).
181 But users can choose to disable that in such a way that activation is entirely
182 driven the shell client.
183
184 Implicitly having this activate-by-default papered over various
185 issue when don't have that activation by default turned on. Supporting both
186 use-cases (activate-by-default, on and off) turned out to be cluster of
187 problems and regression over time. Not only that the amount of complexity in
188 the compositor is unwarranted and can simplified by telling the shell client
189 handle any window management interaction on its own.
190
191 Further more, with this protocol update we also includes some events already
192 present in the agl-shell-desktop protocol like  deactivate and terminate.
193
194 ### agl-shell-desktop (deprecated, will be removed in future, see gRPC proxy)
195
196 This extension is targeted at keeping some of the functionally already
197 established in AGL as to a) allow applications display/activate other
198 surfaces/application window, and b) set further roles, specially dialog/window
199 pop-ups and split-type of surfaces.
200
201 Clients can make use of this protocol to set further roles, like independently
202 positioned pop-up dialog windows, split type of surfaces or fullscreen ones.
203 Additional roles, and implicitly functionality can be added by extending the
204 protocol. These roles serve as hints for the compositor and should be used
205 before the actual surface creation takes place, such that the compositor can
206 take the necessary steps to satisfy those requirements.
207
208 Please consult the [protocol file](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-compositor.git;a=blob_plain;f=protocol/agl-shell-desktop.xml;hb=refs/heads/master)
209 as that is the authoritative way of getting the latest version.
210
211 #### Additional surface roles in agl-shell-desktop
212
213 Like mentioned earlier, the compositor is already making use of some (internal)
214 roles, and with this extension we add some further ones. These are:
215
216 * split (there's vertical and a horizontal one)
217 * fullscreen
218 * dialog/pop-up
219
220 Internally these are encoded with different values such that there's a
221 translation needed, between the protocol values and the internal ones.  Besides
222 the roles, additional data can to be passed on, but only depending on the role.
223 It is highly recommend **to avoid** using the protocol to pass down information
224 between different applications using this communication channel. It is only
225 intended to help out with demo applications. Other sharing mechanism are
226 available in the AGL project that can satisfy those requirements.
227
228 #### Receiving application state events from (other) applications
229
230 agl-shell-desktop exposes two events which client can install handlers for, one
231 that signals when regular xdg application have been created, and one that
232 signals state changes (active/hidden) as well as destroyed/no longer present
233 surfaces. These events can be useful to add additional functionality if
234 needed.
235
236 #### Activating (other) applications
237
238 Both agl-shell and agl-shell-desktop have requests to activate other
239 application based on their xdg-shell app_id. In case the application is
240 present/running, it will attempt to make the surface backing that application
241 the current activate one, with each output having independently active
242 surfaces.
243
244 ## gRPC proxy for window management
245
246 The gRPC proxy is an alternative to allow management of windows,
247 without the need for clients to "speak" native Wayland C code.  Most major
248 languages have RPC bindings, and in AGL clients do not touch Wayland code
249 natively, using most of the time toolkits. It seemed reasonably to use gRPC
250 as a way to interact with the compositor. The way this works is that
251 there's proxy daemon started by the compositor which translates the gRPC
252 calls to Wayland ones, using agl-shell protocol. Events coming from the
253 compositor are handled by subscribing to RPC stream events, such that
254 clients can act upon as well, so it is not just one way interaction.
255
256 With respect to window management: placement, movement, and surface role
257 changes all should, and can be done with RPC. Some of the calls, specifically
258 background set-up or activation area, are still required to happen prior or
259 require wayland primitives which can't be passed between processes, so those
260 can't be used with RPC proxy.
261
262 In terms of API, the following are available: activation/deactivation,
263 role management, and events. All the message arguments are self-explanatory,
264 requiring always an app_id, in form of string and possibly an output, in
265 form a string as well. Toolkits can set/retrieve this information so refer
266 to the respective toolkit. At the wayland level, the app_id is set/get
267 with [xdg-shell](https://wayland.app/protocols/xdg-shell#xdg_toplevel:request:set_app_id)
268 whereas output from [wl_output interface](https://wayland.app/protocols/wayland#wl_output:event:name)
269
270 Activation and deactivation of applications:
271
272 ```
273 rpc ActivateApp(ActivateRequest)         returns (ActivateResponse) {}
274 rpc DeactivateApp(DeactivateRequest)     returns (DeactivateResponse) {}
275 ```
276 With the following message arguments:
277
278 ```
279 message ActivateRequest {
280        string app_id = 1;
281        string output_name = 2;
282 }
283
284 message ActivateResponse {
285 };
286
287
288 message DeactivateRequest {
289        string app_id = 1;
290 };
291
292 message DeactivateResponse {
293 };
294 ```
295
296 Management of surface roles can be done with these requests:
297
298
299 ```
300 rpc SetAppSplit(SplitRequest)            returns  (SplitResponse) {}
301 rpc SetAppFloat(FloatRequest)            returns  (FloatResponse) {}
302 rpc SetAppFullscreen(FullscreenRequest)  returns  (FullscreenResponse) {}
303 rpc AppStatusState(AppStateRequest)      returns  (stream AppStateResponse) {}
304 rpc GetOutputs(OutputRequest)            returns  (ListOutputResponse) {}
305 rpc SetAppNormal(NormalRequest)          returns  (NormalResponse) {}
306 rpc SetAppOnOutput(AppOnOutputRequest)   returns  (AppOnOutputResponse) {}
307 rpc SetAppPosition(AppPositionRequest)   returns  (AppPositionResponse) {}
308 rpc SetAppScale(AppScaleRequest)         returns  (AppScaleResponse) {}
309 ```
310
311 Message arguments are:
312
313 ```
314 message SplitRequest {
315        string app_id = 1;
316        int32 tile_orientation = 2;
317        int32 width = 3;
318        int32 sticky = 4;
319        string output_name = 5;
320 }
321
322 message SplitResponse {
323 };
324
325 message FloatRequest {
326        string app_id = 1;
327        int32 x_pos = 2;
328        int32 y_pos = 3;
329 };
330
331 message FloatResponse {
332 };
333
334 message NormalRequest {
335         string app_id = 1;
336 };
337
338 message NormalResponse {
339 };
340
341 message FullscreenRequest {
342         string app_id = 1;
343 };
344
345 message FullscreenResponse {
346 };
347
348 message AppOnOutputRequest {
349         string app_id = 1;
350         string output = 2;
351 };
352
353 message AppOnOutputResponse {
354 };
355
356 message AppPositionRequest {
357        string app_id = 1;
358        int32 x = 2;
359        int32 y = 3;
360 };
361
362 message AppPositionResponse {
363 };
364
365 message AppScaleRequest {
366        string app_id = 1;
367        int32 width = 2;
368        int32 height = 3;
369 };
370
371 message AppScaleResponse {
372 };
373 ```
374
375 Events which clients can subscribe to:
376
377 ```
378 rpc AppStatusState(AppStateRequest) returns (stream AppStateResponse) {}
379 ```
380
381 With the message arguments:
382
383 ```
384 message AppStateRequest {
385 };
386
387 message AppStateResponse {
388         int32 state = 1;
389         string app_id = 2;
390 };
391 ```
392
393 A C++ client implementation the gRPC API can be found in [agl-shell-activator](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-shell-activator.git;a=tree;h=refs/heads/master;hb=refs/heads/master)
394 or in [window-management-client-grpc](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/window-management-client-grpc.git;a=tree;h=refs/heads/master;hb=refs/heads/master).
395
396 ## Explicit output
397
398 The activation and setting surface roles requires passing a Wayland output
399 (wl_output).  The output is the wayland interface representation of an output
400 and is **mandatory** to pass it down to the compositor when activating a surface.
401 Clients can retrieve it (the output) if they wish to place the surface on other
402 outputs by using the toolkits that expose the Wayland objects.  A human-like
403 representation is provided by either the toolkit, or by using other extensions
404 implemented by the client, for instance [xdg-output](https://gitlab.freedesktop.org/wayland/wayland-protocols/-/raw/master/unstable/xdg-output/xdg-output-unstable-v1.xml)
405 is the one recommended way and provides a mapping between a human
406 representation of the output and the wayland one.
407
408 One can also choose the output where the application can start, by configuring
409 directly the AGL compositor. Under the `[output]` section one can use
410 `agl-shell-app-id=appid` restart the AGL compositor unitd systemd service and
411 start the application. Currently this *only* applies to regular applications, the
412 client shell having to handle it in the code.
413
414 ## Available toolkits, application conversions and available eco-systems
415
416 Users and OEM vendors alike have the possibility, depending on their use-cases,
417 to either use some kind of a toolkit (Qt/GTK) for writing  application,
418 or use plain C and the wayland library to communicate with the compositor
419 directly, without any toolkit abstraction.
420
421 Currently, the demo applications in AGL use the Qt platform with Chromium being
422 at this phase, a second-class citizen, being currently in the works of
423 achieving the same level of integration as QtWayland (the underlying library that
424 abstracts the Wayland interaction) has at this moment. The Qt platform has
425 long been favoured in embedded systems so it feels natural why AGL project
426 chose it over other alternatives.  In the same time, as web applications are
427 for quite some time now permeating the application development scene, it also
428 felt natural to add support for a runtime that gives that option, which in AGL
429 was achieved with the help of the Chromium project.
430
431 For normal applications, not needing the ability to activate or displaying
432 other's application surface, would basically mean that it would use what the
433 toolkit has to offer, simplifying the application handling even more.  Under
434 Qt, the client shell can use QPA (Qt Platform Abstraction) to gain access to
435 Wayland primitives, and implicitly is being able use the private extensions.
436
437 ![Architecture Diagram](images/agl-compositor/arch_diagram.png)
438
439 On the Chromium side of things, that happens indirectly, as Chromium doesn't
440 expose the Wayland primitives. Not only that, but on the Chromium platform,
441 there's another mid-layer component, called [WAM](https://github.com/webosose/wam)
442 (WebApplicationManager) with the purpose of handling web applications life-cycle.
443
444 So, controlling and passing information from a web application, that resembles
445 that of a shell client, has to travel more than a few levels in the software
446 stack, until it reaches the lower layers in Chromium where the Wayland
447 communication and interaction takes place. Support for the private extension
448 was done at the Ozone interface abstraction, which Chromium projects uses now
449 to handle the display/graphical interaction with the lower stack levels.
450
451 ## Streaming buffers and receiving events to and from remote outputs
452
453 Quite a common feature, in the infotainment market, is the ability to stream
454 out buffers/data to remote outputs. For instance, super-imposing the navigation
455 application, between the speedometer and tachometer, in the IC (Instrument
456 Cluster) of a car is such a scenario. Just like weston, the AGL compositor is
457 capable of loading up libweston modules and make use of them. And just like
458 weston, the AGL compositor loads up the remoting-plugin to achieve the same
459 thing.
460
461 The remoting-plugin uses the DRM virtual output API from libweston together
462 with gstreamer pipeline to capture, using DMA buffers, the DRM output and to
463 stream it, remotely to another machine. They can be over the network, or
464 locally.
465
466 Further more, to cope with situations where the output is just a
467 panel/display, without some kind of compositor driving it, the necessity of
468 handling input events is an important feature to have, giving the user to
469 possibility to manipulate the application/environment as he or she seems fit.
470
471 The compositor loads a plug-in that streams out the buffers to an output
472 remotely, with another plug-in was used to handle the input events. The events,
473 which are sent back from the display to the compositor, are generated with
474 the help of wayland-eque protocol that works over the network, called
475 [Waltham](https://github.com/waltham/waltham). This solution was deprecated
476 and removed a while back, with an alternative in the works to achieve
477 the same functionality.
478
479 Together, they provide proper means to achieve a seamless integration with
480 other display devices in the car cabin.
481
482 ## Policies and Role Base Arbitration
483
484 The compositor contains an API useful for implementing user-defined policies.
485 It contains a policy engine, and installs by default an allow-all kind of
486 policy. The policy engine controls if the client using the private extensions
487 is permitted to perform those calls. Not only that, but with some policies, it
488 won't allow the client to bind to the interfaces in the first place. That
489 happens with the deny-all policy, which is able to retrieve the client's
490 SMACK label and compares it with the ones statically defined.
491
492 In the works, there's a new policy model, called [Role Based
493 Arbitration](https://gerrit.automotivelinux.org/gerrit/admin/repos/staging/rba).
494 Internally, how it works, should be found at [RBA](04_Rule_Based_Arbitrator.md).
495 While the other two policies are embedded into the compositor, the RBA policy
496 model is an off the-shell policy.  Obviously, vendors and users can hook up
497 their own policies, just like RBA did.  These all work towards satisfying
498 the driver distraction mitigation requirement for the AGL project, as to avoid
499 overwhelming the driver with too much information.
500
501 Users wanting  to create their own policy should create a specialized version
502 of the callbacks defined in `struct ivi_policy_api`.
503
504 As there's no dynamic loading of policies you'll need to recompile the compositor
505 with that policy in mind, specifically like the following:
506
507         $ meson -Dprefix=/path/to/install-compositor/ -Dpolicy-default=my_policy build_directory
508
509 The default policy found in src/policy-default.c should more than sufficient to
510 get started on creating new ones. Users can either re-purpose the default
511 policy or create a new one entirely different, based on their needs.
512
513 These are hooks in place by the policy engine control the creation, committing
514 and activation of surfaces (`ivi_policy_api::surface_create()`,
515 `ivi_policy_api::surface_commited()`, `ivi_policy_api::surface_activate()`),
516 among other situations.
517
518 Users can customize the hooks by using some sort of database to retrieve the
519 application name to compare against, or incorporate some kind of policy rule
520 engine.  Alternatively, one can use the deny-all policy engine which allows the
521 top panel applications to be used/displayed as permitted applications.
522
523 ### Reactive rules
524
525 The policy engine is stateful,  and allows the ability to inject back events,
526 such that it allows the user to add custom rules into a policy and, depending
527 on the event received by the policy engine, to execute a rule match for that
528 event. Further more, the framework allows adding new states and events and the
529 default implementation has code for handling events like showing or hiding the
530 application specified in the policy rule.  The most common example to exemplify
531 this feature is the ability to show a custom application, like displaying the
532 rear view camera application, when the automobile has been put in reverse.
533
534 For deadling with these kind of rules, `ivi_policy_api::policy_rule_allow_to_add()`
535 can be used to control if policy rules could be added or not. Finally, we have
536 `ivi_policy_api::policy_rule_try_event()` which is executed for each policy
537 rule added, by using the policy API `ivi_policy_add()` function.
538
539 By default the policy framework it will add the 'show', and 'hide' events and
540 the 'start', 'stop' and 'reverse' states. An special type, assigned by default
541 is 'invalid'.  A **state change** has to be propagated to the compositor, which can
542 happen by using `ivi_policy_state_change()` function, and which signals the
543 compositor the state change took place, in order to apply the policy rules, and
544 implicitly to call the event handler `ivi_policy_api::policy_rule_try_event()`.
545
546 ## Back-ends and specific options for agl-compositor
547
548 The compositor has support for the following back-ends:
549
550 * **DRM/KMS** - runs a stand-alone back-end, uses Direct Rendering Manager/Kernel
551   Modesetting and evdev, that is utilizes and runs on real or virtualized HW
552   (qemu/Vbox/etc).
553 * **Wayland** - runs as a Wayland application, nested in another Wayland compositor
554   instance
555 * **X11** - run as a x11 application, nested in a X11 display server instance
556
557 ### Building and running the compositor on different platforms
558
559 The compositor can run on desktop machines as easily as it does on AGL
560 platform. It should infer, depending on the environment, if it is being
561 compiled with the AGL SDK, or with the host build system.  Running would also
562 be inferred from the environment.
563
564 The compositor has some additional configuration options like:
565
566 * `--debug` - enables the screenshooter interface, useful if one would want to
567   take a screenshot using `agl-screenshooter` client. This might be seen as a
568   security risk to it only be enabled in the AGL platform if built with agl-devel
569   DISTRO FEATURES.
570
571 Additional configuration ini options have been added to help with the CI
572 integration. Worth mentioning are:
573
574 * `activate-by-default=[true]` - if the surface of the client should be
575   displayed when the application started. Present in the `[core]` section.
576   By default set to `true`. Setting it to `false` will not activate,
577   by default, the client's surface when started.
578 * `hide-cursor=[false]` - do not advertise pointer/cursor to clients. Present
579   in the `[core]` section.
580
581 ## Running with software rendering
582
583 By default the compositor will attempt to use the GL-renderer, and implicitly
584 the GPU. One could instead use the CPU, by making use of the Pixman library. To
585 use it in the compositor append `--use-pixman` to the command line. This purely
586 software approach has the benefit that would not rely at all on any GL
587 implementatation or library. In constrast, even if the GL-renderer is used,
588 in some situations it won't be able to use the GPU supported implementation
589 and fallback to sofware based one, and for instance that might happen when
590 running in virtualized environments.
591
592 Both approaches could end up not actually using the GPU, but the latter does
593 actually use the GL library and perform the operations in software, while the
594 former does not use any GL whatsover. All back-ends support disabling the
595 GL-render to make sure it does not interfere with the composing process.
596
597 ## Multiple output set-up and touch input devices
598
599 There's no deterministic way in which the compositor enables the outputs and
600 depending on the input devices, specifically touch input devices, and the way
601 the connectors are wired, a touch input device might be associated with a
602 different output than the one intended.
603
604 A consistent way, that survives a reboot, is to use
605 [udev rules](https://man7.org/linux/man-pages/man7/udev.7.html), which
606 libweston would be able to use such that a particular output is tied/associated
607 to a particular touch input device.
608
609 For instance, assuming that you have a set-up consisting of 4 outputs, a 4
610 touch input devices, when the outputs are being enabled the compositor
611 front-end will associate all 4 touch input device -- if they haven't been
612 previously being associated to a particular output, to the first enabled
613 output.
614
615 In order to avoid that, and associate each touch input device to
616 their respective output an udev rule can be installed, for the default
617 seat (named `seat0`).
618
619 Example of a udev rule:
620
621 ```
622 SUBSYSTEM=="input", ATTRS{idVendor}=="222a", ATTRS{idProduct}=="004a", OWNER="display", ENV{ID_SEAT}="seat0", ENV{WL_OUTPUT}="HDMI-A-1"
623 SUBSYSTEM=="input", ATTRS{idVendor}=="222a", ATTRS{idProduct}=="004b", OWNER="display", ENV{ID_SEAT}="seat0", ENV{WL_OUTPUT}="HDMI-A-2"
624 SUBSYSTEM=="input", ATTRS{idVendor}=="222a", ATTRS{idProduct}=="004c", OWNER="display", ENV{ID_SEAT}="seat0", ENV{WL_OUTPUT}="HDMI-A-3"
625 SUBSYSTEM=="input", ATTRS{idVendor}=="222a", ATTRS{idProduct}=="004d", OWNER="display", ENV{ID_SEAT}="seat0", ENV{WL_OUTPUT}="HDMI-A-4"
626 ```
627
628 Add the following under `/etc/udev/rules.d/91-output.rules` and reload udev
629 rules for these changes to take effect:
630
631         $ udevadm control --reload-rules && udevadm trigger
632
633 Note that in the above example, we use physical seat, named `seat0` which is
634 the default physical seat. You can verify that these changes have been applied by
635 checking the compositor logs (under `/run/platform/display/compositor.log` file)
636 You should be seeing `CONNECTOR-NO by udev` message like the following:
637
638 ```
639 associating input device event0 with output HDMI-A-1 (HDMI-A-1 by udev)
640 ```
641
642 vs
643
644 ```
645 associating input device event0 with output HDMI-A-2 (none by udev)
646 ```
647
648 where the rules are either incorrect or badly written.
649
650 Retrieving device attributes could be done archaically using `lsusb` or `lspci`
651 or using `udevadm info -a /dev/input/event*` which can provide with a multitude
652 of attributes to use. In our above example we only relied `idVendor` and
653 `idProduct` but potentially other attributes might be used.