| Message ID | 20190423212246.3542-3-ehabkost@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | Export machine type deprecation info through QMP | expand |
On 4/23/19 11:22 PM, Eduardo Habkost wrote: > Use SupportStatusInfo to represent deprecation information of > machine types. > > Instead of using a generic "use XXX instead" message for humans, > encode the suggested alternative in a machine-friendly way at the > 'suggested_alternatives' field. > > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> > --- > include/hw/boards.h | 7 ++++--- > hw/i386/pc_piix.c | 4 +++- > hw/ppc/prep.c | 4 +++- > vl.c | 13 +++++++++---- > 4 files changed, 19 insertions(+), 9 deletions(-) > > diff --git a/include/hw/boards.h b/include/hw/boards.h > index e231860666..243bf3c7ce 100644 > --- a/include/hw/boards.h > +++ b/include/hw/boards.h > @@ -8,6 +8,8 @@ > #include "hw/qdev.h" > #include "qom/object.h" > #include "qom/cpu.h" > +#include "qapi/qapi-types-common.h" > + > > /** > * memory_region_allocate_system_memory - Allocate a board's main memory > @@ -105,8 +107,7 @@ typedef struct { > > /** > * MachineClass: > - * @deprecation_reason: If set, the machine is marked as deprecated. The > - * string should provide some clear information about what to use instead. > + * @support_status: Support and deprecation status of machine type. > * @max_cpus: maximum number of CPUs supported. Default: 1 > * @min_cpus: minimum number of CPUs supported. Default: 1 > * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 > @@ -169,7 +170,7 @@ struct MachineClass { > char *name; > const char *alias; > const char *desc; > - const char *deprecation_reason; > + SupportStatusInfo support_status; > > void (*init)(MachineState *state); > void (*reset)(void); > diff --git a/hw/i386/pc_piix.c b/hw/i386/pc_piix.c > index 8ad8e885c6..97bd401618 100644 > --- a/hw/i386/pc_piix.c > +++ b/hw/i386/pc_piix.c > @@ -781,7 +781,9 @@ static void pc_i440fx_0_15_machine_options(MachineClass *m) > > pc_i440fx_1_0_machine_options(m); > m->hw_version = "0.15"; > - m->deprecation_reason = "use a newer machine type instead"; > + m->support_status.deprecated = true; > + m->support_status.has_suggested_alternative = true; > + m->support_status.suggested_alternative = g_strdup("pc"); > compat_props_add(m->compat_props, compat, G_N_ELEMENTS(compat)); > } > > diff --git a/hw/ppc/prep.c b/hw/ppc/prep.c > index 847d320465..9a02b0eec4 100644 > --- a/hw/ppc/prep.c > +++ b/hw/ppc/prep.c > @@ -587,7 +587,9 @@ static void ppc_prep_init(MachineState *machine) > > static void prep_machine_init(MachineClass *mc) > { > - mc->deprecation_reason = "use 40p machine type instead"; > + mc->support_status.deprecated = true; > + mc->support_status.has_suggested_alternative = true; > + mc->support_status.suggested_alternative = g_strdup("40p"); > mc->desc = "PowerPC PREP platform"; > mc->init = ppc_prep_init; > mc->block_default_type = IF_IDE; > diff --git a/vl.c b/vl.c > index c696ad2a13..99b857ed2a 100644 > --- a/vl.c > +++ b/vl.c > @@ -2610,7 +2610,7 @@ static gint machine_class_cmp(gconstpointer a, gconstpointer b) > } > printf("%-20s %s%s%s\n", mc->name, mc->desc, > mc->is_default ? " (default)" : "", > - mc->deprecation_reason ? " (deprecated)" : ""); > + mc->support_status.deprecated ? " (deprecated)" : ""); > } > } > > @@ -4308,9 +4308,14 @@ int main(int argc, char **argv, char **envp) > * called from configure_accelerator(). > */ > > - if (!qtest_enabled() && machine_class->deprecation_reason) { > - error_report("Machine type '%s' is deprecated: %s", > - machine_class->name, machine_class->deprecation_reason); > + if (!qtest_enabled() && machine_class->support_status.deprecated) { > + error_report("Machine type '%s' is deprecated%s%s", machine_class->name, > + machine_class->support_status.status_message ? ": " : "", > + machine_class->support_status.status_message ?: ""); > + if (machine_class->support_status.suggested_alternative) { > + error_report("Suggested solution: use '%s' machine type instead", Maybe "Recommended alternative:"? (Also consider renaming the SupportStatusInfo.suggested_alternative field). > + machine_class->support_status.suggested_alternative); > + } > } > > /* >
On Tue, Apr 23, 2019 at 06:22:45PM -0300, Eduardo Habkost wrote: > Use SupportStatusInfo to represent deprecation information of > machine types. > > Instead of using a generic "use XXX instead" message for humans, > encode the suggested alternative in a machine-friendly way at the > 'suggested_alternatives' field. > > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> ppc parts Acked-by: David Gibson <david@gibson.dropbear.id.au> > --- > include/hw/boards.h | 7 ++++--- > hw/i386/pc_piix.c | 4 +++- > hw/ppc/prep.c | 4 +++- > vl.c | 13 +++++++++---- > 4 files changed, 19 insertions(+), 9 deletions(-) > > diff --git a/include/hw/boards.h b/include/hw/boards.h > index e231860666..243bf3c7ce 100644 > --- a/include/hw/boards.h > +++ b/include/hw/boards.h > @@ -8,6 +8,8 @@ > #include "hw/qdev.h" > #include "qom/object.h" > #include "qom/cpu.h" > +#include "qapi/qapi-types-common.h" > + > > /** > * memory_region_allocate_system_memory - Allocate a board's main memory > @@ -105,8 +107,7 @@ typedef struct { > > /** > * MachineClass: > - * @deprecation_reason: If set, the machine is marked as deprecated. The > - * string should provide some clear information about what to use instead. > + * @support_status: Support and deprecation status of machine type. > * @max_cpus: maximum number of CPUs supported. Default: 1 > * @min_cpus: minimum number of CPUs supported. Default: 1 > * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 > @@ -169,7 +170,7 @@ struct MachineClass { > char *name; > const char *alias; > const char *desc; > - const char *deprecation_reason; > + SupportStatusInfo support_status; > > void (*init)(MachineState *state); > void (*reset)(void); > diff --git a/hw/i386/pc_piix.c b/hw/i386/pc_piix.c > index 8ad8e885c6..97bd401618 100644 > --- a/hw/i386/pc_piix.c > +++ b/hw/i386/pc_piix.c > @@ -781,7 +781,9 @@ static void pc_i440fx_0_15_machine_options(MachineClass *m) > > pc_i440fx_1_0_machine_options(m); > m->hw_version = "0.15"; > - m->deprecation_reason = "use a newer machine type instead"; > + m->support_status.deprecated = true; > + m->support_status.has_suggested_alternative = true; > + m->support_status.suggested_alternative = g_strdup("pc"); > compat_props_add(m->compat_props, compat, G_N_ELEMENTS(compat)); > } > > diff --git a/hw/ppc/prep.c b/hw/ppc/prep.c > index 847d320465..9a02b0eec4 100644 > --- a/hw/ppc/prep.c > +++ b/hw/ppc/prep.c > @@ -587,7 +587,9 @@ static void ppc_prep_init(MachineState *machine) > > static void prep_machine_init(MachineClass *mc) > { > - mc->deprecation_reason = "use 40p machine type instead"; > + mc->support_status.deprecated = true; > + mc->support_status.has_suggested_alternative = true; > + mc->support_status.suggested_alternative = g_strdup("40p"); > mc->desc = "PowerPC PREP platform"; > mc->init = ppc_prep_init; > mc->block_default_type = IF_IDE; > diff --git a/vl.c b/vl.c > index c696ad2a13..99b857ed2a 100644 > --- a/vl.c > +++ b/vl.c > @@ -2610,7 +2610,7 @@ static gint machine_class_cmp(gconstpointer a, gconstpointer b) > } > printf("%-20s %s%s%s\n", mc->name, mc->desc, > mc->is_default ? " (default)" : "", > - mc->deprecation_reason ? " (deprecated)" : ""); > + mc->support_status.deprecated ? " (deprecated)" : ""); > } > } > > @@ -4308,9 +4308,14 @@ int main(int argc, char **argv, char **envp) > * called from configure_accelerator(). > */ > > - if (!qtest_enabled() && machine_class->deprecation_reason) { > - error_report("Machine type '%s' is deprecated: %s", > - machine_class->name, machine_class->deprecation_reason); > + if (!qtest_enabled() && machine_class->support_status.deprecated) { > + error_report("Machine type '%s' is deprecated%s%s", machine_class->name, > + machine_class->support_status.status_message ? ": " : "", > + machine_class->support_status.status_message ?: ""); > + if (machine_class->support_status.suggested_alternative) { > + error_report("Suggested solution: use '%s' machine type instead", > + machine_class->support_status.suggested_alternative); > + } > } > > /*
On Tue, Apr 23, 2019 at 06:22:45PM -0300, Eduardo Habkost wrote: > Use SupportStatusInfo to represent deprecation information of > machine types. > > Instead of using a generic "use XXX instead" message for humans, > encode the suggested alternative in a machine-friendly way at the > 'suggested_alternatives' field. > > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> > --- > include/hw/boards.h | 7 ++++--- > hw/i386/pc_piix.c | 4 +++- > hw/ppc/prep.c | 4 +++- > vl.c | 13 +++++++++---- > 4 files changed, 19 insertions(+), 9 deletions(-) > > diff --git a/include/hw/boards.h b/include/hw/boards.h > index e231860666..243bf3c7ce 100644 > --- a/include/hw/boards.h > +++ b/include/hw/boards.h > @@ -8,6 +8,8 @@ > #include "hw/qdev.h" > #include "qom/object.h" > #include "qom/cpu.h" > +#include "qapi/qapi-types-common.h" > + > > /** > * memory_region_allocate_system_memory - Allocate a board's main memory > @@ -105,8 +107,7 @@ typedef struct { > > /** > * MachineClass: > - * @deprecation_reason: If set, the machine is marked as deprecated. The > - * string should provide some clear information about what to use instead. > + * @support_status: Support and deprecation status of machine type. > * @max_cpus: maximum number of CPUs supported. Default: 1 > * @min_cpus: minimum number of CPUs supported. Default: 1 > * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 > @@ -169,7 +170,7 @@ struct MachineClass { > char *name; > const char *alias; > const char *desc; > - const char *deprecation_reason; > + SupportStatusInfo support_status; > > void (*init)(MachineState *state); > void (*reset)(void); > diff --git a/hw/i386/pc_piix.c b/hw/i386/pc_piix.c > index 8ad8e885c6..97bd401618 100644 > --- a/hw/i386/pc_piix.c > +++ b/hw/i386/pc_piix.c > @@ -781,7 +781,9 @@ static void pc_i440fx_0_15_machine_options(MachineClass *m) > > pc_i440fx_1_0_machine_options(m); > m->hw_version = "0.15"; > - m->deprecation_reason = "use a newer machine type instead"; > + m->support_status.deprecated = true; > + m->support_status.has_suggested_alternative = true; > + m->support_status.suggested_alternative = g_strdup("pc"); > compat_props_add(m->compat_props, compat, G_N_ELEMENTS(compat)); > } > > diff --git a/hw/ppc/prep.c b/hw/ppc/prep.c > index 847d320465..9a02b0eec4 100644 > --- a/hw/ppc/prep.c > +++ b/hw/ppc/prep.c > @@ -587,7 +587,9 @@ static void ppc_prep_init(MachineState *machine) > > static void prep_machine_init(MachineClass *mc) > { > - mc->deprecation_reason = "use 40p machine type instead"; > + mc->support_status.deprecated = true; > + mc->support_status.has_suggested_alternative = true; > + mc->support_status.suggested_alternative = g_strdup("40p"); > mc->desc = "PowerPC PREP platform"; > mc->init = ppc_prep_init; > mc->block_default_type = IF_IDE; > diff --git a/vl.c b/vl.c > index c696ad2a13..99b857ed2a 100644 > --- a/vl.c > +++ b/vl.c > @@ -2610,7 +2610,7 @@ static gint machine_class_cmp(gconstpointer a, gconstpointer b) > } > printf("%-20s %s%s%s\n", mc->name, mc->desc, > mc->is_default ? " (default)" : "", > - mc->deprecation_reason ? " (deprecated)" : ""); > + mc->support_status.deprecated ? " (deprecated)" : ""); > } > } > > @@ -4308,9 +4308,14 @@ int main(int argc, char **argv, char **envp) > * called from configure_accelerator(). > */ > > - if (!qtest_enabled() && machine_class->deprecation_reason) { > - error_report("Machine type '%s' is deprecated: %s", > - machine_class->name, machine_class->deprecation_reason); > + if (!qtest_enabled() && machine_class->support_status.deprecated) { > + error_report("Machine type '%s' is deprecated%s%s", machine_class->name, > + machine_class->support_status.status_message ? ": " : "", > + machine_class->support_status.status_message ?: ""); > + if (machine_class->support_status.suggested_alternative) { > + error_report("Suggested solution: use '%s' machine type instead", > + machine_class->support_status.suggested_alternative); I'd just drop the word "Suggested solution: " as I think it is fine to just say "Use foobar machine type instead". Regards, Daniel
On Wed, Apr 24, 2019 at 09:23:09AM +0100, Daniel P. Berrangé wrote: > On Tue, Apr 23, 2019 at 06:22:45PM -0300, Eduardo Habkost wrote: > > Use SupportStatusInfo to represent deprecation information of > > machine types. > > > > Instead of using a generic "use XXX instead" message for humans, > > encode the suggested alternative in a machine-friendly way at the > > 'suggested_alternatives' field. > > > > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> > > --- > > include/hw/boards.h | 7 ++++--- > > hw/i386/pc_piix.c | 4 +++- > > hw/ppc/prep.c | 4 +++- > > vl.c | 13 +++++++++---- > > 4 files changed, 19 insertions(+), 9 deletions(-) > > > > diff --git a/include/hw/boards.h b/include/hw/boards.h > > index e231860666..243bf3c7ce 100644 > > --- a/include/hw/boards.h > > +++ b/include/hw/boards.h > > @@ -8,6 +8,8 @@ > > #include "hw/qdev.h" > > #include "qom/object.h" > > #include "qom/cpu.h" > > +#include "qapi/qapi-types-common.h" > > + > > > > /** > > * memory_region_allocate_system_memory - Allocate a board's main memory > > @@ -105,8 +107,7 @@ typedef struct { > > > > /** > > * MachineClass: > > - * @deprecation_reason: If set, the machine is marked as deprecated. The > > - * string should provide some clear information about what to use instead. > > + * @support_status: Support and deprecation status of machine type. > > * @max_cpus: maximum number of CPUs supported. Default: 1 > > * @min_cpus: minimum number of CPUs supported. Default: 1 > > * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 > > @@ -169,7 +170,7 @@ struct MachineClass { > > char *name; > > const char *alias; > > const char *desc; > > - const char *deprecation_reason; > > + SupportStatusInfo support_status; > > > > void (*init)(MachineState *state); > > void (*reset)(void); > > diff --git a/hw/i386/pc_piix.c b/hw/i386/pc_piix.c > > index 8ad8e885c6..97bd401618 100644 > > --- a/hw/i386/pc_piix.c > > +++ b/hw/i386/pc_piix.c > > @@ -781,7 +781,9 @@ static void pc_i440fx_0_15_machine_options(MachineClass *m) > > > > pc_i440fx_1_0_machine_options(m); > > m->hw_version = "0.15"; > > - m->deprecation_reason = "use a newer machine type instead"; > > + m->support_status.deprecated = true; > > + m->support_status.has_suggested_alternative = true; > > + m->support_status.suggested_alternative = g_strdup("pc"); > > compat_props_add(m->compat_props, compat, G_N_ELEMENTS(compat)); > > } > > > > diff --git a/hw/ppc/prep.c b/hw/ppc/prep.c > > index 847d320465..9a02b0eec4 100644 > > --- a/hw/ppc/prep.c > > +++ b/hw/ppc/prep.c > > @@ -587,7 +587,9 @@ static void ppc_prep_init(MachineState *machine) > > > > static void prep_machine_init(MachineClass *mc) > > { > > - mc->deprecation_reason = "use 40p machine type instead"; > > + mc->support_status.deprecated = true; > > + mc->support_status.has_suggested_alternative = true; > > + mc->support_status.suggested_alternative = g_strdup("40p"); > > mc->desc = "PowerPC PREP platform"; > > mc->init = ppc_prep_init; > > mc->block_default_type = IF_IDE; > > diff --git a/vl.c b/vl.c > > index c696ad2a13..99b857ed2a 100644 > > --- a/vl.c > > +++ b/vl.c > > @@ -2610,7 +2610,7 @@ static gint machine_class_cmp(gconstpointer a, gconstpointer b) > > } > > printf("%-20s %s%s%s\n", mc->name, mc->desc, > > mc->is_default ? " (default)" : "", > > - mc->deprecation_reason ? " (deprecated)" : ""); > > + mc->support_status.deprecated ? " (deprecated)" : ""); > > } > > } > > > > @@ -4308,9 +4308,14 @@ int main(int argc, char **argv, char **envp) > > * called from configure_accelerator(). > > */ > > > > - if (!qtest_enabled() && machine_class->deprecation_reason) { > > - error_report("Machine type '%s' is deprecated: %s", > > - machine_class->name, machine_class->deprecation_reason); > > + if (!qtest_enabled() && machine_class->support_status.deprecated) { > > + error_report("Machine type '%s' is deprecated%s%s", machine_class->name, > > + machine_class->support_status.status_message ? ": " : "", > > + machine_class->support_status.status_message ?: ""); > > + if (machine_class->support_status.suggested_alternative) { > > + error_report("Suggested solution: use '%s' machine type instead", > > + machine_class->support_status.suggested_alternative); > > I'd just drop the word "Suggested solution: " as I think it is fine to just > say "Use foobar machine type instead". I'm not sure. Can we reword this, but in a way that it still sounds like a suggestion, not as a definitive solution? Sometimes the provided alternative won't work for everybody. e.g. if one day we deprecate pc-i440fx, we can't be sure that everybody will be able to use q35 instead.
diff --git a/include/hw/boards.h b/include/hw/boards.h index e231860666..243bf3c7ce 100644 --- a/include/hw/boards.h +++ b/include/hw/boards.h @@ -8,6 +8,8 @@ #include "hw/qdev.h" #include "qom/object.h" #include "qom/cpu.h" +#include "qapi/qapi-types-common.h" + /** * memory_region_allocate_system_memory - Allocate a board's main memory @@ -105,8 +107,7 @@ typedef struct { /** * MachineClass: - * @deprecation_reason: If set, the machine is marked as deprecated. The - * string should provide some clear information about what to use instead. + * @support_status: Support and deprecation status of machine type. * @max_cpus: maximum number of CPUs supported. Default: 1 * @min_cpus: minimum number of CPUs supported. Default: 1 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 @@ -169,7 +170,7 @@ struct MachineClass { char *name; const char *alias; const char *desc; - const char *deprecation_reason; + SupportStatusInfo support_status; void (*init)(MachineState *state); void (*reset)(void); diff --git a/hw/i386/pc_piix.c b/hw/i386/pc_piix.c index 8ad8e885c6..97bd401618 100644 --- a/hw/i386/pc_piix.c +++ b/hw/i386/pc_piix.c @@ -781,7 +781,9 @@ static void pc_i440fx_0_15_machine_options(MachineClass *m) pc_i440fx_1_0_machine_options(m); m->hw_version = "0.15"; - m->deprecation_reason = "use a newer machine type instead"; + m->support_status.deprecated = true; + m->support_status.has_suggested_alternative = true; + m->support_status.suggested_alternative = g_strdup("pc"); compat_props_add(m->compat_props, compat, G_N_ELEMENTS(compat)); } diff --git a/hw/ppc/prep.c b/hw/ppc/prep.c index 847d320465..9a02b0eec4 100644 --- a/hw/ppc/prep.c +++ b/hw/ppc/prep.c @@ -587,7 +587,9 @@ static void ppc_prep_init(MachineState *machine) static void prep_machine_init(MachineClass *mc) { - mc->deprecation_reason = "use 40p machine type instead"; + mc->support_status.deprecated = true; + mc->support_status.has_suggested_alternative = true; + mc->support_status.suggested_alternative = g_strdup("40p"); mc->desc = "PowerPC PREP platform"; mc->init = ppc_prep_init; mc->block_default_type = IF_IDE; diff --git a/vl.c b/vl.c index c696ad2a13..99b857ed2a 100644 --- a/vl.c +++ b/vl.c @@ -2610,7 +2610,7 @@ static gint machine_class_cmp(gconstpointer a, gconstpointer b) } printf("%-20s %s%s%s\n", mc->name, mc->desc, mc->is_default ? " (default)" : "", - mc->deprecation_reason ? " (deprecated)" : ""); + mc->support_status.deprecated ? " (deprecated)" : ""); } } @@ -4308,9 +4308,14 @@ int main(int argc, char **argv, char **envp) * called from configure_accelerator(). */ - if (!qtest_enabled() && machine_class->deprecation_reason) { - error_report("Machine type '%s' is deprecated: %s", - machine_class->name, machine_class->deprecation_reason); + if (!qtest_enabled() && machine_class->support_status.deprecated) { + error_report("Machine type '%s' is deprecated%s%s", machine_class->name, + machine_class->support_status.status_message ? ": " : "", + machine_class->support_status.status_message ?: ""); + if (machine_class->support_status.suggested_alternative) { + error_report("Suggested solution: use '%s' machine type instead", + machine_class->support_status.suggested_alternative); + } } /*
Use SupportStatusInfo to represent deprecation information of machine types. Instead of using a generic "use XXX instead" message for humans, encode the suggested alternative in a machine-friendly way at the 'suggested_alternatives' field. Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> --- include/hw/boards.h | 7 ++++--- hw/i386/pc_piix.c | 4 +++- hw/ppc/prep.c | 4 +++- vl.c | 13 +++++++++---- 4 files changed, 19 insertions(+), 9 deletions(-)