From nobody Tue Feb 22 00:17:21 2022 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id E5DF419DF288; Tue, 22 Feb 2022 00:17:22 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4K2fr22zTjz3LgW; Tue, 22 Feb 2022 00:17:22 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1645489042; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=lBZTJYK/E5pqwtatOUa5QIDlexv47VgIwVM66yq0C2s=; b=dsX50wWXa8gkyXMQjJZiYEfHPN2QJ+KOVyXBFyik3vyQrmPIx+HGtxKNl249FOilX0gBiY lP1bJn88YZd9+Itbtx1mRx2Z6WG4XU2oUFWVL+T7zU2ytCqdGIqIkEzLoYBnh8JAaWH+T7 iIZN/xaDVCVnEt/z3s/7wRFivJNoRhU7cT8bNAu+rZIitDZwwNmP6yI29D/MCnFybSAmE2 UQbQHMIms+YKLam9aZuFrOuPnm022X0DzEgkkQj0PrvpYuaLHG2JO4jLtnwFEIjX+kHKC+ LGCuOCMI7wOxCgPupdnfgSmEWVpO+Spwb3LGVr9+RTzslpcOnjwAO8odVkFRMg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 1037E19EBD; Tue, 22 Feb 2022 00:17:22 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 21M0HLNw041231; Tue, 22 Feb 2022 00:17:21 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 21M0HLc8041230; Tue, 22 Feb 2022 00:17:21 GMT (envelope-from git) Date: Tue, 22 Feb 2022 00:17:21 GMT Message-Id: <202202220017.21M0HLc8041230@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mitchell Horne Subject: git: 13ec1e3155c7 - main - boottrace(8): small wrapper utility List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: mhorne X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 13ec1e3155c7e9bf037b12af186351b7fa9b9450 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1645489042; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=lBZTJYK/E5pqwtatOUa5QIDlexv47VgIwVM66yq0C2s=; b=sIl+Ci9hYpmT4ZOOQSMnl3v5/S+Ok2abRpDkUX96n7Nu41W+4hj8atcDcmQfG5nhTUTfB1 kfWJ9baDmARwjRn+DzJjxzXcdn7O8mJnlMNv8hQI0XJXomxGSNiegtIsDfviIYEZT5SQcN UpjybwFQMT5b7Hgai506nnFcjUKSFYcOR3jY2QKdp4ot4hwjzXva3dqAisX9jBpZCJ8re7 1dGPBKWuCXgQvT542EZnRyQsuLa4cTtjsHjAa8v6RuMv8ZMsYMt1b3jeVCYTSs73GjGaVp 4OiZDugC4KviRNOCn3n1ZAwcSyuHGOnlH526Qv/FyNoTUbJdlosOT22l1UkRfw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1645489042; a=rsa-sha256; cv=none; b=Ia/lwqGthsoUO/PvJZjACv9zDU+j9nycaJ/EA24i6F0eJ6dGQfU6rrTB5Cse43PE0nTZo9 1aOX9c9ZLuWTfD+11QF4aq4/IECXsaE0I7iJg9jzrdOxcr+xx+z7r3RLvfC+2V9ROdLAr0 hKYQXpf7rFnTtXS+O+KOv2gp6OPCcyRJ7Ktljf1tN67Sit222bsWN341foTjRYub0NDMZ6 UUgguEU+He376ZjkW9gB3XRHRuQiW0xd5cz8Qad80wv9IvsnWoylsB1nNVYr1DUno+0aGB Qq1p7KxQT4IBTxn6OBrPWlJCMEyCTCA9aRYLZuf7IoAZeZe93YKk5JSpi8p/kQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=13ec1e3155c7e9bf037b12af186351b7fa9b9450 commit 13ec1e3155c7e9bf037b12af186351b7fa9b9450 Author: Mitchell Horne AuthorDate: 2021-02-05 20:07:39 +0000 Commit: Mitchell Horne CommitDate: 2022-02-22 00:16:12 +0000 boottrace(8): small wrapper utility This is a small program that when invoked will create start and stop boottrace entries via sysctl, and execute the desired command. Having this as an executable -- as opposed to some shell script invoking sysctl(8) -- allows the total resource usage recorded by the trace entries to include the child process. Reviewed by: 0mp, trasz (older version) Sponsored by: NetApp, Inc. Sponsored by: Klara, Inc. Differential Revision: https://reviews.freebsd.org/D31929 --- usr.sbin/Makefile | 1 + usr.sbin/boottrace/Makefile | 4 ++ usr.sbin/boottrace/boottrace.8 | 85 ++++++++++++++++++++++++++++++++++++++++++ usr.sbin/boottrace/boottrace.c | 71 +++++++++++++++++++++++++++++++++++ 4 files changed, 161 insertions(+) diff --git a/usr.sbin/Makefile b/usr.sbin/Makefile index d7e0811a961c..d57cb3bb9ea6 100644 --- a/usr.sbin/Makefile +++ b/usr.sbin/Makefile @@ -6,6 +6,7 @@ SUBDIR= adduser \ arp \ binmiscctl \ + boottrace \ camdd \ cdcontrol \ chkgrp \ diff --git a/usr.sbin/boottrace/Makefile b/usr.sbin/boottrace/Makefile new file mode 100644 index 000000000000..2a407c5572ae --- /dev/null +++ b/usr.sbin/boottrace/Makefile @@ -0,0 +1,4 @@ +PROG= boottrace +MAN= boottrace.8 + +.include diff --git a/usr.sbin/boottrace/boottrace.8 b/usr.sbin/boottrace/boottrace.8 new file mode 100644 index 000000000000..7e7ea7b82bd1 --- /dev/null +++ b/usr.sbin/boottrace/boottrace.8 @@ -0,0 +1,85 @@ +.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD +.\" +.\" Copyright (c) 2022 NetApp, Inc. +.\" +.\" 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. +.\" +.Dd February 18, 2022 +.Dt BOOTTRACE 8 +.Os +.Sh NAME +.Nm boottrace +.Nd trace command execution with +.Xr boottrace 4 +.Sh SYNOPSIS +.Nm +.Ar utility Op Ar argument ... +.Sh DESCRIPTION +The +.Nm +utility +executes the specified +.Ar utility , +creating two +.Xr boottrace 4 +trace entries before and after its execution. +.Sh ENVIRONMENT +The +.Ev PATH +environment variable is used to locate the requested +.Ar utility +if the name contains no +.Ql / +characters. +.Sh EXIT STATUS +If +.Ar utility +was executed successfully, its exit status is returned. +.Pp +If +.Ar utility +was found but could not be executed, an exit status of 126 is returned. +If +.Ar utility +could not be found, an exit status of 127 is returned. +.Sh EXAMPLES +Execute the +.Xr dumpon 8 +utility, logging the trace entries: +.Bd -literal -offset indent +$ boottrace dumpon -z /dev/gpt/swap0 +.Ed +.Pp +This will appear in the output of the +.Va kern.boottrace.log +.Xr sysctl 8 +node: +.Bd -literal +CPU msecs delta process event PID CPUtime IBlks OBlks + 0 63918567 0 kernel sysinit 0x2100001 0 0.00 0 0 +[...] + 0 64076940 120605 boottrace dumpon start 1602 0.00 0 0 + 0 64076942 2 boottrace dumpon done 1602 0.00 0 0 +.Ed +.Sh SEE ALSO +.Xr boottrace 4 , +.Xr rc.subr 8 diff --git a/usr.sbin/boottrace/boottrace.c b/usr.sbin/boottrace/boottrace.c new file mode 100644 index 000000000000..7696d96e0d96 --- /dev/null +++ b/usr.sbin/boottrace/boottrace.c @@ -0,0 +1,71 @@ +/*- + * SPDX-License-Identifier: BSD-2-Clause-FreeBSD + * + * Copyright (c) 2022 NetApp, Inc. + * + * 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. + */ + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +static void +usage(void) +{ + fprintf(stderr, "usage: boottrace utility [argument ...]\n"); + exit(1); +} + +int +main(int argc, char **argv) +{ + pid_t pid; + int status; + + if (argc < 2) + usage(); + argv++; + + BOOTTRACE("%s start", *argv); + pid = fork(); + if (pid == -1) { + exit(1); + } else if (pid == 0) { + execvp(*argv, argv); + err(errno == ENOENT ? 127 : 126, "execvp %s", *argv); + } + waitpid(pid, &status, 0); + if (!WIFEXITED(status)) + warnx("command terminated abnormally"); + BOOTTRACE("%s done", *argv); + + return (WIFEXITED(status) ? WEXITSTATUS(status) : EXIT_FAILURE); +}