Commit 047f7038 authored by Igor Mammedov's avatar Igor Mammedov Committed by Eduardo Habkost
Browse files

cli: add --preconfig option 



This option allows pausing QEMU in the new RUN_STATE_PRECONFIG state,
allowing the configuration of QEMU from QMP before the machine jumps
into board initialization code of machine_run_board_init()

The intent is to allow management to query machine state and additionally
configure it using previous query results within one QEMU instance
(i.e. eliminate the need to start QEMU twice, 1st to query board specific
parameters and 2nd for actual VM start using query results for
additional parameters).

The new option complements -S option and could be used with or without
it. The difference is that -S pauses QEMU when the machine is completely
initialized with all devices wired up and ready to execute guest code
(QEMU needs only to unpause VCPUs to let guest execute its code),
while the "preconfig" option pauses QEMU early before board specific init
callback (machine_run_board_init) is executed and allows the configuration
of machine parameters which will be used by board init code.

When early introspection/configuration is done, command 'exit-preconfig'
should be used to exit RUN_STATE_PRECONFIG and transition to the next
requested state (i.e. if -S is used then QEMU will pause the second
time when board/device initialization is completed or start guest
execution if -S isn't provided on CLI)

PS:
Initially 'preconfig' is planned to be used for configuring numa
topology depending on board specified possible cpus layout.

Signed-off-by: default avatarIgor Mammedov <imammedo@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Message-Id: <1526059483-42847-1-git-send-email-imammedo@redhat.com>
[ehabkost: Changed "since 2.13" to "since 3.0"]
Signed-off-by: default avatarEduardo Habkost <ehabkost@redhat.com>
parent 7b13f2c2

include/sysemu/sysemu.h

+1 −0
Original line number Diff line number Diff line
@@ -66,6 +66,7 @@ typedef enum WakeupReason { 
    QEMU_WAKEUP_REASON_OTHER,

} WakeupReason;



void qemu_exit_preconfig_request(void);

void qemu_system_reset_request(ShutdownCause reason);

void qemu_system_suspend_request(void);

void qemu_register_suspend_notifier(Notifier *notifier);

qapi/misc.json

+23 −0
Original line number Diff line number Diff line
@@ -1244,6 +1244,29 @@ 
##

{ 'command': 'cont' }



##

# @exit-preconfig:

#

# Exit from "preconfig" state

#

# This command makes QEMU exit the preconfig state and proceed with

# VM initialization using configuration data provided on the command line

# and via the QMP monitor during the preconfig state. The command is only

# available during the preconfig state (i.e. when the --preconfig command

# line option was in use).

#

# Since 3.0

#

# Returns: nothing

#

# Example:

#

# -> { "execute": "exit-preconfig" }

# <- { "return": {} }

#

##

{ 'command': 'exit-preconfig', 'allow-preconfig': true }



##

# @system_wakeup:

#

qapi/qmp-dispatch.c

+8 −0
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ 
#include "qapi/qmp/qdict.h"

#include "qapi/qmp/qjson.h"

#include "qapi/qmp/qbool.h"

#include "sysemu/sysemu.h"



QDict *qmp_dispatch_check_obj(const QObject *request, Error **errp)

{
@@ -101,6 +102,13 @@ static QObject *do_qmp_dispatch(QmpCommandList *cmds, QObject *request, 
        return NULL;

    }



    if (runstate_check(RUN_STATE_PRECONFIG) &&

        !(cmd->options & QCO_ALLOW_PRECONFIG)) {

        error_setg(errp, "The command '%s' isn't permitted in '%s' state",

                   cmd->name, RunState_str(RUN_STATE_PRECONFIG));

        return NULL;

    }



    if (!qdict_haskey(dict, "arguments")) {

        args = qdict_new();

    } else {

qemu-options.hx

+13 −0
Original line number Diff line number Diff line
@@ -3299,6 +3299,19 @@ STEXI 
Run the emulation in single step mode.

ETEXI



DEF("preconfig", 0, QEMU_OPTION_preconfig, \

    "--preconfig     pause QEMU before machine is initialized\n",

    QEMU_ARCH_ALL)

STEXI

@item --preconfig

@findex --preconfig

Pause QEMU for interactive configuration before the machine is created,

which allows querying and configuring properties that will affect

machine initialization. Use the QMP command 'exit-preconfig' to exit

the preconfig state and move to the next state (ie. run guest if -S

isn't used or pause the second time if -S is used).

ETEXI



DEF("S", 0, QEMU_OPTION_S, \

    "-S              freeze CPU at startup (use 'c' to start execution)\n",

    QEMU_ARCH_ALL)

qemu-tech.texi

+40 −0
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@ 
* CPU emulation::

* Translator Internals::

* QEMU compared to other emulators::

* Managed start up options::

* Bibliography::

@end menu
@@ -314,6 +315,45 @@ VirtualBox [9], Xen [10] and KVM [11] are based on QEMU. QEMU-SystemC 
[12] uses QEMU to simulate a system where some hardware devices are

developed in SystemC.



@node Managed start up options

@section Managed start up options



In system mode emulation, it's possible to create a VM in a paused state using

the -S command line option. In this state the machine is completely initialized

according to command line options and ready to execute VM code but VCPU threads

are not executing any code. The VM state in this paused state depends on the way

QEMU was started. It could be in:

@table @asis

@item initial state (after reset/power on state)

@item with direct kernel loading, the initial state could be amended to execute

code loaded by QEMU in the VM's RAM and with incoming migration

@item with incoming migration, initial state will by amended with the migrated

machine state after migration completes.

@end table



This paused state is typically used by users to query machine state and/or

additionally configure the machine (by hotplugging devices) in runtime before

allowing VM code to run.



However, at the -S pause point, it's impossible to configure options that affect

initial VM creation (like: -smp/-m/-numa ...) or cold plug devices. That's

when the --preconfig command line option should be used. It allows pausing QEMU

before the initial VM creation, in a new preconfig state, where additional

queries and configuration can be performed via QMP before moving on to

the resulting configuration startup. In the preconfig state, QEMU only allows

a limited set of commands over the QMP monitor, where the commands do not

depend on an initialized machine, including but not limited to:

@table @asis

@item qmp_capabilities

@item query-qmp-schema

@item query-commands

@item query-status

@item exit-preconfig

@end table

The full list of commands is in QMP schema which could be queried with

query-qmp-schema, where commands supported at preconfig state have option

'allow-preconfig' set to true.



@node Bibliography

@section Bibliography