| Message ID | 20230622141248.459133-2-peter.hoyes@arm.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v3,1/2] tools/console: Add escape argument to configure escape character | expand |
On Thu, Jun 22, 2023 at 03:12:48PM +0100, Peter Hoyes wrote: > diff --git a/tools/include/libxl.h b/tools/include/libxl.h > index cac641a7eb..c513c39483 100644 > --- a/tools/include/libxl.h > +++ b/tools/include/libxl.h > @@ -1958,7 +1958,8 @@ int libxl_vncviewer_exec(libxl_ctx *ctx, uint32_t domid, int autopass); > * the caller that it has connected to the guest console. > */ > int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, > - libxl_console_type type, int notify_fd); > + libxl_console_type type, int notify_fd, > + char* escape_character); So, this is changing the libxl API, it's possible, but it's going to be a bit more complicated than that. You'll need to: - Increment LIBXL_API_VERSION, well more like allow a new api version. That's adding 0x041800 to the list of allowed value for LIBXL_API_VERSION, at around line 793 in "libxl.h", just before "#error Unknown LIBXL_API_VERSION". - Introduce API compatible caller for earlier API version. A good example of this done would be libxl_retrieve_domain_configuration_0x041200(). Actually, there's already some changed been made in the past to libxl_console_exec() and libxl_primary_console_exec(), so those are probably better example and need to modified. - Introduce LIBXL_HAVE_* macro in libxl.h to advertise the new arg. There's already LIBXL_HAVE_CONSOLE_NOTIFY_FD, so I guess the new macro could be named LIBXL_HAVE_CONSOLE_ESCAPE_CHARACTER. > /* libxl_primary_console_exec finds the domid and console number > * corresponding to the primary console of the given vm, then calls > * libxl_console_exec with the right arguments (domid might be different > @@ -1968,9 +1969,12 @@ int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, > * guests using pygrub. > * If notify_fd is not -1, xenconsole will write 0x00 to it to nofity > * the caller that it has connected to the guest console. > + * If escape_character is not NULL, the provided value is used to exit > + * the guest console. > */ > int libxl_primary_console_exec(libxl_ctx *ctx, uint32_t domid_vm, > - int notify_fd); > + int notify_fd, > + char* escape_character); > > #if defined(LIBXL_API_VERSION) && LIBXL_API_VERSION < 0x040800 > > diff --git a/tools/libs/light/libxl_console.c b/tools/libs/light/libxl_console.c > index f497be141b..0b7293fe71 100644 > --- a/tools/libs/light/libxl_console.c > +++ b/tools/libs/light/libxl_console.c > @@ -75,15 +76,26 @@ int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, > goto out; > } > > + char *args[] = { > + p, domid_s, "--num", cons_num_s, "--type", cons_type_s, > + NULL, NULL, NULL, NULL, // start-notify-fd, escape > + NULL, // list terminator - do not use > + }; > + char **args_extra = args + 6; > + > if (notify_fd != -1) { > notify_fd_s = GCSPRINTF("%d", notify_fd); > - execl(p, p, domid_s, "--num", cons_num_s, "--type", cons_type_s, > - "--start-notify-fd", notify_fd_s, (void *)NULL); > - } else { > - execl(p, p, domid_s, "--num", cons_num_s, "--type", cons_type_s, > - (void *)NULL); > + *args_extra++ = "--start-notify-fd"; > + *args_extra++ = notify_fd_s; > } > > + if (escape_character) { > + *args_extra++ = "--escape"; > + *args_extra++ = escape_character; > + } There is flexarray_* that could be use, but I guess a preset `*args` kind of work here. > + > + execv(p, args); > + > out: > GC_FREE; > return ERROR_FAIL; > diff --git a/tools/xl/xl_cmdtable.c b/tools/xl/xl_cmdtable.c > index ccf4d83584..67604e9536 100644 > --- a/tools/xl/xl_cmdtable.c > +++ b/tools/xl/xl_cmdtable.c > @@ -141,7 +141,8 @@ const struct cmd_spec cmd_table[] = { > "Attach to domain's console", > "[options] <Domain>\n" > "-t <type> console type, pv , serial or vuart\n" > - "-n <number> console number" > + "-n <number> console number\n" > + "-e <escape> escape character" Could you also update "docs/man/xl.1.pod.in" with this new option? Thanks,
Thanks for the feedback. On 10/07/2023 15:43, Anthony PERARD wrote: > On Thu, Jun 22, 2023 at 03:12:48PM +0100, Peter Hoyes wrote: >> /* libxl_primary_console_exec finds the domid and console number >> * corresponding to the primary console of the given vm, then calls >> * libxl_console_exec with the right arguments (domid might be different >> @@ -1968,9 +1969,12 @@ int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, >> * guests using pygrub. >> * If notify_fd is not -1, xenconsole will write 0x00 to it to nofity >> * the caller that it has connected to the guest console. >> + * If escape_character is not NULL, the provided value is used to exit >> + * the guest console. >> */ >> int libxl_primary_console_exec(libxl_ctx *ctx, uint32_t domid_vm, >> - int notify_fd); >> + int notify_fd, >> + char* escape_character); >> >> #if defined(LIBXL_API_VERSION) && LIBXL_API_VERSION < 0x040800 >> >> diff --git a/tools/libs/light/libxl_console.c b/tools/libs/light/libxl_console.c >> index f497be141b..0b7293fe71 100644 >> --- a/tools/libs/light/libxl_console.c >> +++ b/tools/libs/light/libxl_console.c >> @@ -75,15 +76,26 @@ int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, >> goto out; >> } >> >> + char *args[] = { >> + p, domid_s, "--num", cons_num_s, "--type", cons_type_s, >> + NULL, NULL, NULL, NULL, // start-notify-fd, escape >> + NULL, // list terminator - do not use >> + }; >> + char **args_extra = args + 6; >> + >> if (notify_fd != -1) { >> notify_fd_s = GCSPRINTF("%d", notify_fd); >> - execl(p, p, domid_s, "--num", cons_num_s, "--type", cons_type_s, >> - "--start-notify-fd", notify_fd_s, (void *)NULL); >> - } else { >> - execl(p, p, domid_s, "--num", cons_num_s, "--type", cons_type_s, >> - (void *)NULL); >> + *args_extra++ = "--start-notify-fd"; >> + *args_extra++ = notify_fd_s; >> } >> >> + if (escape_character) { >> + *args_extra++ = "--escape"; >> + *args_extra++ = escape_character; >> + } > There is flexarray_* that could be use, but I guess a preset `*args` > kind of work here. > I looked into flexarray but didn't implement in v4 - as it stands, libxl_console_exec and libxl_vncviewer_exec are using the same pattern. Peter
diff --git a/tools/include/libxl.h b/tools/include/libxl.h index cac641a7eb..c513c39483 100644 --- a/tools/include/libxl.h +++ b/tools/include/libxl.h @@ -1958,7 +1958,8 @@ int libxl_vncviewer_exec(libxl_ctx *ctx, uint32_t domid, int autopass); * the caller that it has connected to the guest console. */ int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, - libxl_console_type type, int notify_fd); + libxl_console_type type, int notify_fd, + char* escape_character); /* libxl_primary_console_exec finds the domid and console number * corresponding to the primary console of the given vm, then calls * libxl_console_exec with the right arguments (domid might be different @@ -1968,9 +1969,12 @@ int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, * guests using pygrub. * If notify_fd is not -1, xenconsole will write 0x00 to it to nofity * the caller that it has connected to the guest console. + * If escape_character is not NULL, the provided value is used to exit + * the guest console. */ int libxl_primary_console_exec(libxl_ctx *ctx, uint32_t domid_vm, - int notify_fd); + int notify_fd, + char* escape_character); #if defined(LIBXL_API_VERSION) && LIBXL_API_VERSION < 0x040800 diff --git a/tools/libs/light/libxl_console.c b/tools/libs/light/libxl_console.c index f497be141b..0b7293fe71 100644 --- a/tools/libs/light/libxl_console.c +++ b/tools/libs/light/libxl_console.c @@ -52,7 +52,8 @@ out: } int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, - libxl_console_type type, int notify_fd) + libxl_console_type type, int notify_fd, + char* escape_character) { GC_INIT(ctx); char *p = GCSPRINTF("%s/xenconsole", libxl__private_bindir_path()); @@ -75,15 +76,26 @@ int libxl_console_exec(libxl_ctx *ctx, uint32_t domid, int cons_num, goto out; } + char *args[] = { + p, domid_s, "--num", cons_num_s, "--type", cons_type_s, + NULL, NULL, NULL, NULL, // start-notify-fd, escape + NULL, // list terminator - do not use + }; + char **args_extra = args + 6; + if (notify_fd != -1) { notify_fd_s = GCSPRINTF("%d", notify_fd); - execl(p, p, domid_s, "--num", cons_num_s, "--type", cons_type_s, - "--start-notify-fd", notify_fd_s, (void *)NULL); - } else { - execl(p, p, domid_s, "--num", cons_num_s, "--type", cons_type_s, - (void *)NULL); + *args_extra++ = "--start-notify-fd"; + *args_extra++ = notify_fd_s; } + if (escape_character) { + *args_extra++ = "--escape"; + *args_extra++ = escape_character; + } + + execv(p, args); + out: GC_FREE; return ERROR_FAIL; @@ -156,7 +168,8 @@ out: return rc; } -int libxl_primary_console_exec(libxl_ctx *ctx, uint32_t domid_vm, int notify_fd) +int libxl_primary_console_exec(libxl_ctx *ctx, uint32_t domid_vm, int notify_fd, + char* escape_character) { uint32_t domid; int cons_num; @@ -165,7 +178,8 @@ int libxl_primary_console_exec(libxl_ctx *ctx, uint32_t domid_vm, int notify_fd) rc = libxl__primary_console_find(ctx, domid_vm, &domid, &cons_num, &type); if ( rc ) return rc; - return libxl_console_exec(ctx, domid, cons_num, type, notify_fd); + return libxl_console_exec(ctx, domid, cons_num, type, notify_fd, + escape_character); } int libxl_primary_console_get_tty(libxl_ctx *ctx, uint32_t domid_vm, diff --git a/tools/xl/xl_cmdtable.c b/tools/xl/xl_cmdtable.c index ccf4d83584..67604e9536 100644 --- a/tools/xl/xl_cmdtable.c +++ b/tools/xl/xl_cmdtable.c @@ -141,7 +141,8 @@ const struct cmd_spec cmd_table[] = { "Attach to domain's console", "[options] <Domain>\n" "-t <type> console type, pv , serial or vuart\n" - "-n <number> console number" + "-n <number> console number\n" + "-e <escape> escape character" }, { "vncviewer", &main_vncviewer, 0, 0, diff --git a/tools/xl/xl_console.c b/tools/xl/xl_console.c index b27f9e0136..5633c6f6f7 100644 --- a/tools/xl/xl_console.c +++ b/tools/xl/xl_console.c @@ -28,8 +28,9 @@ int main_console(int argc, char **argv) int opt = 0, num = 0; libxl_console_type type = 0; const char *console_names = "pv, serial, vuart"; + char* escape_character = NULL; - SWITCH_FOREACH_OPT(opt, "n:t:", NULL, "console", 1) { + SWITCH_FOREACH_OPT(opt, "n:t:e:", NULL, "console", 1) { case 't': if (!strcmp(optarg, "pv")) type = LIBXL_CONSOLE_TYPE_PV; @@ -45,13 +46,16 @@ int main_console(int argc, char **argv) case 'n': num = atoi(optarg); break; + case 'e': + escape_character = optarg; + break; } domid = find_domain(argv[optind]); if (!type) - libxl_primary_console_exec(ctx, domid, -1); + libxl_primary_console_exec(ctx, domid, -1, escape_character); else - libxl_console_exec(ctx, domid, num, type, -1); + libxl_console_exec(ctx, domid, num, type, -1, escape_character); fprintf(stderr, "Unable to attach console\n"); return EXIT_FAILURE; } diff --git a/tools/xl/xl_vmcontrol.c b/tools/xl/xl_vmcontrol.c index 5518c78dc6..03971927e9 100644 --- a/tools/xl/xl_vmcontrol.c +++ b/tools/xl/xl_vmcontrol.c @@ -643,7 +643,7 @@ static void autoconnect_console(libxl_ctx *ctx_ignored, postfork(); sleep(1); - libxl_primary_console_exec(ctx, bldomid, notify_fd); + libxl_primary_console_exec(ctx, bldomid, notify_fd, NULL); /* Do not return. xl continued in child process */ perror("xl: unable to exec console client"); _exit(1);