Skip to contentSkip to conversation

ubifs: add test for race between listxattr and setxatr

PATCH In review Chen Long 3 participants 3 messages Jan 8, 2022 – Jan 11, 2022

lore
Share & tools
lore

Chen Long

author
#0 lore raw

PATCH 1/1 ubifs: add test for race between listxattr and setxatr

Add reproducer for a bug on ubifs where listxattr() copies the newly created xattr names regardless of the remaining buffer size, fails the assertion of used buffer size, and may corrupt buffer memory.

This is a regression test for three kernel commit:
1. f4e3634a3b642 (ubifs: Fix races between xattr_{set|get} and listxattr operations)
2. 819f9ab430a44 (ubifs: Remove ui_mutex in ubifs_xattr_get and change_xattr)

---
 tests/ubifs/001      | 54 ++++++++++++++++++++++++++++++++++++++++++++
 tests/ubifs/001.out  |  2 ++
 tests/ubifs/Makefile | 24 ++++++++++++++++++++
 3 files changed, 80 insertions(+)
 create mode 100755 tests/ubifs/001
 create mode 100644 tests/ubifs/001.out
 create mode 100644 tests/ubifs/Makefile
tests/ubifs/001 new file +54 -0
new file mode 100755
index 00000000..1e9a4de2
@@ -0,0 +1,54 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2022 Huawei.  All Rights Reserved.
+#
+# FS QA Test 001
+#
+# Regression test for kernel commit:
+# 1. f4e3634a3b642 (ubifs: Fix races between xattr_{set|get} and
+#	listxattr operations)
+# 2. 819f9ab430a44 (ubifs: Remove ui_mutex in ubifs_xattr_get and
+#	change_xattr)
+#
+. ./common/preamble
+_begin_fstest auto quick attr
+
+_cleanup()
+{
+    cd /
+    rm -r -f $tmp.*
+}
+
+# Import common functions.
+. ./common/filter
+. ./common/attr
+
+# real QA test starts here
+_supported_fs ubifs
+_require_test
+_require_attrs
+
+target=$TEST_DIR/$seq
+touch $target
+
+# start a background listxattr
+runfile="$tmp.listxattr"
+touch $runfile
+while [ -e $runfile ]; do
+    ${GETFATTR_PROG} $target >/dev/null 2>&1
+done &
+
+# add new xattr continuously
+largename=`for i in $(seq 0 128); do echo -n a; done`
+for i in $(seq 0 99); do
+    ${SETFATTR_PROG} -n user.${largename}.$i -v $i $target
+done
+
+rm -f $runfile
+wait > /dev/null 2>&1
+rm -f $target
+
+echo "Silence is golden"
+# success, all done
+status=0
+exit
tests/ubifs/001.out new file +2 -0
new file mode 100644
index 00000000..88678b8e
@@ -0,0 +1,2 @@
+QA output created by 001
+Silence is golden
tests/ubifs/Makefile new file +24 -0
new file mode 100644
index 00000000..b464b22b
@@ -0,0 +1,24 @@
+#
+# Copyright (c) 2003-2005 Silicon Graphics, Inc.  All Rights Reserved.
+#
+
+TOPDIR = ../..
+include $(TOPDIR)/include/builddefs
+include $(TOPDIR)/include/buildgrouplist
+
+GENERIC_DIR = generic
+TARGET_DIR = $(PKG_LIB_DIR)/$(TESTS_DIR)/$(GENERIC_DIR)
+DIRT = group.list
+
+default: $(DIRT)
+
+include $(BUILDRULES)
+
+install:
+	$(INSTALL) -m 755 -d $(TARGET_DIR)
+	$(INSTALL) -m 755 $(TESTS) $(TARGET_DIR)
+	$(INSTALL) -m 644 group.list $(TARGET_DIR)
+	$(INSTALL) -m 644 $(OUTFILES) $(TARGET_DIR)
+
+# Nothing.
+install-dev install-lib:
Signature · 1 line
2.17.1
#1 lore raw
Quoted 10 lines · Chen Long

Add reproducer for a bug on ubifs where listxattr() copies the newly created xattr names regardless of the remaining buffer size, fails the assertion of used buffer size, and may corrupt buffer memory.

This is a regression test for three kernel commit:
1. f4e3634a3b642 (ubifs: Fix races between xattr_{set|get} and listxattr operations)
2. 819f9ab430a44 (ubifs: Remove ui_mutex in ubifs_xattr_get and change_xattr)

Only two commits listed above, but description mentioned 'three' kernel commits. Missed one commit or should s/three/the/ ?

And I don't see any ubifs-specific setups or tests, I think it's possible to make it a generic test.

Quoted 27 lines
---
 tests/ubifs/001      | 54 ++++++++++++++++++++++++++++++++++++++++++++
 tests/ubifs/001.out  |  2 ++
 tests/ubifs/Makefile | 24 ++++++++++++++++++++
 3 files changed, 80 insertions(+)
 create mode 100755 tests/ubifs/001
 create mode 100644 tests/ubifs/001.out
 create mode 100644 tests/ubifs/Makefile
tests/ubifs/001 new file +10 -0
new file mode 100755
index 00000000..1e9a4de2
@@ -0,0 +1,54 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2022 Huawei.  All Rights Reserved.
+#
+# FS QA Test 001
+#
+# Regression test for kernel commit:
+# 1. f4e3634a3b642 (ubifs: Fix races between xattr_{set|get} and
+#	listxattr operations)
+# 2. 819f9ab430a44 (ubifs: Remove ui_mutex in ubifs_xattr_get and

tests/ubifs/001 line 20

Quoted 10 lines
tests/ubifs/001 new file +10 -0
+#	change_xattr)
+#
+. ./common/preamble
+_begin_fstest auto quick attr
+
+_cleanup()
+{
+    cd /
+    rm -r -f $tmp.*
+}

Use tab for indention, not spaces.

And this _cleanup() function is the same as the default one, so you don't need to override it.

Quoted 12 lines
tests/ubifs/001 new file +12 -0
+
+# Import common functions.
+. ./common/filter
+. ./common/attr
+
+# real QA test starts here
+_supported_fs ubifs
+_require_test
+_require_attrs
+
+target=$TEST_DIR/$seq
+touch $target

tests/ubifs/001 line 42

Quoted 10 lines
tests/ubifs/001 new file +10 -0
+
+# start a background listxattr
+runfile="$tmp.listxattr"
+touch $runfile
+while [ -e $runfile ]; do
+    ${GETFATTR_PROG} $target >/dev/null 2>&1
+done &
+
+# add new xattr continuously
+largename=`for i in $(seq 0 128); do echo -n a; done`

Don't have to loop for 129 times, perl could do it as

largename=$PERL_PROG -e 'print "a"x129;'

tests/ubifs/001 line 43

Quoted 1 line
tests/ubifs/001 new file +1 -0
+for i in $(seq 0 99); do

for i in {0..99}; do

which could avoid forking a new process :)

tests/ubifs/001 line 45

Quoted 2 lines
tests/ubifs/001 new file +2 -0
+    ${SETFATTR_PROG} -n user.${largename}.$i -v $i $target
+done

Thanks,
Eryu

Quoted 49 lines
tests/ubifs/001 new file +9 -0
+
+rm -f $runfile
+wait > /dev/null 2>&1
+rm -f $target
+
+echo "Silence is golden"
+# success, all done
+status=0
+exit
tests/ubifs/001.out new file +2 -0
new file mode 100644
index 00000000..88678b8e
@@ -0,0 +1,2 @@
+QA output created by 001
+Silence is golden
tests/ubifs/Makefile new file +24 -0
new file mode 100644
index 00000000..b464b22b
@@ -0,0 +1,24 @@
+#
+# Copyright (c) 2003-2005 Silicon Graphics, Inc.  All Rights Reserved.
+#
+
+TOPDIR = ../..
+include $(TOPDIR)/include/builddefs
+include $(TOPDIR)/include/buildgrouplist
+
+GENERIC_DIR = generic
+TARGET_DIR = $(PKG_LIB_DIR)/$(TESTS_DIR)/$(GENERIC_DIR)
+DIRT = group.list
+
+default: $(DIRT)
+
+include $(BUILDRULES)
+
+install:
+	$(INSTALL) -m 755 -d $(TARGET_DIR)
+	$(INSTALL) -m 755 $(TESTS) $(TARGET_DIR)
+	$(INSTALL) -m 644 group.list $(TARGET_DIR)
+	$(INSTALL) -m 644 $(OUTFILES) $(TARGET_DIR)
+
+# Nothing.
+install-dev install-lib:
Signature · 1 line
2.17.1
#2 lore raw
In reply to Chen Long
Quoted 44 lines · Chen Long

Add reproducer for a bug on ubifs where listxattr() copies the newly created xattr names regardless of the remaining buffer size, fails the assertion of used buffer size, and may corrupt buffer memory.

This is a regression test for three kernel commit:
1. f4e3634a3b642 (ubifs: Fix races between xattr_{set|get} and listxattr operations)
2. 819f9ab430a44 (ubifs: Remove ui_mutex in ubifs_xattr_get and change_xattr)

---
 tests/ubifs/001      | 54 ++++++++++++++++++++++++++++++++++++++++++++
 tests/ubifs/001.out  |  2 ++
 tests/ubifs/Makefile | 24 ++++++++++++++++++++
 3 files changed, 80 insertions(+)
 create mode 100755 tests/ubifs/001
 create mode 100644 tests/ubifs/001.out
 create mode 100644 tests/ubifs/Makefile
tests/ubifs/001 new file +17 -0
new file mode 100755
index 00000000..1e9a4de2
@@ -0,0 +1,54 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2022 Huawei.  All Rights Reserved.
+#
+# FS QA Test 001
+#
+# Regression test for kernel commit:
+# 1. f4e3634a3b642 (ubifs: Fix races between xattr_{set|get} and
+#	listxattr operations)
+# 2. 819f9ab430a44 (ubifs: Remove ui_mutex in ubifs_xattr_get and
+#	change_xattr)
+#
+. ./common/preamble
+_begin_fstest auto quick attr
+
+_cleanup()
+{

tests/ubifs/001 line 27

Quoted 10 lines
tests/ubifs/001 new file +10 -0
+    cd /
+    rm -r -f $tmp.*
+}
+
+# Import common functions.
+. ./common/filter
+. ./common/attr
+
+# real QA test starts here
+_supported_fs ubifs

From the whole test case, I don't think it's an ubifs special case. So we can make it to be a generic case.

tests/ubifs/001 line 37

Quoted 10 lines
tests/ubifs/001 new file +10 -0
+_require_test
+_require_attrs
+
+target=$TEST_DIR/$seq
+touch $target
+
+# start a background listxattr
+runfile="$tmp.listxattr"
+touch $runfile
+while [ -e $runfile ]; do

We might can explain at here, that if run getfattr without "-n" option, it uses listxattr system call, or it uses getxattr system call. It's the code logic of getfattr.c

        if (opt_name)
                err = print_attribute(path, opt_name, &header_printed);
        else
                err = list_attributes(path, &header_printed);

tests/ubifs/001 line 38

Quoted 1 line
tests/ubifs/001 new file +1 -0
+    ${GETFATTR_PROG} $target >/dev/null 2>&1

JFYI: There's a wrapper of ${GETFATTR_PROG} _getfattr(). But if you filter all output of getfattr, I think it's fine to use ${GETFATTR_PROG} directly :)

Quoted 44 lines
tests/ubifs/001 new file +16 -0
+done &
+
+# add new xattr continuously
+largename=`for i in $(seq 0 128); do echo -n a; done`
+for i in $(seq 0 99); do
+    ${SETFATTR_PROG} -n user.${largename}.$i -v $i $target
+done
+
+rm -f $runfile
+wait > /dev/null 2>&1
+rm -f $target
+
+echo "Silence is golden"
+# success, all done
+status=0
+exit
tests/ubifs/001.out new file +2 -0
new file mode 100644
index 00000000..88678b8e
@@ -0,0 +1,2 @@
+QA output created by 001
+Silence is golden
tests/ubifs/Makefile new file +14 -0
new file mode 100644
index 00000000..b464b22b
@@ -0,0 +1,24 @@
+#
+# Copyright (c) 2003-2005 Silicon Graphics, Inc.  All Rights Reserved.
+#
+
+TOPDIR = ../..
+include $(TOPDIR)/include/builddefs
+include $(TOPDIR)/include/buildgrouplist
+
+GENERIC_DIR = generic
+TARGET_DIR = $(PKG_LIB_DIR)/$(TESTS_DIR)/$(GENERIC_DIR)
+DIRT = group.list
+
+default: $(DIRT)
+

tests/ubifs/Makefile line 24

Quoted 10 lines
tests/ubifs/Makefile new file +10 -0
+include $(BUILDRULES)
+
+install:
+	$(INSTALL) -m 755 -d $(TARGET_DIR)
+	$(INSTALL) -m 755 $(TESTS) $(TARGET_DIR)
+	$(INSTALL) -m 644 group.list $(TARGET_DIR)
+	$(INSTALL) -m 644 $(OUTFILES) $(TARGET_DIR)
+
+# Nothing.
+install-dev install-lib:

Make this case to be a generic case, will avoid doing this :)

Quoted 3 lines
Signature · 1 line
2.17.1