2015-07-07 12:03:40

by Naresh Kamboju

[permalink] [raw]
Subject: [PATCH] selftests/zram: Adding zram tests

From: Naresh Kamboju <[email protected]>

zram_lib.sh: create library with initialization/cleanup functions
zram01.sh: creates general purpose ram disks with different filesystems
zram02.sh: creates block device for swap
README: ZRAM introduction and Kconfig required.
Makefile: To run zram tests

Author: Alexey Kodanev <[email protected]>
Signed-off-by: Naresh Kamboju <[email protected]>
---
tools/testing/selftests/Makefile | 1 +
tools/testing/selftests/zram/Makefile | 12 ++
tools/testing/selftests/zram/README | 39 ++++++
tools/testing/selftests/zram/zram01.sh | 102 ++++++++++++++
tools/testing/selftests/zram/zram02.sh | 57 ++++++++
tools/testing/selftests/zram/zram_lib.sh | 223 +++++++++++++++++++++++++++++++
6 files changed, 434 insertions(+)
create mode 100644 tools/testing/selftests/zram/Makefile
create mode 100644 tools/testing/selftests/zram/README
create mode 100755 tools/testing/selftests/zram/zram01.sh
create mode 100755 tools/testing/selftests/zram/zram02.sh
create mode 100755 tools/testing/selftests/zram/zram_lib.sh

diff --git a/tools/testing/selftests/Makefile b/tools/testing/selftests/Makefile
index 24ae9e8..9763dd9 100644
--- a/tools/testing/selftests/Makefile
+++ b/tools/testing/selftests/Makefile
@@ -22,6 +22,7 @@ endif
TARGETS += user
TARGETS += vm
TARGETS += x86
+TARGETS += zram
#Please keep the TARGETS list alphabetically sorted
# Run "make quicktest=1 run_tests" or
# "make quicktest=1 kselftest from top level Makefile
diff --git a/tools/testing/selftests/zram/Makefile b/tools/testing/selftests/zram/Makefile
new file mode 100644
index 0000000..a27a797
--- /dev/null
+++ b/tools/testing/selftests/zram/Makefile
@@ -0,0 +1,12 @@
+all:
+
+TEST_PROGS := zram01.sh zram02.sh zram_lib.sh
+
+include ../lib.mk
+
+run_tests:
+ @/bin/bash ./zram01.sh; \
+ /bin/bash ./zram02.sh
+
+clean:
+ $(RM) err.log
diff --git a/tools/testing/selftests/zram/README b/tools/testing/selftests/zram/README
new file mode 100644
index 0000000..36db066
--- /dev/null
+++ b/tools/testing/selftests/zram/README
@@ -0,0 +1,39 @@
+zram: Compressed RAM based block devices
+----------------------------------------
+* Introduction
+
+The zram module creates RAM based block devices named /dev/zram<id>
+(<id> = 0, 1, ...). Pages written to these disks are compressed and stored
+in memory itself. These disks allow very fast I/O and compression provides
+good amounts of memory savings. Some of the usecases include /tmp storage,
+use as swap disks, various caches under /var and maybe many more :)
+
+Statistics for individual zram devices are exported through sysfs nodes at
+/sys/block/zram<id>/
+
+Kconfig required:
+CONFIG_ZRAM=y
+CONFIG_ZRAM_LZ4_COMPRESS=y
+CONFIG_ZPOOL=y
+CONFIG_ZSMALLOC=y
+
+ZRAM Testcases
+--------------
+zram_lib.sh: create library with initialization/cleanup functions
+
+Two functional tests: zram01 and zram02:
+zram01.sh: creates general purpose ram disks with ext4 filesystems
+zram02.sh: creates block device for swap
+
+Commands required for testing:
+ - bc
+ - dd
+ - free
+ - awk
+ - mkswap
+ - swapon
+ - swapoff
+ - mkfs/ mkfs.ext4
+
+For more information please refer:
+kernel-source-tree/Documentation/blockdev/zram.txt
diff --git a/tools/testing/selftests/zram/zram01.sh b/tools/testing/selftests/zram/zram01.sh
new file mode 100755
index 0000000..b63eb5d
--- /dev/null
+++ b/tools/testing/selftests/zram/zram01.sh
@@ -0,0 +1,102 @@
+#!/bin/bash
+# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it would be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+#
+# Test creates several zram devices with different filesystems on them.
+# It fills each device with zeros and checks that compression works.
+#
+# Author: Alexey Kodanev <[email protected]>
+# Modified: Naresh Kamboju <[email protected]>
+
+TCID="zram01"
+ERR_CODE=0
+
+. ./zram_lib.sh
+
+# Test will create the following number of zram devices:
+dev_num=1
+# This is a list of parameters for zram devices.
+# Number of items must be equal to 'dev_num' parameter.
+zram_max_streams="2"
+
+# The zram sysfs node 'disksize' value can be either in bytes,
+# or you can use mem suffixes. But in some old kernels, mem
+# suffixes are not supported, for example, in RHEL6.6GA's kernel
+# layer, it uses strict_strtoull() to parse disksize which does
+# not support mem suffixes, in some newer kernels, they use
+# memparse() which supports mem suffixes. So here we just use
+# bytes to make sure everything works correctly.
+zram_sizes="2097152" # 2MB
+zram_mem_limits="2M"
+zram_filesystems="ext4"
+zram_algs="lzo"
+
+zram_fill_fs()
+{
+ local mem_free0=$(free -m | awk 'NR==2 {print $4}')
+
+ for i in $(seq 0 $(($dev_num - 1))); do
+ echo "fill zram$i..."
+ local b=0
+ while [ true ]; do
+ dd conv=notrunc if=/dev/zero of=zram${i}/file \
+ oflag=append count=1 bs=1024 status=none \
+ > /dev/null 2>&1 || break
+ b=$(($b + 1))
+ done
+ echo "zram$i can be filled with '$b' KB"
+ done
+
+ local mem_free1=$(free -m | awk 'NR==2 {print $4}')
+ local used_mem=$(($mem_free0 - $mem_free1))
+
+ local total_size=0
+ for sm in $zram_sizes; do
+ local s=$(echo $sm | sed 's/M//')
+ total_size=$(($total_size + $s))
+ done
+
+ echo "zram used ${used_mem}M, zram disk sizes ${total_size}M"
+
+ local v=$((100 * $total_size / $used_mem))
+
+ if [ "$v" -lt 100 ]; then
+ echo "FAIL compression ratio: 0.$v:1"
+ ERR_CODE=-1
+ zram_cleanup
+ return
+ fi
+
+ echo "zram compression ratio: $(echo "scale=2; $v / 100 " | bc):1: OK"
+}
+
+zram_load
+zram_max_streams
+zram_compress_alg
+zram_set_disksizes
+zram_set_memlimit
+zram_makefs
+zram_mount
+
+zram_fill_fs
+zram_cleanup
+zram_unload
+
+if [ $ERR_CODE -ne 0 ]; then
+ echo "$TCID : [FAIL]"
+else
+ echo "$TCID : [PASS]"
+fi
diff --git a/tools/testing/selftests/zram/zram02.sh b/tools/testing/selftests/zram/zram02.sh
new file mode 100755
index 0000000..81855ce
--- /dev/null
+++ b/tools/testing/selftests/zram/zram02.sh
@@ -0,0 +1,57 @@
+#!/bin/bash
+# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it would be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+#
+# Test checks that we can create swap zram device.
+#
+# Author: Alexey Kodanev <[email protected]>
+# Modified: Naresh Kamboju <[email protected]>
+
+TCID="zram02"
+ERR_CODE=0
+
+. ./zram_lib.sh
+
+# Test will create the following number of zram devices:
+dev_num=1
+# This is a list of parameters for zram devices.
+# Number of items must be equal to 'dev_num' parameter.
+zram_max_streams="2"
+
+# The zram sysfs node 'disksize' value can be either in bytes,
+# or you can use mem suffixes. But in some old kernels, mem
+# suffixes are not supported, for example, in RHEL6.6GA's kernel
+# layer, it uses strict_strtoull() to parse disksize which does
+# not support mem suffixes, in some newer kernels, they use
+# memparse() which supports mem suffixes. So here we just use
+# bytes to make sure everything works correctly.
+zram_sizes="1048576" # 1M
+zram_mem_limits="1M"
+
+zram_load
+zram_max_streams
+zram_set_disksizes
+zram_set_memlimit
+zram_makeswap
+zram_swapoff
+zram_cleanup
+zram_unload
+
+if [ $ERR_CODE -ne 0 ]; then
+ echo "$TCID : [FAIL]"
+else
+ echo "$TCID : [PASS]"
+fi
diff --git a/tools/testing/selftests/zram/zram_lib.sh b/tools/testing/selftests/zram/zram_lib.sh
new file mode 100755
index 0000000..c40a1cf
--- /dev/null
+++ b/tools/testing/selftests/zram/zram_lib.sh
@@ -0,0 +1,223 @@
+#!/bin/sh
+# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it would be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+#
+# Author: Alexey Kodanev <[email protected]>
+# Modified: Naresh Kamboju <[email protected]>
+
+MODULE=0
+dev_makeswap=-1
+dev_mounted=-1
+
+trap INT
+
+zram_cleanup()
+{
+ echo "zram cleanup"
+ local i=
+ for i in $(seq 0 $dev_makeswap); do
+ swapoff /dev/zram$i
+ done
+
+ for i in $(seq 0 $dev_mounted); do
+ umount /dev/zram$i
+ done
+
+ for i in $(seq 0 $(($dev_num - 1))); do
+ echo 1 > /sys/block/zram${i}/reset
+ rm -rf zram$i
+ done
+
+}
+
+zram_unload()
+{
+ if [ $MODULE -ne 0 ] ; then
+ echo "zram rmmod zram"
+ rmmod zram > /dev/null 2>&1
+ fi
+}
+
+zram_load()
+{
+ # check zram module exists
+ MODULE_PATH=/lib/modules/`uname -r`/kernel/drivers/zram/zram.ko
+ if [ -f $MODULE_PATH ]; then
+ MODULE=1
+ echo "create '$dev_num' zram device(s)"
+ modprobe zram num_devices=$dev_num || \
+ echo "failed to insert zram module"
+
+ dev_num_created=$(ls /dev/zram* | wc -w)
+
+ if [ "$dev_num_created" -ne "$dev_num" ]; then
+ echo "unexpected num of devices: $dev_num_created"
+ ERR_CODE=-1
+ else
+ echo "zram load module successful"
+ fi
+ elif [ -b /dev/zram0 ]; then
+ echo "/dev/zram0 device file found: OK"
+ else
+ echo "ERROR: No zram.ko module or no /dev/zram0 device found"
+ echo "$TCID : CONFIG_ZRAM is not set"
+ exit 1
+ fi
+}
+
+zram_max_streams()
+{
+ echo "set max_comp_streams to zram device(s)"
+
+ local i=0
+ for max_s in $zram_max_streams; do
+ local sys_path="/sys/block/zram${i}/max_comp_streams"
+ echo $max_s > $sys_path || \
+ echo "FAIL failed to set '$max_s' to $sys_path"
+ sleep 1
+ local max_streams=$(cat $sys_path)
+
+ [ "$max_s" -ne "$max_streams" ] && \
+ echo "FAIL can't set max_streams '$max_s', get $max_stream"
+
+ i=$(($i + 1))
+ echo "$sys_path = '$max_streams' ($i/$dev_num)"
+ done
+
+ echo "zram max streams: OK"
+}
+
+zram_compress_alg()
+{
+ echo "test that we can set compression algorithm"
+
+ local algs=$(cat /sys/block/zram0/comp_algorithm)
+ echo "supported algs: $algs"
+ local i=0
+ for alg in $zram_algs; do
+ local sys_path="/sys/block/zram${i}/comp_algorithm"
+ echo "$alg" > $sys_path || \
+ echo "FAIL can't set '$alg' to $sys_path"
+ i=$(($i + 1))
+ echo "$sys_path = '$alg' ($i/$dev_num)"
+ done
+
+ echo "zram set compression algorithm: OK"
+}
+
+zram_set_disksizes()
+{
+ echo "set disk size to zram device(s)"
+ local i=0
+ for ds in $zram_sizes; do
+ local sys_path="/sys/block/zram${i}/disksize"
+ echo "$ds" > $sys_path || \
+ echo "FAIL can't set '$ds' to $sys_path"
+
+ i=$(($i + 1))
+ echo "$sys_path = '$ds' ($i/$dev_num)"
+ done
+
+ echo "zram set disksizes: OK"
+}
+
+zram_set_memlimit()
+{
+ echo "set memory limit to zram device(s)"
+
+ local i=0
+ for ds in $zram_mem_limits; do
+ local sys_path="/sys/block/zram${i}/mem_limit"
+ echo "$ds" > $sys_path || \
+ echo "FAIL can't set '$ds' to $sys_path"
+
+ i=$(($i + 1))
+ echo "$sys_path = '$ds' ($i/$dev_num)"
+ done
+
+ echo "zram set memory limit: OK"
+}
+
+zram_makeswap()
+{
+ echo "make swap with zram device(s)"
+ local i=0
+ for i in $(seq 0 $(($dev_num - 1))); do
+ mkswap /dev/zram$i > err.log 2>&1
+ if [ $? -ne 0 ]; then
+ cat err.log
+ echo "FAIL mkswap /dev/zram$1 failed"
+ fi
+
+ swapon /dev/zram$i > err.log 2>&1
+ if [ $? -ne 0 ]; then
+ cat err.log
+ echo "FAIL swapon /dev/zram$1 failed"
+ fi
+
+ echo "done with /dev/zram$i"
+ dev_makeswap=$i
+ done
+
+ echo "zram making zram mkswap and swapon: OK"
+}
+
+zram_swapoff()
+{
+ local i=
+ for i in $(seq 0 $dev_makeswap); do
+ swapoff /dev/zram$i > err.log 2>&1
+ if [ $? -ne 0 ]; then
+ cat err.log
+ echo "FAIL swapoff /dev/zram$i failed"
+ fi
+ done
+ dev_makeswap=-1
+
+ echo "zram swapoff: OK"
+}
+
+zram_makefs()
+{
+ local i=0
+ for fs in $zram_filesystems; do
+ # if requested fs not supported default it to ext2
+ which mkfs.$fs > /dev/null 2>&1 || fs=ext2
+
+ echo "make $fs filesystem on /dev/zram$i"
+ mkfs.$fs /dev/zram$i > err.log 2>&1
+ if [ $? -ne 0 ]; then
+ cat err.log
+ echo "FAIL failed to make $fs on /dev/zram$i"
+ fi
+ i=$(($i + 1))
+ echo "zram mkfs.$fs: OK"
+ done
+}
+
+zram_mount()
+{
+ local i=0
+ for i in $(seq 0 $(($dev_num - 1))); do
+ echo "mount /dev/zram$i"
+ mkdir zram$i
+ mount /dev/zram$i zram$i > /dev/null || \
+ echo "FAIL mount /dev/zram$i failed"
+ dev_mounted=$i
+ done
+
+ echo "zram mount of zram device(s): OK"
+}
--
1.9.1


2015-07-23 00:00:33

by Tyler Baker

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests

Hi Naresh,

On 7 July 2015 at 05:03, <[email protected]> wrote:
> From: Naresh Kamboju <[email protected]>
>
> zram_lib.sh: create library with initialization/cleanup functions
> zram01.sh: creates general purpose ram disks with different filesystems
> zram02.sh: creates block device for swap
> README: ZRAM introduction and Kconfig required.
> Makefile: To run zram tests

(./zram01.sh && echo "selftests: zram01.sh [PASS]") || echo
"selftests: zram01.sh [FAIL]"
(./zram02.sh && echo "selftests: zram02.sh [PASS]") || echo
"selftests: zram02.sh [FAIL]"
(./zram_lib.sh && echo "selftests: zram_lib.sh [PASS]") || echo
"selftests: zram_lib.sh [FAIL]"

Above is the output from the run_kselftests.sh. Do we want to run
zram_lib.sh as a test case as it just a library?

> Author: Alexey Kodanev <[email protected]>
> Signed-off-by: Naresh Kamboju <[email protected]>
> ---
> tools/testing/selftests/Makefile | 1 +
> tools/testing/selftests/zram/Makefile | 12 ++
> tools/testing/selftests/zram/README | 39 ++++++
> tools/testing/selftests/zram/zram01.sh | 102 ++++++++++++++
> tools/testing/selftests/zram/zram02.sh | 57 ++++++++
> tools/testing/selftests/zram/zram_lib.sh | 223 +++++++++++++++++++++++++++++++
> 6 files changed, 434 insertions(+)
> create mode 100644 tools/testing/selftests/zram/Makefile
> create mode 100644 tools/testing/selftests/zram/README
> create mode 100755 tools/testing/selftests/zram/zram01.sh
> create mode 100755 tools/testing/selftests/zram/zram02.sh
> create mode 100755 tools/testing/selftests/zram/zram_lib.sh
>
> diff --git a/tools/testing/selftests/Makefile b/tools/testing/selftests/Makefile
> index 24ae9e8..9763dd9 100644
> --- a/tools/testing/selftests/Makefile
> +++ b/tools/testing/selftests/Makefile
> @@ -22,6 +22,7 @@ endif
> TARGETS += user
> TARGETS += vm
> TARGETS += x86
> +TARGETS += zram
> #Please keep the TARGETS list alphabetically sorted
> # Run "make quicktest=1 run_tests" or
> # "make quicktest=1 kselftest from top level Makefile
> diff --git a/tools/testing/selftests/zram/Makefile b/tools/testing/selftests/zram/Makefile
> new file mode 100644
> index 0000000..a27a797
> --- /dev/null
> +++ b/tools/testing/selftests/zram/Makefile
> @@ -0,0 +1,12 @@
> +all:
> +
> +TEST_PROGS := zram01.sh zram02.sh zram_lib.sh
> +
> +include ../lib.mk
> +
> +run_tests:
> + @/bin/bash ./zram01.sh; \
> + /bin/bash ./zram02.sh
> +
> +clean:
> + $(RM) err.log
> diff --git a/tools/testing/selftests/zram/README b/tools/testing/selftests/zram/README
> new file mode 100644
> index 0000000..36db066
> --- /dev/null
> +++ b/tools/testing/selftests/zram/README
> @@ -0,0 +1,39 @@
> +zram: Compressed RAM based block devices
> +----------------------------------------
> +* Introduction
> +
> +The zram module creates RAM based block devices named /dev/zram<id>
> +(<id> = 0, 1, ...). Pages written to these disks are compressed and stored
> +in memory itself. These disks allow very fast I/O and compression provides
> +good amounts of memory savings. Some of the usecases include /tmp storage,
> +use as swap disks, various caches under /var and maybe many more :)
> +
> +Statistics for individual zram devices are exported through sysfs nodes at
> +/sys/block/zram<id>/
> +
> +Kconfig required:
> +CONFIG_ZRAM=y
> +CONFIG_ZRAM_LZ4_COMPRESS=y
> +CONFIG_ZPOOL=y
> +CONFIG_ZSMALLOC=y
> +
> +ZRAM Testcases
> +--------------
> +zram_lib.sh: create library with initialization/cleanup functions
> +
> +Two functional tests: zram01 and zram02:
> +zram01.sh: creates general purpose ram disks with ext4 filesystems
> +zram02.sh: creates block device for swap
> +
> +Commands required for testing:
> + - bc
> + - dd
> + - free
> + - awk
> + - mkswap
> + - swapon
> + - swapoff
> + - mkfs/ mkfs.ext4
> +
> +For more information please refer:
> +kernel-source-tree/Documentation/blockdev/zram.txt
> diff --git a/tools/testing/selftests/zram/zram01.sh b/tools/testing/selftests/zram/zram01.sh
> new file mode 100755
> index 0000000..b63eb5d
> --- /dev/null
> +++ b/tools/testing/selftests/zram/zram01.sh
> @@ -0,0 +1,102 @@
> +#!/bin/bash
> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
> +#
> +# This program is free software; you can redistribute it and/or
> +# modify it under the terms of the GNU General Public License as
> +# published by the Free Software Foundation; either version 2 of
> +# the License, or (at your option) any later version.
> +#
> +# This program is distributed in the hope that it would be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> +# GNU General Public License for more details.
> +#
> +# You should have received a copy of the GNU General Public License
> +# along with this program; if not, write the Free Software Foundation,
> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

checkpatch is complaining about including the FSF address, so lets remove it.

> +#
> +# Test creates several zram devices with different filesystems on them.
> +# It fills each device with zeros and checks that compression works.
> +#
> +# Author: Alexey Kodanev <[email protected]>
> +# Modified: Naresh Kamboju <[email protected]>
> +
> +TCID="zram01"
> +ERR_CODE=0
> +
> +. ./zram_lib.sh
> +
> +# Test will create the following number of zram devices:
> +dev_num=1
> +# This is a list of parameters for zram devices.
> +# Number of items must be equal to 'dev_num' parameter.
> +zram_max_streams="2"
> +
> +# The zram sysfs node 'disksize' value can be either in bytes,
> +# or you can use mem suffixes. But in some old kernels, mem
> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
> +# layer, it uses strict_strtoull() to parse disksize which does
> +# not support mem suffixes, in some newer kernels, they use
> +# memparse() which supports mem suffixes. So here we just use
> +# bytes to make sure everything works correctly.
> +zram_sizes="2097152" # 2MB
> +zram_mem_limits="2M"
> +zram_filesystems="ext4"
> +zram_algs="lzo"
> +
> +zram_fill_fs()
> +{
> + local mem_free0=$(free -m | awk 'NR==2 {print $4}')
> +
> + for i in $(seq 0 $(($dev_num - 1))); do
> + echo "fill zram$i..."
> + local b=0
> + while [ true ]; do
> + dd conv=notrunc if=/dev/zero of=zram${i}/file \
> + oflag=append count=1 bs=1024 status=none \
> + > /dev/null 2>&1 || break
> + b=$(($b + 1))
> + done
> + echo "zram$i can be filled with '$b' KB"
> + done
> +
> + local mem_free1=$(free -m | awk 'NR==2 {print $4}')
> + local used_mem=$(($mem_free0 - $mem_free1))
> +
> + local total_size=0
> + for sm in $zram_sizes; do
> + local s=$(echo $sm | sed 's/M//')
> + total_size=$(($total_size + $s))
> + done
> +
> + echo "zram used ${used_mem}M, zram disk sizes ${total_size}M"
> +
> + local v=$((100 * $total_size / $used_mem))
> +
> + if [ "$v" -lt 100 ]; then
> + echo "FAIL compression ratio: 0.$v:1"
> + ERR_CODE=-1
> + zram_cleanup
> + return
> + fi
> +
> + echo "zram compression ratio: $(echo "scale=2; $v / 100 " | bc):1: OK"
> +}
> +
> +zram_load
> +zram_max_streams
> +zram_compress_alg
> +zram_set_disksizes
> +zram_set_memlimit
> +zram_makefs
> +zram_mount
> +
> +zram_fill_fs
> +zram_cleanup
> +zram_unload
> +
> +if [ $ERR_CODE -ne 0 ]; then
> + echo "$TCID : [FAIL]"
> +else
> + echo "$TCID : [PASS]"
> +fi
> diff --git a/tools/testing/selftests/zram/zram02.sh b/tools/testing/selftests/zram/zram02.sh
> new file mode 100755
> index 0000000..81855ce
> --- /dev/null
> +++ b/tools/testing/selftests/zram/zram02.sh
> @@ -0,0 +1,57 @@
> +#!/bin/bash
> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
> +#
> +# This program is free software; you can redistribute it and/or
> +# modify it under the terms of the GNU General Public License as
> +# published by the Free Software Foundation; either version 2 of
> +# the License, or (at your option) any later version.
> +#
> +# This program is distributed in the hope that it would be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> +# GNU General Public License for more details.
> +#
> +# You should have received a copy of the GNU General Public License
> +# along with this program; if not, write the Free Software Foundation,
> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Here as well.

> +#
> +# Test checks that we can create swap zram device.
> +#
> +# Author: Alexey Kodanev <[email protected]>
> +# Modified: Naresh Kamboju <[email protected]>
> +
> +TCID="zram02"
> +ERR_CODE=0
> +
> +. ./zram_lib.sh
> +
> +# Test will create the following number of zram devices:
> +dev_num=1
> +# This is a list of parameters for zram devices.
> +# Number of items must be equal to 'dev_num' parameter.
> +zram_max_streams="2"
> +
> +# The zram sysfs node 'disksize' value can be either in bytes,
> +# or you can use mem suffixes. But in some old kernels, mem
> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
> +# layer, it uses strict_strtoull() to parse disksize which does
> +# not support mem suffixes, in some newer kernels, they use
> +# memparse() which supports mem suffixes. So here we just use
> +# bytes to make sure everything works correctly.
> +zram_sizes="1048576" # 1M
> +zram_mem_limits="1M"
> +
> +zram_load
> +zram_max_streams
> +zram_set_disksizes
> +zram_set_memlimit
> +zram_makeswap
> +zram_swapoff
> +zram_cleanup
> +zram_unload
> +
> +if [ $ERR_CODE -ne 0 ]; then
> + echo "$TCID : [FAIL]"
> +else
> + echo "$TCID : [PASS]"
> +fi
> diff --git a/tools/testing/selftests/zram/zram_lib.sh b/tools/testing/selftests/zram/zram_lib.sh
> new file mode 100755
> index 0000000..c40a1cf
> --- /dev/null
> +++ b/tools/testing/selftests/zram/zram_lib.sh
> @@ -0,0 +1,223 @@
> +#!/bin/sh
> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
> +#
> +# This program is free software; you can redistribute it and/or
> +# modify it under the terms of the GNU General Public License as
> +# published by the Free Software Foundation; either version 2 of
> +# the License, or (at your option) any later version.
> +#
> +# This program is distributed in the hope that it would be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> +# GNU General Public License for more details.
> +#
> +# You should have received a copy of the GNU General Public License
> +# along with this program; if not, write the Free Software Foundation,
> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

And here again.

> +#
> +# Author: Alexey Kodanev <[email protected]>
> +# Modified: Naresh Kamboju <[email protected]>
> +
> +MODULE=0
> +dev_makeswap=-1
> +dev_mounted=-1
> +
> +trap INT
> +
> +zram_cleanup()
> +{
> + echo "zram cleanup"
> + local i=
> + for i in $(seq 0 $dev_makeswap); do
> + swapoff /dev/zram$i
> + done
> +
> + for i in $(seq 0 $dev_mounted); do
> + umount /dev/zram$i
> + done
> +
> + for i in $(seq 0 $(($dev_num - 1))); do
> + echo 1 > /sys/block/zram${i}/reset
> + rm -rf zram$i
> + done
> +
> +}
> +
> +zram_unload()
> +{
> + if [ $MODULE -ne 0 ] ; then
> + echo "zram rmmod zram"
> + rmmod zram > /dev/null 2>&1
> + fi
> +}
> +
> +zram_load()
> +{
> + # check zram module exists
> + MODULE_PATH=/lib/modules/`uname -r`/kernel/drivers/zram/zram.ko
> + if [ -f $MODULE_PATH ]; then
> + MODULE=1
> + echo "create '$dev_num' zram device(s)"
> + modprobe zram num_devices=$dev_num || \
> + echo "failed to insert zram module"
> +
> + dev_num_created=$(ls /dev/zram* | wc -w)
> +
> + if [ "$dev_num_created" -ne "$dev_num" ]; then
> + echo "unexpected num of devices: $dev_num_created"
> + ERR_CODE=-1
> + else
> + echo "zram load module successful"
> + fi
> + elif [ -b /dev/zram0 ]; then
> + echo "/dev/zram0 device file found: OK"
> + else
> + echo "ERROR: No zram.ko module or no /dev/zram0 device found"
> + echo "$TCID : CONFIG_ZRAM is not set"
> + exit 1
> + fi
> +}
> +
> +zram_max_streams()
> +{
> + echo "set max_comp_streams to zram device(s)"
> +
> + local i=0
> + for max_s in $zram_max_streams; do
> + local sys_path="/sys/block/zram${i}/max_comp_streams"
> + echo $max_s > $sys_path || \
> + echo "FAIL failed to set '$max_s' to $sys_path"
> + sleep 1
> + local max_streams=$(cat $sys_path)
> +
> + [ "$max_s" -ne "$max_streams" ] && \
> + echo "FAIL can't set max_streams '$max_s', get $max_stream"
> +
> + i=$(($i + 1))
> + echo "$sys_path = '$max_streams' ($i/$dev_num)"
> + done
> +
> + echo "zram max streams: OK"
> +}
> +
> +zram_compress_alg()
> +{
> + echo "test that we can set compression algorithm"
> +
> + local algs=$(cat /sys/block/zram0/comp_algorithm)
> + echo "supported algs: $algs"
> + local i=0
> + for alg in $zram_algs; do
> + local sys_path="/sys/block/zram${i}/comp_algorithm"
> + echo "$alg" > $sys_path || \
> + echo "FAIL can't set '$alg' to $sys_path"
> + i=$(($i + 1))
> + echo "$sys_path = '$alg' ($i/$dev_num)"
> + done
> +
> + echo "zram set compression algorithm: OK"
> +}
> +
> +zram_set_disksizes()
> +{
> + echo "set disk size to zram device(s)"
> + local i=0
> + for ds in $zram_sizes; do
> + local sys_path="/sys/block/zram${i}/disksize"
> + echo "$ds" > $sys_path || \
> + echo "FAIL can't set '$ds' to $sys_path"
> +
> + i=$(($i + 1))
> + echo "$sys_path = '$ds' ($i/$dev_num)"
> + done
> +
> + echo "zram set disksizes: OK"
> +}
> +
> +zram_set_memlimit()
> +{
> + echo "set memory limit to zram device(s)"
> +
> + local i=0
> + for ds in $zram_mem_limits; do
> + local sys_path="/sys/block/zram${i}/mem_limit"
> + echo "$ds" > $sys_path || \
> + echo "FAIL can't set '$ds' to $sys_path"
> +
> + i=$(($i + 1))
> + echo "$sys_path = '$ds' ($i/$dev_num)"
> + done
> +
> + echo "zram set memory limit: OK"
> +}
> +
> +zram_makeswap()
> +{
> + echo "make swap with zram device(s)"
> + local i=0
> + for i in $(seq 0 $(($dev_num - 1))); do
> + mkswap /dev/zram$i > err.log 2>&1
> + if [ $? -ne 0 ]; then
> + cat err.log
> + echo "FAIL mkswap /dev/zram$1 failed"
> + fi
> +
> + swapon /dev/zram$i > err.log 2>&1
> + if [ $? -ne 0 ]; then
> + cat err.log
> + echo "FAIL swapon /dev/zram$1 failed"
> + fi
> +
> + echo "done with /dev/zram$i"
> + dev_makeswap=$i
> + done
> +
> + echo "zram making zram mkswap and swapon: OK"
> +}
> +
> +zram_swapoff()
> +{
> + local i=
> + for i in $(seq 0 $dev_makeswap); do
> + swapoff /dev/zram$i > err.log 2>&1
> + if [ $? -ne 0 ]; then
> + cat err.log
> + echo "FAIL swapoff /dev/zram$i failed"
> + fi
> + done
> + dev_makeswap=-1
> +
> + echo "zram swapoff: OK"
> +}
> +
> +zram_makefs()
> +{
> + local i=0
> + for fs in $zram_filesystems; do
> + # if requested fs not supported default it to ext2
> + which mkfs.$fs > /dev/null 2>&1 || fs=ext2
> +
> + echo "make $fs filesystem on /dev/zram$i"
> + mkfs.$fs /dev/zram$i > err.log 2>&1
> + if [ $? -ne 0 ]; then
> + cat err.log
> + echo "FAIL failed to make $fs on /dev/zram$i"
> + fi
> + i=$(($i + 1))
> + echo "zram mkfs.$fs: OK"
> + done
> +}
> +
> +zram_mount()
> +{
> + local i=0
> + for i in $(seq 0 $(($dev_num - 1))); do
> + echo "mount /dev/zram$i"
> + mkdir zram$i
> + mount /dev/zram$i zram$i > /dev/null || \
> + echo "FAIL mount /dev/zram$i failed"
> + dev_mounted=$i
> + done
> +
> + echo "zram mount of zram device(s): OK"
> +}
> --
> 1.9.1
>

Otherwise the code looks fine to me so...

Reviewed-By: Tyler Baker <[email protected]>

Cheers,

Tyler

2015-07-23 15:04:10

by Shuah Khan

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests

On 07/22/2015 06:00 PM, Tyler Baker wrote:
> Hi Naresh,
>
> On 7 July 2015 at 05:03, <[email protected]> wrote:
>> From: Naresh Kamboju <[email protected]>
>>
>> zram_lib.sh: create library with initialization/cleanup functions
>> zram01.sh: creates general purpose ram disks with different filesystems
>> zram02.sh: creates block device for swap
>> README: ZRAM introduction and Kconfig required.
>> Makefile: To run zram tests
>
> (./zram01.sh && echo "selftests: zram01.sh [PASS]") || echo
> "selftests: zram01.sh [FAIL]"
> (./zram02.sh && echo "selftests: zram02.sh [PASS]") || echo
> "selftests: zram02.sh [FAIL]"
> (./zram_lib.sh && echo "selftests: zram_lib.sh [PASS]") || echo
> "selftests: zram_lib.sh [FAIL]"
>
> Above is the output from the run_kselftests.sh. Do we want to run
> zram_lib.sh as a test case as it just a library?

Please make sure test doesn't fail when zram isn't configured.
i.e it should exit gracefully with a message saying zram isn't
configured. Please see below:

>
>> Author: Alexey Kodanev <[email protected]>
>> Signed-off-by: Naresh Kamboju <[email protected]>
>> ---
>> tools/testing/selftests/Makefile | 1 +
>> tools/testing/selftests/zram/Makefile | 12 ++
>> tools/testing/selftests/zram/README | 39 ++++++
>> tools/testing/selftests/zram/zram01.sh | 102 ++++++++++++++
>> tools/testing/selftests/zram/zram02.sh | 57 ++++++++
>> tools/testing/selftests/zram/zram_lib.sh | 223 +++++++++++++++++++++++++++++++
>> 6 files changed, 434 insertions(+)
>> create mode 100644 tools/testing/selftests/zram/Makefile
>> create mode 100644 tools/testing/selftests/zram/README
>> create mode 100755 tools/testing/selftests/zram/zram01.sh
>> create mode 100755 tools/testing/selftests/zram/zram02.sh
>> create mode 100755 tools/testing/selftests/zram/zram_lib.sh
>>
>> diff --git a/tools/testing/selftests/Makefile b/tools/testing/selftests/Makefile
>> index 24ae9e8..9763dd9 100644
>> --- a/tools/testing/selftests/Makefile
>> +++ b/tools/testing/selftests/Makefile
>> @@ -22,6 +22,7 @@ endif
>> TARGETS += user
>> TARGETS += vm
>> TARGETS += x86
>> +TARGETS += zram
>> #Please keep the TARGETS list alphabetically sorted
>> # Run "make quicktest=1 run_tests" or
>> # "make quicktest=1 kselftest from top level Makefile
>> diff --git a/tools/testing/selftests/zram/Makefile b/tools/testing/selftests/zram/Makefile
>> new file mode 100644
>> index 0000000..a27a797
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/Makefile
>> @@ -0,0 +1,12 @@
>> +all:
>> +
>> +TEST_PROGS := zram01.sh zram02.sh zram_lib.sh
>> +
>> +include ../lib.mk
>> +
>> +run_tests:
>> + @/bin/bash ./zram01.sh; \
>> + /bin/bash ./zram02.sh
>> +
>> +clean:
>> + $(RM) err.log
>> diff --git a/tools/testing/selftests/zram/README b/tools/testing/selftests/zram/README
>> new file mode 100644
>> index 0000000..36db066
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/README
>> @@ -0,0 +1,39 @@
>> +zram: Compressed RAM based block devices
>> +----------------------------------------
>> +* Introduction
>> +
>> +The zram module creates RAM based block devices named /dev/zram<id>
>> +(<id> = 0, 1, ...). Pages written to these disks are compressed and stored
>> +in memory itself. These disks allow very fast I/O and compression provides
>> +good amounts of memory savings. Some of the usecases include /tmp storage,
>> +use as swap disks, various caches under /var and maybe many more :)
>> +
>> +Statistics for individual zram devices are exported through sysfs nodes at
>> +/sys/block/zram<id>/
>> +
>> +Kconfig required:
>> +CONFIG_ZRAM=y
>> +CONFIG_ZRAM_LZ4_COMPRESS=y
>> +CONFIG_ZPOOL=y
>> +CONFIG_ZSMALLOC=y
>> +
>> +ZRAM Testcases
>> +--------------
>> +zram_lib.sh: create library with initialization/cleanup functions
>> +
>> +Two functional tests: zram01 and zram02:
>> +zram01.sh: creates general purpose ram disks with ext4 filesystems
>> +zram02.sh: creates block device for swap
>> +
>> +Commands required for testing:
>> + - bc
>> + - dd
>> + - free
>> + - awk
>> + - mkswap
>> + - swapon
>> + - swapoff
>> + - mkfs/ mkfs.ext4
>> +
>> +For more information please refer:
>> +kernel-source-tree/Documentation/blockdev/zram.txt
>> diff --git a/tools/testing/selftests/zram/zram01.sh b/tools/testing/selftests/zram/zram01.sh
>> new file mode 100755
>> index 0000000..b63eb5d
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/zram01.sh
>> @@ -0,0 +1,102 @@
>> +#!/bin/bash
>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>> +#
>> +# This program is free software; you can redistribute it and/or
>> +# modify it under the terms of the GNU General Public License as
>> +# published by the Free Software Foundation; either version 2 of
>> +# the License, or (at your option) any later version.
>> +#
>> +# This program is distributed in the hope that it would be useful,
>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> +# GNU General Public License for more details.
>> +#
>> +# You should have received a copy of the GNU General Public License
>> +# along with this program; if not, write the Free Software Foundation,
>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>
> checkpatch is complaining about including the FSF address, so lets remove it.
>
>> +#
>> +# Test creates several zram devices with different filesystems on them.
>> +# It fills each device with zeros and checks that compression works.
>> +#
>> +# Author: Alexey Kodanev <[email protected]>
>> +# Modified: Naresh Kamboju <[email protected]>
>> +
>> +TCID="zram01"
>> +ERR_CODE=0
>> +
>> +. ./zram_lib.sh
>> +
>> +# Test will create the following number of zram devices:
>> +dev_num=1
>> +# This is a list of parameters for zram devices.
>> +# Number of items must be equal to 'dev_num' parameter.
>> +zram_max_streams="2"
>> +
>> +# The zram sysfs node 'disksize' value can be either in bytes,
>> +# or you can use mem suffixes. But in some old kernels, mem
>> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
>> +# layer, it uses strict_strtoull() to parse disksize which does
>> +# not support mem suffixes, in some newer kernels, they use
>> +# memparse() which supports mem suffixes. So here we just use
>> +# bytes to make sure everything works correctly.
>> +zram_sizes="2097152" # 2MB
>> +zram_mem_limits="2M"
>> +zram_filesystems="ext4"
>> +zram_algs="lzo"
>> +
>> +zram_fill_fs()
>> +{
>> + local mem_free0=$(free -m | awk 'NR==2 {print $4}')
>> +
>> + for i in $(seq 0 $(($dev_num - 1))); do
>> + echo "fill zram$i..."
>> + local b=0
>> + while [ true ]; do
>> + dd conv=notrunc if=/dev/zero of=zram${i}/file \
>> + oflag=append count=1 bs=1024 status=none \
>> + > /dev/null 2>&1 || break
>> + b=$(($b + 1))
>> + done
>> + echo "zram$i can be filled with '$b' KB"
>> + done
>> +
>> + local mem_free1=$(free -m | awk 'NR==2 {print $4}')
>> + local used_mem=$(($mem_free0 - $mem_free1))
>> +
>> + local total_size=0
>> + for sm in $zram_sizes; do
>> + local s=$(echo $sm | sed 's/M//')
>> + total_size=$(($total_size + $s))
>> + done
>> +
>> + echo "zram used ${used_mem}M, zram disk sizes ${total_size}M"
>> +
>> + local v=$((100 * $total_size / $used_mem))
>> +
>> + if [ "$v" -lt 100 ]; then
>> + echo "FAIL compression ratio: 0.$v:1"
>> + ERR_CODE=-1
>> + zram_cleanup
>> + return
>> + fi
>> +
>> + echo "zram compression ratio: $(echo "scale=2; $v / 100 " | bc):1: OK"
>> +}
>> +
>> +zram_load
>> +zram_max_streams
>> +zram_compress_alg
>> +zram_set_disksizes
>> +zram_set_memlimit
>> +zram_makefs
>> +zram_mount
>> +
>> +zram_fill_fs
>> +zram_cleanup
>> +zram_unload
>> +
>> +if [ $ERR_CODE -ne 0 ]; then
>> + echo "$TCID : [FAIL]"
>> +else
>> + echo "$TCID : [PASS]"
>> +fi
>> diff --git a/tools/testing/selftests/zram/zram02.sh b/tools/testing/selftests/zram/zram02.sh
>> new file mode 100755
>> index 0000000..81855ce
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/zram02.sh
>> @@ -0,0 +1,57 @@
>> +#!/bin/bash
>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>> +#
>> +# This program is free software; you can redistribute it and/or
>> +# modify it under the terms of the GNU General Public License as
>> +# published by the Free Software Foundation; either version 2 of
>> +# the License, or (at your option) any later version.
>> +#
>> +# This program is distributed in the hope that it would be useful,
>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> +# GNU General Public License for more details.
>> +#
>> +# You should have received a copy of the GNU General Public License
>> +# along with this program; if not, write the Free Software Foundation,
>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>
> Here as well.
>
>> +#
>> +# Test checks that we can create swap zram device.
>> +#
>> +# Author: Alexey Kodanev <[email protected]>
>> +# Modified: Naresh Kamboju <[email protected]>
>> +
>> +TCID="zram02"
>> +ERR_CODE=0
>> +
>> +. ./zram_lib.sh
>> +
>> +# Test will create the following number of zram devices:
>> +dev_num=1
>> +# This is a list of parameters for zram devices.
>> +# Number of items must be equal to 'dev_num' parameter.
>> +zram_max_streams="2"
>> +
>> +# The zram sysfs node 'disksize' value can be either in bytes,
>> +# or you can use mem suffixes. But in some old kernels, mem
>> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
>> +# layer, it uses strict_strtoull() to parse disksize which does
>> +# not support mem suffixes, in some newer kernels, they use
>> +# memparse() which supports mem suffixes. So here we just use
>> +# bytes to make sure everything works correctly.
>> +zram_sizes="1048576" # 1M
>> +zram_mem_limits="1M"
>> +
>> +zram_load
>> +zram_max_streams
>> +zram_set_disksizes
>> +zram_set_memlimit
>> +zram_makeswap
>> +zram_swapoff
>> +zram_cleanup
>> +zram_unload
>> +
>> +if [ $ERR_CODE -ne 0 ]; then
>> + echo "$TCID : [FAIL]"
>> +else
>> + echo "$TCID : [PASS]"
>> +fi
>> diff --git a/tools/testing/selftests/zram/zram_lib.sh b/tools/testing/selftests/zram/zram_lib.sh
>> new file mode 100755
>> index 0000000..c40a1cf
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/zram_lib.sh
>> @@ -0,0 +1,223 @@
>> +#!/bin/sh
>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>> +#
>> +# This program is free software; you can redistribute it and/or
>> +# modify it under the terms of the GNU General Public License as
>> +# published by the Free Software Foundation; either version 2 of
>> +# the License, or (at your option) any later version.
>> +#
>> +# This program is distributed in the hope that it would be useful,
>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> +# GNU General Public License for more details.
>> +#
>> +# You should have received a copy of the GNU General Public License
>> +# along with this program; if not, write the Free Software Foundation,
>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>
> And here again.
>
>> +#
>> +# Author: Alexey Kodanev <[email protected]>
>> +# Modified: Naresh Kamboju <[email protected]>
>> +
>> +MODULE=0
>> +dev_makeswap=-1
>> +dev_mounted=-1
>> +
>> +trap INT
>> +
>> +zram_cleanup()
>> +{
>> + echo "zram cleanup"
>> + local i=
>> + for i in $(seq 0 $dev_makeswap); do
>> + swapoff /dev/zram$i
>> + done
>> +
>> + for i in $(seq 0 $dev_mounted); do
>> + umount /dev/zram$i
>> + done
>> +
>> + for i in $(seq 0 $(($dev_num - 1))); do
>> + echo 1 > /sys/block/zram${i}/reset
>> + rm -rf zram$i
>> + done
>> +
>> +}
>> +
>> +zram_unload()
>> +{
>> + if [ $MODULE -ne 0 ] ; then
>> + echo "zram rmmod zram"
>> + rmmod zram > /dev/null 2>&1
>> + fi
>> +}
>> +
>> +zram_load()
>> +{
>> + # check zram module exists
>> + MODULE_PATH=/lib/modules/`uname -r`/kernel/drivers/zram/zram.ko
>> + if [ -f $MODULE_PATH ]; then
>> + MODULE=1
>> + echo "create '$dev_num' zram device(s)"
>> + modprobe zram num_devices=$dev_num || \
>> + echo "failed to insert zram module"
>> +
>> + dev_num_created=$(ls /dev/zram* | wc -w)
>> +
>> + if [ "$dev_num_created" -ne "$dev_num" ]; then
>> + echo "unexpected num of devices: $dev_num_created"
>> + ERR_CODE=-1
>> + else
>> + echo "zram load module successful"
>> + fi
>> + elif [ -b /dev/zram0 ]; then
>> + echo "/dev/zram0 device file found: OK"
>> + else
>> + echo "ERROR: No zram.ko module or no /dev/zram0 device found"
>> + echo "$TCID : CONFIG_ZRAM is not set"
>> + exit 1
>> + fi

In this case, when zram.ko module or no /dev/zram0 device found,
test should exit gracefully.

thanks,
-- Shuah

--
Shuah Khan
Sr. Linux Kernel Developer
Open Source Innovation Group
Samsung Research America (Silicon Valley)
[email protected] | (970) 217-8978

2015-07-27 01:47:07

by Alex Shi

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests



On 07/25/2015 12:32 AM, Mark Brown wrote:
> On 7 July 2015 at 13:03, <[email protected]
> <mailto:[email protected]>> wrote:
>
> From: Naresh Kamboju <[email protected]
> <mailto:[email protected]>>
>
> zram_lib.sh: create library with initialization/cleanup functions
> zram01.sh: creates general purpose ram disks with different filesystems
> zram02.sh: creates block device for swap
> README: ZRAM introduction and Kconfig required.
> Makefile: To run zram tests
>
> Author: Alexey Kodanev <[email protected]
> <mailto:[email protected]>>
> Signed-off-by: Naresh Kamboju <[email protected]
> <mailto:[email protected]>>
>
>
> If this was written by Alexey you need a Signed-off-by from him for it
> before submitting it upstream.


And remove the 'Author: Alex...' line,
then replace 'From: Naresh K..' with 'From: Alexey K...'

2015-08-13 19:08:11

by Naresh Kamboju

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests

Hi Tyler,

On 23 July 2015 at 05:30, Tyler Baker <[email protected]> wrote:
> Hi Naresh,
>
> On 7 July 2015 at 05:03, <[email protected]> wrote:
>> From: Naresh Kamboju <[email protected]>
>>
>> zram_lib.sh: create library with initialization/cleanup functions
>> zram01.sh: creates general purpose ram disks with different filesystems
>> zram02.sh: creates block device for swap
>> README: ZRAM introduction and Kconfig required.
>> Makefile: To run zram tests
>
> (./zram01.sh && echo "selftests: zram01.sh [PASS]") || echo
> "selftests: zram01.sh [FAIL]"
> (./zram02.sh && echo "selftests: zram02.sh [PASS]") || echo
> "selftests: zram02.sh [FAIL]"
> (./zram_lib.sh && echo "selftests: zram_lib.sh [PASS]") || echo
> "selftests: zram_lib.sh [FAIL]"
>
> Above is the output from the run_kselftests.sh. Do we want to run
> zram_lib.sh as a test case as it just a library?

zram_lib.sh is not a test as it just a library.
run_kselftest.sh should not pick this file as test case. Any idea howto ?

>
>> Author: Alexey Kodanev <[email protected]>
>> Signed-off-by: Naresh Kamboju <[email protected]>
>> ---
>> tools/testing/selftests/Makefile | 1 +
>> tools/testing/selftests/zram/Makefile | 12 ++
>> tools/testing/selftests/zram/README | 39 ++++++
>> tools/testing/selftests/zram/zram01.sh | 102 ++++++++++++++
>> tools/testing/selftests/zram/zram02.sh | 57 ++++++++
>> tools/testing/selftests/zram/zram_lib.sh | 223 +++++++++++++++++++++++++++++++
>> 6 files changed, 434 insertions(+)
>> create mode 100644 tools/testing/selftests/zram/Makefile
>> create mode 100644 tools/testing/selftests/zram/README
>> create mode 100755 tools/testing/selftests/zram/zram01.sh
>> create mode 100755 tools/testing/selftests/zram/zram02.sh
>> create mode 100755 tools/testing/selftests/zram/zram_lib.sh
>>
>> diff --git a/tools/testing/selftests/Makefile b/tools/testing/selftests/Makefile
>> index 24ae9e8..9763dd9 100644
>> --- a/tools/testing/selftests/Makefile
>> +++ b/tools/testing/selftests/Makefile
>> @@ -22,6 +22,7 @@ endif
>> TARGETS += user
>> TARGETS += vm
>> TARGETS += x86
>> +TARGETS += zram
>> #Please keep the TARGETS list alphabetically sorted
>> # Run "make quicktest=1 run_tests" or
>> # "make quicktest=1 kselftest from top level Makefile
>> diff --git a/tools/testing/selftests/zram/Makefile b/tools/testing/selftests/zram/Makefile
>> new file mode 100644
>> index 0000000..a27a797
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/Makefile
>> @@ -0,0 +1,12 @@
>> +all:
>> +
>> +TEST_PROGS := zram01.sh zram02.sh zram_lib.sh
>> +
>> +include ../lib.mk
>> +
>> +run_tests:
>> + @/bin/bash ./zram01.sh; \
>> + /bin/bash ./zram02.sh
>> +
>> +clean:
>> + $(RM) err.log
>> diff --git a/tools/testing/selftests/zram/README b/tools/testing/selftests/zram/README
>> new file mode 100644
>> index 0000000..36db066
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/README
>> @@ -0,0 +1,39 @@
>> +zram: Compressed RAM based block devices
>> +----------------------------------------
>> +* Introduction
>> +
>> +The zram module creates RAM based block devices named /dev/zram<id>
>> +(<id> = 0, 1, ...). Pages written to these disks are compressed and stored
>> +in memory itself. These disks allow very fast I/O and compression provides
>> +good amounts of memory savings. Some of the usecases include /tmp storage,
>> +use as swap disks, various caches under /var and maybe many more :)
>> +
>> +Statistics for individual zram devices are exported through sysfs nodes at
>> +/sys/block/zram<id>/
>> +
>> +Kconfig required:
>> +CONFIG_ZRAM=y
>> +CONFIG_ZRAM_LZ4_COMPRESS=y
>> +CONFIG_ZPOOL=y
>> +CONFIG_ZSMALLOC=y
>> +
>> +ZRAM Testcases
>> +--------------
>> +zram_lib.sh: create library with initialization/cleanup functions
>> +
>> +Two functional tests: zram01 and zram02:
>> +zram01.sh: creates general purpose ram disks with ext4 filesystems
>> +zram02.sh: creates block device for swap
>> +
>> +Commands required for testing:
>> + - bc
>> + - dd
>> + - free
>> + - awk
>> + - mkswap
>> + - swapon
>> + - swapoff
>> + - mkfs/ mkfs.ext4
>> +
>> +For more information please refer:
>> +kernel-source-tree/Documentation/blockdev/zram.txt
>> diff --git a/tools/testing/selftests/zram/zram01.sh b/tools/testing/selftests/zram/zram01.sh
>> new file mode 100755
>> index 0000000..b63eb5d
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/zram01.sh
>> @@ -0,0 +1,102 @@
>> +#!/bin/bash
>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>> +#
>> +# This program is free software; you can redistribute it and/or
>> +# modify it under the terms of the GNU General Public License as
>> +# published by the Free Software Foundation; either version 2 of
>> +# the License, or (at your option) any later version.
>> +#
>> +# This program is distributed in the hope that it would be useful,
>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> +# GNU General Public License for more details.
>> +#
>> +# You should have received a copy of the GNU General Public License
>> +# along with this program; if not, write the Free Software Foundation,
>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>
> checkpatch is complaining about including the FSF address, so lets remove it.

Valid point.
I will remove this address.


>
>> +#
>> +# Test creates several zram devices with different filesystems on them.
>> +# It fills each device with zeros and checks that compression works.
>> +#
>> +# Author: Alexey Kodanev <[email protected]>
>> +# Modified: Naresh Kamboju <[email protected]>
>> +
>> +TCID="zram01"
>> +ERR_CODE=0
>> +
>> +. ./zram_lib.sh
>> +
>> +# Test will create the following number of zram devices:
>> +dev_num=1
>> +# This is a list of parameters for zram devices.
>> +# Number of items must be equal to 'dev_num' parameter.
>> +zram_max_streams="2"
>> +
>> +# The zram sysfs node 'disksize' value can be either in bytes,
>> +# or you can use mem suffixes. But in some old kernels, mem
>> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
>> +# layer, it uses strict_strtoull() to parse disksize which does
>> +# not support mem suffixes, in some newer kernels, they use
>> +# memparse() which supports mem suffixes. So here we just use
>> +# bytes to make sure everything works correctly.
>> +zram_sizes="2097152" # 2MB
>> +zram_mem_limits="2M"
>> +zram_filesystems="ext4"
>> +zram_algs="lzo"
>> +
>> +zram_fill_fs()
>> +{
>> + local mem_free0=$(free -m | awk 'NR==2 {print $4}')
>> +
>> + for i in $(seq 0 $(($dev_num - 1))); do
>> + echo "fill zram$i..."
>> + local b=0
>> + while [ true ]; do
>> + dd conv=notrunc if=/dev/zero of=zram${i}/file \
>> + oflag=append count=1 bs=1024 status=none \
>> + > /dev/null 2>&1 || break
>> + b=$(($b + 1))
>> + done
>> + echo "zram$i can be filled with '$b' KB"
>> + done
>> +
>> + local mem_free1=$(free -m | awk 'NR==2 {print $4}')
>> + local used_mem=$(($mem_free0 - $mem_free1))
>> +
>> + local total_size=0
>> + for sm in $zram_sizes; do
>> + local s=$(echo $sm | sed 's/M//')
>> + total_size=$(($total_size + $s))
>> + done
>> +
>> + echo "zram used ${used_mem}M, zram disk sizes ${total_size}M"
>> +
>> + local v=$((100 * $total_size / $used_mem))
>> +
>> + if [ "$v" -lt 100 ]; then
>> + echo "FAIL compression ratio: 0.$v:1"
>> + ERR_CODE=-1
>> + zram_cleanup
>> + return
>> + fi
>> +
>> + echo "zram compression ratio: $(echo "scale=2; $v / 100 " | bc):1: OK"
>> +}
>> +
>> +zram_load
>> +zram_max_streams
>> +zram_compress_alg
>> +zram_set_disksizes
>> +zram_set_memlimit
>> +zram_makefs
>> +zram_mount
>> +
>> +zram_fill_fs
>> +zram_cleanup
>> +zram_unload
>> +
>> +if [ $ERR_CODE -ne 0 ]; then
>> + echo "$TCID : [FAIL]"
>> +else
>> + echo "$TCID : [PASS]"
>> +fi
>> diff --git a/tools/testing/selftests/zram/zram02.sh b/tools/testing/selftests/zram/zram02.sh
>> new file mode 100755
>> index 0000000..81855ce
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/zram02.sh
>> @@ -0,0 +1,57 @@
>> +#!/bin/bash
>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>> +#
>> +# This program is free software; you can redistribute it and/or
>> +# modify it under the terms of the GNU General Public License as
>> +# published by the Free Software Foundation; either version 2 of
>> +# the License, or (at your option) any later version.
>> +#
>> +# This program is distributed in the hope that it would be useful,
>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> +# GNU General Public License for more details.
>> +#
>> +# You should have received a copy of the GNU General Public License
>> +# along with this program; if not, write the Free Software Foundation,
>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>
> Here as well.

I will remove this address.

>
>> +#
>> +# Test checks that we can create swap zram device.
>> +#
>> +# Author: Alexey Kodanev <[email protected]>
>> +# Modified: Naresh Kamboju <[email protected]>
>> +
>> +TCID="zram02"
>> +ERR_CODE=0
>> +
>> +. ./zram_lib.sh
>> +
>> +# Test will create the following number of zram devices:
>> +dev_num=1
>> +# This is a list of parameters for zram devices.
>> +# Number of items must be equal to 'dev_num' parameter.
>> +zram_max_streams="2"
>> +
>> +# The zram sysfs node 'disksize' value can be either in bytes,
>> +# or you can use mem suffixes. But in some old kernels, mem
>> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
>> +# layer, it uses strict_strtoull() to parse disksize which does
>> +# not support mem suffixes, in some newer kernels, they use
>> +# memparse() which supports mem suffixes. So here we just use
>> +# bytes to make sure everything works correctly.
>> +zram_sizes="1048576" # 1M
>> +zram_mem_limits="1M"
>> +
>> +zram_load
>> +zram_max_streams
>> +zram_set_disksizes
>> +zram_set_memlimit
>> +zram_makeswap
>> +zram_swapoff
>> +zram_cleanup
>> +zram_unload
>> +
>> +if [ $ERR_CODE -ne 0 ]; then
>> + echo "$TCID : [FAIL]"
>> +else
>> + echo "$TCID : [PASS]"
>> +fi
>> diff --git a/tools/testing/selftests/zram/zram_lib.sh b/tools/testing/selftests/zram/zram_lib.sh
>> new file mode 100755
>> index 0000000..c40a1cf
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/zram_lib.sh
>> @@ -0,0 +1,223 @@
>> +#!/bin/sh
>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>> +#
>> +# This program is free software; you can redistribute it and/or
>> +# modify it under the terms of the GNU General Public License as
>> +# published by the Free Software Foundation; either version 2 of
>> +# the License, or (at your option) any later version.
>> +#
>> +# This program is distributed in the hope that it would be useful,
>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> +# GNU General Public License for more details.
>> +#
>> +# You should have received a copy of the GNU General Public License
>> +# along with this program; if not, write the Free Software Foundation,
>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>
> And here again.

I will remove this address.

>
>> +#
>> +# Author: Alexey Kodanev <[email protected]>
>> +# Modified: Naresh Kamboju <[email protected]>
>> +
>> +MODULE=0
>> +dev_makeswap=-1
>> +dev_mounted=-1
>> +
>> +trap INT
>> +
>> +zram_cleanup()
>> +{
>> + echo "zram cleanup"
>> + local i=
>> + for i in $(seq 0 $dev_makeswap); do
>> + swapoff /dev/zram$i
>> + done
>> +
>> + for i in $(seq 0 $dev_mounted); do
>> + umount /dev/zram$i
>> + done
>> +
>> + for i in $(seq 0 $(($dev_num - 1))); do
>> + echo 1 > /sys/block/zram${i}/reset
>> + rm -rf zram$i
>> + done
>> +
>> +}
>> +
>> +zram_unload()
>> +{
>> + if [ $MODULE -ne 0 ] ; then
>> + echo "zram rmmod zram"
>> + rmmod zram > /dev/null 2>&1
>> + fi
>> +}
>> +
>> +zram_load()
>> +{
>> + # check zram module exists
>> + MODULE_PATH=/lib/modules/`uname -r`/kernel/drivers/zram/zram.ko
>> + if [ -f $MODULE_PATH ]; then
>> + MODULE=1
>> + echo "create '$dev_num' zram device(s)"
>> + modprobe zram num_devices=$dev_num || \
>> + echo "failed to insert zram module"
>> +
>> + dev_num_created=$(ls /dev/zram* | wc -w)
>> +
>> + if [ "$dev_num_created" -ne "$dev_num" ]; then
>> + echo "unexpected num of devices: $dev_num_created"
>> + ERR_CODE=-1
>> + else
>> + echo "zram load module successful"
>> + fi
>> + elif [ -b /dev/zram0 ]; then
>> + echo "/dev/zram0 device file found: OK"
>> + else
>> + echo "ERROR: No zram.ko module or no /dev/zram0 device found"
>> + echo "$TCID : CONFIG_ZRAM is not set"
>> + exit 1
>> + fi
>> +}
>> +
>> +zram_max_streams()
>> +{
>> + echo "set max_comp_streams to zram device(s)"
>> +
>> + local i=0
>> + for max_s in $zram_max_streams; do
>> + local sys_path="/sys/block/zram${i}/max_comp_streams"
>> + echo $max_s > $sys_path || \
>> + echo "FAIL failed to set '$max_s' to $sys_path"
>> + sleep 1
>> + local max_streams=$(cat $sys_path)
>> +
>> + [ "$max_s" -ne "$max_streams" ] && \
>> + echo "FAIL can't set max_streams '$max_s', get $max_stream"
>> +
>> + i=$(($i + 1))
>> + echo "$sys_path = '$max_streams' ($i/$dev_num)"
>> + done
>> +
>> + echo "zram max streams: OK"
>> +}
>> +
>> +zram_compress_alg()
>> +{
>> + echo "test that we can set compression algorithm"
>> +
>> + local algs=$(cat /sys/block/zram0/comp_algorithm)
>> + echo "supported algs: $algs"
>> + local i=0
>> + for alg in $zram_algs; do
>> + local sys_path="/sys/block/zram${i}/comp_algorithm"
>> + echo "$alg" > $sys_path || \
>> + echo "FAIL can't set '$alg' to $sys_path"
>> + i=$(($i + 1))
>> + echo "$sys_path = '$alg' ($i/$dev_num)"
>> + done
>> +
>> + echo "zram set compression algorithm: OK"
>> +}
>> +
>> +zram_set_disksizes()
>> +{
>> + echo "set disk size to zram device(s)"
>> + local i=0
>> + for ds in $zram_sizes; do
>> + local sys_path="/sys/block/zram${i}/disksize"
>> + echo "$ds" > $sys_path || \
>> + echo "FAIL can't set '$ds' to $sys_path"
>> +
>> + i=$(($i + 1))
>> + echo "$sys_path = '$ds' ($i/$dev_num)"
>> + done
>> +
>> + echo "zram set disksizes: OK"
>> +}
>> +
>> +zram_set_memlimit()
>> +{
>> + echo "set memory limit to zram device(s)"
>> +
>> + local i=0
>> + for ds in $zram_mem_limits; do
>> + local sys_path="/sys/block/zram${i}/mem_limit"
>> + echo "$ds" > $sys_path || \
>> + echo "FAIL can't set '$ds' to $sys_path"
>> +
>> + i=$(($i + 1))
>> + echo "$sys_path = '$ds' ($i/$dev_num)"
>> + done
>> +
>> + echo "zram set memory limit: OK"
>> +}
>> +
>> +zram_makeswap()
>> +{
>> + echo "make swap with zram device(s)"
>> + local i=0
>> + for i in $(seq 0 $(($dev_num - 1))); do
>> + mkswap /dev/zram$i > err.log 2>&1
>> + if [ $? -ne 0 ]; then
>> + cat err.log
>> + echo "FAIL mkswap /dev/zram$1 failed"
>> + fi
>> +
>> + swapon /dev/zram$i > err.log 2>&1
>> + if [ $? -ne 0 ]; then
>> + cat err.log
>> + echo "FAIL swapon /dev/zram$1 failed"
>> + fi
>> +
>> + echo "done with /dev/zram$i"
>> + dev_makeswap=$i
>> + done
>> +
>> + echo "zram making zram mkswap and swapon: OK"
>> +}
>> +
>> +zram_swapoff()
>> +{
>> + local i=
>> + for i in $(seq 0 $dev_makeswap); do
>> + swapoff /dev/zram$i > err.log 2>&1
>> + if [ $? -ne 0 ]; then
>> + cat err.log
>> + echo "FAIL swapoff /dev/zram$i failed"
>> + fi
>> + done
>> + dev_makeswap=-1
>> +
>> + echo "zram swapoff: OK"
>> +}
>> +
>> +zram_makefs()
>> +{
>> + local i=0
>> + for fs in $zram_filesystems; do
>> + # if requested fs not supported default it to ext2
>> + which mkfs.$fs > /dev/null 2>&1 || fs=ext2
>> +
>> + echo "make $fs filesystem on /dev/zram$i"
>> + mkfs.$fs /dev/zram$i > err.log 2>&1
>> + if [ $? -ne 0 ]; then
>> + cat err.log
>> + echo "FAIL failed to make $fs on /dev/zram$i"
>> + fi
>> + i=$(($i + 1))
>> + echo "zram mkfs.$fs: OK"
>> + done
>> +}
>> +
>> +zram_mount()
>> +{
>> + local i=0
>> + for i in $(seq 0 $(($dev_num - 1))); do
>> + echo "mount /dev/zram$i"
>> + mkdir zram$i
>> + mount /dev/zram$i zram$i > /dev/null || \
>> + echo "FAIL mount /dev/zram$i failed"
>> + dev_mounted=$i
>> + done
>> +
>> + echo "zram mount of zram device(s): OK"
>> +}
>> --
>> 1.9.1
>>
>
> Otherwise the code looks fine to me so...
>
> Reviewed-By: Tyler Baker <[email protected]>
>
> Cheers,
>
> Tyler


Thank you.

Best regards
Naresh Kamboju

2015-08-13 19:21:40

by Naresh Kamboju

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests

Hi Shuah Khan,

On 23 July 2015 at 20:33, Shuah Khan <[email protected]> wrote:
> On 07/22/2015 06:00 PM, Tyler Baker wrote:
>> Hi Naresh,
>>
>> On 7 July 2015 at 05:03, <[email protected]> wrote:
>>> From: Naresh Kamboju <[email protected]>
>>>
>>> zram_lib.sh: create library with initialization/cleanup functions
>>> zram01.sh: creates general purpose ram disks with different filesystems
>>> zram02.sh: creates block device for swap
>>> README: ZRAM introduction and Kconfig required.
>>> Makefile: To run zram tests
>>
>> (./zram01.sh && echo "selftests: zram01.sh [PASS]") || echo
>> "selftests: zram01.sh [FAIL]"
>> (./zram02.sh && echo "selftests: zram02.sh [PASS]") || echo
>> "selftests: zram02.sh [FAIL]"
>> (./zram_lib.sh && echo "selftests: zram_lib.sh [PASS]") || echo
>> "selftests: zram_lib.sh [FAIL]"
>>
>> Above is the output from the run_kselftests.sh. Do we want to run
>> zram_lib.sh as a test case as it just a library?
>
> Please make sure test doesn't fail when zram isn't configured.
> i.e it should exit gracefully with a message saying zram isn't
> configured. Please see below:

I agree with Shuah Khan comments.
run_kselftests.sh is design to print results in PASS or FAIL.
We need a way in run_kselftests.sh to print NO_CONFIG when it is not a
real failure instead it is a Kconfig not enabled.

>
>>
>>> Author: Alexey Kodanev <[email protected]>
>>> Signed-off-by: Naresh Kamboju <[email protected]>
>>> ---
>>> tools/testing/selftests/Makefile | 1 +
>>> tools/testing/selftests/zram/Makefile | 12 ++
>>> tools/testing/selftests/zram/README | 39 ++++++
>>> tools/testing/selftests/zram/zram01.sh | 102 ++++++++++++++
>>> tools/testing/selftests/zram/zram02.sh | 57 ++++++++
>>> tools/testing/selftests/zram/zram_lib.sh | 223 +++++++++++++++++++++++++++++++
>>> 6 files changed, 434 insertions(+)
>>> create mode 100644 tools/testing/selftests/zram/Makefile
>>> create mode 100644 tools/testing/selftests/zram/README
>>> create mode 100755 tools/testing/selftests/zram/zram01.sh
>>> create mode 100755 tools/testing/selftests/zram/zram02.sh
>>> create mode 100755 tools/testing/selftests/zram/zram_lib.sh
>>>
>>> diff --git a/tools/testing/selftests/Makefile b/tools/testing/selftests/Makefile
>>> index 24ae9e8..9763dd9 100644
>>> --- a/tools/testing/selftests/Makefile
>>> +++ b/tools/testing/selftests/Makefile
>>> @@ -22,6 +22,7 @@ endif
>>> TARGETS += user
>>> TARGETS += vm
>>> TARGETS += x86
>>> +TARGETS += zram
>>> #Please keep the TARGETS list alphabetically sorted
>>> # Run "make quicktest=1 run_tests" or
>>> # "make quicktest=1 kselftest from top level Makefile
>>> diff --git a/tools/testing/selftests/zram/Makefile b/tools/testing/selftests/zram/Makefile
>>> new file mode 100644
>>> index 0000000..a27a797
>>> --- /dev/null
>>> +++ b/tools/testing/selftests/zram/Makefile
>>> @@ -0,0 +1,12 @@
>>> +all:
>>> +
>>> +TEST_PROGS := zram01.sh zram02.sh zram_lib.sh
>>> +
>>> +include ../lib.mk
>>> +
>>> +run_tests:
>>> + @/bin/bash ./zram01.sh; \
>>> + /bin/bash ./zram02.sh
>>> +
>>> +clean:
>>> + $(RM) err.log
>>> diff --git a/tools/testing/selftests/zram/README b/tools/testing/selftests/zram/README
>>> new file mode 100644
>>> index 0000000..36db066
>>> --- /dev/null
>>> +++ b/tools/testing/selftests/zram/README
>>> @@ -0,0 +1,39 @@
>>> +zram: Compressed RAM based block devices
>>> +----------------------------------------
>>> +* Introduction
>>> +
>>> +The zram module creates RAM based block devices named /dev/zram<id>
>>> +(<id> = 0, 1, ...). Pages written to these disks are compressed and stored
>>> +in memory itself. These disks allow very fast I/O and compression provides
>>> +good amounts of memory savings. Some of the usecases include /tmp storage,
>>> +use as swap disks, various caches under /var and maybe many more :)
>>> +
>>> +Statistics for individual zram devices are exported through sysfs nodes at
>>> +/sys/block/zram<id>/
>>> +
>>> +Kconfig required:
>>> +CONFIG_ZRAM=y
>>> +CONFIG_ZRAM_LZ4_COMPRESS=y
>>> +CONFIG_ZPOOL=y
>>> +CONFIG_ZSMALLOC=y
>>> +
>>> +ZRAM Testcases
>>> +--------------
>>> +zram_lib.sh: create library with initialization/cleanup functions
>>> +
>>> +Two functional tests: zram01 and zram02:
>>> +zram01.sh: creates general purpose ram disks with ext4 filesystems
>>> +zram02.sh: creates block device for swap
>>> +
>>> +Commands required for testing:
>>> + - bc
>>> + - dd
>>> + - free
>>> + - awk
>>> + - mkswap
>>> + - swapon
>>> + - swapoff
>>> + - mkfs/ mkfs.ext4
>>> +
>>> +For more information please refer:
>>> +kernel-source-tree/Documentation/blockdev/zram.txt
>>> diff --git a/tools/testing/selftests/zram/zram01.sh b/tools/testing/selftests/zram/zram01.sh
>>> new file mode 100755
>>> index 0000000..b63eb5d
>>> --- /dev/null
>>> +++ b/tools/testing/selftests/zram/zram01.sh
>>> @@ -0,0 +1,102 @@
>>> +#!/bin/bash
>>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>>> +#
>>> +# This program is free software; you can redistribute it and/or
>>> +# modify it under the terms of the GNU General Public License as
>>> +# published by the Free Software Foundation; either version 2 of
>>> +# the License, or (at your option) any later version.
>>> +#
>>> +# This program is distributed in the hope that it would be useful,
>>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>>> +# GNU General Public License for more details.
>>> +#
>>> +# You should have received a copy of the GNU General Public License
>>> +# along with this program; if not, write the Free Software Foundation,
>>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>>
>> checkpatch is complaining about including the FSF address, so lets remove it.
>>
>>> +#
>>> +# Test creates several zram devices with different filesystems on them.
>>> +# It fills each device with zeros and checks that compression works.
>>> +#
>>> +# Author: Alexey Kodanev <[email protected]>
>>> +# Modified: Naresh Kamboju <[email protected]>
>>> +
>>> +TCID="zram01"
>>> +ERR_CODE=0
>>> +
>>> +. ./zram_lib.sh
>>> +
>>> +# Test will create the following number of zram devices:
>>> +dev_num=1
>>> +# This is a list of parameters for zram devices.
>>> +# Number of items must be equal to 'dev_num' parameter.
>>> +zram_max_streams="2"
>>> +
>>> +# The zram sysfs node 'disksize' value can be either in bytes,
>>> +# or you can use mem suffixes. But in some old kernels, mem
>>> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
>>> +# layer, it uses strict_strtoull() to parse disksize which does
>>> +# not support mem suffixes, in some newer kernels, they use
>>> +# memparse() which supports mem suffixes. So here we just use
>>> +# bytes to make sure everything works correctly.
>>> +zram_sizes="2097152" # 2MB
>>> +zram_mem_limits="2M"
>>> +zram_filesystems="ext4"
>>> +zram_algs="lzo"
>>> +
>>> +zram_fill_fs()
>>> +{
>>> + local mem_free0=$(free -m | awk 'NR==2 {print $4}')
>>> +
>>> + for i in $(seq 0 $(($dev_num - 1))); do
>>> + echo "fill zram$i..."
>>> + local b=0
>>> + while [ true ]; do
>>> + dd conv=notrunc if=/dev/zero of=zram${i}/file \
>>> + oflag=append count=1 bs=1024 status=none \
>>> + > /dev/null 2>&1 || break
>>> + b=$(($b + 1))
>>> + done
>>> + echo "zram$i can be filled with '$b' KB"
>>> + done
>>> +
>>> + local mem_free1=$(free -m | awk 'NR==2 {print $4}')
>>> + local used_mem=$(($mem_free0 - $mem_free1))
>>> +
>>> + local total_size=0
>>> + for sm in $zram_sizes; do
>>> + local s=$(echo $sm | sed 's/M//')
>>> + total_size=$(($total_size + $s))
>>> + done
>>> +
>>> + echo "zram used ${used_mem}M, zram disk sizes ${total_size}M"
>>> +
>>> + local v=$((100 * $total_size / $used_mem))
>>> +
>>> + if [ "$v" -lt 100 ]; then
>>> + echo "FAIL compression ratio: 0.$v:1"
>>> + ERR_CODE=-1
>>> + zram_cleanup
>>> + return
>>> + fi
>>> +
>>> + echo "zram compression ratio: $(echo "scale=2; $v / 100 " | bc):1: OK"
>>> +}
>>> +
>>> +zram_load
>>> +zram_max_streams
>>> +zram_compress_alg
>>> +zram_set_disksizes
>>> +zram_set_memlimit
>>> +zram_makefs
>>> +zram_mount
>>> +
>>> +zram_fill_fs
>>> +zram_cleanup
>>> +zram_unload
>>> +
>>> +if [ $ERR_CODE -ne 0 ]; then
>>> + echo "$TCID : [FAIL]"
>>> +else
>>> + echo "$TCID : [PASS]"
>>> +fi
>>> diff --git a/tools/testing/selftests/zram/zram02.sh b/tools/testing/selftests/zram/zram02.sh
>>> new file mode 100755
>>> index 0000000..81855ce
>>> --- /dev/null
>>> +++ b/tools/testing/selftests/zram/zram02.sh
>>> @@ -0,0 +1,57 @@
>>> +#!/bin/bash
>>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>>> +#
>>> +# This program is free software; you can redistribute it and/or
>>> +# modify it under the terms of the GNU General Public License as
>>> +# published by the Free Software Foundation; either version 2 of
>>> +# the License, or (at your option) any later version.
>>> +#
>>> +# This program is distributed in the hope that it would be useful,
>>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>>> +# GNU General Public License for more details.
>>> +#
>>> +# You should have received a copy of the GNU General Public License
>>> +# along with this program; if not, write the Free Software Foundation,
>>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>>
>> Here as well.
>>
>>> +#
>>> +# Test checks that we can create swap zram device.
>>> +#
>>> +# Author: Alexey Kodanev <[email protected]>
>>> +# Modified: Naresh Kamboju <[email protected]>
>>> +
>>> +TCID="zram02"
>>> +ERR_CODE=0
>>> +
>>> +. ./zram_lib.sh
>>> +
>>> +# Test will create the following number of zram devices:
>>> +dev_num=1
>>> +# This is a list of parameters for zram devices.
>>> +# Number of items must be equal to 'dev_num' parameter.
>>> +zram_max_streams="2"
>>> +
>>> +# The zram sysfs node 'disksize' value can be either in bytes,
>>> +# or you can use mem suffixes. But in some old kernels, mem
>>> +# suffixes are not supported, for example, in RHEL6.6GA's kernel
>>> +# layer, it uses strict_strtoull() to parse disksize which does
>>> +# not support mem suffixes, in some newer kernels, they use
>>> +# memparse() which supports mem suffixes. So here we just use
>>> +# bytes to make sure everything works correctly.
>>> +zram_sizes="1048576" # 1M
>>> +zram_mem_limits="1M"
>>> +
>>> +zram_load
>>> +zram_max_streams
>>> +zram_set_disksizes
>>> +zram_set_memlimit
>>> +zram_makeswap
>>> +zram_swapoff
>>> +zram_cleanup
>>> +zram_unload
>>> +
>>> +if [ $ERR_CODE -ne 0 ]; then
>>> + echo "$TCID : [FAIL]"
>>> +else
>>> + echo "$TCID : [PASS]"
>>> +fi
>>> diff --git a/tools/testing/selftests/zram/zram_lib.sh b/tools/testing/selftests/zram/zram_lib.sh
>>> new file mode 100755
>>> index 0000000..c40a1cf
>>> --- /dev/null
>>> +++ b/tools/testing/selftests/zram/zram_lib.sh
>>> @@ -0,0 +1,223 @@
>>> +#!/bin/sh
>>> +# Copyright (c) 2015 Oracle and/or its affiliates. All Rights Reserved.
>>> +#
>>> +# This program is free software; you can redistribute it and/or
>>> +# modify it under the terms of the GNU General Public License as
>>> +# published by the Free Software Foundation; either version 2 of
>>> +# the License, or (at your option) any later version.
>>> +#
>>> +# This program is distributed in the hope that it would be useful,
>>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>>> +# GNU General Public License for more details.
>>> +#
>>> +# You should have received a copy of the GNU General Public License
>>> +# along with this program; if not, write the Free Software Foundation,
>>> +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
>>
>> And here again.
>>
>>> +#
>>> +# Author: Alexey Kodanev <[email protected]>
>>> +# Modified: Naresh Kamboju <[email protected]>
>>> +
>>> +MODULE=0
>>> +dev_makeswap=-1
>>> +dev_mounted=-1
>>> +
>>> +trap INT
>>> +
>>> +zram_cleanup()
>>> +{
>>> + echo "zram cleanup"
>>> + local i=
>>> + for i in $(seq 0 $dev_makeswap); do
>>> + swapoff /dev/zram$i
>>> + done
>>> +
>>> + for i in $(seq 0 $dev_mounted); do
>>> + umount /dev/zram$i
>>> + done
>>> +
>>> + for i in $(seq 0 $(($dev_num - 1))); do
>>> + echo 1 > /sys/block/zram${i}/reset
>>> + rm -rf zram$i
>>> + done
>>> +
>>> +}
>>> +
>>> +zram_unload()
>>> +{
>>> + if [ $MODULE -ne 0 ] ; then
>>> + echo "zram rmmod zram"
>>> + rmmod zram > /dev/null 2>&1
>>> + fi
>>> +}
>>> +
>>> +zram_load()
>>> +{
>>> + # check zram module exists
>>> + MODULE_PATH=/lib/modules/`uname -r`/kernel/drivers/zram/zram.ko
>>> + if [ -f $MODULE_PATH ]; then
>>> + MODULE=1
>>> + echo "create '$dev_num' zram device(s)"
>>> + modprobe zram num_devices=$dev_num || \
>>> + echo "failed to insert zram module"
>>> +
>>> + dev_num_created=$(ls /dev/zram* | wc -w)
>>> +
>>> + if [ "$dev_num_created" -ne "$dev_num" ]; then
>>> + echo "unexpected num of devices: $dev_num_created"
>>> + ERR_CODE=-1
>>> + else
>>> + echo "zram load module successful"
>>> + fi
>>> + elif [ -b /dev/zram0 ]; then
>>> + echo "/dev/zram0 device file found: OK"
>>> + else
>>> + echo "ERROR: No zram.ko module or no /dev/zram0 device found"
>>> + echo "$TCID : CONFIG_ZRAM is not set"
>>> + exit 1
>>> + fi
>
> In this case, when zram.ko module or no /dev/zram0 device found,
> test should exit gracefully.

Here with this case, when test run manually it prints "CONFIG_ZRAM is
not set" but with run_kselftests.sh script file it gonna FAIL with
non-zero exit code. but it is not a real failure.
How to handle this case ?

Thank you.

Best regards
Naresh Kamboju

>
> thanks,
> -- Shuah
>
> --
> Shuah Khan
> Sr. Linux Kernel Developer
> Open Source Innovation Group
> Samsung Research America (Silicon Valley)
> [email protected] | (970) 217-8978

2015-08-13 19:36:23

by Shuah Khan

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests

On 08/13/2015 01:08 PM, Naresh Kamboju wrote:
> Hi Tyler,
>
> On 23 July 2015 at 05:30, Tyler Baker <[email protected]> wrote:
>> Hi Naresh,
>>
>> On 7 July 2015 at 05:03, <[email protected]> wrote:
>>> From: Naresh Kamboju <[email protected]>
>>>
>>> zram_lib.sh: create library with initialization/cleanup functions
>>> zram01.sh: creates general purpose ram disks with different filesystems
>>> zram02.sh: creates block device for swap
>>> README: ZRAM introduction and Kconfig required.
>>> Makefile: To run zram tests
>>
>> (./zram01.sh && echo "selftests: zram01.sh [PASS]") || echo
>> "selftests: zram01.sh [FAIL]"
>> (./zram02.sh && echo "selftests: zram02.sh [PASS]") || echo
>> "selftests: zram02.sh [FAIL]"
>> (./zram_lib.sh && echo "selftests: zram_lib.sh [PASS]") || echo
>> "selftests: zram_lib.sh [FAIL]"
>>
>> Above is the output from the run_kselftests.sh. Do we want to run
>> zram_lib.sh as a test case as it just a library?
>
> zram_lib.sh is not a test as it just a library.
> run_kselftest.sh should not pick this file as test case. Any idea howto ?
>

TEST_PROGS := zram01.sh zram02.sh zram_lib.sh

The above tells run_kselftest.sh to run these.
You will have to add zram_lib.h to TEST_FILES instead.

Please take a look at other tests that do this. e.g: net/Makefile

thanks,
-- Shuah


--
Shuah Khan
Sr. Linux Kernel Developer
Open Source Innovation Group
Samsung Research America (Silicon Valley)
[email protected] | (970) 217-8978

2015-08-13 19:39:56

by Shuah Khan

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests

On 08/13/2015 01:21 PM, Naresh Kamboju wrote:
> Hi Shuah Khan,
>
> On 23 July 2015 at 20:33, Shuah Khan <[email protected]> wrote:
>> On 07/22/2015 06:00 PM, Tyler Baker wrote:
>>> Hi Naresh,
>>>
>>> On 7 July 2015 at 05:03, <[email protected]> wrote:
>>>> From: Naresh Kamboju <[email protected]>
>>>>
>>>> zram_lib.sh: create library with initialization/cleanup functions
>>>> zram01.sh: creates general purpose ram disks with different filesystems
>>>> zram02.sh: creates block device for swap
>>>> README: ZRAM introduction and Kconfig required.
>>>> Makefile: To run zram tests
>>>
>>> (./zram01.sh && echo "selftests: zram01.sh [PASS]") || echo
>>> "selftests: zram01.sh [FAIL]"
>>> (./zram02.sh && echo "selftests: zram02.sh [PASS]") || echo
>>> "selftests: zram02.sh [FAIL]"
>>> (./zram_lib.sh && echo "selftests: zram_lib.sh [PASS]") || echo
>>> "selftests: zram_lib.sh [FAIL]"
>>>
>>> Above is the output from the run_kselftests.sh. Do we want to run
>>> zram_lib.sh as a test case as it just a library?
>>
>> Please make sure test doesn't fail when zram isn't configured.
>> i.e it should exit gracefully with a message saying zram isn't
>> configured. Please see below:
>
> I agree with Shuah Khan comments.
> run_kselftests.sh is design to print results in PASS or FAIL.
> We need a way in run_kselftests.sh to print NO_CONFIG when it is not a
> real failure instead it is a Kconfig not enabled.
>
>>

snip

>>>> +zram_load()
>>>> +{
>>>> + # check zram module exists
>>>> + MODULE_PATH=/lib/modules/`uname -r`/kernel/drivers/zram/zram.ko
>>>> + if [ -f $MODULE_PATH ]; then
>>>> + MODULE=1
>>>> + echo "create '$dev_num' zram device(s)"
>>>> + modprobe zram num_devices=$dev_num || \
>>>> + echo "failed to insert zram module"
>>>> +
>>>> + dev_num_created=$(ls /dev/zram* | wc -w)
>>>> +
>>>> + if [ "$dev_num_created" -ne "$dev_num" ]; then
>>>> + echo "unexpected num of devices: $dev_num_created"
>>>> + ERR_CODE=-1
>>>> + else
>>>> + echo "zram load module successful"
>>>> + fi
>>>> + elif [ -b /dev/zram0 ]; then
>>>> + echo "/dev/zram0 device file found: OK"
>>>> + else
>>>> + echo "ERROR: No zram.ko module or no /dev/zram0 device found"
>>>> + echo "$TCID : CONFIG_ZRAM is not set"
>>>> + exit 1
>>>> + fi
>>
>> In this case, when zram.ko module or no /dev/zram0 device found,
>> test should exit gracefully.
>
> Here with this case, when test run manually it prints "CONFIG_ZRAM is
> not set" but with run_kselftests.sh script file it gonna FAIL with
> non-zero exit code. but it is not a real failure.
> How to handle this case ?
>

Right. One way to do this is write wrapper script zram.sh that does
these checks first and then invokes the zram01.sh and zram02.sh
This way you can do the pre-reqs checks first and then run the tests.

Please take a look at tests that do this. e.g: net/test_bpf.sh

thanks,
-- Shuah

--
Shuah Khan
Sr. Linux Kernel Developer
Open Source Innovation Group
Samsung Research America (Silicon Valley)
[email protected] | (970) 217-8978

2015-08-14 11:40:29

by Alexey Kodanev

[permalink] [raw]
Subject: Re: [PATCH] selftests/zram: Adding zram tests

Hi Naresh,

On 07/07/2015 03:03 PM, [email protected] wrote:
> From: Naresh Kamboju<[email protected]>
>
> zram_lib.sh: create library with initialization/cleanup functions
> zram01.sh: creates general purpose ram disks with different filesystems
> zram02.sh: creates block device for swap
> README: ZRAM introduction and Kconfig required.
> Makefile: To run zram tests
...
> +zram_load()
> +{
> + # check zram module exists
> + MODULE_PATH=/lib/modules/`uname -r`/kernel/drivers/zram/zram.ko

Should it rather be "/lib/modules/`uname
-r`/kernel/drivers/block/zram/zram.ko" path?

Also adding: Signed-off-by: Alexey Kodanev <[email protected]>

Best regards,
Alexey