[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-devel] [PATCH v3 3/3] xl: Improve xl documentation in regards to guest memory management



Improve xl documentation in regards to guest memory management.

Some improvements are suggested by Ian Jackson and Konrad Rzeszutek Wilk.

Signed-off-by: Daniel Kiper <daniel.kiper@xxxxxxxxxx>
---
 docs/man/xl.conf.pod.5            |   15 +++++++++++++++
 docs/misc/libxl_memory.txt        |   38 +++++++++++++++++++++++--------------
 docs/misc/xenstore-paths.markdown |   15 +++++++--------
 tools/examples/xl.conf            |    4 ++++
 4 files changed, 50 insertions(+), 22 deletions(-)

diff --git a/docs/man/xl.conf.pod.5 b/docs/man/xl.conf.pod.5
index 7b9fcac..34d6a5d 100644
--- a/docs/man/xl.conf.pod.5
+++ b/docs/man/xl.conf.pod.5
@@ -55,6 +55,21 @@ reduce the amount of memory given to domain 0 by default.
 
 Default: C<1>
 
+=item B<mem_set_enforce_limit=BOOLEAN>
+
+If enabled, then C<xl mem-set> by default will set a memory allocation
+target and enforce the maximum memory allocation for a given domain.
+If disabled, then C<xl mem-set> by default will set a memory allocation
+target only for a given domain.
+
+The memory allocation target is a suggested amount of memory which
+should be allocated by a guest. It is nice when the guest follows this
+value but it may have its own idea about memory requirments. However,
+it could not allocate more memory than a ceiling known as the maximum
+memory allocation.
+
+Default: C<1>
+
 =item B<run_hotplug_scripts=BOOLEAN>
 
 If disabled hotplug scripts will be called from udev, as it used to
diff --git a/docs/misc/libxl_memory.txt b/docs/misc/libxl_memory.txt
index 253476d..f9b9a67 100644
--- a/docs/misc/libxl_memory.txt
+++ b/docs/misc/libxl_memory.txt
@@ -15,14 +15,19 @@
              |  |          |  |    |        | target  |          |            
              |  | guest    |  |    | build  |         |          |            
              |  |          |  |    | start  |         |          |            
-      static |  |          |  |    |        |         |          |            
-     maximum |  +----------+  |    +        +         +          +            
-             |  |          |  |                                               
-             |  |          |  |                                               
+             |  |          |  |    |        |         |          |            
+             |  +----------+  |    +        +         +          +            
+      static |  |          |  |                                               
+     maximum |  |          |  |                                               
              |  | balloon  |  | build                                         
              |  |          |  | maximum                                       
              |  |          |  |                                               
-             +  +----------+  +                                               
+             |  +----------+  +                                               
+             |  |          |
+             |  | memory   |
+             |  | hotplug  |
+             |  |          |
+             +  +----------+
                 
                 
     extra internal = LIBXL_MAXMEM_CONSTANT
@@ -31,8 +36,8 @@
     static maximum = libxl_domain_build_info.max_memkb
     video = libxl_domain_build_info.video_memkb
     build start = libxl_domain_build_info.target_memkb
-    libxl_domain_setmaxmem -> xen maximum
-    libxl_set_memory_target -> actual target
+    libxl_domain_setmaxmem -> xen maximum & static maximum
+    libxl_set_memory_target -> actual target & optionaly xen maximum
                 
                 
  === Domain memory breakdown: PV guests ==================================
@@ -49,22 +54,27 @@
              |  |          |  |    |        | actual  | maximum  | 
              |  | guest    |  |    | build  | target  |          |            
              |  |          |  |    | start  |         |          |            
-      static |  |          |  |    |        |         |          |            
-     maximum |  +----------+  |    +        +         +          +            
+             |  |          |  |    |        |         |          |            
+             |  +----------+  |    +        +         +          +            
              |  |          |  |                                               
-             |  |          |  |                                               
-             |  | balloon  |  | build                                         
+      static |  |          |  |                                               
+     maximum |  | balloon  |  | build                                         
              |  |          |  | maximum                                       
              |  |          |  |                                               
-             +  +----------+  +                                               
+             |  +----------+  +                                               
+             |  |          |
+             |  | memory   |
+             |  | hotplug  |
+             |  |          |
+             +  +----------+
                 
 
     extra internal = LIBXL_MAXMEM_CONSTANT
     extra external = LIBXL_PV_EXTRA_MEMORY
     static maximum = libxl_domain_build_info.max_memkb
     build start = libxl_domain_build_info.target_memkb
-    libxl_domain_setmaxmem -> xen maximum
-    libxl_set_memory_target -> actual target
+    libxl_domain_setmaxmem -> xen maximum & static maximum
+    libxl_set_memory_target -> actual target & optionaly xen maximum
 
 
  ========================================================================= */
diff --git a/docs/misc/xenstore-paths.markdown 
b/docs/misc/xenstore-paths.markdown
index 535830e..911d1ad 100644
--- a/docs/misc/xenstore-paths.markdown
+++ b/docs/misc/xenstore-paths.markdown
@@ -124,18 +124,17 @@ This protocol is not currently well documented.
 
 #### ~/memory/static-max = MEMKB []
 
-Specifies a static maximum amount memory which this domain should
-expect to be given. In the absence of in-guest memory hotplug support
-this set on domain boot and is usually the maximum amount of RAM which
-a guest can make use of. See [docs/misc/libxl_memory.txt][LIBXLMEM]
-for a description of how memory is accounted for in toolstacks using
-the libxl library.
+Specifies a static maximum amount of memory which this domain should
+expect to be given. It is usually the maximum amount of RAM which a guest
+can make use of. This value is set on the domain boot and can be changed by
+xl mem-max. See [docs/misc/libxl_memory.txt][LIBXLMEM] for a description
+of how the memory is accounted for in toolstacks using the libxl library.
 
 #### ~/memory/target = MEMKB []
 
 The current balloon target for the domain. The balloon driver within
-the guest is expected to make every effort to every effort use no more
-than this amount of RAM.
+the guest is expected to make every effort to use no more than this
+amount of RAM.
 
 #### ~/memory/videoram = MEMKB [HVM,INTERNAL]
 
diff --git a/tools/examples/xl.conf b/tools/examples/xl.conf
index b0caa32..c48caad 100644
--- a/tools/examples/xl.conf
+++ b/tools/examples/xl.conf
@@ -4,6 +4,10 @@
 # memory to create a domain
 #autoballoon=1
 
+# xl mem-set by default will set a memory allocation target and enforce
+# the maximum memory allocation for a given domain
+#mem_set_enforce_limit=1
+
 # full path of the lockfile used by xl during domain creation
 #lockfile="/var/lock/xl"
 
-- 
1.7.10.4


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel


 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.