git: 938ff8990d53 - stable/13 - renice: support -- as per POSIX.

From: Dag-Erling Smørgrav <des_at_FreeBSD.org>
Date: Wed, 02 Nov 2022 12:35:47 UTC
The branch stable/13 has been updated by des:

URL: https://cgit.FreeBSD.org/src/commit/?id=938ff8990d53d17fa42a2ad784b1230f5d972c0e

commit 938ff8990d53d17fa42a2ad784b1230f5d972c0e
Author:     Dag-Erling Smørgrav <des@FreeBSD.org>
AuthorDate: 2022-08-04 23:50:00 +0000
Commit:     Dag-Erling Smørgrav <des@FreeBSD.org>
CommitDate: 2022-11-02 09:37:00 +0000

    renice: support -- as per POSIX.
    
    Sponsored by:   Klara, Inc.
    MFC after:      1 week
    
    (cherry picked from commit e24c5c60d724120d137f9e5db4e59cf67fd06ba2)
    
    renice: fix argument order.
    
    The target modifiers (-g, -p, -u) may occur in any position except
    between -n and its argument; furthermore, we support both the old
    absolute form (without -n) and the modern relative form (with -n).
    
    Sponsored by: Klara, Inc.
    
    (cherry picked from commit 65ee0a8495538bcf462480c83a9a5dd6f23b6f95)
    
    renice: add unit tests.
    
    Sponsored by:   Klara, Inc.
    
    (cherry picked from commit 7ccdad905f30e90606e11104d46e39c9a6405279)
---
 etc/mtree/BSD.tests.dist            |   2 +
 usr.bin/renice/Makefile             |   5 ++
 usr.bin/renice/renice.c             |  70 ++++++++-------
 usr.bin/renice/tests/Makefile       |   3 +
 usr.bin/renice/tests/renice_test.sh | 169 ++++++++++++++++++++++++++++++++++++
 5 files changed, 219 insertions(+), 30 deletions(-)

diff --git a/etc/mtree/BSD.tests.dist b/etc/mtree/BSD.tests.dist
index 736fb95f9440..3171988e1035 100644
--- a/etc/mtree/BSD.tests.dist
+++ b/etc/mtree/BSD.tests.dist
@@ -1056,6 +1056,8 @@
         ..
         procstat
         ..
+        renice
+        ..
         rs
         ..
         sdiff
diff --git a/usr.bin/renice/Makefile b/usr.bin/renice/Makefile
index d5471379fe1e..8baf6936d7bc 100644
--- a/usr.bin/renice/Makefile
+++ b/usr.bin/renice/Makefile
@@ -1,7 +1,12 @@
 #	@(#)Makefile	8.1 (Berkeley) 6/9/93
 # $FreeBSD$
 
+.include <src.opts.mk>
+
 PROG=	renice
 MAN=	renice.8
 
+HAS_TESTS=
+SUBDIR.${MK_TESTS}+= tests
+
 .include <bsd.prog.mk>
diff --git a/usr.bin/renice/renice.c b/usr.bin/renice/renice.c
index 67917f96e1f8..890d7043ebbd 100644
--- a/usr.bin/renice/renice.c
+++ b/usr.bin/renice/renice.c
@@ -52,11 +52,12 @@ __FBSDID("$FreeBSD$");
 #include <errno.h>
 #include <limits.h>
 #include <pwd.h>
+#include <stdbool.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
-static int	donice(int, int, int, int);
+static int	donice(int, int, int, bool);
 static int	getnum(const char *, const char *, int *);
 static void	usage(void);
 
@@ -69,35 +70,42 @@ int
 main(int argc, char *argv[])
 {
 	struct passwd *pwd;
-	int errs, incr, prio, which, who;
+	bool havedelim = false, haveprio = false, incr = false;
+	int errs = 0, prio = 0, who = 0, which = PRIO_PROCESS;
 
-	errs = 0;
-	incr = 0;
-	which = PRIO_PROCESS;
-	who = 0;
-	argc--, argv++;
-	if (argc < 2)
-		usage();
-	if (strcmp(*argv, "-n") == 0) {
-		incr = 1;
-		argc--, argv++;
-		if (argc < 2)
-			usage();
-	}
-	if (getnum("priority", *argv, &prio))
-		return (1);
-	argc--, argv++;
-	for (; argc > 0; argc--, argv++) {
-		if (strcmp(*argv, "-g") == 0) {
-			which = PRIO_PGRP;
-			continue;
-		}
-		if (strcmp(*argv, "-u") == 0) {
-			which = PRIO_USER;
-			continue;
+	for (argc--, argv++; argc > 0; argc--, argv++) {
+		if (!havedelim) {
+			/* can occur at any time prior to delimiter */
+			if (strcmp(*argv, "-g") == 0) {
+				which = PRIO_PGRP;
+				continue;
+			}
+			if (strcmp(*argv, "-u") == 0) {
+				which = PRIO_USER;
+				continue;
+			}
+			if (strcmp(*argv, "-p") == 0) {
+				which = PRIO_PROCESS;
+				continue;
+			}
+			if (strcmp(*argv, "--") == 0) {
+				havedelim = true;
+				continue;
+			}
+			if (strcmp(*argv, "-n") == 0) {
+				/* may occur only once, prior to priority */
+				if (haveprio || incr)
+					usage();
+				incr = true;
+				(void)argc--, argv++;
+				/* fall through to priority */
+			}
 		}
-		if (strcmp(*argv, "-p") == 0) {
-			which = PRIO_PROCESS;
+		if (!haveprio) {
+			/* must occur exactly once, prior to target */
+			if (getnum("priority", *argv, &prio))
+				return (1);
+			haveprio = true;
 			continue;
 		}
 		if (which == PRIO_USER) {
@@ -124,11 +132,13 @@ main(int argc, char *argv[])
 		}
 		errs += donice(which, who, prio, incr);
 	}
+	if (!haveprio)
+		usage();
 	exit(errs != 0);
 }
 
 static int
-donice(int which, int who, int prio, int incr)
+donice(int which, int who, int prio, bool incr)
 {
 	int oldprio;
 
@@ -166,7 +176,7 @@ getnum(const char *com, const char *str, int *val)
 		return (1);
 	}
 	if (ep == str || *ep != '\0' || errno != 0) {
-		warnx("Bad %s argument: %s.", com, str);
+		warnx("%s argument %s is invalid.", com, str);
 		return (1);
 	}
 
diff --git a/usr.bin/renice/tests/Makefile b/usr.bin/renice/tests/Makefile
new file mode 100644
index 000000000000..c252e396811c
--- /dev/null
+++ b/usr.bin/renice/tests/Makefile
@@ -0,0 +1,3 @@
+ATF_TESTS_SH+=	renice_test
+
+.include <bsd.test.mk>
diff --git a/usr.bin/renice/tests/renice_test.sh b/usr.bin/renice/tests/renice_test.sh
new file mode 100644
index 000000000000..323fe44591c8
--- /dev/null
+++ b/usr.bin/renice/tests/renice_test.sh
@@ -0,0 +1,169 @@
+#!/bin/sh
+#-
+# Copyright (c) 2022 Klara, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+
+# Name of user to use for -u tests when running as root.  Beware that
+# processes owned by that user will be affected by the test.
+TEST_USER=nobody
+
+_renice() {
+	atf_check -o empty -e ignore -s exit:0 renice "$@"
+}
+
+# Set a process's nice number to an absolute value
+atf_test_case renice_abs_pid
+renice_abs_pid_body() {
+	local pid nice incr
+	sleep 60 &
+	pid=$!
+	nice="$(ps -o nice= -p $pid)"
+	incr=3
+	_renice $((nice+incr)) $pid
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	kill $pid
+}
+
+# Change a process's nice number by a relative value
+atf_test_case renice_rel_pid
+renice_rel_pid_body() {
+	local pid nice incr
+	sleep 60 &
+	pid=$!
+	nice="$(ps -o nice= -p $pid)"
+	incr=3
+	_renice -n $incr $pid
+	_renice -p -n $incr $pid
+	_renice -n $incr -p $pid
+	atf_check_equal $((nice+incr+incr+incr)) "$(ps -o nice= -p $pid)"
+	kill $pid
+}
+
+# Set a process group's nice number to an absolute value
+atf_test_case renice_abs_pgid
+renice_abs_pgid_body() {
+	local pid pgid nice incr
+	# make sure target runs in a different pgrp than ours
+	pid=$(sh -mc "sleep 60 >/dev/null & echo \$!")
+	pgid="$(ps -o pgid= -p $pid)"
+	nice="$(ps -o nice= -p $pid)"
+	incr=3
+	_renice $((nice+incr)) -g $pgid
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	kill $pid
+}
+
+# Change a process group's nice number by a relative value
+atf_test_case renice_rel_pgid
+renice_rel_pgid_body() {
+	local pid pgid nice incr
+	# make sure target runs in a different pgrp than ours
+	pid=$(sh -mc "sleep 60 >/dev/null & echo \$!")
+	pgid="$(ps -o pgid= -p $pid)"
+	nice="$(ps -o nice= -p $pid)"
+	incr=3
+	_renice -g -n $incr $pgid
+	_renice -n $incr -g $pgid
+	atf_check_equal $((nice+incr+incr)) "$(ps -o nice= -p $pid)"
+	kill $pid
+}
+
+# Set a user's processes' nice numbers to an absolute value
+atf_test_case renice_abs_user
+renice_abs_user_head() {
+	atf_set "require.user" "root"
+}
+renice_abs_user_body() {
+	local user pid nice incr
+	pid=$(su -m $TEST_USER -c "sleep 60 >/dev/null & echo \$!")
+	nice="$(ps -o nice= -p $pid)"
+	incr=3
+	_renice $((nice+incr)) -u $TEST_USER
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	kill $pid
+}
+
+# Change a user's processes' nice numbers by a relative value
+atf_test_case renice_rel_user
+renice_rel_user_head() {
+	atf_set "require.user" "root"
+}
+renice_rel_user_body() {
+	local user pid nice incr
+	pid=$(su -m $TEST_USER -c "sleep 60 >/dev/null & echo \$!")
+	nice="$(ps -o nice= -p $pid)"
+	incr=3
+	_renice -u -n $incr $TEST_USER
+	_renice -n $incr -u $TEST_USER
+	atf_check_equal $((nice+incr+incr)) "$(ps -o nice= -p $pid)"
+	kill $pid
+}
+
+# Test various delimiter positions
+atf_test_case renice_delim
+renice_delim_body() {
+	local pid nice incr
+	sleep 60 &
+	pid=$!
+	nice="$(ps -o nice= -p $pid)"
+	incr=0
+	# without -p
+	: $((incr=incr+1))
+	_renice -- $((nice+incr)) $pid
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	: $((incr=incr+1))
+	_renice $((nice+incr)) -- $pid
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	: $((incr=incr+1))
+	_renice $((nice+incr)) $pid --
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	# with -p
+	: $((incr=incr+1))
+	_renice -p -- $((nice+incr)) $pid
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	: $((incr=incr+1))
+	_renice -p $((nice+incr)) -- $pid
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	: $((incr=incr+1))
+	_renice -p $((nice+incr)) $pid --
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	: $((incr=incr+1))
+	_renice $((nice+incr)) -p -- $pid
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	: $((incr=incr+1))
+	_renice $((nice+incr)) -p $pid --
+	atf_check_equal $((nice+incr)) "$(ps -o nice= -p $pid)"
+	kill $pid
+}
+
+atf_init_test_cases() {
+	atf_add_test_case renice_abs_pid
+	atf_add_test_case renice_rel_pid
+	atf_add_test_case renice_abs_pgid
+	atf_add_test_case renice_rel_pgid
+	atf_add_test_case renice_abs_user
+	atf_add_test_case renice_rel_user
+	atf_add_test_case renice_delim
+}