monitor: add trace option to debug server-client protocol
[platform/core/uifw/libtdm.git] / src / tdm_monitor_server.c
1 /**************************************************************************
2  *
3  * libtdm
4  *
5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
6  *
7  * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
8  *          JinYoung Jeon <jy0.jeon@samsung.com>,
9  *          Taeheon Kim <th908.kim@samsung.com>,
10  *          YoungJun Cho <yj44.cho@samsung.com>,
11  *          SooChan Lim <sc1.lim@samsung.com>,
12  *          Boram Park <sc1.lim@samsung.com>
13  *
14  * Permission is hereby granted, free of charge, to any person obtaining a
15  * copy of this software and associated documentation files (the
16  * "Software"), to deal in the Software without restriction, including
17  * without limitation the rights to use, copy, modify, merge, publish,
18  * distribute, sub license, and/or sell copies of the Software, and to
19  * permit persons to whom the Software is furnished to do so, subject to
20  * the following conditions:
21  *
22  * The above copyright notice and this permission notice (including the
23  * next paragraph) shall be included in all copies or substantial portions
24  * of the Software.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
27  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
29  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
30  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
31  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
32  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33  *
34 **************************************************************************/
35
36 #include <stdio.h>
37 #include <string.h>
38 #include <stdlib.h>
39 #include <stdint.h>
40
41 #include "tdm.h"
42 #include "tdm_private.h"
43 #include "tdm_helper.h"
44 #include "tdm_log.h"
45
46 #define TDM_DBG_SERVER_ARGS_MAX         32
47
48 static void _tdm_monitor_server_usage(char *app_name, char *reply, int *len);
49
50 static void
51 _tdm_monitor_server_query(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
52 {
53         tdm_helper_get_display_information(dpy, reply, len);
54 }
55
56 static void
57 _tdm_monitor_server_protocol_trace(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
58 {
59         int enable;
60
61         if (argc < 3) {
62                 _tdm_monitor_server_usage(argv[0], reply, len);
63                 return;
64         }
65
66         enable = atoi(argv[2]);
67
68         tdm_event_loop_trace_enable(dpy, enable);
69
70         TDM_SNPRINTF(reply, len, "protocol trace: '%s'\n", (enable) ? "enabled" : "disabled");
71 }
72
73 static void
74 _tdm_monitor_server_dpms(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
75 {
76         tdm_output *output;
77         int output_idx, dpms_value;
78         char *arg;
79         char *end;
80         tdm_error ret;
81
82         if (argc < 3) {
83                 _tdm_monitor_server_usage(argv[0], reply, len);
84                 return;
85         }
86
87         arg = argv[2];
88         output_idx = strtol(arg, &end, 10);
89         if (*end != ':') {
90                 TDM_SNPRINTF(reply, len, "failed: no onoff value\n");
91                 return;
92         }
93
94         arg = end + 1;
95         dpms_value = strtol(arg, &end, 10);
96
97         output = tdm_display_get_output(dpy, output_idx, &ret);
98         TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE && output != NULL);
99
100         ret = tdm_output_set_dpms(output, dpms_value);
101         TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE);
102
103         TDM_SNPRINTF(reply, len, "done: DPMS %s\n", tdm_dpms_str(dpms_value));
104 }
105
106 static void
107 _tdm_monitor_server_ttrace_vblank(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
108 {
109         int enable, output_id = 0;
110         tdm_output *output;
111         char *arg;
112         char *end;
113         tdm_error ret;
114         tdm_output_type type;
115
116         if (argc < 3) {
117                 _tdm_monitor_server_usage(argv[0], reply, len);
118                 return;
119         }
120
121         arg = argv[2];
122         enable = strtol(arg, &end, 10);
123
124         if (*end == '@') {
125                 arg = end + 1;
126                 output_id = strtol(arg, &end, 10);
127         }
128
129         output = tdm_display_get_output(dpy, output_id, NULL);
130         if (!output) {
131                 TDM_SNPRINTF(reply, len, "can't find the output_id(%d)\n", output_id);
132                 return;
133         }
134
135         ret = tdm_output_get_output_type(output, &type);
136         if (ret != TDM_ERROR_NONE) {
137                 TDM_SNPRINTF(reply, len, "can't find the type of output_id(%d)\n", output_id);
138                 return;
139         }
140
141         tdm_display_enable_ttrace_vblank(dpy, output, enable);
142
143         TDM_SNPRINTF(reply, len, "%s ttrace vblank for '%s'\n",
144                                  (enable) ? "enable" : "disable", tdm_conn_str(type));
145 }
146
147 static void
148 _tdm_monitor_server_debug(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
149 {
150         int level;
151         char *arg;
152         char *end;
153
154         if (argc < 3) {
155                 _tdm_monitor_server_usage(argv[0], reply, len);
156                 return;
157         }
158
159         arg = argv[2];
160         level = strtol(arg, &end, 10);
161
162         tdm_log_set_debug_level(level);
163         TDM_SNPRINTF(reply, len, "debug level: %d\n", level);
164
165         if (*end == '@') {
166                 char *arg = end + 1;
167
168                 tdm_display_enable_debug_module((const char *)arg);
169
170                 TDM_SNPRINTF(reply, len, "debugging... '%s'\n", arg);
171         }
172 }
173
174 static void
175 _tdm_monitor_server_log_path(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
176 {
177         static int old_stdout = -1;
178         char fd_name[TDM_PATH_LEN];
179         char *path;
180
181         if (argc < 3) {
182                 _tdm_monitor_server_usage(argv[0], reply, len);
183                 return;
184         }
185
186         if (old_stdout == -1)
187                 old_stdout = dup(STDOUT_FILENO);
188
189         path = argv[2];
190         TDM_DBG_RETURN_IF_FAIL(path != NULL);
191
192         tdm_log_enable_dlog(0);
193
194         if (!strncmp(path, "dlog", 4)) {
195                 tdm_log_enable_dlog(1);
196                 goto done;
197         } else if (!strncmp(path, "console", 7))
198                 snprintf(fd_name, TDM_PATH_LEN, "/proc/%d/fd/1", pid);
199         else {
200                 if (path[0] == '/')
201                         snprintf(fd_name, TDM_PATH_LEN, "%s", path);
202                 else {
203                         if (cwd)
204                                 snprintf(fd_name, TDM_PATH_LEN, "%s/%s", cwd, path);
205                         else
206                                 snprintf(fd_name, TDM_PATH_LEN, "%s", path);
207                 }
208                 tdm_log_enable_color(0);
209         }
210
211         if (tdm_display_enable_path((const char*)fd_name) != TDM_ERROR_NONE) {
212                 TDM_SNPRINTF(reply, len, "failed: '%s'\n", path);
213                 return;
214         }
215
216 done:
217         TDM_SNPRINTF(reply, len, "log path: '%s'\n", path);
218 }
219
220 static void
221 _tdm_monitor_server_commit_per_vblank(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
222 {
223         int enable;
224         char *arg;
225         char *end;
226
227         if (argc < 3) {
228                 _tdm_monitor_server_usage(argv[0], reply, len);
229                 return;
230         }
231
232         arg = argv[2];
233         enable = strtol(arg, &end, 10);
234
235         tdm_display_enable_commit_per_vblank(dpy, enable);
236
237         TDM_SNPRINTF(reply, len, "%s the commit-per-vblank\n", (enable) ? "enable" : "disable");
238 }
239
240 static void
241 _tdm_monitor_server_fps(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
242 {
243         int enable;
244         char *arg;
245         char *end;
246
247         if (argc < 3) {
248                 _tdm_monitor_server_usage(argv[0], reply, len);
249                 return;
250         }
251
252         arg = argv[2];
253         enable = strtol(arg, &end, 10);
254
255         tdm_display_enable_fps(dpy, enable);
256
257         TDM_SNPRINTF(reply, len, "%s to print fps\n", (enable) ? "enable" : "disable");
258 }
259
260 static void
261 _tdm_monitor_server_vblank_list(unsigned int pid, char *cwd, int argc, char *argv[],
262                                                                 char *reply, int *len, tdm_display *dpy)
263 {
264         tdm_vblank_get_vblank_list_information(dpy, reply, len);
265 }
266
267 static void
268 _tdm_monitor_server_vblank_fps(unsigned int pid, char *cwd, int argc, char *argv[],
269                                                            char *reply, int *len, tdm_display *dpy)
270 {
271         unsigned int target_pid, fps;
272         char *arg;
273         char *end;
274         char name[TDM_NAME_LEN];
275         tdm_error ret;
276
277         if (argc < 3) {
278                 _tdm_monitor_server_usage(argv[0], reply, len);
279                 return;
280         }
281
282         arg = argv[2];
283         target_pid = strtol(arg, &end, 10);
284
285         if (*end == ',') {
286                 arg = end + 1;
287                 end = strtostr(name, TDM_NAME_LEN, arg, TDM_DELIM);
288         } else {
289                 strncpy(name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN - 1);
290                 name[TDM_NAME_LEN - 1] = '\0';
291         }
292
293         if (*end != '@') {
294                 TDM_SNPRINTF(reply, len, "failed: no fps value\n");
295                 return;
296         }
297
298         arg = end + 1;
299         fps = strtol(arg, &end, 10);
300
301         ret = tdm_vblank_set_client_vblank_fps(target_pid, name, fps);
302         if (ret != TDM_ERROR_NONE) {
303                 TDM_SNPRINTF(reply, len, "can't set '%u' fps to '%s' client vblank(PID:%u)\n", fps, name, target_pid);
304                 return;
305         }
306
307         TDM_SNPRINTF(reply, len, "success: '%u' fps for '%s' client vblank(PID:%u)\n", fps, name, target_pid);
308 }
309
310 static void
311 _tdm_monitor_server_prop(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
312 {
313         tdm_output *output;
314         tdm_output *layer = NULL;
315         int output_idx, layer_idx = -1;
316         int cnt, i, done = 0;
317         tdm_value value;
318         char temp[TDM_PATH_LEN];
319         char *prop_name;
320         char *arg;
321         char *end;
322         tdm_error ret;
323         const tdm_prop *props;
324
325         if (argc < 3) {
326                 _tdm_monitor_server_usage(argv[0], reply, len);
327                 return;
328         }
329
330         snprintf(temp, TDM_PATH_LEN, "%s", argv[2]);
331         arg = temp;
332
333         output_idx = strtol(arg, &end, 10);
334         if (*end == ',') {
335                 arg = end + 1;
336                 layer_idx = strtol(arg, &end, 10);
337         }
338
339         if (*end != ':') {
340                 TDM_SNPRINTF(reply, len, "failed: no prop_name\n");
341                 return;
342         }
343
344         arg = end + 1;
345         prop_name = strtok_r(arg, ",", &end);
346         if (!prop_name) {
347                 TDM_SNPRINTF(reply, len, "failed: get prop_name by strtok_r\n");
348                 return;
349         }
350
351         if (*end == '\0') {
352                 TDM_SNPRINTF(reply, len, "failed: no value\n");
353                 return;
354         }
355
356         arg = strtok_r(NULL, TDM_DELIM, &end);
357         if (!arg) {
358                 TDM_SNPRINTF(reply, len, "failed: get arg by strtok_r\n");
359                 return;
360         }
361         value.u32 = strtol(arg, &end, 10);
362
363         output = tdm_display_get_output(dpy, output_idx, &ret);
364         TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE && output != NULL);
365
366         if (layer_idx != -1) {
367                 layer = tdm_output_get_layer(output, layer_idx, &ret);
368                 TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE && layer != NULL);
369         }
370
371         if (layer) {
372                 ret = tdm_layer_get_available_properties(layer, &props, &cnt);
373                 TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE);
374
375                 for (i = 0; i < cnt; i++) {
376                         if (!strncmp(props[i].name, prop_name, TDM_NAME_LEN)) {
377                                 ret = tdm_layer_set_property(layer, props[i].id, value);
378                                 TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE);
379                                 done = 1;
380                                 break;
381                         }
382                 }
383         } else {
384                 ret = tdm_output_get_available_properties(output, &props, &cnt);
385                 TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE);
386
387                 for (i = 0; i < cnt; i++) {
388                         if (!strncmp(props[i].name, prop_name, TDM_NAME_LEN)) {
389                                 ret = tdm_output_set_property(output, props[i].id, value);
390                                 TDM_DBG_RETURN_IF_FAIL(ret == TDM_ERROR_NONE);
391                                 done = 1;
392                                 break;
393                         }
394                 }
395         }
396
397         if (done)
398                 TDM_SNPRINTF(reply, len, "done: %s:%d \n", prop_name, value.u32);
399         else
400                 TDM_SNPRINTF(reply, len, "no '%s' propperty \n", prop_name);
401 }
402
403 static void
404 _tdm_monitor_server_dump(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
405 {
406         if (argc < 3) {
407                 _tdm_monitor_server_usage(argv[0], reply, len);
408                 return;
409         }
410
411         tdm_display_enable_dump(dpy, (const char*)argv[2], reply, len);
412 }
413
414 static void
415 _tdm_monitor_server_punch(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy)
416 {
417         char *arg, *end;
418         unsigned int output_id, layer_id;
419         tdm_output *output;
420         tdm_layer *layer;
421         tbm_surface_h buffer;
422
423         arg = argv[2];
424
425         output_id = strtol(arg, &end, 10);
426         output = tdm_display_get_output(dpy, output_id, NULL);
427         if (!output) {
428                 TDM_SNPRINTF(reply, len, "not found output\n");
429                 return;
430         }
431         if (*end != ',') {
432                 TDM_SNPRINTF(reply, len, "not found ',<layer_idx>'\n");
433                 return;
434         }
435
436         arg = end + 1;
437         layer_id = strtol(arg, &end, 10);
438         layer = tdm_output_get_layer(output, layer_id, NULL);
439         if (!layer) {
440                 TDM_SNPRINTF(reply, len, "not found layer\n");
441                 return;
442         }
443
444         buffer = tdm_layer_get_displaying_buffer(layer, NULL);
445         if (!buffer) {
446                 TDM_SNPRINTF(reply, len, "not found buffer\n");
447                 return;
448         }
449
450         if (*end == ':') {
451                 tdm_pos pos = {0,};
452
453                 arg = end + 1;
454                 pos.w = strtol(arg, &end, 10);
455                 TDM_EXIT_IF_FAIL(*end == 'x');
456                 arg = end + 1;
457                 pos.h = strtol(arg, &end, 10);
458                 if (*end == '+') {
459                         arg = end + 1;
460                         pos.x = strtol(arg, &end, 10);
461                         TDM_EXIT_IF_FAIL(*end == '+');
462                         arg = end + 1;
463                         pos.y = strtol(arg, &end, 10);
464                 }
465
466                 tdm_helper_clear_buffer_pos(buffer, &pos);
467         } else
468                 tdm_helper_clear_buffer(buffer);
469 }
470
471 static struct {
472         const char *opt;
473         void (*func)(unsigned int pid, char *cwd, int argc, char *argv[], char *reply, int *len, tdm_display *dpy);
474         const char *desc;
475         const char *arg;
476         const char *ex;
477 } option_proc[] = {
478         {
479                 "info", _tdm_monitor_server_query,
480                 "show tdm output, layer information", NULL, NULL
481         },
482         {
483                 "trace", _tdm_monitor_server_protocol_trace,
484                 "enable/disable the wl protocol",
485                 "<enable>",
486                 "0 or 1"
487         },
488         {
489                 "dpms", _tdm_monitor_server_dpms,
490                 "set output dpms", "<output_idx>:<dpms>", "0:3 or 0:0"
491         },
492         {
493                 "ttrace_vblank", _tdm_monitor_server_ttrace_vblank,
494                 "enable/disable the vblank for ttrace [0:disable 1:enable]",
495                 "<enable>[@<output_idx>]", "0 or 1"
496         },
497         {
498                 "debug", _tdm_monitor_server_debug,
499                 "set the debug level and modules(module: none, mutex, buffer, thread, vblank)",
500                 "<level>[@<module1>[,<module2>]]",
501                 NULL
502         },
503         {
504                 "log_path", _tdm_monitor_server_log_path,
505                 "set the log path (console,dlog,filepath)",
506                 "<path>",
507                 "console"
508         },
509         {
510                 "commit_per_vblank", _tdm_monitor_server_commit_per_vblank,
511                 "enable/disable the commit per vblank",
512                 "<enable>",
513                 "0 or 1"
514         },
515         {
516                 "fps", _tdm_monitor_server_fps,
517                 "enable/disable to print fps",
518                 "<enable>",
519                 "0 or 1"
520         },
521         {
522                 "vblank_list", _tdm_monitor_server_vblank_list,
523                 "print the client vblank list",
524                 NULL,
525                 NULL
526         },
527         {
528                 "vblank_fps", _tdm_monitor_server_vblank_fps,
529                 "set the client vblank fps for the given process ID and client vblank name",
530                 "<pid>[,<vblank_name>]@<fps>",
531                 NULL
532         },
533         {
534                 "prop", _tdm_monitor_server_prop,
535                 "set the property of a output or a layer",
536                 "<output_idx>[,<layer_idx>]:<prop_name>,<value>",
537                 NULL
538         },
539         {
540                 "dump", _tdm_monitor_server_dump,
541                 "dump buffers (type: none, layer, pp, capture, current)\n"
542                 "\t\t  layer, pp, capture - start to dump buffers of layer, pp, capture\n"
543                 "\t\t  none               - stop to dump buffers\n"
544                 "\t\t  current            - dump the current buffer of all layers",
545                 "<object_type1>[,<object_type2>[,...]][@<directory_path>]",
546                 NULL
547         },
548         {
549                 "punch", _tdm_monitor_server_punch,
550                 "punch a layer",
551                 "<output_idx>,<layer_idx>[:<w>x<h>[+<x>+<y>]]",
552                 NULL
553         },
554 };
555
556 static void
557 _tdm_monitor_server_usage(char *app_name, char *reply, int *len)
558 {
559         int opt_size = sizeof(option_proc) / sizeof(option_proc[0]);
560         int i;
561
562         TDM_SNPRINTF(reply, len, "usage: %s \n\n", app_name);
563
564         for (i = 0; i < opt_size; i++) {
565                 TDM_SNPRINTF(reply, len, "\t-%s\t%s\n", option_proc[i].opt, option_proc[i].desc);
566                 if (option_proc[i].arg)
567                         TDM_SNPRINTF(reply, len, "\t\t  %s\n", option_proc[i].arg);
568                 if (option_proc[i].ex)
569                         TDM_SNPRINTF(reply, len, "\t\t  ex) %s\n", option_proc[i].ex);
570                 TDM_SNPRINTF(reply, len, "\n");
571         }
572 }
573
574 static void
575 _tdm_monitor_server_command(unsigned int pid, char *cwd, tdm_display *dpy, int argc, char *argv[], char *reply, int *len)
576 {
577         int opt_size = sizeof(option_proc) / sizeof(option_proc[0]);
578         int i;
579
580         if (argc < 2) {
581                 _tdm_monitor_server_usage(argv[0], reply, len);
582                 return;
583         }
584
585         for (i = 0; i < opt_size; i++) {
586                 if (argv[1][0] == '-' && !strncmp(argv[1] + 1, option_proc[i].opt, 32)) {
587                         if (option_proc[i].func) {
588                                 option_proc[i].func(pid, cwd, argc, argv, reply, len, dpy);
589                                 return;
590                         } else {
591                                 TDM_SNPRINTF(reply, len, "'%s' not implemented.\n", argv[1]);
592                                 return;
593                         }
594                 }
595         }
596
597         _tdm_monitor_server_usage(argv[0], reply, len);
598         return;
599 }
600
601
602 INTERN void
603 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len)
604 {
605         unsigned int pid;
606         char cwd[1024];
607         int argc = 0;
608         char *argv[TDM_DBG_SERVER_ARGS_MAX] = {0,};
609         char temp[1024];
610         char *arg;
611         char *end = NULL, *e;
612
613         snprintf(temp, sizeof(temp), "%s", options);
614
615         arg = strtok_r(temp, " ", &end);
616         if (!arg) {
617                 TDM_SNPRINTF(reply, len, "no pid for tdm-monitor");
618                 return;
619         }
620         pid = strtol(arg, &e, 10);
621
622         arg = strtok_r(NULL, " ", &end);
623         if (!arg) {
624                 TDM_SNPRINTF(reply, len, "no cwd for tdm-monitor");
625                 return;
626         }
627         snprintf(cwd, sizeof(cwd), "%s", arg);
628
629         TDM_DBG("pid(%d) cwd(%s)", pid, cwd);
630
631         argv[argc] = strtok_r(NULL, " ", &end);
632         while (argv[argc]) {
633                 argc++;
634                 if (argc == TDM_DBG_SERVER_ARGS_MAX) {
635                         TDM_SNPRINTF(reply, len, "too many arguments for tdm-monitor");
636                         break;
637                 }
638                 argv[argc] = strtok_r(NULL, " ", &end);
639         }
640
641         _tdm_monitor_server_command(pid, cwd, dpy, argc, argv, reply, len);
642 }