Skip to contentSkip to conversation

Two useradd fixes

PATCH Applied Scott Garman 3 participants 5 messages Mar 23, 2012

lore
Share & tools
lore
#0 lore raw

cover Two useradd fixes

Hello,

This pull request fixes two race conditions related to the useradd code.

Yocto bug #2127 describes how when using the RPM package manager, the order of package installation during generatin of the rootfs did not guarantee that base-passwd and shadow would be installed before other packages which need to install custom users/groups in their postinstall functions. This fix ensures that when base-passwd and/or shadow are part of an image, they will be installed first during image generation.

The second race condition is described in Yocto bug #1794, and can occur if two build steps try to update the sysroot passwd/group files at the same time. Since the shadow utilities enforce file locking, the commands will fail to run. The fix for this involves checking for failure and retrying the commands up to 10 times, with a 1s delay between attempts before giving up.

Verifying these fixes involved creating numerous images and useradd-based packages repeatedly on a build host with high parallelism, and also doing so from a pre-populated sstate-cache. I was able to reliably simulate the file locking behavior by making the passwd/group files read only when developing the fix for #1794.

Scott

The following changes since commit 87e581bb7da9f1530d190cd023fcf892c8b858f5:

ddimage: Add script for writing images to boot media (2012-03-22 19:17:54 +0000)

are available in the git repository at:
git://git.pokylinux.org/poky-contrib sgarman/useradd-lock-fix-oe
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=sgarman/useradd-lock-fix-oe

Scott Garman (2):
package_rpm.bbclass: ensure base-passwd and shadow get installed
first
useradd.bbclass: retry useradd/groupadd commands to avoid lock race
issues

 meta/classes/package_rpm.bbclass |    9 ++++++++-
 meta/classes/useradd.bbclass     |   36 ++++++++++++++++++++++++++++++++++--
 2 files changed, 42 insertions(+), 3 deletions(-)
Signature · 1 line
1.7.5.4
#1 lore raw

PATCH 1/2 package_rpm.bbclass: ensure base-passwd and shadow get installed first

When generating images, we need to make sure that base-passwd and shadow get installed before other packages, which might need to create custom user accounts.

Thanks to Richard Purdie for the initial version of this fix.

This fixes [YOCTO #2127]

---
 meta/classes/package_rpm.bbclass |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)
meta/classes/package_rpm.bbclass +8 -1
index 80b1619..e83fc55 100644
@@ -439,7 +439,14 @@ package_install_internal_rpm () {
 
 	fi
 
-	cat ${target_rootfs}/install/install_solution.manifest > ${target_rootfs}/install/total_solution.manifest
+	# If base-passwd or shadow are in the list of packages to install,
+	# ensure they are installed first to support later packages that
+	# may create custom users/groups (fixes Yocto bug #2127)
+	infile=${target_rootfs}/install/install_solution.manifest
+	outfile=${target_rootfs}/install/total_solution.manifest
+	cat $infile | grep /base-passwd-[0-9] > $outfile || true
+	cat $infile | grep /shadow-[0-9] >> $outfile || true
+	cat $infile | grep -v /shadow-[0-9] | grep -v /base-passwd-[0-9] >> $outfile
 	cat ${target_rootfs}/install/install_multilib_solution.manifest >> ${target_rootfs}/install/total_solution.manifest
 
 	# Construct install scriptlet wrapper
Signature · 1 line
1.7.5.4
#2 lore raw

PATCH 2/2 useradd.bbclass: retry useradd/groupadd commands to avoid lock race issues

In reply to Scott Garman

A race condition can occur when adding users and groups to the passwd and group files, causing errors like the following:

ERROR: Function 'useradd_sysroot' failed Tried to access "/etc/group" but this was locked.

This fix will cause the useradd code to retry the useradd and groupadd commands up to 10 times (with a 1s sleep in between attempts) before failing.

This fixes [YOCTO #1794]

---
 meta/classes/useradd.bbclass |   36 ++++++++++++++++++++++++++++++++++--
 1 files changed, 34 insertions(+), 2 deletions(-)
meta/classes/useradd.bbclass +34 -2
index 7981a68..0bbb371 100644
@@ -45,7 +45,23 @@ if test "x$GROUPADD_PARAM" != "x"; then
 		groupname=`echo "$opts" | awk '{ print $NF }'`
 		group_exists=`grep "^$groupname:" $SYSROOT/etc/group || true`
 		if test "x$group_exists" = "x"; then
-			eval $PSEUDO groupadd  $OPT $opts
+			count=1
+			while true; do
+				eval $PSEUDO groupadd $OPT $opts || true
+				group_exists=`grep "^$groupname:" $SYSROOT/etc/group || true`
+				if test "x$group_exists" = "x"; then
+					# File locking issues can require us to retry the command
+					echo "WARNING: groupadd command did not succeed. Retrying..."
+					sleep 1
+				else
+					break
+				fi
+				count=`expr $count + 1`
+				if test $count = 11; then
+					echo "ERROR: tried running groupadd command 10 times without success, giving up"
+					exit 1
+				fi
+			done		
 		else
 			echo "Note: group $groupname already exists, not re-creating it"
 		fi
@@ -70,7 +86,23 @@ if test "x$USERADD_PARAM" != "x"; then
 		username=`echo "$opts" | awk '{ print $NF }'`
 		user_exists=`grep "^$username:" $SYSROOT/etc/passwd || true`
 		if test "x$user_exists" = "x"; then
-			eval $PSEUDO useradd $OPT $opts
+			count=1
+			while true; do
+				eval $PSEUDO useradd $OPT $opts || true
+				user_exists=`grep "^$username:" $SYSROOT/etc/passwd || true`
+				if test "x$user_exists" = "x"; then
+					# File locking issues can require us to retry the command
+					echo "WARNING: useradd command did not succeed. Retrying..."
+					sleep 1
+				else
+					break
+				fi
+				count=`expr $count + 1`
+				if test $count = 11; then
+					echo "ERROR: tried running useradd command 10 times without success, giving up"
+					exit 1
+				fi
+			done
 		else
 			echo "Note: username $username already exists, not re-creating it"
 		fi
Signature · 1 line
1.7.5.4
#3 lore raw

Re: [PATCH 2/2] useradd.bbclass: retry useradd/groupadd commands to avoid lock race issues

This should go in our edison 1.1.2 release as well.

-M

Quoted 79 lines · Scott Garman

A race condition can occur when adding users and groups to the passwd and group files, causing errors like the following:

 ERROR: Function 'useradd_sysroot' failed Tried to access "/etc/group" but this was locked.

This fix will cause the useradd code to retry the useradd and groupadd commands up to 10 times (with a 1s sleep in between attempts) before failing.

This fixes [YOCTO #1794]

---
 meta/classes/useradd.bbclass |   36 ++++++++++++++++++++++++++++++++++--

 1 files changed, 34 insertions(+), 2 deletions(-)
meta/classes/useradd.bbclass +0 -0
index 7981a68..0bbb371 100644
@@ -45,7 +45,23 @@ if test "x$GROUPADD_PARAM" != "x"; then

               groupname=echo "$opts" | awk '{ print $NF }'
               group_exists=grep "^$groupname:" $SYSROOT/etc/group || true
               if test "x$group_exists" = "x"; then
-                       eval $PSEUDO groupadd  $OPT $opts
+                       count=1
+                       while true; do
+                               eval $PSEUDO groupadd $OPT $opts || true
+                               group_exists=grep "^$groupname:" $SYSROOT/etc/group || true
+                               if test "x$group_exists" = "x"; then
+                                       # File locking issues can require us to retry the command
+                                       echo "WARNING: groupadd command did not succeed. Retrying..."
+                                       sleep 1
+                               else
+                                       break
+                               fi
+                               count=expr $count + 1
+                               if test $count = 11; then
+                                       echo "ERROR: tried running groupadd command 10 times without success, giving up"
+                                       exit 1
+                               fi
+                       done
               else
                       echo "Note: group $groupname already exists, not re-creating it"
               fi

meta/classes/useradd.bbclass +0 -0
@@ -70,7 +86,23 @@ if test "x$USERADD_PARAM" != "x"; then

               username=echo "$opts" | awk '{ print $NF }'
               user_exists=grep "^$username:" $SYSROOT/etc/passwd || true
               if test "x$user_exists" = "x"; then
-                       eval $PSEUDO useradd $OPT $opts
+                       count=1
+                       while true; do
+                               eval $PSEUDO useradd $OPT $opts || true
+                               user_exists=grep "^$username:" $SYSROOT/etc/passwd || true
+                               if test "x$user_exists" = "x"; then
+                                       # File locking issues can require us to retry the command
+                                       echo "WARNING: useradd command did not succeed. Retrying..."
+                                       sleep 1
+                               else
+                                       break
+                               fi
+                               count=expr $count + 1
+                               if test $count = 11; then
+                                       echo "ERROR: tried running useradd command 10 times without success, giving up"
+                                       exit 1
+                               fi
+                       done
               else
                       echo "Note: username $username already exists, not re-creating it"
               fi
--
1.7.5.4

_______________________________________________
Openembedded-core mailing list
[email protected]
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-core

#4 lore raw
In reply to Scott Garman
Quoted 34 lines · Scott Garman

Hello,

This pull request fixes two race conditions related to the useradd code.

Yocto bug #2127 describes how when using the RPM package manager, the order of package installation during generatin of the rootfs did not guarantee that base-passwd and shadow would be installed before other packages which need to install custom users/groups in their postinstall functions. This fix ensures that when base-passwd and/or shadow are part of an image, they will be installed first during image generation.

The second race condition is described in Yocto bug #1794, and can occur if two build steps try to update the sysroot passwd/group files at the same time. Since the shadow utilities enforce file locking, the commands will fail to run. The fix for this involves checking for failure and retrying the commands up to 10 times, with a 1s delay between attempts before giving up.

Verifying these fixes involved creating numerous images and useradd-based packages repeatedly on a build host with high parallelism, and also doing so from a pre-populated sstate-cache. I was able to reliably simulate the file locking behavior by making the passwd/group files read only when developing the fix for #1794.

Scott

The following changes since commit 87e581bb7da9f1530d190cd023fcf892c8b858f5:

ddimage: Add script for writing images to boot media (2012-03-22 19:17:54 +0000)

are available in the git repository at:
git://git.pokylinux.org/poky-contrib sgarman/useradd-lock-fix-oe
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=sgarman/useradd-lock-fix-oe

Quoted 5 lines

Scott Garman (2):
package_rpm.bbclass: ensure base-passwd and shadow get installed
first
useradd.bbclass: retry useradd/groupadd commands to avoid lock race
issues

Merged to master, thanks!

Richard