tools/xenstore: set open file descriptor limit for xenstored
authorJuergen Gross <jgross@suse.com>
Tue, 12 Oct 2021 13:41:48 +0000 (15:41 +0200)
committerIan Jackson <iwj@xenproject.org>
Mon, 18 Oct 2021 13:17:28 +0000 (14:17 +0100)
Add a configuration item for the maximum number of open file
descriptors xenstored should be allowed to have.

The default should be "unlimited" in order not to restrict xenstored
in the number of domains it can support, but unfortunately the kernel
is normally limiting the maximum value via /proc/sys/fs/nr_open [1],
[2]. So check that file to exist and if it does, limit the maximum
value to the one specified by /proc/sys/fs/nr_open.

As an aid for the admin configuring the value add a comment specifying
the common needs of xenstored for the different domain types.

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=60fd760fb9ff7034360bab7137c917c0330628c2
[2]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0c2d64fb6cae9aae480f6a46cfe79f8d7d48b59f

Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Ian Jackson <iwj@xenproject.org>
Release-Acked-by: Ian Jackson <iwj@xenproject.org>
tools/hotplug/Linux/init.d/sysconfig.xencommons.in
tools/hotplug/Linux/launch-xenstore.in

index b83101ab7e03caee3756380ffb7aa1b3fa385ffa..433e4849af1b002e6369b543a67ba9521726ebaa 100644 (file)
 # Changing this requires a reboot to take effect.
 #XENSTORED=@XENSTORED@
 
+## Type: string
+## Default: unlimited
+#
+# Select maximum number of file descriptors xenstored is allowed to have
+# opened at one time.
+# For each HVM domain xenstored might need up to 5 open file descriptors,
+# PVH and PV domains will require up to 3 open file descriptors. Additionally
+# 20-30 file descriptors will be opened for internal uses.
+# The specified value (including "unlimited") will be capped by the contents
+# of /proc/sys/fs/nr_open if existing.
+# Only evaluated if XENSTORETYPE is "daemon".
+#XENSTORED_MAX_OPEN_FDS=unlimited
+
 ## Type: string
 ## Default: ""
 #
index 1747c9606563204e208fc3693837b2a7b169fb47..8438af99774a058ae4aef638b81db7ebd1c0111e 100644 (file)
@@ -54,6 +54,7 @@ test -f @CONFIG_DIR@/@CONFIG_LEAF_DIR@/xencommons && . @CONFIG_DIR@/@CONFIG_LEAF
 
 [ "$XENSTORETYPE" = "daemon" ] && {
        [ -z "$XENSTORED_TRACE" ] || XENSTORED_ARGS="$XENSTORED_ARGS -T @XEN_LOG_DIR@/xenstored-trace.log"
+       [ -z "$XENSTORED_MAX_OPEN_FDS" ] && XENSTORED_MAX_OPEN_FDS=unlimited
        [ -z "$XENSTORED" ] && XENSTORED=@XENSTORED@
        [ -x "$XENSTORED" ] || {
                echo "No xenstored found"
@@ -62,10 +63,28 @@ test -f @CONFIG_DIR@/@CONFIG_LEAF_DIR@/xencommons && . @CONFIG_DIR@/@CONFIG_LEAF
        [ -z "$XENSTORED_OOM_MEM_THRESHOLD" ] || XENSTORED_OOM_MEM_THRESHOLD=50
        XS_OOM_SCORE=-$(($XENSTORED_OOM_MEM_THRESHOLD * 10))
 
+       [ "$XENSTORED_MAX_OPEN_FDS" = "unlimited" ] || {
+               [ -z "${XENSTORED_MAX_OPEN_FDS//[0-9]}" ] &&
+               [ -n "$XENSTORED_MAX_OPEN_FDS" ] || {
+                       echo "XENSTORED_MAX_OPEN_FDS=$XENSTORED_MAX_OPEN_FDS invalid"
+                       echo "Setting to default \"unlimited\"."
+                       XENSTORED_MAX_OPEN_FDS=unlimited
+               }
+       }
+       [ -r /proc/sys/fs/nr_open ] && {
+               MAX_FDS=`cat /proc/sys/fs/nr_open`
+               [ "$XENSTORED_MAX_OPEN_FDS" = "unlimited" ] && XENSTORED_MAX_OPEN_FDS=$MAX_FDS
+               [ $XENSTORED_MAX_OPEN_FDS -gt $MAX_FDS ] && {
+                       echo "XENSTORED_MAX_OPEN_FDS exceeds system limit."
+                       echo "Setting to \"$MAX_FDS\"."
+                       XENSTORED_MAX_OPEN_FDS=$MAX_FDS
+               }
+       }
+
        rm -f @XEN_RUN_DIR@/xenstored.pid
 
        echo -n Starting $XENSTORED...
-       $XENSTORED --pid-file @XEN_RUN_DIR@/xenstored.pid $XENSTORED_ARGS
+       prlimit --nofile=$XENSTORED_MAX_OPEN_FDS $XENSTORED --pid-file @XEN_RUN_DIR@/xenstored.pid $XENSTORED_ARGS
 
        systemd-notify --booted 2>/dev/null || timeout_xenstore $XENSTORED || exit 1
        XS_PID=`cat @XEN_RUN_DIR@/xenstored.pid`