* [PATCH 00 of 15 v2] Documentation updates
@ 2011-11-25 14:49 Ian Campbell
2011-11-25 14:49 ` [PATCH 01 of 15 v2] Replace references to old wiki with ones to new Ian Campbell
` (14 more replies)
0 siblings, 15 replies; 23+ messages in thread
From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw)
To: xen-devel; +Cc: ian.jackson
Repost of my documentation series.
Changes since last time:
Dropped "docs: generate docs direct into final filename", using a
temp file prevents half completed docsshowing up after an error
Applied IanJ's review of my perl code.
^ permalink raw reply [flat|nested] 23+ messages in thread* [PATCH 01 of 15 v2] Replace references to old wiki with ones to new 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-29 13:54 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 02 of 15 v2] docs: xlexample.hvm is missing "builder = 'hvm'" Ian Campbell ` (13 subsequent siblings) 14 siblings, 1 reply; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221956 0 # Node ID 732154549538fe983a8cc6ea74605e04e8ea0a64 # Parent 1027e7d13d02143048c7d48d7960967c5b1657a8 Replace references to old wiki with ones to new. I have confirmed that the relevant pages have been transitioned. What remains is pages which have not yet been moved over: $ rgrep xenwiki * docs/misc/xenstore.txt: See http://wiki.xensource.com/xenwiki/XenBus section tools/libxen/README:http://wiki.xensource.com/xenwiki/XenApi tools/xenballoon/xenballoond.README:http://wiki.xensource.com/xenwiki/Open_Topics_For_Discussion?action=AttachFile&do=get&target=Memory+Overcommit.pdf Note that "PythonInXlConfig" never existed in the old wiki and does not exist in the new. This reference was introduced by 22735:cb94dbe20f97 and was supposed to have been written prior to the 4.1 release. I have transitioned it anyway but it's not clear how valuable the message actually is. Perhaps we should just remove that aspect of it? Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 1027e7d13d02 -r 732154549538 README --- a/README Sun Nov 20 18:26:16 2011 +0100 +++ b/README Fri Nov 25 11:52:36 2011 +0000 @@ -61,10 +61,10 @@ provided by your OS distributor: Second, you need to acquire a suitable kernel for use in domain 0. If possible you should use a kernel provided by your OS distributor. If no suitable kernel is available from your OS distributor then refer to -http://wiki.xen.org/xenwiki/XenDom0Kernels for suggestions for +http://wiki.xen.org/wiki/XenDom0Kernels for suggestions for suitable kernels to use. If you are looking to compile a Dom0 kernel from source, please refer to -http://wiki.xensource.com/xenwiki/XenParavirtOps. +http://wiki.xensource.com/wiki/XenParavirtOps. [NB. Unless noted otherwise, all the following steps should be performed with root privileges.] diff -r 1027e7d13d02 -r 732154549538 docs/misc/vtd.txt --- a/docs/misc/vtd.txt Sun Nov 20 18:26:16 2011 +0100 +++ b/docs/misc/vtd.txt Fri Nov 25 11:52:36 2011 +0000 @@ -184,7 +184,7 @@ http://www.dell.com/content/products/cat - HP Compaq: DC7800 http://h10010.www1.hp.com/wwpc/us/en/en/WF04a/12454-12454-64287-321860-3328898.html -For more information, pls refer to http://wiki.xensource.com/xenwiki/VTdHowTo. +For more information, pls refer to http://wiki.xensource.com/wiki/VTdHowTo. Assigning devices to HVM domains diff -r 1027e7d13d02 -r 732154549538 docs/misc/xl-network-configuration.markdown --- a/docs/misc/xl-network-configuration.markdown Sun Nov 20 18:26:16 2011 +0100 +++ b/docs/misc/xl-network-configuration.markdown Fri Nov 25 11:52:36 2011 +0000 @@ -123,4 +123,4 @@ defaults to domain 0. Specifying another driver domain which is outside the scope of this document. [oui]: http://en.wikipedia.org/wiki/Organizationally_Unique_Identifier -[net]: http://wiki.xen.org/xenwiki/HostConfiguration/Networking +[net]: http://wiki.xen.org/wiki/HostConfiguration/Networking diff -r 1027e7d13d02 -r 732154549538 docs/src/interface.tex --- a/docs/src/interface.tex Sun Nov 20 18:26:16 2011 +0100 +++ b/docs/src/interface.tex Fri Nov 25 11:52:36 2011 +0000 @@ -1579,7 +1579,7 @@ This contains links to the latest versio documentation, including the latest version of the FAQ. Information regarding Xen is also available at the Xen Wiki at -\begin{quote} {\tt http://wiki.xensource.com/xenwiki/}\end{quote} +\begin{quote} {\tt http://wiki.xensource.com/wiki/}\end{quote} The Xen project uses Bugzilla as its bug tracking system. You'll find the Xen Bugzilla at http://bugzilla.xensource.com/bugzilla/. diff -r 1027e7d13d02 -r 732154549538 docs/src/user.tex --- a/docs/src/user.tex Sun Nov 20 18:26:16 2011 +0100 +++ b/docs/src/user.tex Fri Nov 25 11:52:36 2011 +0000 @@ -2349,7 +2349,7 @@ This contains links to the latest versio documentation, including the latest version of the FAQ. Information regarding Xen is also available at the Xen Wiki at -\begin{quote} {\tt http://wiki.xensource.com/xenwiki/}\end{quote} +\begin{quote} {\tt http://wiki.xensource.com/wiki/}\end{quote} The Xen project uses Bugzilla as its bug tracking system. You'll find the Xen Bugzilla at http://bugzilla.xensource.com/bugzilla/. diff -r 1027e7d13d02 -r 732154549538 tools/libxl/libxlu_cfg.c --- a/tools/libxl/libxlu_cfg.c Sun Nov 20 18:26:16 2011 +0100 +++ b/tools/libxl/libxlu_cfg.c Fri Nov 25 11:52:36 2011 +0000 @@ -72,7 +72,7 @@ static void parse(CfgParseContext *ctx) fputs( "warning: Config file looks like it contains Python code.\n" "warning: Arbitrary Python is no longer supported.\n" - "warning: See http://wiki.xen.org/xenwiki/PythonInXlConfig\n", + "warning: See http://wiki.xen.org/wiki/PythonInXlConfig\n", ctx->cfg->report); } } diff -r 1027e7d13d02 -r 732154549538 xen/common/sched_credit2.c --- a/xen/common/sched_credit2.c Sun Nov 20 18:26:16 2011 +0100 +++ b/xen/common/sched_credit2.c Fri Nov 25 11:52:36 2011 +0000 @@ -51,7 +51,7 @@ /* * WARNING: This is still in an experimental phase. Status and work can be found at the * credit2 wiki page: - * http://wiki.xensource.com/xenwiki/Credit2_Scheduler_Development + * http://wiki.xensource.com/wiki/Credit2_Scheduler_Development * TODO: * + Immediate bug-fixes * - Do per-runqueue, grab proper lock for dump debugkey ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 01 of 15 v2] Replace references to old wiki with ones to new 2011-11-25 14:49 ` [PATCH 01 of 15 v2] Replace references to old wiki with ones to new Ian Campbell @ 2011-11-29 13:54 ` Ian Campbell 0 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-29 13:54 UTC (permalink / raw) To: xen-devel@lists.xensource.com; +Cc: Ian Jackson On Fri, 2011-11-25 at 14:49 +0000, Ian Campbell wrote: > # HG changeset patch > # User Ian Campbell <ian.campbell@citrix.com> > # Date 1322221956 0 > # Node ID 732154549538fe983a8cc6ea74605e04e8ea0a64 > # Parent 1027e7d13d02143048c7d48d7960967c5b1657a8 > Replace references to old wiki with ones to new. Updated version switches the XenBus page too and also switches everything to wiki.xen.org instead of the xensource.com address. Please use this instead. 8<----------------------------------- # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322574811 0 # Node ID 4bdc0f7611d72d80b5d7efedc86fd70df06a6bbc # Parent a2cb7ed6d0a2ee5aecb3a988750ce9c8d8b718ee Replace references to old wiki with ones to new. I have confirmed that the relevant pages have been transitioned. What remains is pages which have not yet been moved over: $ rgrep xenwiki * tools/libxen/README:http://wiki.xensource.com/xenwiki/XenApi tools/xenballoon/xenballoond.README:http://wiki.xensource.com/xenwiki/Open_Topics_For_Discussion?action=AttachFile&do=get&target=Memory+Overcommit.pdf Note that "PythonInXlConfig" never existed in the old wiki and does not exist in the new. This reference was introduced by 22735:cb94dbe20f97 and was supposed to have been written prior to the 4.1 release. I have transitioned it anyway but it's not clear how valuable the message actually is. Perhaps we should just remove that aspect of it? Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 README --- a/README Mon Nov 28 17:42:40 2011 +0000 +++ b/README Tue Nov 29 13:53:31 2011 +0000 @@ -61,10 +61,10 @@ provided by your OS distributor: Second, you need to acquire a suitable kernel for use in domain 0. If possible you should use a kernel provided by your OS distributor. If no suitable kernel is available from your OS distributor then refer to -http://wiki.xen.org/xenwiki/XenDom0Kernels for suggestions for +http://wiki.xen.org/wiki/XenDom0Kernels for suggestions for suitable kernels to use. If you are looking to compile a Dom0 kernel from source, please refer to -http://wiki.xensource.com/xenwiki/XenParavirtOps. +http://wiki.xen.org/wiki/XenParavirtOps. [NB. Unless noted otherwise, all the following steps should be performed with root privileges.] diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 docs/misc/vtd.txt --- a/docs/misc/vtd.txt Mon Nov 28 17:42:40 2011 +0000 +++ b/docs/misc/vtd.txt Tue Nov 29 13:53:31 2011 +0000 @@ -184,7 +184,7 @@ http://www.dell.com/content/products/cat - HP Compaq: DC7800 http://h10010.www1.hp.com/wwpc/us/en/en/WF04a/12454-12454-64287-321860-3328898.html -For more information, pls refer to http://wiki.xensource.com/xenwiki/VTdHowTo. +For more information, pls refer to http://wiki.xen.org/wiki/VTdHowTo. Assigning devices to HVM domains diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 docs/misc/xenstore.txt --- a/docs/misc/xenstore.txt Mon Nov 28 17:42:40 2011 +0000 +++ b/docs/misc/xenstore.txt Tue Nov 29 13:53:31 2011 +0000 @@ -159,7 +159,7 @@ SET_PERMS <path>|<perm-as-string>|+? r<domid> read only b<domid> both read and write n<domid> no access - See http://wiki.xensource.com/xenwiki/XenBus section + See http://wiki.xen.org/wiki/XenBus section `Permissions' for details of the permissions system. ---------- Watches ---------- diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 docs/misc/xl-network-configuration.markdown --- a/docs/misc/xl-network-configuration.markdown Mon Nov 28 17:42:40 2011 +0000 +++ b/docs/misc/xl-network-configuration.markdown Tue Nov 29 13:53:31 2011 +0000 @@ -123,4 +123,4 @@ defaults to domain 0. Specifying another driver domain which is outside the scope of this document. [oui]: http://en.wikipedia.org/wiki/Organizationally_Unique_Identifier -[net]: http://wiki.xen.org/xenwiki/HostConfiguration/Networking +[net]: http://wiki.xen.org/wiki/HostConfiguration/Networking diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 docs/src/interface.tex --- a/docs/src/interface.tex Mon Nov 28 17:42:40 2011 +0000 +++ b/docs/src/interface.tex Tue Nov 29 13:53:31 2011 +0000 @@ -1579,7 +1579,7 @@ This contains links to the latest versio documentation, including the latest version of the FAQ. Information regarding Xen is also available at the Xen Wiki at -\begin{quote} {\tt http://wiki.xensource.com/xenwiki/}\end{quote} +\begin{quote} {\tt http://wiki.xen.org/wiki/}\end{quote} The Xen project uses Bugzilla as its bug tracking system. You'll find the Xen Bugzilla at http://bugzilla.xensource.com/bugzilla/. diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 docs/src/user.tex --- a/docs/src/user.tex Mon Nov 28 17:42:40 2011 +0000 +++ b/docs/src/user.tex Tue Nov 29 13:53:31 2011 +0000 @@ -2349,7 +2349,7 @@ This contains links to the latest versio documentation, including the latest version of the FAQ. Information regarding Xen is also available at the Xen Wiki at -\begin{quote} {\tt http://wiki.xensource.com/xenwiki/}\end{quote} +\begin{quote} {\tt http://wiki.xen.org/wiki/}\end{quote} The Xen project uses Bugzilla as its bug tracking system. You'll find the Xen Bugzilla at http://bugzilla.xensource.com/bugzilla/. diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 tools/libxl/libxlu_cfg.c --- a/tools/libxl/libxlu_cfg.c Mon Nov 28 17:42:40 2011 +0000 +++ b/tools/libxl/libxlu_cfg.c Tue Nov 29 13:53:31 2011 +0000 @@ -72,7 +72,7 @@ static void parse(CfgParseContext *ctx) fputs( "warning: Config file looks like it contains Python code.\n" "warning: Arbitrary Python is no longer supported.\n" - "warning: See http://wiki.xen.org/xenwiki/PythonInXlConfig\n", + "warning: See http://wiki.xen.org/wiki/PythonInXlConfig\n", ctx->cfg->report); } } diff -r a2cb7ed6d0a2 -r 4bdc0f7611d7 xen/common/sched_credit2.c --- a/xen/common/sched_credit2.c Mon Nov 28 17:42:40 2011 +0000 +++ b/xen/common/sched_credit2.c Tue Nov 29 13:53:31 2011 +0000 @@ -51,7 +51,7 @@ /* * WARNING: This is still in an experimental phase. Status and work can be found at the * credit2 wiki page: - * http://wiki.xensource.com/xenwiki/Credit2_Scheduler_Development + * http://wiki.xen.org/wiki/Credit2_Scheduler_Development * TODO: * + Immediate bug-fixes * - Do per-runqueue, grab proper lock for dump debugkey ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 02 of 15 v2] docs: xlexample.hvm is missing "builder = 'hvm'" 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell 2011-11-25 14:49 ` [PATCH 01 of 15 v2] Replace references to old wiki with ones to new Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 03 of 15 v2] README: add markdown to dependency list Ian Campbell ` (12 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221963 0 # Node ID 6d7ef8b8a5631f6324b14468ea0f458918f4ad77 # Parent 732154549538fe983a8cc6ea74605e04e8ea0a64 docs: xlexample.hvm is missing "builder = 'hvm'" This is rather critical... Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 732154549538 -r 6d7ef8b8a563 tools/examples/xlexample.hvm --- a/tools/examples/xlexample.hvm Fri Nov 25 11:52:36 2011 +0000 +++ b/tools/examples/xlexample.hvm Fri Nov 25 11:52:43 2011 +0000 @@ -5,6 +5,9 @@ # This is a fairly minimal example of what is required for an # HVM guest. For a more complete guide see <XXX Document TBD> +# This configures an HVM rather than PV guest +builder = "hvm" + # Guest name name = "example.hvm" ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 03 of 15 v2] README: add markdown to dependency list 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell 2011-11-25 14:49 ` [PATCH 01 of 15 v2] Replace references to old wiki with ones to new Ian Campbell 2011-11-25 14:49 ` [PATCH 02 of 15 v2] docs: xlexample.hvm is missing "builder = 'hvm'" Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 04 of 15 v2] docs: install html and txt versions of manpages Ian Campbell ` (11 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221966 0 # Node ID 224340062d194a2ef551402cdf79ecd92c34d8f3 # Parent 6d7ef8b8a5631f6324b14468ea0f458918f4ad77 README: add markdown to dependency list although this tool is strictly speaking optional we are providing various user docs in this format so increase the changes that they will install it. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 6d7ef8b8a563 -r 224340062d19 README --- a/README Fri Nov 25 11:52:43 2011 +0000 +++ b/README Fri Nov 25 11:52:46 2011 +0000 @@ -57,6 +57,7 @@ provided by your OS distributor: * GNU gettext * 16-bit x86 assembler, loader and compiler (dev86 rpm or bin86 & bcc debs) * ACPI ASL compiler (iasl) + * markdown Second, you need to acquire a suitable kernel for use in domain 0. If possible you should use a kernel provided by your OS distributor. If ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 04 of 15 v2] docs: install html and txt versions of manpages 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (2 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 03 of 15 v2] README: add markdown to dependency list Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax Ian Campbell ` (10 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221968 0 # Node ID 96479242221d8b58dde242442c47da2ab4c71a8f # Parent 224340062d194a2ef551402cdf79ecd92c34d8f3 docs: install html and txt versions of manpages Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 224340062d19 -r 96479242221d docs/Docs.mk --- a/docs/Docs.mk Fri Nov 25 11:52:46 2011 +0000 +++ b/docs/Docs.mk Fri Nov 25 11:52:48 2011 +0000 @@ -5,6 +5,8 @@ FIG2DEV := fig2dev LATEX2HTML := latex2html DOXYGEN := doxygen POD2MAN := pod2man +POD2HTML := pod2html +POD2TEXT := pod2text DOT := dot NEATO := neato MARKDOWN := markdown diff -r 224340062d19 -r 96479242221d docs/Makefile --- a/docs/Makefile Fri Nov 25 11:52:46 2011 +0000 +++ b/docs/Makefile Fri Nov 25 11:52:48 2011 +0000 @@ -15,9 +15,13 @@ DOC_MARKDOWN := $(wildcard misc/*.markdo DOC_PS := $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX)) DOC_PDF := $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX)) DOC_HTML := $(patsubst src/%.tex,html/%/index.html,$(DOC_TEX)) \ - $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) + $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) \ + $(patsubst man/%.pod.1,html/man/%.1.html,$(DOC_MAN1SRC)) \ + $(patsubst man/%.pod.5,html/man/%.5.html,$(DOC_MAN5SRC)) DOC_TXT := $(patsubst %.txt,txt/%.txt,$(wildcard misc/*.txt)) \ - $(patsubst %.markdown,txt/%.txt,$(DOC_MARKDOWN)) + $(patsubst %.markdown,txt/%.txt,$(DOC_MARKDOWN)) \ + $(patsubst man/%.pod.1,txt/man/%.1.txt,$(DOC_MAN1SRC)) \ + $(patsubst man/%.pod.5,txt/man/%.5.txt,$(DOC_MAN5SRC)) GFX = $(patsubst %.fig, %.eps, $(wildcard figs/*.fig)) @@ -76,7 +80,7 @@ clean: $(MAKE) -C xen-api clean rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~ rm -rf *.ilg *.log *.ind *.toc *.bak core - rm -rf $(GFX) ps pdf html + rm -rf $(GFX) ps pdf html txt rm -rf api rm -rf man5 rm -rf man1 @@ -132,6 +136,16 @@ html/%.html: %.markdown $(call move-if-changed,$@.tmp,$@) ; else \ echo "markdown not installed; skipping $*.html."; fi +html/man/%.1.html: man/%.pod.1 Makefile + $(INSTALL_DIR) $(@D) + $(POD2HTML) --infile=$< --outfile=$@.tmp + $(call move-if-changed,$@.tmp,$@) + +html/man/%.5.html: man/%.pod.5 Makefile + $(INSTALL_DIR) $(@D) + $(POD2HTML) --infile=$< --outfile=$@.tmp + $(call move-if-changed,$@.tmp,$@) + txt/%.txt: %.txt $(INSTALL_DIR) $(@D) cp $< $@.tmp @@ -141,3 +155,14 @@ txt/%.txt: %.markdown $(INSTALL_DIR) $(@D) cp $< $@.tmp $(call move-if-changed,$@.tmp,$@) + +txt/man/%.1.txt: man/%.pod.1 Makefile + $(INSTALL_DIR) $(@D) + $(POD2TEXT) $< $@.tmp + $(call move-if-changed,$@.tmp,$@) + +txt/man/%.5.txt: man/%.pod.5 Makefile + $(INSTALL_DIR) $(@D) + $(POD2TEXT) $< $@.tmp + $(call move-if-changed,$@.tmp,$@) + ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (3 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 04 of 15 v2] docs: install html and txt versions of manpages Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 15:05 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 06 of 15 v2] xl: the name field in a guest config file is mandatory Ian Campbell ` (9 subsequent siblings) 14 siblings, 1 reply; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221975 0 # Node ID 08a74d202a0a5b19b1229da893526856d832807b # Parent 96479242221d8b58dde242442c47da2ab4c71a8f docs: add a document describing the xl cfg file syntax Based on an initial version by Ian Jackson. I believe that all keys are now present in the document although there are are various omissions in the actual documentation of them. Hopefully however this covers the majority of the most interesting keys. Spice section: Signed-off-by: Zhou Peng <zhoupeng@nfs.iscas.ac.cn> The rest: Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 96479242221d -r 08a74d202a0a docs/man/xl.cfg.pod.5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/xl.cfg.pod.5 Fri Nov 25 11:52:55 2011 +0000 @@ -0,0 +1,844 @@ +=head1 NAME + +xl.cfg - XL Domain Configuration File Syntax + +=head1 SYNOPSIS + + /etc/xen/xldomain + +=head1 DESCRIPTION + +To create a VM (a domain in Xen terminology, sometimes called a guest) +with xl requires the provision of a domain config file. Typically +these live in `/etc/xen/DOMAIN.cfg` where DOMAIN is the name of the +domain. + +=head1 SYNTAX + +A domain config file consists of a series of C<KEY=VALUE> pairs. + +Some C<KEY>s are mandatory, others are global options which apply to +any guest type while others relate only to specific guest types +(e.g. PV or HVM guests). + +A value C<VALUE> is one of: + +=over 4 + +=item B<"STRING"> + +A string, surrounded by either single or double quotes. + +=item B<NUMBER> + +A number, in either decimal, octal (using a C<0> prefix) or +hexadecimal (using an C<0x> prefix). + +=item B<BOOLEAN> + +A C<NUMBER> interpreted as C<False> (C<0>) or C<True> (any other +value). + +=item B<[ VALUE, VALUE, ... ]> + +A list of C<VALUES> of the above types. Lists are homogeneous and are +not nested. + +=back + +The semantics of each C<KEY> defines which form of C<VALUE> is required. + +=head1 OPTIONS + +=head2 Mandatory Configuration Items + +The following key is mandatory for any guest type: + +=over 4 + +=item B<name="NAME"> + +Specifies the name of the domain. Names of domains existing on a +single host must be unique. + +=back + +=head2 Selecting Guest Type + +=over 4 + +=item B<builder="generic"> + +Specifies that this is to be a PV domain. This is the default. + +=item B<builder="hvm"> + +Specifies that this is to be an HVM domain. That is, a fully +virtualised computer with emulated BIOS, disk and network peripherals, +etc. The default is a PV domain, suitable for hosting Xen-aware guest +operating systems. + +=back + +=head2 Global Options + +The following options apply to guests of any type. + +=over 4 + +=item B<uuid="UUID"> + +Specifies the UUID of the domain. If not specified, a fresh unique +UUID will be generated. + +=item B<pool="CPUPOOLNAME"> + +Put the guest's vcpus into the named cpu pool. + +=item B<vcpus=N> + +Start the guest with N vcpus initially online. + +=item B<maxvcpus=M> + +Allow the guest to bring up a maximum of M vcpus. At start of day if +`vcpus=N` is less than `maxvcpus=M` then the first `N` vcpus will be +created online and the remainder will be offline. + +=item B<memory=MBYTES> + +Start the guest with MBYTES megabytes of RAM. + +=item B<on_poweroff="ACTION"> + +Specifies what should be done with the domain if it shuts itself down. +The C<ACTION>s are: + +=over 4 + +=item B<destroy> + +destroy the domain + +=item B<restart> + +destroy the domain and immediately create a new domain with the same +configuration + +=item B<rename-restart> + +rename the domain which terminated, and thenimmediately create a new +domain with the same configuration as the original + +=item B<preserve> + +keep the domain. It can be examined, and later destroyed with `xl +destroy`. + +=item B<coredump-destroy> + +write a "coredump" of the domain to F</var/xen/dump/NAME> and then +destroy the domain. + +=item B<coredump-restart> + +write a "coredump" of the domain to F</var/xen/dump/NAME> and then +restart the domain. + +=back + +The default for C<on_poweroff> is C<destroy>. + +=item B<on_reboot="ACTION"> + +Action to take if the domain shuts down with a reason code requesting +a reboot. Default is C<restart>. + +=item B<on_watchdog="ACTION"> + +Action to take if the domain shuts down due to a Xen watchdog timeout. +Default is C<destroy>. + +=item B<on_crash="ACTION"> + +Action to take if the domain crashes. Default is C<destroy>. + +=item B<seclabel="LABEL"> + +Assign an XSM security label to this domain. + +=back + +=head2 Devices + +The following options define the paravirtual, emulated and physical +devices which the guest will contain. + +=over 4 + +=item B<disk=[ "DISK_SPEC_STRING", "DISK_SPEC_STRING", ...]> + +Specifies the disks (both emulated disks and Xen virtual block +devices) which are to be provided to the guest, and what objects on +the they should map to. See F<docs/misc/xl-disk-configuration.txt>. + +=item B<vif=[ "NET_SPEC_STRING", "NET_SPEC_STRING", ...]> + +Specifies the networking provision (both emulated network adapters, +and Xen virtual interfaces) to provided to the guest. See +F<docs/misc/xl-network-configuration.markdown>. + +=item B<vfb=[ "VFB_SPEC_STRING", "VFB_SPEC_STRING", ...]> + +Specifies the paravirtual framebuffer devices which should be supplied +to the domain. + +This options does not control the emulated graphics card presented to +an HVM guest. See L<Emulated VGA Graphics Device> below for how to +configure the emulated device. + +Each B<VFB_SPEC_STRING> is a comma-separated list of C<KEY=VALUE> +settings, from the following list: + +=over 4 + +=item C<vnc=BOOLEAN> + +Allow access to the display via the VNC protocol. This enables the +other VNC-related settings. The default is to enable this. + +=item C<vnclisten="ADDRESS[:DISPLAYNUM]"> + +Specifies the IP address, and optionally VNC display number, to use. + +=item C<vncdisplay=DISPLAYNUM> + +Specifies the VNC display number to use. The actual TCP port number +will be DISPLAYNUM+5900. + +=item C<vncunused=BOOLEAN> + +Requests that the VNC display setup search for a free TCP port to use. +The actual display used can be accessed with C<xl vncviewer>. + +=item C<vncpasswd="PASSWORD"> + +Specifies the password for the VNC server. + +=item C<sdl=BOOLEAN> + +Specifies that the display should be presented via an X window (using +Simple DirectMedia Layer). The default is to not enable this mode + +=item C<opengl=BOOLEAN> + +Enable OpenGL acceleration of the SDL display. Only effects machines +using C<device_model_version="qemu-xen-traditonal"> and only if the +device-model was compiled with OpenGL support. Disabled by default. + +=item C<keymap="LANG"> + +Configure the keymap to use for the keyboard associated with this +display. If the input method does not easily support raw keycodes +(e.g. this is often the case when using VNC) then this allows us to +correctly map the input keys into keycodes seen by the guest. The +specific values which are accepted are defined by the version of the +device-model which you are using. See L<Keymaps> below or consult the +L<qemu(1)> manpage. The default is B<en-us>. + +=item C<display=XXX> + +XXX written to xenstore backend for vfb but does not appear to be used +anywhere? + +=item C<authority=XXX> + +XXX written to xenstore backend for vfb but does not appear to be used +anywhere? + +=back + +=item B<pci=[ "PCI_SPEC_STRING", "PCI_SPEC_STRING", ... ]> + +Specifies the host PCI devices to passthrough to this guest. Each B<PCI_SPEC_STRING> +has the form C<[DDDD:]BB:DD.F[@VSLOT],KEY=VALUE,KEY=VALUE,...> where: + +=over 4 + +=item B<DDDD:BB:DD.F> + +identifies the PCI device from the host perspective in domain +(B<DDDD>), Bus (B<BB>), Device (B<DD>) and Function (B<F>) syntax. This is +the same scheme as used in the output of C<lspci> for the device in +question. Note: By default C<lspci> will omit the domain (B<DDDD>) if it +is zero and it is optional here also. You may specify the function +(B<F>) as B<*> to indicate all functions. + +=item B<@VSLOT> + +specifies the virtual device where the guest will see this +device. This is equivalent to the B<DD> which the guest sees. In a +guest B<DDDD> and B<BB> are C<0000:00>. XXX how does this really work? + +=item B<KEY=VALUE> + +Posible B<KEY>s are: + +=over 4 + +=item B<msitranslate=BOOLEAN> + +XXX + +=item B<power_mgmt=BOOLEAN> + +XXX + +=back + +=back + +=back + +=head2 Paravirtualised (PV) Guest Specific Options + +The following options apply only to Paravirtual guests. + +=over 4 + +=item B<kernel="PATHNAME"> + +Load the specified file as the kernel image. Either B<kernel> or +B<bootloader> must be specified for PV guests. + +=item B<ramdisk="PATHNAME"> + +Load the specified file as the ramdisk. + +=item B<bootloader="PROGRAM"> + +Run C<PROGRAM> to find the kernel image and ramdisk to use. Normally +C<PROGRAM> would be C<pygrub>, which is an emulation of +grub/grub2/syslinux. + +=item B<bootloader_args=STRING> + +Append B<STRING> (split into words at whitespace) to the arguments to +the B<bootloader> program. XXX this should be a list of strings. + +=item B<root="STRING"> + +Append B<root="STRING"> to the kernel command line (Note: it is guest +specific what meaning this has). + +=item B<extra="STRING"> + +Append B<STRING> to the kernel command line. Note: it is guest +specific what meaning this has). + +=item B<e820_host=BOOLEAN> + +Selects whether to expose the host e820 (memory map) to the guest via +the virtual e820. When this option is false the guest psuedo-physical +address space consists of a single contiguous RAM region. When this +option is specified the virtual e820 instead reflects the host e820 +and contains the same PCI holes. The total amount of RAM represented +by the memory map is always the same, this option configures only how +it is layed out. + +Exposing the host e820 to the guest gives the guest kernel the +opportunity to set aside the required part of its pseudo-physical +address space in order to provide address space to map passedthrough +PCI devices. It is guest Operaring System dependant whether this +option is required, specifically it is required when using a mainline +Linux ("pvops") kernel. This option defaults to true if any PCI +passthrough devices are configued and false otherwise. If you do not +configure any passthrough devices at domain creation time but expect +to hotplug devices later then you should set this option. Conversely +if your particular guest kernel does not require this behaviour then +it is safe to allow this to be enabled but you may wish to disable it +anyway. + +=back + +=head2 Fully-virtualised (HVM) Guest Specific Options + +The following options apply only to HVM guests. + +=head3 Boot Device + +=over 4 + +=item B<boot=[c|d|n]> + +Selects the emulated virtual device to boot from. Options are hard +disk (B<c>), cd-rom (B<d>) or network/PXE (B<n>). Multiple options can be +given and will be attempted in the order they are given. e.g. to boot +from cd-rom but fallback to the hard disk you can give B<dc>. The +default is B<cd>. + +=back + +=head3 Paging + +The following options control the mechanisms used to virtualise guest +memory. The defaults are selected to give the best results for the +common case and so you should normally leave these options +unspecified. + +=over 4 + +=item B<hap=BOOLEAN> + +Turns "hardware assisted paging" (the use of the hardware nested page +table feature) on or off. This feature is called EPT (Extended Page +Tables) by Intel and NPT (Nested Page Tables) or RVI (Rapid +Virtualisation Indexing) by AMD. Affects HVM guests only. If turned +off, Xen will run the guest in "shadow page table" mode where the +guest's page table updates and/or TLB flushes etc. will be emulated. +Use of HAP is the default when available. + +=item B<oos=BOOLEAN> + +Turns "out of sync pagetables" on or off. When running in shadow page +table mode, the guest's page table updates may be deferred as +specified in the Intel/AMD architecture manuals. However this may +expose unexpected bugs in the guest, or find bugs in Xen, so it is +possible to disable this feature. Use of out of sync page tables, +when Xen thinks it appropriate, is the default. + +=item B<shadow_memory=MBYTES> + +Number of megabytes to set aside for shadowing guest pagetable pages +(effectively acting as a cache of translated pages) or to use for HAP +state. By default this is 1MB per guest vcpu plus 8KB per MB of guest +RAM. You should not normally need to adjust this value. However if you +are not using hardware assisted paging (i.e. you are using shadow +mode) and your guest workload consists of a a very large number of +similar processes then increasing this value may improve performance. + +=back + +=head3 Processor and Platform Features + +The following options allow various processor and platform level +features to be hidden or exposed from the guest's point of view. This +can be useful when running older guest Operating Systems which may +misbehave when faced with more modern features. In general you should +accept the defaults for these options wherever possible. + +=over 4 + +=item B<pae=BOOLEAN> + +Hide or expose the IA32 Physical Address Extensions. These extensions +make it possible for a 32 bit guest Operating System to access more +than 4GB of RAM. Enabling PAE also enabled other features such as +NX. PAE is required if you wish to run a 64-bit guest Operating +System. In general you should leave this enabled and allow the guest +Operating System to choose whether or not to use PAE. (X86 only) + +=item B<acpi=BOOLEAN> + +Expose ACPI (Advanced Configuration and Power Interface) tables from +the virtual firmware to the guest Operating System. ACPI is required +by most modern guest Operating Systems. This option is enabled by +default and usually you should omit it. However it may be necessary to +disable ACPI for compatibility with some guest Operating Systems. + +=item B<apic=BOOLEAN> + +Include information regarding APIC (Advanced Programmable Interrupt +Controller) in the firmware/BIOS tables on a single processor +guest. This causes the MP (multiprocessor) and PIR (PCI Interrupt +Routing) tables to be exported by the virtual firmware. This option +has no effect on a guest with multiple virtual CPUS as they must +always include these tables. This option is enabled by default and you +should usually omit it but it may be necessary to disable these +firmware tables when using certain older guest Operating +Systems. These tables have been superceded by newer constructs within +the ACPI tables. (X86 only) + +=item B<nx=BOOLEAN> + +Hides or exposes the No-eXecute capability. This allows a guest +Operating system to map pages such that they cannot be executed which +can enhance security. This options requires that PAE also be +enabled. (X86 only) + +=item B<hpet=BOOLEAN> + +Enables or disables HPET (High Precision Event Timer). This option is +enabled by default and you should usually omit it. It may be necessary +to disable the HPET in order to improve compatibility with guest +Operating Systems (X86 only) + +=item B<nestedhvm=BOOLEAN> + +Enable or disables guest access to hardware virtualisation features, +e.g. it allows a guest Operating System to also function as a +hypervisor. This option is disabled by default. You may want this +option if you want to run another hypervisor (including another copy +of Xen) within a Xen guest or to support a guest Operating System +which uses hardware virtualisation extensions (e.g. Windows XP +compatibility mode on more modern Windows OS). + +=back + +=head3 Guest Virtual Time Controls + +=over 4 + +=item B<tsc_mode="MODE"> + +Specifies how the TSC (Time Stamp Counter) should be provided to the +guest. XXX ??? + +=back + +=head3 Support for Paravirtualisation of HVM Guests + +The following options allow Paravirtualised features (such as devices) +to be exposed to the guest Operating System in an HVM guest. +Utilising these features requires specific guest support but when +available they will result in improved performance. + +=over 4 + +=item B<xen_platform_pci=BOOLEAN> + +Enable or disable the Xen platform PCI device. The presence of this +virtual device enables a guest Operating System (subject to the +availability of suitable drivers) to make use of paravirtualisation +features such as disk and network devices etc. Enabling these drivers +improves performance and is strongly recommended when available. PV +drivers are available for various Operating Systems including HVM +Linux L<http://wiki.xen.org/wiki/XenLinuxPVonHVMdrivers> and Microsoft +Windows L<http://wiki.xen.org/wiki/XenWindowsGplPv>. + +=item B<viridian=BOOLEAN> + +Turns on or off the exposure of MicroSoft Hyper-V (AKA viridian) +compatible enlightenments to the guest. These can improve performance +of Microsoft Windows guests (XXX which versions of Windows benefit?) + +=back + +=head3 Emulated VGA Graphics Device + +The following options control the features of the emulated graphics +device. Many of these options behave similarly to the equivalent key +in the B<VFB_SPEC_STRING> for configuring virtual frame buffer devices +(see above). + +=over 4 + +=item B<videoram=MBYTES> + +Sets the amount of RAM which the emulated video card will contain, +which in turn limits the resolutions and bit depths which will be +available. This option is only available when using the B<stdvga> +option (see below). The default is 8MB which is sufficient for +e.g. 1600x1200 at 32bpp. When not using the B<stdvga> option the +amount of video ram is fixed at 4MB which is sufficient for 1024x768 +at 32 bpp. + +=item B<stdvga=BOOLEAN> + +Select a standard VGA card with VBE (VESA BIOS Extensions) as the +emulated graphics device. The default is false which means to emulate +a Cirrus Logic GD5446 VGA card. If your guest supports VBE 2.0 or +later (e.g. Windows XP onwards) then you should enable this. + +=item B<vnc=BOOLEAN> + +Allow access to the display via the VNC protocol. This enables the +other VNC-related settings. The default is to enable this. + +=item B<vnclisten="ADDRESS[:DISPLAYNUM]"> + +Specifies the IP address, and optionally VNC display number, to use. + +=item B<vncdisplay=DISPLAYNUM> + +Specifies the VNC display number to use. The actual TCP port number +will be DISPLAYNUM+5900. + +=item B<vncunused=BOOLEAN> + +Requests that the VNC display setup search for a free TCP port to use. +The actual display used can be accessed with C<xl vncviewer>. + +=item B<vncpasswd="PASSWORD"> + +Specifies the password for the VNC server. + +=item B<keymap="LANG"> + +Configure the keymap to use for the keyboard associated with this +display. If the input method does not easily support raw keycodes +(e.g. this is often the case when using VNC) then this allows us to +correctly map the input keys into keycodes seen by the guest. The +specific values which are accepted are defined by the version of the +device-model which you are using. See L<Keymaps> below of consult the +L<qemu(1)> manpage. The default is B<en-us>. + +=item B<sdl=BOOLEAN> + +Specifies that the display should be presented via an X window (using +Simple DirectMedia Layer). The default is not to enable this mode. + +=item B<opengl=BOOLEAN> + +Enable OpenGL acceleration of the SDL display. Only effects machines +using B<device_model_version="qemu-xen-traditonal"> and only if the +device-model was compiled with OpenGL support. Disabled by default. + +=item B<nographic=BOOLEAN> + +Enable or disable the virtual graphics device. The default is to +provide a VGA graphics device but this option can be used to disable +it. + +=back + +=head3 Spice Graphics Support + +The following options control the features of SPICE. + +=over 4 + +=item B<spice=BOOLEAN> + +Allow access to the display via the SPICE protocol. This enables the +other SPICE-related settings. + +=item B<spicehost="ADDRESS"> + +Specify the interface address to listen on if given, otherwise any +interface. + +=item B<spiceport=NUMBER> + +Specify the port to listen on by the SPICE server if the SPICE is +enabled. + +=item B<spicetls_port=NUMBER> + +Specify the secure port to listen on by the SPICE server if the SPICE +is enabled. At least one of the spiceport or spicetls_port must be +given if SPICE is enabled. NB. the options depending on spicetls_port +have not been supported. + +=item B<spicedisable_ticketing=BOOLEAN> + +Enable client connection without password. The default is false. If +it's false (set to 0), spicepasswd must be set. + +=item B<spicepasswd="PASSWORD"> + +Specify the ticket password which is used by a client for connection. + +=item B<spiceagent_mouse=BOOLEAN> + +Whether SPICE agent is used for client mouse mode. The default is true +(turn on) + +=back + +=head3 Miscellaneous Emulated Hardware + +=over 4 + +=item B<serial=DEVICE> + +Redirect the virtual serial port to B<DEVICE>. Please see the +B<-serial> option in the L<qemu(1)> manpage for details of the valid +B<DEVICE> options. Default is B<vc> when in graphical mode and +B<stdio> if B<nographics=1> is used. + +=item B<soundhw=DEVICE> + +Select the virtual sound card to expose to the guest. The valid +devices are defined by the device model configuration, please see the +L<qemu(1)> manpage for details. The default is not to export any sound +device. + +=item B<usb=BOOLEAN> + +Enables or disables a USB bus in the guest. + +=item B<usbdevice=DEVICE> + +Adds B<DEVICE> to the USB bus. The USB bus must also be enabled using +B<usb=1>. The most common use for this option is B<usbdevice=tablet> +which adds pointer device using absolute coordinates. Such devices +function better than relative coordinate devices (such as a standard +mouse) since many methods of exporting guest graphics (such as VNC) +work better in this mode. Note that this is independent of the actual +pointer device you are using on the host/client side. XXX should/could +be a list of devices. + +=back + +=head3 Unclassified HVM Specific Options + +These HVM specific options have not yet been documented or +classified. They almost certainly belong in a more appropriate +section. + +=over 4 + +=item B<vpt_align=BOOLEAN> + +Align the Virtual Platform Timer ??? XXX Reduces interrupts? + +=item B<timer_mode=NUMBER> + +Set mode for Virtual Timers XXX ??? should be an enum of particular +values. See C<HVM_PARAM_TIMER_MODE> in +F<xen/include/public/hvm/params.h>. + +=back + +=head2 Device-Model Options + +The following options control the selection of the device-model. This +is the component which provides emulation of the virtual devices to an +HVM guest. For a PV guest a device-model is sometimes used to provide +backends for certain PV devices (most usually a virtual framebuffer +device). + +=over 4 + +=item B<device_model_version="DEVICE-MODEL"> + +Selects which variant of the device-model should be used for this +guest. Valid values are: + +=over 4 + +=item B<qemu-xen-traditional> + +Use the device-model based upon the historical Xen fork of Qemu. This +device-model is currently the default. + +=item B<qemu-xen> + +use the device-model merged into the upstream Qemu project. This +device-model will become the default in a future version of Xen. + +=back + +It is recommended to accept the default value for new guests. If +you have existing guests then, depeending on the nature of the guest +Operating System, you may wish to force them to use the device +model which they were installed with. + +=item B<device_model_override="PATH"> + +Override the path to the binary to be used as the device-model. The +binary provided here MUST be consistent with the +`device_model_version` which you have specified. You should not +normally need to specify this option. + +=item B<device_model_stubdomain_override=BOOLEAN> + +Override the use of stubdomain based device-model. Normally this will +be automatically selected based upon the other features and options +you have selected. + +=item B<device_model_args=[ "ARG", "ARG", ...]> + +Pass additional arbitrary options on the devide-model command +line. Each element in the list is passed as an option to the +device-model. + +=item B<device_model_args_pv=[ "ARG", "ARG", ...]> + +Pass additional arbitrary options on the devide-model command line for +a PV device model only. Each element in the list is passed as an +option to the device-model. + +=item B<device_model_args_hvm=[ "ARG", "ARG", ...]> + +Pass additional arbitrary options on the devide-model command line for +an HVM device model only. Each element in the list is passed as an +option to the device-model. + +=back + +=head2 Unclassified General Options + +These have not yet been fully documented or classified. They almost +certainly belong in a more appropriate section. + +=over 4 + +=item B<gfx_passthrough=BOOLEAN> + +Enable graphics device PCI passthrough. XXX which device is passed through ? + +=item B<nomigrate=BOOLEAN> + +Disable migration of this domain. This enables certain other features +which are incompatible with migration (currently certain TSC modes XXX +?). + +=item B<pci_msitranslate=BOOLEAN> + +XXX + +=item B<pci_power_mgmt=BOOLEAN> + +XXX + +=item B<cpuid=XXX> + +XXX + +=back + +=head2 Keymaps + +The keymaps available are defined by the device-model which you are +using. Commonly this includes: + + ar de-ch es fo fr-ca hu ja mk no pt-br sv + da en-gb et fr fr-ch is lt nl pl ru th + de en-us fi fr-be hr it lv nl-be pt sl tr + +The default is B<en-us>. + +See L<qemu(1)> for more information. + +=head1 SEE ALSO + +=over 4 + +=item L<xl(1)> + +=item F<xl-disk-configuration> + +=item F<xl-network-configuration> + +=back + +=head1 FILES + +F</etc/xen/NAME.cfg> +F</var/xen/dump/NAME> +F<docs/misc/tscmode.txt> + +=head1 BUGS + +This document is a work in progress and contains items which require +further documentation and which are generally incomplete (marked with +XXX). However all options are included here whether or not they are +fully documented. + +Patches to improve incomplete items (or any other item) would be +greatfully received on the xen-devel@lists.xensource.com mailing +list. Please see L<http://wiki.xen.org/wiki/SubmittingXenPatches> for +information on how to submit a patch to Xen. + diff -r 96479242221d -r 08a74d202a0a docs/man/xl.pod.1 --- a/docs/man/xl.pod.1 Fri Nov 25 11:52:48 2011 +0000 +++ b/docs/man/xl.pod.1 Fri Nov 25 11:52:55 2011 +0000 @@ -54,7 +54,7 @@ previously, most commands take I<domain- =item B<create> [I<OPTIONS>] I<configfile> -The create subcommand requires a config file: see L<xldomain.cfg> for +The create subcommand requires a config file: see L<xl.cfg(5)> for full details of that file format and possible options. I<configfile> can either be an absolute path to a file, or a relative @@ -232,7 +232,7 @@ FIXME: Why would you ever see this state The domain has crashed, which is always a violent ending. Usually this state can only occur if the domain has been configured not to -restart on crash. See L<xldomain.cfg> for more info. +restart on crash. See L<xl.cfg(5)> for more info. =item B<d - dying> @@ -319,8 +319,8 @@ executed the reboot action, which may be domain actually reboots. The behavior of what happens to a domain when it reboots is set by the -B<on_reboot> parameter of the xldomain.cfg file when the domain was -created. +B<on_reboot> parameter of the domain configuration file when the +domain was created. =item B<restore> [I<OPTIONS>] [I<ConfigFile>] I<CheckpointFile> @@ -372,8 +372,8 @@ services must be shutdown in the domain. immediately after signally the domain unless that B<-w> flag is used. The behavior of what happens to a domain when it reboots is set by the -B<on_shutdown> parameter of the xldomain.cfg file when the domain was -created. +B<on_shutdown> parameter of the domain configuration file when the +domain was created. B<OPTIONS> @@ -699,7 +699,7 @@ The domain id of the guest domain that t =item I<disc-spec-component> A disc specification in the same format used for the B<disk> variable in -the domain config file. See L<xldomain.cfg>. +the domain config file. See F<xl-disk-configuration>. =back @@ -733,9 +733,9 @@ How the device should be presented to th =item I<be-dev> -the device in the backend domain (usually domain 0) to be exported; it can be a -path to a file (file://path/to/file.iso). See B<disk> in L<xldomain.cfg> for the -details. +the device in the backend domain (usually domain 0) to be exported; it +can be a path to a file (file://path/to/file.iso). See B<disk> in +L<xl.cfg(5)> for the details. =back @@ -754,7 +754,7 @@ I<VirtualDevice> is the cdrom device in Creates a new network device in the domain specified by I<domain-id>. I<network-device> describes the device to attach, using the same format as the -B<vif> string in the domain config file. See L<xldomain.cfg> for the +B<vif> string in the domain config file. See L<xl.cfg(5)> for the description. =item B<network-detach> I<domain-id> I<devid|mac> @@ -795,7 +795,7 @@ List pass-through pci devices for a doma =head1 SEE ALSO -B<xldomain.cfg>(5), B<xlcpupool.cfg>(5), B<xentop>(1) +L<xl.cfg(5)>, L<xlcpupool.cfg(5)>, B<xentop(1)> =head1 AUTHOR diff -r 96479242221d -r 08a74d202a0a tools/examples/xlexample.hvm --- a/tools/examples/xlexample.hvm Fri Nov 25 11:52:48 2011 +0000 +++ b/tools/examples/xlexample.hvm Fri Nov 25 11:52:55 2011 +0000 @@ -3,7 +3,7 @@ # ===================================================================== # # This is a fairly minimal example of what is required for an -# HVM guest. For a more complete guide see <XXX Document TBD> +# HVM guest. For a more complete guide see xl.cfg(5) # This configures an HVM rather than PV guest builder = "hvm" diff -r 96479242221d -r 08a74d202a0a tools/examples/xlexample.pvlinux --- a/tools/examples/xlexample.pvlinux Fri Nov 25 11:52:48 2011 +0000 +++ b/tools/examples/xlexample.pvlinux Fri Nov 25 11:52:55 2011 +0000 @@ -3,7 +3,7 @@ # ===================================================================== # # This is a fairly minimal example of what is required for a -# Paravirtualised Linux guest. For a more complete guide see <XXX Document TBD> +# Paravirtualised Linux guest. For a more complete guide see xl.cfg(5) # Guest name name = "example.pvlinux" ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax 2011-11-25 14:49 ` [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax Ian Campbell @ 2011-11-25 15:05 ` Ian Campbell 2011-11-25 15:16 ` Paul Durrant 0 siblings, 1 reply; 23+ messages in thread From: Ian Campbell @ 2011-11-25 15:05 UTC (permalink / raw) To: xen-devel@lists.xensource.com; +Cc: Paul Durrant, Ian Jackson Paul, On Fri, 2011-11-25 at 14:49 +0000, Ian Campbell wrote: > > +=item B<viridian=BOOLEAN> > + > +Turns on or off the exposure of MicroSoft Hyper-V (AKA viridian) > +compatible enlightenments to the guest. These can improve > performance > +of Microsoft Windows guests (XXX which versions of Windows benefit?) Is there anything else we can say here? What are the first versions of Windows which benefit from this? Ian. ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax 2011-11-25 15:05 ` Ian Campbell @ 2011-11-25 15:16 ` Paul Durrant 2011-11-25 16:39 ` Ian Campbell 0 siblings, 1 reply; 23+ messages in thread From: Paul Durrant @ 2011-11-25 15:16 UTC (permalink / raw) To: Ian Campbell, xen-devel@lists.xensource.com; +Cc: Ian Jackson > -----Original Message----- > From: Ian Campbell > Sent: 25 November 2011 15:06 > To: xen-devel@lists.xensource.com > Cc: Ian Jackson; Paul Durrant > Subject: Re: [Xen-devel] [PATCH 05 of 15 v2] docs: add a document > describing the xl cfg file syntax > > Paul, > > On Fri, 2011-11-25 at 14:49 +0000, Ian Campbell wrote: > > > > +=item B<viridian=BOOLEAN> > > + > > +Turns on or off the exposure of MicroSoft Hyper-V (AKA viridian) > > +compatible enlightenments to the guest. These can improve > > performance > > +of Microsoft Windows guests (XXX which versions of Windows > benefit?) > > Is there anything else we can say here? What are the first versions > of Windows which benefit from this? > Ian, I think that's probably good enough. AFAIK viridian enlightenments came in with the 6.0 kernel in Vista/2K8 but having the flag on should do no harm for older kernels. Paul ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax 2011-11-25 15:16 ` Paul Durrant @ 2011-11-25 16:39 ` Ian Campbell 2011-11-25 17:06 ` Paul Durrant 0 siblings, 1 reply; 23+ messages in thread From: Ian Campbell @ 2011-11-25 16:39 UTC (permalink / raw) To: Paul Durrant; +Cc: xen-devel@lists.xensource.com, Ian Jackson On Fri, 2011-11-25 at 15:16 +0000, Paul Durrant wrote: > > -----Original Message----- > > From: Ian Campbell > > Sent: 25 November 2011 15:06 > > To: xen-devel@lists.xensource.com > > Cc: Ian Jackson; Paul Durrant > > Subject: Re: [Xen-devel] [PATCH 05 of 15 v2] docs: add a document > > describing the xl cfg file syntax > > > > Paul, > > > > On Fri, 2011-11-25 at 14:49 +0000, Ian Campbell wrote: > > > > > > +=item B<viridian=BOOLEAN> > > > + > > > +Turns on or off the exposure of MicroSoft Hyper-V (AKA viridian) > > > +compatible enlightenments to the guest. These can improve > > > performance > > > +of Microsoft Windows guests (XXX which versions of Windows > > benefit?) > > > > Is there anything else we can say here? What are the first versions > > of Windows which benefit from this? > > > > Ian, > > I think that's probably good enough. AFAIK viridian enlightenments > came in with the 6.0 kernel in Vista/2K8 but having the flag on should > do no harm for older kernels. How about this incremental patch? diff -r b4c07fbe3557 docs/man/xl.cfg.pod.5 --- a/docs/man/xl.cfg.pod.5 Fri Nov 25 15:11:30 2011 +0000 +++ b/docs/man/xl.cfg.pod.5 Fri Nov 25 15:23:14 2011 +0000 @@ -555,7 +555,13 @@ Windows L<http://wiki.xen.org/wiki/XenWi Turns on or off the exposure of MicroSoft Hyper-V (AKA viridian) compatible enlightenments to the guest. These can improve performance -of Microsoft Windows guests (XXX which versions of Windows benefit?) +of Microsoft Windows guests from Windows Vista and Windows 2008 +onwards and setting this option for such guests is strongly +recommended. This option should be harmless for other versions of +Windows (although it won't give any benefit) and the majority of other +non-Windows OSes. However it is known to be incompatible with some +other Operating Systems and in some circumstance can prevent Xen's own +paravirtualisation interfaces for HVM guests from being used. =back ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax 2011-11-25 16:39 ` Ian Campbell @ 2011-11-25 17:06 ` Paul Durrant 0 siblings, 0 replies; 23+ messages in thread From: Paul Durrant @ 2011-11-25 17:06 UTC (permalink / raw) To: Ian Campbell; +Cc: xen-devel@lists.xensource.com, Ian Jackson Looks ok to me. Paul > -----Original Message----- > From: Ian Campbell > Sent: 25 November 2011 16:39 > To: Paul Durrant > Cc: xen-devel@lists.xensource.com; Ian Jackson > Subject: RE: [Xen-devel] [PATCH 05 of 15 v2] docs: add a document > describing the xl cfg file syntax > > On Fri, 2011-11-25 at 15:16 +0000, Paul Durrant wrote: > > > -----Original Message----- > > > From: Ian Campbell > > > Sent: 25 November 2011 15:06 > > > To: xen-devel@lists.xensource.com > > > Cc: Ian Jackson; Paul Durrant > > > Subject: Re: [Xen-devel] [PATCH 05 of 15 v2] docs: add a > document > > > describing the xl cfg file syntax > > > > > > Paul, > > > > > > On Fri, 2011-11-25 at 14:49 +0000, Ian Campbell wrote: > > > > > > > > +=item B<viridian=BOOLEAN> > > > > + > > > > +Turns on or off the exposure of MicroSoft Hyper-V (AKA > viridian) > > > > +compatible enlightenments to the guest. These can improve > > > > performance > > > > +of Microsoft Windows guests (XXX which versions of Windows > > > benefit?) > > > > > > Is there anything else we can say here? What are the first > versions > > > of Windows which benefit from this? > > > > > > > Ian, > > > > I think that's probably good enough. AFAIK viridian > enlightenments > > came in with the 6.0 kernel in Vista/2K8 but having the flag on > should > > do no harm for older kernels. > > How about this incremental patch? > > diff -r b4c07fbe3557 docs/man/xl.cfg.pod.5 > --- a/docs/man/xl.cfg.pod.5 Fri Nov 25 15:11:30 2011 +0000 > +++ b/docs/man/xl.cfg.pod.5 Fri Nov 25 15:23:14 2011 +0000 > @@ -555,7 +555,13 @@ Windows L<http://wiki.xen.org/wiki/XenWi > > Turns on or off the exposure of MicroSoft Hyper-V (AKA viridian) > compatible enlightenments to the guest. These can improve > performance -of Microsoft Windows guests (XXX which versions of > Windows benefit?) > +of Microsoft Windows guests from Windows Vista and Windows 2008 > onwards > +and setting this option for such guests is strongly recommended. > This > +option should be harmless for other versions of Windows (although > it > +won't give any benefit) and the majority of other non-Windows OSes. > +However it is known to be incompatible with some other Operating > +Systems and in some circumstance can prevent Xen's own > +paravirtualisation interfaces for HVM guests from being used. > > =back > > ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 06 of 15 v2] xl: the name field in a guest config file is mandatory 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (4 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 07 of 15 v2] xlu: add "dont_warn" to xlu_cfg_* Ian Campbell ` (8 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221978 0 # Node ID 5a4e9f351a8ea57568a4a2dd8a5c4684628c56c9 # Parent 08a74d202a0a5b19b1229da893526856d832807b xl: the name field in a guest config file is mandatory Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 08a74d202a0a -r 5a4e9f351a8e tools/libxl/xl_cmdimpl.c --- a/tools/libxl/xl_cmdimpl.c Fri Nov 25 11:52:55 2011 +0000 +++ b/tools/libxl/xl_cmdimpl.c Fri Nov 25 11:52:58 2011 +0000 @@ -575,8 +575,10 @@ static void parse_config_data(const char if (!xlu_cfg_get_long (config, "hap", &l)) c_info->hap = l; - if (xlu_cfg_replace_string (config, "name", &c_info->name)) - c_info->name = strdup("test"); + if (xlu_cfg_replace_string (config, "name", &c_info->name)) { + fprintf(stderr, "Domain name must be specified."); + exit(1); + } if (!xlu_cfg_get_string (config, "uuid", &buf) ) { if ( libxl_uuid_from_string(&c_info->uuid, buf) ) { ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 07 of 15 v2] xlu: add "dont_warn" to xlu_cfg_* 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (5 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 06 of 15 v2] xl: the name field in a guest config file is mandatory Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 08 of 15 v2] libxl: use named options for tsc_mode Ian Campbell ` (7 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221980 0 # Node ID 88eee947a2bd15d4811c664ba6ed345a066708eb # Parent 5a4e9f351a8ea57568a4a2dd8a5c4684628c56c9 xlu: add "dont_warn" to xlu_cfg_* I want it for get_long but we might as well have it everywhere. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 5a4e9f351a8e -r 88eee947a2bd tools/libxl/libxlu_cfg.c --- a/tools/libxl/libxlu_cfg.c Fri Nov 25 11:52:58 2011 +0000 +++ b/tools/libxl/libxlu_cfg.c Fri Nov 25 11:53:00 2011 +0000 @@ -165,17 +165,18 @@ static XLU_ConfigSetting *find(const XLU } static int find_atom(const XLU_Config *cfg, const char *n, - XLU_ConfigSetting **set_r) { + XLU_ConfigSetting **set_r, int dont_warn) { XLU_ConfigSetting *set; set= find(cfg,n); if (!set) return ESRCH; if (set->avalues!=1) { - fprintf(cfg->report, - "%s:%d: warning: parameter `%s' is" - " a list but should be a single value\n", - cfg->filename, set->lineno, n); + if (!dont_warn) + fprintf(cfg->report, + "%s:%d: warning: parameter `%s' is" + " a list but should be a single value\n", + cfg->filename, set->lineno, n); return EINVAL; } *set_r= set; @@ -183,49 +184,51 @@ static int find_atom(const XLU_Config *c } int xlu_cfg_get_string(const XLU_Config *cfg, const char *n, - const char **value_r) { + const char **value_r, int dont_warn) { XLU_ConfigSetting *set; int e; - e= find_atom(cfg,n,&set); if (e) return e; + e= find_atom(cfg,n,&set,dont_warn); if (e) return e; *value_r= set->values[0]; return 0; } int xlu_cfg_replace_string(const XLU_Config *cfg, const char *n, - char **value_r) { + char **value_r, int dont_warn) { XLU_ConfigSetting *set; int e; - e= find_atom(cfg,n,&set); if (e) return e; + e= find_atom(cfg,n,&set,dont_warn); if (e) return e; free(*value_r); *value_r= strdup(set->values[0]); return 0; } int xlu_cfg_get_long(const XLU_Config *cfg, const char *n, - long *value_r) { + long *value_r, int dont_warn) { long l; XLU_ConfigSetting *set; int e; char *ep; - e= find_atom(cfg,n,&set); if (e) return e; + e= find_atom(cfg,n,&set,dont_warn); if (e) return e; errno= 0; l= strtol(set->values[0], &ep, 0); e= errno; if (errno) { e= errno; assert(e==EINVAL || e==ERANGE); - fprintf(cfg->report, - "%s:%d: warning: parameter `%s' could not be parsed" - " as a number: %s\n", - cfg->filename, set->lineno, n, strerror(e)); + if (!dont_warn) + fprintf(cfg->report, + "%s:%d: warning: parameter `%s' could not be parsed" + " as a number: %s\n", + cfg->filename, set->lineno, n, strerror(e)); return e; } if (*ep || ep==set->values[0]) { - fprintf(cfg->report, - "%s:%d: warning: parameter `%s' is not a valid number\n", - cfg->filename, set->lineno, n); + if (!dont_warn) + fprintf(cfg->report, + "%s:%d: warning: parameter `%s' is not a valid number\n", + cfg->filename, set->lineno, n); return EINVAL; } *value_r= l; diff -r 5a4e9f351a8e -r 88eee947a2bd tools/libxl/libxlutil.h --- a/tools/libxl/libxlutil.h Fri Nov 25 11:52:58 2011 +0000 +++ b/tools/libxl/libxlutil.h Fri Nov 25 11:53:00 2011 +0000 @@ -41,13 +41,17 @@ void xlu_cfg_destroy(XLU_Config*); * Return values are: * 0 OK * ESRCH not defined - * EINVAL value found but wrong format for request (prints warning) + * EINVAL value found but wrong format for request (prints warning unless dont_warn=true) * ERANGE value out of range (from strtol) */ -int xlu_cfg_get_string(const XLU_Config*, const char *n, const char **value_r); -int xlu_cfg_replace_string(const XLU_Config *cfg, const char *n, char **value_r); /* free/strdup version */ -int xlu_cfg_get_long(const XLU_Config*, const char *n, long *value_r); +int xlu_cfg_get_string(const XLU_Config*, const char *n, const char **value_r, + int dont_warn); +/* free/strdup version */ +int xlu_cfg_replace_string(const XLU_Config *cfg, const char *n, + char **value_r, int dont_warn); +int xlu_cfg_get_long(const XLU_Config*, const char *n, long *value_r, + int dont_warn); int xlu_cfg_get_list(const XLU_Config*, const char *n, XLU_ConfigList **list_r /* may be 0 */, diff -r 5a4e9f351a8e -r 88eee947a2bd tools/libxl/xl.c --- a/tools/libxl/xl.c Fri Nov 25 11:52:58 2011 +0000 +++ b/tools/libxl/xl.c Fri Nov 25 11:53:00 2011 +0000 @@ -62,10 +62,10 @@ static void parse_global_config(const ch exit(1); } - if (!xlu_cfg_get_long (config, "autoballoon", &l)) + if (!xlu_cfg_get_long (config, "autoballoon", &l, 0)) autoballoon = l; - if (!xlu_cfg_get_string (config, "lockfile", &buf)) + if (!xlu_cfg_get_string (config, "lockfile", &buf, 0)) lockfile = strdup(buf); else { e = asprintf(&lockfile, "%s/xl", (char *)libxl_lock_dir_path()); @@ -75,7 +75,7 @@ static void parse_global_config(const ch } } - if (!xlu_cfg_get_string (config, "vifscript", &buf)) + if (!xlu_cfg_get_string (config, "vifscript", &buf, 0)) default_vifscript = strdup(buf); xlu_cfg_destroy(config); diff -r 5a4e9f351a8e -r 88eee947a2bd tools/libxl/xl_cmdimpl.c --- a/tools/libxl/xl_cmdimpl.c Fri Nov 25 11:52:58 2011 +0000 +++ b/tools/libxl/xl_cmdimpl.c Fri Nov 25 11:53:00 2011 +0000 @@ -554,7 +554,7 @@ static void parse_config_data(const char if (libxl_init_create_info(ctx, c_info)) exit(1); - if (!xlu_cfg_get_string (config, "seclabel", &buf)) { + if (!xlu_cfg_get_string (config, "seclabel", &buf, 0)) { e = libxl_flask_context_to_sid(ctx, (char *)buf, strlen(buf), &c_info->ssidref); if (e) { @@ -568,19 +568,19 @@ static void parse_config_data(const char } c_info->type = LIBXL_DOMAIN_TYPE_PV; - if (!xlu_cfg_get_string (config, "builder", &buf) && + if (!xlu_cfg_get_string (config, "builder", &buf, 0) && !strncmp(buf, "hvm", strlen(buf))) c_info->type = LIBXL_DOMAIN_TYPE_HVM; - if (!xlu_cfg_get_long (config, "hap", &l)) + if (!xlu_cfg_get_long (config, "hap", &l, 0)) c_info->hap = l; - if (xlu_cfg_replace_string (config, "name", &c_info->name)) { + if (xlu_cfg_replace_string (config, "name", &c_info->name, 0)) { fprintf(stderr, "Domain name must be specified."); exit(1); } - if (!xlu_cfg_get_string (config, "uuid", &buf) ) { + if (!xlu_cfg_get_string (config, "uuid", &buf, 0) ) { if ( libxl_uuid_from_string(&c_info->uuid, buf) ) { fprintf(stderr, "Failed to parse UUID: %s\n", buf); exit(1); @@ -589,10 +589,10 @@ static void parse_config_data(const char libxl_uuid_generate(&c_info->uuid); } - if (!xlu_cfg_get_long(config, "oos", &l)) + if (!xlu_cfg_get_long(config, "oos", &l, 0)) c_info->oos = l; - if (!xlu_cfg_get_string (config, "pool", &buf)) { + if (!xlu_cfg_get_string (config, "pool", &buf, 0)) { c_info->poolid = -1; cpupool_qualifier_to_cpupoolid(buf, &c_info->poolid, NULL); } @@ -606,37 +606,37 @@ static void parse_config_data(const char exit(1); /* the following is the actual config parsing with overriding values in the structures */ - if (!xlu_cfg_get_long (config, "vcpus", &l)) { + if (!xlu_cfg_get_long (config, "vcpus", &l, 0)) { b_info->max_vcpus = l; b_info->cur_vcpus = (1 << l) - 1; } - if (!xlu_cfg_get_long (config, "maxvcpus", &l)) + if (!xlu_cfg_get_long (config, "maxvcpus", &l, 0)) b_info->max_vcpus = l; - if (!xlu_cfg_get_long (config, "memory", &l)) { + if (!xlu_cfg_get_long (config, "memory", &l, 0)) { b_info->max_memkb = l * 1024; b_info->target_memkb = b_info->max_memkb; } - if (!xlu_cfg_get_long (config, "maxmem", &l)) + if (!xlu_cfg_get_long (config, "maxmem", &l, 0)) b_info->max_memkb = l * 1024; - if (xlu_cfg_get_string (config, "on_poweroff", &buf)) + if (xlu_cfg_get_string (config, "on_poweroff", &buf, 0)) buf = "destroy"; if (!parse_action_on_shutdown(buf, &d_config->on_poweroff)) { fprintf(stderr, "Unknown on_poweroff action \"%s\" specified\n", buf); exit(1); } - if (xlu_cfg_get_string (config, "on_reboot", &buf)) + if (xlu_cfg_get_string (config, "on_reboot", &buf, 0)) buf = "restart"; if (!parse_action_on_shutdown(buf, &d_config->on_reboot)) { fprintf(stderr, "Unknown on_reboot action \"%s\" specified\n", buf); exit(1); } - if (xlu_cfg_get_string (config, "on_watchdog", &buf)) + if (xlu_cfg_get_string (config, "on_watchdog", &buf, 0)) buf = "destroy"; if (!parse_action_on_shutdown(buf, &d_config->on_watchdog)) { fprintf(stderr, "Unknown on_watchdog action \"%s\" specified\n", buf); @@ -644,7 +644,7 @@ static void parse_config_data(const char } - if (xlu_cfg_get_string (config, "on_crash", &buf)) + if (xlu_cfg_get_string (config, "on_crash", &buf, 0)) buf = "destroy"; if (!parse_action_on_shutdown(buf, &d_config->on_crash)) { fprintf(stderr, "Unknown on_crash action \"%s\" specified\n", buf); @@ -654,52 +654,52 @@ static void parse_config_data(const char /* libxl_get_required_shadow_memory() must be called after final values * (default or specified) for vcpus and memory are set, because the * calculation depends on those values. */ - b_info->shadow_memkb = !xlu_cfg_get_long(config, "shadow_memory", &l) + b_info->shadow_memkb = !xlu_cfg_get_long(config, "shadow_memory", &l, 0) ? l * 1024 : libxl_get_required_shadow_memory(b_info->max_memkb, b_info->max_vcpus); - if (!xlu_cfg_get_long (config, "nomigrate", &l)) + if (!xlu_cfg_get_long (config, "nomigrate", &l, 0)) b_info->disable_migrate = l; - if (!xlu_cfg_get_long(config, "tsc_mode", &l)) + if (!xlu_cfg_get_long(config, "tsc_mode", &l, 0)) b_info->tsc_mode = l; - if (!xlu_cfg_get_long (config, "videoram", &l)) + if (!xlu_cfg_get_long (config, "videoram", &l, 0)) b_info->video_memkb = l * 1024; - if (!xlu_cfg_get_long (config, "gfx_passthru", &l)) + if (!xlu_cfg_get_long (config, "gfx_passthru", &l, 0)) dm_info->gfx_passthru = l; switch(c_info->type) { case LIBXL_DOMAIN_TYPE_HVM: - if (!xlu_cfg_get_string (config, "kernel", &buf)) + if (!xlu_cfg_get_string (config, "kernel", &buf, 0)) fprintf(stderr, "WARNING: ignoring \"kernel\" directive for HVM guest. " "Use \"firmware_override\" instead if you really want a non-default firmware\n"); xlu_cfg_replace_string (config, "firmware_override", - &b_info->u.hvm.firmware); - if (!xlu_cfg_get_long (config, "pae", &l)) + &b_info->u.hvm.firmware, 0); + if (!xlu_cfg_get_long (config, "pae", &l, 0)) b_info->u.hvm.pae = l; - if (!xlu_cfg_get_long (config, "apic", &l)) + if (!xlu_cfg_get_long (config, "apic", &l, 0)) b_info->u.hvm.apic = l; - if (!xlu_cfg_get_long (config, "acpi", &l)) + if (!xlu_cfg_get_long (config, "acpi", &l, 0)) b_info->u.hvm.acpi = l; - if (!xlu_cfg_get_long (config, "acpi_s3", &l)) + if (!xlu_cfg_get_long (config, "acpi_s3", &l, 0)) b_info->u.hvm.acpi_s3 = l; - if (!xlu_cfg_get_long (config, "acpi_s4", &l)) + if (!xlu_cfg_get_long (config, "acpi_s4", &l, 0)) b_info->u.hvm.acpi_s4 = l; - if (!xlu_cfg_get_long (config, "nx", &l)) + if (!xlu_cfg_get_long (config, "nx", &l, 0)) b_info->u.hvm.nx = l; - if (!xlu_cfg_get_long (config, "viridian", &l)) + if (!xlu_cfg_get_long (config, "viridian", &l, 0)) b_info->u.hvm.viridian = l; - if (!xlu_cfg_get_long (config, "hpet", &l)) + if (!xlu_cfg_get_long (config, "hpet", &l, 0)) b_info->u.hvm.hpet = l; - if (!xlu_cfg_get_long (config, "vpt_align", &l)) + if (!xlu_cfg_get_long (config, "vpt_align", &l, 0)) b_info->u.hvm.vpt_align = l; - if (!xlu_cfg_get_long (config, "timer_mode", &l)) + if (!xlu_cfg_get_long (config, "timer_mode", &l, 0)) b_info->u.hvm.timer_mode = l; - if (!xlu_cfg_get_long (config, "nestedhvm", &l)) + if (!xlu_cfg_get_long (config, "nestedhvm", &l, 0)) b_info->u.hvm.nested_hvm = l; break; case LIBXL_DOMAIN_TYPE_PV: @@ -707,12 +707,12 @@ static void parse_config_data(const char char *cmdline = NULL; const char *root = NULL, *extra = ""; - xlu_cfg_replace_string (config, "kernel", &b_info->u.pv.kernel.path); - - xlu_cfg_replace_string (config, "kernel", &b_info->u.pv.kernel.path); - - xlu_cfg_get_string (config, "root", &root); - xlu_cfg_get_string (config, "extra", &extra); + xlu_cfg_replace_string (config, "kernel", &b_info->u.pv.kernel.path, 0); + + xlu_cfg_replace_string (config, "kernel", &b_info->u.pv.kernel.path, 0); + + xlu_cfg_get_string (config, "root", &root, 0); + xlu_cfg_get_string (config, "extra", &extra, 0); if (root) { if (asprintf(&cmdline, "root=%s %s", root, extra) == -1) @@ -726,8 +726,10 @@ static void parse_config_data(const char exit(1); } - xlu_cfg_replace_string (config, "bootloader", &b_info->u.pv.bootloader); - xlu_cfg_replace_string (config, "bootloader_args", &b_info->u.pv.bootloader_args); + xlu_cfg_replace_string (config, "bootloader", + &b_info->u.pv.bootloader, 0); + xlu_cfg_replace_string (config, "bootloader_args", + &b_info->u.pv.bootloader_args, 0); if (!b_info->u.pv.bootloader && !b_info->u.pv.kernel.path) { fprintf(stderr, "Neither kernel nor bootloader specified\n"); @@ -735,7 +737,7 @@ static void parse_config_data(const char } b_info->u.pv.cmdline = cmdline; - xlu_cfg_replace_string (config, "ramdisk", &b_info->u.pv.ramdisk.path); + xlu_cfg_replace_string (config, "ramdisk", &b_info->u.pv.ramdisk.path, 0); break; } default: @@ -910,15 +912,15 @@ skip_vfb: } } - if (!xlu_cfg_get_long (config, "pci_msitranslate", &l)) + if (!xlu_cfg_get_long (config, "pci_msitranslate", &l, 0)) pci_msitranslate = l; - if (!xlu_cfg_get_long (config, "pci_power_mgmt", &l)) + if (!xlu_cfg_get_long (config, "pci_power_mgmt", &l, 0)) pci_power_mgmt = l; /* To be reworked (automatically enabled) once the auto ballooning * after guest starts is done (with PCI devices passed in). */ - if (!xlu_cfg_get_long (config, "e820_host", &l)) { + if (!xlu_cfg_get_long (config, "e820_host", &l, 0)) { switch (c_info->type) { case LIBXL_DOMAIN_TYPE_HVM: fprintf(stderr, "Can't do e820_host in HVM mode!"); @@ -986,7 +988,7 @@ skip_vfb: } break; case EINVAL: /* config option is not a list, parse as a string */ - if (!xlu_cfg_get_string(config, "cpuid", &buf)) { + if (!xlu_cfg_get_string(config, "cpuid", &buf, 0)) { char *buf2, *p, *strtok_ptr = NULL; const char *errstr; @@ -1034,7 +1036,7 @@ skip_vfb: if (libxl_init_dm_info(ctx, dm_info, c_info, b_info)) exit(1); /* parse device model arguments, this works for pv, hvm and stubdom */ - if (!xlu_cfg_get_string (config, "device_model", &buf)) { + if (!xlu_cfg_get_string (config, "device_model", &buf, 0)) { fprintf(stderr, "WARNING: ignoring device_model directive.\n" "WARNING: Use \"device_model_override\" instead if you" @@ -1053,8 +1055,8 @@ skip_vfb: xlu_cfg_replace_string (config, "device_model_override", - &dm_info->device_model); - if (!xlu_cfg_get_string (config, "device_model_version", &buf)) { + &dm_info->device_model, 0); + if (!xlu_cfg_get_string (config, "device_model_version", &buf, 0)) { if (!strcmp(buf, "qemu-xen-traditional")) { dm_info->device_model_version = LIBXL_DEVICE_MODEL_VERSION_QEMU_XEN_TRADITIONAL; @@ -1068,7 +1070,7 @@ skip_vfb: } } else if (dm_info->device_model) fprintf(stderr, "WARNING: device model override given without specific DM version\n"); - if (!xlu_cfg_get_long (config, "device_model_stubdomain_override", &l)) + if (!xlu_cfg_get_long (config, "device_model_stubdomain_override", &l, 0)) dm_info->device_model_stubdomain = l; #define parse_extra_args(type) \ @@ -1096,46 +1098,46 @@ skip_vfb: #undef parse_extra_args if (c_info->type == LIBXL_DOMAIN_TYPE_HVM) { - if (!xlu_cfg_get_long (config, "stdvga", &l)) + if (!xlu_cfg_get_long (config, "stdvga", &l, 0)) dm_info->stdvga = l; - if (!xlu_cfg_get_long (config, "vnc", &l)) + if (!xlu_cfg_get_long (config, "vnc", &l, 0)) dm_info->vnc = l; - xlu_cfg_replace_string (config, "vnclisten", &dm_info->vnclisten); - xlu_cfg_replace_string (config, "vncpasswd", &dm_info->vncpasswd); - if (!xlu_cfg_get_long (config, "vncdisplay", &l)) + xlu_cfg_replace_string (config, "vnclisten", &dm_info->vnclisten, 0); + xlu_cfg_replace_string (config, "vncpasswd", &dm_info->vncpasswd, 0); + if (!xlu_cfg_get_long (config, "vncdisplay", &l, 0)) dm_info->vncdisplay = l; - if (!xlu_cfg_get_long (config, "vncunused", &l)) + if (!xlu_cfg_get_long (config, "vncunused", &l, 0)) dm_info->vncunused = l; - xlu_cfg_replace_string (config, "keymap", &dm_info->keymap); - if (!xlu_cfg_get_long (config, "sdl", &l)) + xlu_cfg_replace_string (config, "keymap", &dm_info->keymap, 0); + if (!xlu_cfg_get_long (config, "sdl", &l, 0)) dm_info->sdl = l; - if (!xlu_cfg_get_long (config, "opengl", &l)) + if (!xlu_cfg_get_long (config, "opengl", &l, 0)) dm_info->opengl = l; - if (!xlu_cfg_get_long (config, "spice", &l)) + if (!xlu_cfg_get_long (config, "spice", &l, 0)) dm_info->spice = l; - if (!xlu_cfg_get_long (config, "spiceport", &l)) + if (!xlu_cfg_get_long (config, "spiceport", &l, 0)) dm_info->spiceport = l; - if (!xlu_cfg_get_long (config, "spicetls_port", &l)) + if (!xlu_cfg_get_long (config, "spicetls_port", &l, 0)) dm_info->spicetls_port = l; - xlu_cfg_replace_string (config, "spicehost", &dm_info->spicehost); - if (!xlu_cfg_get_long (config, "spicedisable_ticketing", &l)) + xlu_cfg_replace_string (config, "spicehost", &dm_info->spicehost, 0); + if (!xlu_cfg_get_long (config, "spicedisable_ticketing", &l, 0)) dm_info->spicedisable_ticketing = l; - xlu_cfg_replace_string (config, "spicepasswd", &dm_info->spicepasswd); - if (!xlu_cfg_get_long (config, "spiceagent_mouse", &l)) + xlu_cfg_replace_string (config, "spicepasswd", &dm_info->spicepasswd, 0); + if (!xlu_cfg_get_long (config, "spiceagent_mouse", &l, 0)) dm_info->spiceagent_mouse = l; else dm_info->spiceagent_mouse = 1; - if (!xlu_cfg_get_long (config, "nographic", &l)) + if (!xlu_cfg_get_long (config, "nographic", &l, 0)) dm_info->nographic = l; - if (!xlu_cfg_get_long (config, "gfx_passthru", &l)) + if (!xlu_cfg_get_long (config, "gfx_passthru", &l, 0)) dm_info->gfx_passthru = l; - xlu_cfg_replace_string (config, "serial", &dm_info->serial); - xlu_cfg_replace_string (config, "boot", &dm_info->boot); - if (!xlu_cfg_get_long (config, "usb", &l)) + xlu_cfg_replace_string (config, "serial", &dm_info->serial, 0); + xlu_cfg_replace_string (config, "boot", &dm_info->boot, 0); + if (!xlu_cfg_get_long (config, "usb", &l, 0)) dm_info->usb = l; - xlu_cfg_replace_string (config, "usbdevice", &dm_info->usbdevice); - xlu_cfg_replace_string (config, "soundhw", &dm_info->soundhw); - if (!xlu_cfg_get_long (config, "xen_platform_pci", &l)) + xlu_cfg_replace_string (config, "usbdevice", &dm_info->usbdevice, 0); + xlu_cfg_replace_string (config, "soundhw", &dm_info->soundhw, 0); + if (!xlu_cfg_get_long (config, "xen_platform_pci", &l, 0)) dm_info->xen_platform_pci = l; } @@ -4765,7 +4767,7 @@ int main_cpupoolcreate(int argc, char ** return -ERROR_FAIL; } - if (!xlu_cfg_get_string (config, "name", &buf)) + if (!xlu_cfg_get_string (config, "name", &buf, 0)) name = strdup(buf); else name = libxl_basename(filename); @@ -4774,7 +4776,7 @@ int main_cpupoolcreate(int argc, char ** return -ERROR_FAIL; } - if (!xlu_cfg_get_string (config, "sched", &buf)) { + if (!xlu_cfg_get_string (config, "sched", &buf, 0)) { if ((schedid = libxl_name_to_schedid(ctx, buf)) < 0) { fprintf(stderr, "Unknown scheduler\n"); return -ERROR_FAIL; ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 08 of 15 v2] libxl: use named options for tsc_mode 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (6 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 07 of 15 v2] xlu: add "dont_warn" to xlu_cfg_* Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 09 of 15 v2] docs: remove non-breaking spaces from sedf_scheduler_mini-HOWTO.txt Ian Campbell ` (6 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221982 0 # Node ID b0009f28bbf2ec313eead3ed36a2b139fa5f3512 # Parent 88eee947a2bd15d4811c664ba6ed345a066708eb libxl: use named options for tsc_mode. Add an enum at the libxl level with a hopefully descriptive set of names. Deprecate the use of an integer in xl cfg files. Signed-off-by: Ian Campbell diff -r 88eee947a2bd -r b0009f28bbf2 docs/man/xl.cfg.pod.5 --- a/docs/man/xl.cfg.pod.5 Fri Nov 25 11:53:00 2011 +0000 +++ b/docs/man/xl.cfg.pod.5 Fri Nov 25 11:53:02 2011 +0000 @@ -491,11 +491,45 @@ compatibility mode on more modern Window =item B<tsc_mode="MODE"> + Specifies how the TSC (Time Stamp Counter) should be provided to the -guest. XXX ??? +guest (X86 only). Specifying this option as a number is +deprecated. Options are: + +=over 4 + +=item B<"default"> + +Guest rdtsc/p executed natively when monotonicity can be guaranteed +and emulated otherwise (with frequency scaled if necessary). + +=item B<"always_emulate"> + +Guest rdtsc/p always emulated at 1GHz (kernel and user). Guest rdtsc/p +always emulated and the virtual TSC will appear to increment (kernel +and user) at a fixed 1GHz rate, regardless of the PCPU HZ rate or +power state; Although there is an overhead associated with emulation +this will NOT affect underlying CPU performance. + +=item B<"native"> + +Guest rdtsc always executed natively (no monotonicity/frequency +guarantees); guest rdtscp emulated at native frequency if unsupported +by h/w, else executed natively. + +=item B<"native_paravirt"> + +Same as B<native>, except xen manages TSC_AUX register so guest can +determine when a restore/migration has occurred and assumes guest +obtains/uses pvclock-like mechanism to adjust for monotonicity and +frequency changes. =back +=back + +Please see F<docs/misc/tscmode.txt> for more information on this option. + =head3 Support for Paravirtualisation of HVM Guests The following options allow Paravirtualised features (such as devices) diff -r 88eee947a2bd -r b0009f28bbf2 tools/libxl/libxl_dom.c --- a/tools/libxl/libxl_dom.c Fri Nov 25 11:53:00 2011 +0000 +++ b/tools/libxl/libxl_dom.c Fri Nov 25 11:53:02 2011 +0000 @@ -73,12 +73,29 @@ int libxl__build_pre(libxl__gc *gc, uint libxl_domain_build_info *info, libxl__domain_build_state *state) { libxl_ctx *ctx = libxl__gc_owner(gc); + int tsc_mode; xc_domain_max_vcpus(ctx->xch, domid, info->max_vcpus); xc_domain_setmaxmem(ctx->xch, domid, info->target_memkb + LIBXL_MAXMEM_CONSTANT); if (info->type == LIBXL_DOMAIN_TYPE_PV) xc_domain_set_memmap_limit(ctx->xch, domid, (info->max_memkb + info->u.pv.slack_memkb)); - xc_domain_set_tsc_info(ctx->xch, domid, info->tsc_mode, 0, 0, 0); + switch (info->tsc_mode) { + case LIBXL_TSC_MODE_DEFAULT: + tsc_mode = 0; + break; + case LIBXL_TSC_MODE_ALWAYS_EMULATE: + tsc_mode = 1; + break; + case LIBXL_TSC_MODE_NATIVE: + tsc_mode = 2; + break; + case LIBXL_TSC_MODE_NATIVE_PARAVIRT: + tsc_mode = 3; + break; + default: + abort(); + } + xc_domain_set_tsc_info(ctx->xch, domid, tsc_mode, 0, 0, 0); if ( info->disable_migrate ) xc_domain_disable_migrate(ctx->xch, domid); diff -r 88eee947a2bd -r b0009f28bbf2 tools/libxl/libxl_types.idl --- a/tools/libxl/libxl_types.idl Fri Nov 25 11:53:00 2011 +0000 +++ b/tools/libxl/libxl_types.idl Fri Nov 25 11:53:02 2011 +0000 @@ -85,6 +85,13 @@ libxl_button = Enumeration("button", [ (2, "SLEEP"), ]) +libxl_tsc_mode = Enumeration("tsc_mode", [ + (0, "default"), + (1, "always_emulate"), + (2, "native"), + (3, "native_paravirt"), + ]) + # # Complex libxl types # @@ -154,7 +161,7 @@ libxl_domain_create_info = Struct("domai libxl_domain_build_info = Struct("domain_build_info",[ ("max_vcpus", integer), ("cur_vcpus", integer), - ("tsc_mode", integer), + ("tsc_mode", libxl_tsc_mode), ("max_memkb", uint32), ("target_memkb", uint32), ("video_memkb", uint32), diff -r 88eee947a2bd -r b0009f28bbf2 tools/libxl/xl_cmdimpl.c --- a/tools/libxl/xl_cmdimpl.c Fri Nov 25 11:53:00 2011 +0000 +++ b/tools/libxl/xl_cmdimpl.c Fri Nov 25 11:53:02 2011 +0000 @@ -328,7 +328,7 @@ static void printf_info(int domid, printf("\t(build_info)\n"); printf("\t(max_vcpus %d)\n", b_info->max_vcpus); - printf("\t(tsc_mode %d)\n", b_info->tsc_mode); + printf("\t(tsc_mode %s)\n", libxl_tsc_mode_to_string(b_info->tsc_mode)); printf("\t(max_memkb %d)\n", b_info->max_memkb); printf("\t(target_memkb %d)\n", b_info->target_memkb); printf("\t(nomigrate %d)\n", b_info->disable_migrate); @@ -662,8 +662,28 @@ static void parse_config_data(const char if (!xlu_cfg_get_long (config, "nomigrate", &l, 0)) b_info->disable_migrate = l; - if (!xlu_cfg_get_long(config, "tsc_mode", &l, 0)) + if (!xlu_cfg_get_long(config, "tsc_mode", &l, 1)) { + const char *s = libxl_tsc_mode_to_string(l); + fprintf(stderr, "WARNING: specifying \"tsc_mode\" as an integer is deprecated. " + "Please use the named parameter variant. %s%s%s\n", + s ? "e.g. tsc_mode=\"" : "", + s ? s : "", + s ? "\"" : ""); + + if (l < LIBXL_TSC_MODE_DEFAULT || + l > LIBXL_TSC_MODE_NATIVE_PARAVIRT) { + fprintf(stderr, "ERROR: invalid value %ld for \"tsc_mode\"\n", l); + exit (1); + } b_info->tsc_mode = l; + } else if (!xlu_cfg_get_string(config, "tsc_mode", &buf, 0)) { + fprintf(stderr, "got a tsc mode string: \"%s\"\n", buf); + if (libxl_tsc_mode_from_string(buf, &b_info->tsc_mode)) { + fprintf(stderr, "ERROR: invalid value \"%s\" for \"tsc_mode\"\n", + buf); + exit (1); + } + } if (!xlu_cfg_get_long (config, "videoram", &l, 0)) b_info->video_memkb = l * 1024; ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 09 of 15 v2] docs: remove non-breaking spaces from sedf_scheduler_mini-HOWTO.txt 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (7 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 08 of 15 v2] libxl: use named options for tsc_mode Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 10 of 15 v2] docs: tweak markup and wording of qemu upstream doc slightly Ian Campbell ` (5 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #1: Type: text/plain; charset="us-ascii", Size: 3412 bytes --] # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221984 0 # Node ID bf4b5ef1f1d16189cb1a628ec8445a8018c96be5 # Parent b0009f28bbf2ec313eead3ed36a2b139fa5f3512 docs: remove non-breaking spaces from sedf_scheduler_mini-HOWTO.txt This document contains several 0xa0 characters (non-breaking spaces). These do not display correctly in (some) terminals or when the document is rendered by (some) browsers. Re-encode them as spaces. I'm not confident that this change will make it through being encoded as a patch and sent through email. Its effect can be replicated with: perl -i -p -e 's/\xa0/ /g' docs/misc/sedf_scheduler_mini-HOWTO.txt Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r b0009f28bbf2 -r bf4b5ef1f1d1 docs/misc/sedf_scheduler_mini-HOWTO.txt --- a/docs/misc/sedf_scheduler_mini-HOWTO.txt Fri Nov 25 11:53:02 2011 +0000 +++ b/docs/misc/sedf_scheduler_mini-HOWTO.txt Fri Nov 25 11:53:04 2011 +0000 @@ -8,37 +8,37 @@ Overview: uses realtime-algorithms to ensure time guarantees. Usage: - -add "sched=sedf" on Xen's boot command-line - -create domains as usual - -use "xm sched-sedf <dom-id> <period> <slice> <latency-hint> <extra> <weight>" - Where: - -period/slice are the normal EDF scheduling parameters in nanosecs - -latency-hint is the scaled period in case the domain is doing heavy I/O + -add "sched=sedf" on Xen's boot command-line + -create domains as usual + -use "xm sched-sedf <dom-id> <period> <slice> <latency-hint> <extra> <weight>" + Where: + -period/slice are the normal EDF scheduling parameters in nanosecs + -latency-hint is the scaled period in case the domain is doing heavy I/O (unused by the currently compiled version) - -extra is a flag (0/1), which controls whether the domain can run in + -extra is a flag (0/1), which controls whether the domain can run in extra-time - -weight is mutually exclusive with period/slice and specifies another + -weight is mutually exclusive with period/slice and specifies another way of setting a domains cpu slice Examples: - normal EDF (20ms/5ms): - xm sched-sedf <dom-id> 20000000 5000000 0 0 0 + normal EDF (20ms/5ms): + xm sched-sedf <dom-id> 20000000 5000000 0 0 0 - best-effort domains (i.e. non-realtime): - xm sched-sedf <dom-id> 20000000 0 0 1 0 - + best-effort domains (i.e. non-realtime): + xm sched-sedf <dom-id> 20000000 0 0 1 0 + normal EDF (20ms/5ms) + share of extra-time: - xm sched-sedf <dom-id> 20000000 5000000 0 1 0 + xm sched-sedf <dom-id> 20000000 5000000 0 1 0 - 4 domains with weights 2:3:4:2 - xm sched-sedf <d1> 0 0 0 0 2 - xm sched-sedf <d2> 0 0 0 0 3 - xm sched-sedf <d3> 0 0 0 0 4 - xm sched-sedf <d4> 0 0 0 0 2 + 4 domains with weights 2:3:4:2 + xm sched-sedf <d1> 0 0 0 0 2 + xm sched-sedf <d2> 0 0 0 0 3 + xm sched-sedf <d3> 0 0 0 0 4 + xm sched-sedf <d4> 0 0 0 0 2 - 1 fully-specified (10ms/3ms) domain, 3 other domains share - available rest in 2:7:3 ratio: - xm sched-sedf <d1> 10000000 3000000 0 0 0 - xm sched-sedf <d2> 0 0 0 0 2 - xm sched-sedf <d3> 0 0 0 0 7 - xm sched-sedf <d4> 0 0 0 0 3 + 1 fully-specified (10ms/3ms) domain, 3 other domains share + available rest in 2:7:3 ratio: + xm sched-sedf <d1> 10000000 3000000 0 0 0 + xm sched-sedf <d2> 0 0 0 0 2 + xm sched-sedf <d3> 0 0 0 0 7 + xm sched-sedf <d4> 0 0 0 0 3 [-- Attachment #2: Type: text/plain, Size: 138 bytes --] _______________________________________________ Xen-devel mailing list Xen-devel@lists.xensource.com http://lists.xensource.com/xen-devel ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 10 of 15 v2] docs: tweak markup and wording of qemu upstream doc slightly 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (8 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 09 of 15 v2] docs: remove non-breaking spaces from sedf_scheduler_mini-HOWTO.txt Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 11 of 15 v2] docs: generate an index for the html output Ian Campbell ` (4 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322221986 0 # Node ID ddeac8b237e4f71d05c817fa8432417886e7e202 # Parent bf4b5ef1f1d16189cb1a628ec8445a8018c96be5 docs: tweak markup and wording of qemu upstream doc slightly Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r bf4b5ef1f1d1 -r ddeac8b237e4 docs/misc/qemu-upstream_howto_use_it.markdown --- a/docs/misc/qemu-upstream_howto_use_it.markdown Fri Nov 25 11:53:04 2011 +0000 +++ b/docs/misc/qemu-upstream_howto_use_it.markdown Fri Nov 25 11:53:06 2011 +0000 @@ -1,11 +1,11 @@ -Help to use QEMU (upstream version) with Xen -============================================ +Using Upstream QEMU with Xen +============================ Note ---- All these steps will become unnecessary after the patches to integrate -SeaBIOS/QEMU build will be applied. +SeaBIOS/QEMU into the Xen build system have been applied. How to build it @@ -15,14 +15,15 @@ How to build it The new device-model needs a different BIOS, SeaBIOS. Clone the repository from: - - git://git.qemu.org/seabios.git - - http://git.qemu.org/git/seabios.git + - [git://git.qemu.org/seabios.git]() + - [http://git.qemu.org/git/seabios.git]() -Put the `.config` file in the appendix at the root of seabios.git and build SeaBIOS. +Put the `.config` file in the appendix at the root of `seabios.git` +and build SeaBIOS by typing `make`. -In xen-unstable source tree, add the file `.config` with +In the xen-unstable source tree, add the file `.config` with `SEABIOS_DIR = /path/to/seabios.git`. -To build hvmloader with SeaBIOS, you propably need to `make -C tools/firmware +To build hvmloader with SeaBIOS, you probably need to `make -C tools/firmware clean` first and then `make tools`, to use the new SEABIOS_DIR parameter. @@ -30,10 +31,10 @@ clean` first and then `make tools`, to u Get QEMU upstream source from: - - git://xenbits.xensource.com/qemu-upstream-unstable.git - - http://xenbits.xensource.com/git-http/qemu-upstream-unstable.git + - [git://xenbits.xensource.com/qemu-upstream-unstable.git]() + - [http://xenbits.xensource.com/git-http/qemu-upstream-unstable.git]() -To configure build QEMU upstream with Xen +To configure QEMU upstream with support for Xen: ./configure --enable-xen --target-list=i386-softmmu --extra-cflags="-I$path_to_xen_source/tools/include -I$path_to_xen_source/tools/libxc -I$path_to_xen_source/tools/xenstore" --extra-ldflags="-L$path_to_xen_source/tools/libxc -L$path_to_xen_source/tools/xenstore" @@ -43,15 +44,15 @@ You can also use other several options s How to use QEMU upstream ------------------------ -Only xl support QEMU upstream. +Only `xl` supports QEMU upstream. To actually use it, add or change this in your VM configuration file: device_model_version = 'qemu-xen' device_model_override = '/path/to/qemu/i386-softmmu/qemu' -NB: On qemu-upstream repository, the default binary name has been renamed to -`qemu-system-i386`. +NB: In the `qemu-upstream` repository, the default binary name has been +renamed to `qemu-system-i386`. Appendix ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 11 of 15 v2] docs: generate an index for the html output 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (9 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 10 of 15 v2] docs: tweak markup and wording of qemu upstream doc slightly Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 18:43 ` Roger Pau Monné 2011-11-25 14:49 ` [PATCH 12 of 15 v2] docs: move user and interface .tex documents under reference Ian Campbell ` (3 subsequent siblings) 14 siblings, 1 reply; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322231661 0 # Node ID 00ea49f77bdcef16251e3773c99fc02394524b83 # Parent ddeac8b237e4f71d05c817fa8432417886e7e202 docs: generate an index for the html output nb: I'm not a Perl wizard... Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r ddeac8b237e4 -r 00ea49f77bdc docs/INDEX --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/INDEX Fri Nov 25 14:34:21 2011 +0000 @@ -0,0 +1,5 @@ +misc/hvm-emulated-unplug Xen HVM emulated device unplug protocol + +# These are not all that useful anymore, hide them from the index +interface/index NO-INDEX +user/index NO-INDEX diff -r ddeac8b237e4 -r 00ea49f77bdc docs/Makefile --- a/docs/Makefile Fri Nov 25 11:53:06 2011 +0000 +++ b/docs/Makefile Fri Nov 25 14:34:21 2011 +0000 @@ -45,7 +45,7 @@ ps: $(DOC_PS) pdf: $(DOC_PDF) .PHONY: html -html: $(DOC_HTML) +html: $(DOC_HTML) html/index.html .PHONY: txt txt: $(DOC_TXT) @@ -128,6 +128,9 @@ html/%/index.html: src/%.tex $< 1>/dev/null 2>/dev/null ; else \ echo "latex2html not installed; skipping $*."; fi +html/index.html: $(DOC_HTML) ./gen-html-index INDEX + ./gen-html-index -i INDEX html $(DOC_HTML) + html/%.html: %.markdown @$(INSTALL_DIR) $(@D) @set -e ; if which $(MARKDOWN) 1>/dev/null 2>/dev/null; then \ diff -r ddeac8b237e4 -r 00ea49f77bdc docs/gen-html-index --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/gen-html-index Fri Nov 25 14:34:21 2011 +0000 @@ -0,0 +1,136 @@ +#!/usr/bin/perl -w + +# +# Generate indexes for html documentation +# + +use strict; +use warnings; + +use Getopt::Long; +use IO::File; +use File::Basename; +use List::MoreUtils qw/ uniq /; + +Getopt::Long::Configure('bundling'); + +@ARGV >= 2 or die; + +our @docs; +our @dirs; +our %index; + +our $outdir; + +GetOptions("i=s" => sub { read_index(@_);} ) + or die; + +($outdir,@docs) = @ARGV; + +sub write_file ($$) { + my ($opath, $odata) = @_; + print STDOUT "Writing: $opath\n"; + my $out = new IO::File "$opath.new", '>' or die "$opath $!"; + print $out $odata or die $!; + rename "$opath.new", "$opath" or die "$opath $!"; +} + +sub make_page ($$$) { + my ($file,$title,$content) = @_; + my $o = ''; + my $h1; + if ( $title eq "" ) + { + $title = $h1 = "Xen Documentation"; + } + else + { + $h1 = "<a href=\"../index.(?:html|txt)\">Xen Documentation</a> - $title"; + $title = "Xen Documentation - $title"; + } + $o .= <<END; +<html><head><title>$title</title></head> +<body> +<h1>$h1</h1> +<ul> +$content +</ul> +</body></html> +END + write_file($file, $o); +} + +sub make_linktext ($) { + my ($l) = @_; + return "$1($2)" if $l =~ m,^man/(.*)\.([0-9].*)\.html,; + $l =~ s/.(html)$//g; + return $index{$l} if exists $index{$l}; + return basename($l); +} + +sub make_link ($$) { + my ($ref,$base) = @_; + + my $txt = make_linktext($ref); + $ref = basename($ref) if $base; + + return "<li><a href=\"$ref\">$txt</a></li>\n"; +} + +sub make_links ($$@) { + my ($dir,$base,@docs) = @_; + my $idx = ''; + foreach my $of (sort { $a cmp $b } @docs) { + $idx .= make_link($of,$base); + } + return $idx; +} + +sub read_index ($$) { + my ($opt, $val) = @_; + my $idx = new IO::File "$val", '<' or die "$val $!"; + while ($_ = $idx->getline()) { + s/^\s+//; + s/\s+$//; + next if m/^\#/; + next unless m/\S/; + m/^(\S+)\s+(\S.*)$/ or die; + $index{$1} = $2; + } +} + +for (@docs) { s,^\Q$outdir\E/,, } + +@docs = grep { -e "$outdir/$_" && (make_linktext($_) ne "NO-INDEX") } @docs; + +my $top = ''; + +foreach my $od (sort { $a cmp $b } uniq map { dirname($_) } @docs) { + my @d = (grep /^\Q$od\E/, @docs); + if ( @d == 1 and $d[0] eq "$od/index.html" ) + { + $top .= "<li><a href=\"${od}/index.html\">${od}/index.html</a></li>\n"; + } + else + { + my $links = make_links($od,0,@d); + $top .= <<END; +<li><a href=\"${od}/index.html\">$od</a></li> +<ul> +$links +</ul> +END + + $links = make_links($od,1,@d); + my $idx = ''; + $idx .= <<END; +<li>$od</li> +<ul> +$links +</ul> +END + make_page("$outdir/$od/index.html", $od, $idx); + } +} + +make_page("$outdir/index.html", "", $top); ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 11 of 15 v2] docs: generate an index for the html output 2011-11-25 14:49 ` [PATCH 11 of 15 v2] docs: generate an index for the html output Ian Campbell @ 2011-11-25 18:43 ` Roger Pau Monné 2011-11-29 9:41 ` Ian Campbell 0 siblings, 1 reply; 23+ messages in thread From: Roger Pau Monné @ 2011-11-25 18:43 UTC (permalink / raw) To: Ian Campbell; +Cc: ian.jackson, xen-devel 2011/11/25 Ian Campbell <ian.campbell@citrix.com>: > # HG changeset patch > # User Ian Campbell <ian.campbell@citrix.com> > # Date 1322231661 0 > # Node ID 00ea49f77bdcef16251e3773c99fc02394524b83 > # Parent ddeac8b237e4f71d05c817fa8432417886e7e202 > docs: generate an index for the html output > > nb: I'm not a Perl wizard... > > Signed-off-by: Ian Campbell <ian.campbell@citrix.com> > > diff -r ddeac8b237e4 -r 00ea49f77bdc docs/INDEX > --- /dev/null Thu Jan 01 00:00:00 1970 +0000 > +++ b/docs/INDEX Fri Nov 25 14:34:21 2011 +0000 > @@ -0,0 +1,5 @@ > +misc/hvm-emulated-unplug Xen HVM emulated device unplug protocol > + > +# These are not all that useful anymore, hide them from the index > +interface/index NO-INDEX > +user/index NO-INDEX > diff -r ddeac8b237e4 -r 00ea49f77bdc docs/Makefile > --- a/docs/Makefile Fri Nov 25 11:53:06 2011 +0000 > +++ b/docs/Makefile Fri Nov 25 14:34:21 2011 +0000 > @@ -45,7 +45,7 @@ ps: $(DOC_PS) > pdf: $(DOC_PDF) > > .PHONY: html > -html: $(DOC_HTML) > +html: $(DOC_HTML) html/index.html > > .PHONY: txt > txt: $(DOC_TXT) > @@ -128,6 +128,9 @@ html/%/index.html: src/%.tex > $< 1>/dev/null 2>/dev/null ; else \ > echo "latex2html not installed; skipping $*."; fi > > +html/index.html: $(DOC_HTML) ./gen-html-index INDEX > + ./gen-html-index -i INDEX html $(DOC_HTML) > + > html/%.html: %.markdown > @$(INSTALL_DIR) $(@D) > @set -e ; if which $(MARKDOWN) 1>/dev/null 2>/dev/null; then \ > diff -r ddeac8b237e4 -r 00ea49f77bdc docs/gen-html-index > --- /dev/null Thu Jan 01 00:00:00 1970 +0000 > +++ b/docs/gen-html-index Fri Nov 25 14:34:21 2011 +0000 > @@ -0,0 +1,136 @@ > +#!/usr/bin/perl -w What about using the following: #!/usr/bin/env perl use warnings; From what I've read (and tried), "-w" is equivalent to "$^W = 1" and "use warnings", I think "use warnings" is the clearer way to do this. The only problem is that "use warnings" requires perl 5.6, but from what I see this is quite an old version of perl (from 2002 more or less) so every modern Linux distro comes with 5.10 at least. _______________________________________________ Xen-devel mailing list Xen-devel@lists.xensource.com http://lists.xensource.com/xen-devel ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 11 of 15 v2] docs: generate an index for the html output 2011-11-25 18:43 ` Roger Pau Monné @ 2011-11-29 9:41 ` Ian Campbell 0 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-29 9:41 UTC (permalink / raw) To: Roger Pau Monné; +Cc: xen-devel@lists.xensource.com, Ian Jackson On Fri, 2011-11-25 at 18:43 +0000, Roger Pau Monné wrote: > > diff -r ddeac8b237e4 -r 00ea49f77bdc docs/gen-html-index > > --- /dev/null Thu Jan 01 00:00:00 1970 +0000 > > +++ b/docs/gen-html-index Fri Nov 25 14:34:21 2011 +0000 > > @@ -0,0 +1,136 @@ > > +#!/usr/bin/perl -w > > What about using the following: > > #!/usr/bin/env perl > use warnings; [...] Ian J suggested to use "/usr/bin/env perl" and to invoke the script in the Makefile with perl -w directly (in reality only the Makefile invocation matters). So this is what the following replacement patch does: 8<------------------------------------ # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322559594 0 # Node ID f2be6269d5e23dfc71c627aef588adddc6a0da8a # Parent ddeac8b237e4f71d05c817fa8432417886e7e202 docs: generate an index for the html output nb: I'm not a Perl wizard... Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r ddeac8b237e4 -r f2be6269d5e2 docs/INDEX --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/INDEX Tue Nov 29 09:39:54 2011 +0000 @@ -0,0 +1,5 @@ +misc/hvm-emulated-unplug Xen HVM emulated device unplug protocol + +# These are not all that useful anymore, hide them from the index +interface/index NO-INDEX +user/index NO-INDEX diff -r ddeac8b237e4 -r f2be6269d5e2 docs/Makefile --- a/docs/Makefile Fri Nov 25 11:53:06 2011 +0000 +++ b/docs/Makefile Tue Nov 29 09:39:54 2011 +0000 @@ -45,7 +45,7 @@ ps: $(DOC_PS) pdf: $(DOC_PDF) .PHONY: html -html: $(DOC_HTML) +html: $(DOC_HTML) html/index.html .PHONY: txt txt: $(DOC_TXT) @@ -128,6 +128,9 @@ html/%/index.html: src/%.tex $< 1>/dev/null 2>/dev/null ; else \ echo "latex2html not installed; skipping $*."; fi +html/index.html: $(DOC_HTML) ./gen-html-index INDEX + perl -w -- ./gen-html-index -i INDEX html $(DOC_HTML) + html/%.html: %.markdown @$(INSTALL_DIR) $(@D) @set -e ; if which $(MARKDOWN) 1>/dev/null 2>/dev/null; then \ diff -r ddeac8b237e4 -r f2be6269d5e2 docs/gen-html-index --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/gen-html-index Tue Nov 29 09:39:54 2011 +0000 @@ -0,0 +1,136 @@ +#!/usr/bin/env perl + +# +# Generate indexes for html documentation +# + +use strict; +use warnings; + +use Getopt::Long; +use IO::File; +use File::Basename; +use List::MoreUtils qw/ uniq /; + +Getopt::Long::Configure('bundling'); + +@ARGV >= 2 or die; + +our @docs; +our @dirs; +our %index; + +our $outdir; + +GetOptions("i=s" => sub { read_index(@_);} ) + or die; + +($outdir,@docs) = @ARGV; + +sub write_file ($$) { + my ($opath, $odata) = @_; + print STDOUT "Writing: $opath\n"; + my $out = new IO::File "$opath.new", '>' or die "$opath $!"; + print $out $odata or die $!; + rename "$opath.new", "$opath" or die "$opath $!"; +} + +sub make_page ($$$) { + my ($file,$title,$content) = @_; + my $o = ''; + my $h1; + if ( $title eq "" ) + { + $title = $h1 = "Xen Documentation"; + } + else + { + $h1 = "<a href=\"../index.(?:html|txt)\">Xen Documentation</a> - $title"; + $title = "Xen Documentation - $title"; + } + $o .= <<END; +<html><head><title>$title</title></head> +<body> +<h1>$h1</h1> +<ul> +$content +</ul> +</body></html> +END + write_file($file, $o); +} + +sub make_linktext ($) { + my ($l) = @_; + return "$1($2)" if $l =~ m,^man/(.*)\.([0-9].*)\.html,; + $l =~ s/.(html)$//g; + return $index{$l} if exists $index{$l}; + return basename($l); +} + +sub make_link ($$) { + my ($ref,$base) = @_; + + my $txt = make_linktext($ref); + $ref = basename($ref) if $base; + + return "<li><a href=\"$ref\">$txt</a></li>\n"; +} + +sub make_links ($$@) { + my ($dir,$base,@docs) = @_; + my $idx = ''; + foreach my $of (sort { $a cmp $b } @docs) { + $idx .= make_link($of,$base); + } + return $idx; +} + +sub read_index ($$) { + my ($opt, $val) = @_; + my $idx = new IO::File "$val", '<' or die "$val $!"; + while ($_ = $idx->getline()) { + s/^\s+//; + s/\s+$//; + next if m/^\#/; + next unless m/\S/; + m/^(\S+)\s+(\S.*)$/ or die; + $index{$1} = $2; + } +} + +for (@docs) { s,^\Q$outdir\E/,, } + +@docs = grep { -e "$outdir/$_" && (make_linktext($_) ne "NO-INDEX") } @docs; + +my $top = ''; + +foreach my $od (sort { $a cmp $b } uniq map { dirname($_) } @docs) { + my @d = (grep /^\Q$od\E/, @docs); + if ( @d == 1 and $d[0] eq "$od/index.html" ) + { + $top .= "<li><a href=\"${od}/index.html\">${od}/index.html</a></li>\n"; + } + else + { + my $links = make_links($od,0,@d); + $top .= <<END; +<li><a href=\"${od}/index.html\">$od</a></li> +<ul> +$links +</ul> +END + + $links = make_links($od,1,@d); + my $idx = ''; + $idx .= <<END; +<li>$od</li> +<ul> +$links +</ul> +END + make_page("$outdir/$od/index.html", $od, $idx); + } +} + +make_page("$outdir/index.html", "", $top); _______________________________________________ Xen-devel mailing list Xen-devel@lists.xensource.com http://lists.xensource.com/xen-devel ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 12 of 15 v2] docs: move user and interface .tex documents under reference 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (10 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 11 of 15 v2] docs: generate an index for the html output Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 13 of 15 v2] libxlu: add xlu_cfg_get_list_as_string_list Ian Campbell ` (2 subsequent siblings) 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322231662 0 # Node ID 9e98f587da45fced29dc9c317f403f53e3fec904 # Parent 00ea49f77bdcef16251e3773c99fc02394524b83 docs: move user and interface .tex documents under reference. Taking over the top level "user" entry with a relatively obsolete document is a bit of an annoyance but these docs are not so out of date that they should be deleted. Move them out of the top-level instead. (the original motivation here was to allow for user/xl-domain-cfg.markdown but we have since decided to go with man/xl.cfg.pod.5 instead so perhaps this is a waste of time) Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 00ea49f77bdc -r 9e98f587da45 docs/INDEX --- a/docs/INDEX Fri Nov 25 14:34:21 2011 +0000 +++ b/docs/INDEX Fri Nov 25 14:34:22 2011 +0000 @@ -1,5 +1,5 @@ misc/hvm-emulated-unplug Xen HVM emulated device unplug protocol # These are not all that useful anymore, hide them from the index -interface/index NO-INDEX -user/index NO-INDEX +reference/interface/index NO-INDEX +reference/user/index NO-INDEX diff -r 00ea49f77bdc -r 9e98f587da45 docs/Makefile --- a/docs/Makefile Fri Nov 25 14:34:21 2011 +0000 +++ b/docs/Makefile Fri Nov 25 14:34:22 2011 +0000 @@ -14,7 +14,7 @@ DOC_TEX := src/user.tex src/interface.t DOC_MARKDOWN := $(wildcard misc/*.markdown) DOC_PS := $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX)) DOC_PDF := $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX)) -DOC_HTML := $(patsubst src/%.tex,html/%/index.html,$(DOC_TEX)) \ +DOC_HTML := $(patsubst src/%.tex,html/reference/%/index.html,$(DOC_TEX)) \ $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) \ $(patsubst man/%.pod.1,html/man/%.1.html,$(DOC_MAN1SRC)) \ $(patsubst man/%.pod.5,html/man/%.5.html,$(DOC_MAN5SRC)) @@ -119,14 +119,14 @@ ps/%.ps: %.dvi %.eps: %.fig $(FIG2DEV) -L eps $< $@ -html/%/index.html: src/%.tex +html/reference/%/index.html: src/%.tex @$(INSTALL_DIR) $(@D) @set -e ; if which $(LATEX2HTML) 1>/dev/null 2>/dev/null; then \ - echo "Running latex2html to generate $*/index.html ... "; \ + echo "Running latex2html to generate reference/$*/index.html ... "; \ $(LATEX2HTML) -split 0 -show_section_numbers -toc_depth 3 -nonavigation \ -numbered_footnotes -local_icons -noinfo -math -dir $(@D) \ $< 1>/dev/null 2>/dev/null ; else \ - echo "latex2html not installed; skipping $*."; fi + echo "latex2html not installed; skipping reference/$*."; fi html/index.html: $(DOC_HTML) ./gen-html-index INDEX ./gen-html-index -i INDEX html $(DOC_HTML) ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 13 of 15 v2] libxlu: add xlu_cfg_get_list_as_string_list 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (11 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 12 of 15 v2] docs: move user and interface .tex documents under reference Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 14 of 15 v2] xl: make bootloader_args a list Ian Campbell 2011-11-25 14:49 ` [PATCH 15 of 15 v2] docs: install txt files as html Ian Campbell 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322231691 0 # Node ID 5ce5f2cdb7be8faed396b62ce26b4ad8669db0bf # Parent 9e98f587da45fced29dc9c317f403f53e3fec904 libxlu: add xlu_cfg_get_list_as_string_list Returns a cfg list as a libxl_string_list. Use this to simplify the parsing of device model extra args. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 9e98f587da45 -r 5ce5f2cdb7be tools/libxl/libxlu_cfg.c --- a/tools/libxl/libxlu_cfg.c Fri Nov 25 14:34:22 2011 +0000 +++ b/tools/libxl/libxlu_cfg.c Fri Nov 25 14:34:51 2011 +0000 @@ -254,6 +254,29 @@ int xlu_cfg_get_list(const XLU_Config *c return 0; } +int xlu_cfg_get_list_as_string_list(const XLU_Config *cfg, const char *n, + libxl_string_list *psl, int dont_warn) { + int i, rc, nr; + XLU_ConfigList *list; + libxl_string_list sl; + + rc = xlu_cfg_get_list(cfg, n, &list, &nr, dont_warn); + if (rc) return rc; + + sl = malloc(sizeof(char*)*(nr + 1)); + if (sl == NULL) return ENOMEM; + + for (i=0; i<nr; i++) { + const char *a = xlu_cfg_get_listitem(list, i); + sl[i] = a ? strdup(a) : NULL; + } + + sl[nr] = NULL; + + *psl = sl; + return 0; +} + const char *xlu_cfg_get_listitem(const XLU_ConfigList *set, int entry) { if (entry < 0 || entry >= set->nvalues) return 0; return set->values[entry]; diff -r 9e98f587da45 -r 5ce5f2cdb7be tools/libxl/libxlutil.h --- a/tools/libxl/libxlutil.h Fri Nov 25 14:34:22 2011 +0000 +++ b/tools/libxl/libxlutil.h Fri Nov 25 14:34:51 2011 +0000 @@ -58,6 +58,8 @@ int xlu_cfg_get_list(const XLU_Config*, int *entries_r /* may be 0 */, int dont_warn); /* there is no need to free *list_r; lifetime is that of the XLU_Config */ +int xlu_cfg_get_list_as_string_list(const XLU_Config *cfg, const char *n, + libxl_string_list *sl, int dont_warn); const char *xlu_cfg_get_listitem(const XLU_ConfigList*, int entry); /* xlu_cfg_get_listitem cannot fail, except that if entry is * out of range it returns 0 (not setting errno) */ diff -r 9e98f587da45 -r 5ce5f2cdb7be tools/libxl/xl_cmdimpl.c --- a/tools/libxl/xl_cmdimpl.c Fri Nov 25 14:34:22 2011 +0000 +++ b/tools/libxl/xl_cmdimpl.c Fri Nov 25 14:34:51 2011 +0000 @@ -529,13 +529,6 @@ static void parse_config_data(const char int pci_msitranslate = 1; int e; - XLU_ConfigList *dmargs; - int nr_dmargs = 0; - XLU_ConfigList *dmargs_hvm; - int nr_dmargs_hvm = 0; - XLU_ConfigList *dmargs_pv; - int nr_dmargs_pv = 0; - libxl_domain_create_info *c_info = &d_config->c_info; libxl_domain_build_info *b_info = &d_config->b_info; @@ -1093,19 +1086,14 @@ skip_vfb: if (!xlu_cfg_get_long (config, "device_model_stubdomain_override", &l, 0)) dm_info->device_model_stubdomain = l; -#define parse_extra_args(type) \ - if (!xlu_cfg_get_list(config, "device_model_args"#type, \ - &dmargs##type, &nr_dmargs##type, 0)) \ - { \ - int i; \ - dm_info->extra##type = \ - xmalloc(sizeof(char*)*(nr_dmargs##type + 1)); \ - dm_info->extra##type[nr_dmargs##type] = NULL; \ - for (i=0; i<nr_dmargs##type; i++) { \ - const char *a = xlu_cfg_get_listitem(dmargs##type, i); \ - dm_info->extra##type[i] = a ? strdup(a) : NULL; \ - } \ - } \ +#define parse_extra_args(type) \ + e = xlu_cfg_get_list_as_string_list(config, "device_model_args"#type, \ + &dm_info->extra##type, 0); \ + if (e && e != ESRCH) { \ + fprintf(stderr,"xl: Unable to parse device_model_args"#type".\n");\ + exit(-ERROR_FAIL); \ + } + /* parse extra args for qemu, common to both pv, hvm */ parse_extra_args(); ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 14 of 15 v2] xl: make bootloader_args a list 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (12 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 13 of 15 v2] libxlu: add xlu_cfg_get_list_as_string_list Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 15 of 15 v2] docs: install txt files as html Ian Campbell 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322231697 0 # Node ID 484b880d2ddf1137bcbfec50c89627626a1cf8a6 # Parent 5ce5f2cdb7be8faed396b62ce26b4ad8669db0bf xl: make bootloader_args a list This is much more natural. Continue to support the old syntax in xl but deprecate it. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 5ce5f2cdb7be -r 484b880d2ddf docs/man/xl.cfg.pod.5 --- a/docs/man/xl.cfg.pod.5 Fri Nov 25 14:34:51 2011 +0000 +++ b/docs/man/xl.cfg.pod.5 Fri Nov 25 14:34:57 2011 +0000 @@ -321,10 +321,11 @@ Run C<PROGRAM> to find the kernel image C<PROGRAM> would be C<pygrub>, which is an emulation of grub/grub2/syslinux. -=item B<bootloader_args=STRING> +=item B<bootloader_args=[ "ARG", "ARG", ...]> -Append B<STRING> (split into words at whitespace) to the arguments to -the B<bootloader> program. XXX this should be a list of strings. +Append B<ARG>s to the arguments to the B<bootloader> +program. Alternatively if the argument is a simple string then it will +be split into words at whitespace (this second option is deprecated). =item B<root="STRING"> diff -r 5ce5f2cdb7be -r 484b880d2ddf tools/libxl/libxl_bootloader.c --- a/tools/libxl/libxl_bootloader.c Fri Nov 25 14:34:51 2011 +0000 +++ b/tools/libxl/libxl_bootloader.c Fri Nov 25 14:34:57 2011 +0000 @@ -58,13 +58,9 @@ static char **make_bootloader_args(libxl flexarray_set(args, nr++, libxl__sprintf(gc, "--output-directory=%s", "/var/run/libxl/")); if (info->u.pv.bootloader_args) { - char *saveptr; - /* Operate on a duplicate since strtok modifes the argument */ - char *dup = libxl__strdup(gc, info->u.pv.bootloader_args); - char *t = strtok_r(dup, " \t\n", &saveptr); - do { - flexarray_set(args, nr++, t); - } while ((t = strtok_r(NULL, " \t\n", &saveptr))); + char *p = info->u.pv.bootloader_args[0]; + while (*(p++)) + flexarray_set(args, nr++, p); } flexarray_set(args, nr++, disk); diff -r 5ce5f2cdb7be -r 484b880d2ddf tools/libxl/libxl_types.idl --- a/tools/libxl/libxl_types.idl Fri Nov 25 14:34:51 2011 +0000 +++ b/tools/libxl/libxl_types.idl Fri Nov 25 14:34:57 2011 +0000 @@ -187,7 +187,7 @@ libxl_domain_build_info = Struct("domain ("pv", Struct(None, [("kernel", libxl_file_reference), ("slack_memkb", uint32), ("bootloader", string), - ("bootloader_args", string), + ("bootloader_args", libxl_string_list), ("cmdline", string), ("ramdisk", libxl_file_reference), ("features", string, True), diff -r 5ce5f2cdb7be -r 484b880d2ddf tools/libxl/xl_cmdimpl.c --- a/tools/libxl/xl_cmdimpl.c Fri Nov 25 14:34:51 2011 +0000 +++ b/tools/libxl/xl_cmdimpl.c Fri Nov 25 14:34:57 2011 +0000 @@ -334,9 +334,14 @@ static void printf_info(int domid, printf("\t(nomigrate %d)\n", b_info->disable_migrate); if (c_info->type == LIBXL_DOMAIN_TYPE_PV && b_info->u.pv.bootloader) { + int i; printf("\t(bootloader %s)\n", b_info->u.pv.bootloader); - if (b_info->u.pv.bootloader_args) - printf("\t(bootloader_args %s)\n", b_info->u.pv.bootloader_args); + if (b_info->u.pv.bootloader_args) { + printf("\t(bootloader_args"); + for (i=0; b_info->u.pv.bootloader_args[i]; i++) + printf(" %s", b_info->u.pv.bootloader_args[i]); + printf(")\n"); + } } printf("\t(image\n"); @@ -515,6 +520,51 @@ static void parse_disk_config(XLU_Config parse_disk_config_multistring(config, 1, &spec, disk); } +static void split_string_into_string_list(const char *str, + const char *delim, + libxl_string_list *psl) +{ + char *s, *saveptr; + const char *p; + libxl_string_list sl; + + int i = 0, nr = 0; + + s = strdup(str); + if (s == NULL) { + fprintf(stderr, "unable to allocate memory to parse bootloader args\n"); + exit(-1); + } + + /* Count number of entries */ + p = strtok_r(s, delim, &saveptr); + do { + nr++; + } while ((p = strtok_r(NULL, delim, &saveptr))); + + free(s); + + s = strdup(str); + + sl = malloc((nr+1) * sizeof (char *)); + if (sl == NULL) { + fprintf(stderr, "unable to allocate memory for bootloader args\n"); + exit(-1); + } + + p = strtok_r(s, delim, &saveptr); + do { + assert(i < nr); + sl[i] = strdup(p); + i++; + } while ((p = strtok_r(NULL, delim, &saveptr))); + sl[i] = NULL; + + *psl = sl; + + free(s); +} + static void parse_config_data(const char *configfile_filename_report, const char *configfile_data, int configfile_len, @@ -739,10 +789,26 @@ static void parse_config_data(const char exit(1); } - xlu_cfg_replace_string (config, "bootloader", - &b_info->u.pv.bootloader, 0); - xlu_cfg_replace_string (config, "bootloader_args", - &b_info->u.pv.bootloader_args, 0); + xlu_cfg_replace_string (config, "bootloader", &b_info->u.pv.bootloader, 0); + switch (xlu_cfg_get_list_as_string_list(config, "bootloader_args", + &b_info->u.pv.bootloader_args, 1)) + { + + case 0: break; /* Success */ + case ESRCH: break; /* Option not present */ + case EINVAL: + if (!xlu_cfg_get_string(config, "bootloader_args", &buf, 0)) { + + fprintf(stderr, "WARNING: Specifying \"bootloader_args\" as a string is deprecated. " + "Please use a list of arguments.\n"); + split_string_into_string_list(buf, " \t\n", + &b_info->u.pv.bootloader_args); + } + break; + default: + fprintf(stderr,"xl: Unable to parse bootloader_args.\n"); + exit(-ERROR_FAIL); + } if (!b_info->u.pv.bootloader && !b_info->u.pv.kernel.path) { fprintf(stderr, "Neither kernel nor bootloader specified\n"); ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 15 of 15 v2] docs: install txt files as html 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell ` (13 preceding siblings ...) 2011-11-25 14:49 ` [PATCH 14 of 15 v2] xl: make bootloader_args a list Ian Campbell @ 2011-11-25 14:49 ` Ian Campbell 14 siblings, 0 replies; 23+ messages in thread From: Ian Campbell @ 2011-11-25 14:49 UTC (permalink / raw) To: xen-devel; +Cc: ian.jackson # HG changeset patch # User Ian Campbell <ian.campbell@citrix.com> # Date 1322232250 0 # Node ID 31e71820ce93b72b0223882f6c2e1f461920bda9 # Parent 484b880d2ddf1137bcbfec50c89627626a1cf8a6 docs: install txt files as html A browser will display them just fine. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> diff -r 484b880d2ddf -r 31e71820ce93 docs/INDEX --- a/docs/INDEX Fri Nov 25 14:34:57 2011 +0000 +++ b/docs/INDEX Fri Nov 25 14:44:10 2011 +0000 @@ -1,5 +1,7 @@ misc/hvm-emulated-unplug Xen HVM emulated device unplug protocol +misc/console.txt Xen PV Console notes + # These are not all that useful anymore, hide them from the index reference/interface/index NO-INDEX reference/user/index NO-INDEX diff -r 484b880d2ddf -r 31e71820ce93 docs/Makefile --- a/docs/Makefile Fri Nov 25 14:34:57 2011 +0000 +++ b/docs/Makefile Fri Nov 25 14:44:10 2011 +0000 @@ -17,7 +17,8 @@ DOC_PDF := $(patsubst src/%.tex,pdf/%.p DOC_HTML := $(patsubst src/%.tex,html/reference/%/index.html,$(DOC_TEX)) \ $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) \ $(patsubst man/%.pod.1,html/man/%.1.html,$(DOC_MAN1SRC)) \ - $(patsubst man/%.pod.5,html/man/%.5.html,$(DOC_MAN5SRC)) + $(patsubst man/%.pod.5,html/man/%.5.html,$(DOC_MAN5SRC)) \ + $(patsubst %.txt,html/%.txt,$(wildcard misc/*.txt)) DOC_TXT := $(patsubst %.txt,txt/%.txt,$(wildcard misc/*.txt)) \ $(patsubst %.markdown,txt/%.txt,$(DOC_MARKDOWN)) \ $(patsubst man/%.pod.1,txt/man/%.1.txt,$(DOC_MAN1SRC)) \ @@ -139,6 +140,10 @@ html/%.html: %.markdown $(call move-if-changed,$@.tmp,$@) ; else \ echo "markdown not installed; skipping $*.html."; fi +html/%.txt: %.txt + @$(INSTALL_DIR) $(@D) + cp $< $@ + html/man/%.1.html: man/%.pod.1 Makefile $(INSTALL_DIR) $(@D) $(POD2HTML) --infile=$< --outfile=$@.tmp ^ permalink raw reply [flat|nested] 23+ messages in thread
end of thread, other threads:[~2011-11-29 13:54 UTC | newest] Thread overview: 23+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2011-11-25 14:49 [PATCH 00 of 15 v2] Documentation updates Ian Campbell 2011-11-25 14:49 ` [PATCH 01 of 15 v2] Replace references to old wiki with ones to new Ian Campbell 2011-11-29 13:54 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 02 of 15 v2] docs: xlexample.hvm is missing "builder = 'hvm'" Ian Campbell 2011-11-25 14:49 ` [PATCH 03 of 15 v2] README: add markdown to dependency list Ian Campbell 2011-11-25 14:49 ` [PATCH 04 of 15 v2] docs: install html and txt versions of manpages Ian Campbell 2011-11-25 14:49 ` [PATCH 05 of 15 v2] docs: add a document describing the xl cfg file syntax Ian Campbell 2011-11-25 15:05 ` Ian Campbell 2011-11-25 15:16 ` Paul Durrant 2011-11-25 16:39 ` Ian Campbell 2011-11-25 17:06 ` Paul Durrant 2011-11-25 14:49 ` [PATCH 06 of 15 v2] xl: the name field in a guest config file is mandatory Ian Campbell 2011-11-25 14:49 ` [PATCH 07 of 15 v2] xlu: add "dont_warn" to xlu_cfg_* Ian Campbell 2011-11-25 14:49 ` [PATCH 08 of 15 v2] libxl: use named options for tsc_mode Ian Campbell 2011-11-25 14:49 ` [PATCH 09 of 15 v2] docs: remove non-breaking spaces from sedf_scheduler_mini-HOWTO.txt Ian Campbell 2011-11-25 14:49 ` [PATCH 10 of 15 v2] docs: tweak markup and wording of qemu upstream doc slightly Ian Campbell 2011-11-25 14:49 ` [PATCH 11 of 15 v2] docs: generate an index for the html output Ian Campbell 2011-11-25 18:43 ` Roger Pau Monné 2011-11-29 9:41 ` Ian Campbell 2011-11-25 14:49 ` [PATCH 12 of 15 v2] docs: move user and interface .tex documents under reference Ian Campbell 2011-11-25 14:49 ` [PATCH 13 of 15 v2] libxlu: add xlu_cfg_get_list_as_string_list Ian Campbell 2011-11-25 14:49 ` [PATCH 14 of 15 v2] xl: make bootloader_args a list Ian Campbell 2011-11-25 14:49 ` [PATCH 15 of 15 v2] docs: install txt files as html Ian Campbell
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.