From nobody Mon Jul 17 16:49:41 2023 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 4R4Sjd3WZFz4n4df; Mon, 17 Jul 2023 16:49:41 +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 4R4Sjd34wtz4JSJ; Mon, 17 Jul 2023 16:49:41 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1689612581; 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=A6APlKOpQjoe6zSviCoWfxp1ELHULMtyHj+cgOG7gbY=; b=IoV2IzwVvKFy7FP1E3703d1AW27BShCmwL1MD104SUx63Te2usJApGWi0YOi5BuP6cCApf v/3wIKMKtbAYrGgHGwkEpWIKP2NeWNyNRv5s6QIU/GQHN50HBxjVMuAPWPI1xRhB8HE+Rz 5ucE2nD9q/cvFwpSX65PPXSBNENwmBbwMvO98Z/S786x+ClXrHHjN3B+n7AT9J1mc/VlRu EV3i/c9Aiek17vluhqEHSBifa3FxlPWbJdl8mXTBBQ2qxZFJlf4XAfxaO9g9dWNZQM5MJ0 4YDTSq6BIXqUcrWGzujGwJ2Leb8EqJSA1tZL2zbbePEHGyQXOZWo6VcRuAT8fQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1689612581; 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=A6APlKOpQjoe6zSviCoWfxp1ELHULMtyHj+cgOG7gbY=; b=mUMNTZTHcdXl2N+uwR6qD/oLBych1o1uPRP9gI+mjHV9zfG7Zo8wwHcFj0d2rxBFFNMBlh +sTlO0qv40LxzzpSTpqGib9QQOdLweK+9/ba6mRm5/OuwNHi/hEA4dC2e8to+cSl3MZLc8 osRx5XLY9+c8rWVe+SQBbmNk5YWFgO0dqK+sOQ3WesWx1y96HQWr+4Q0dWTfD71j92yhmm fCay7aGYsuNjIE9V+Q4lXJQfURQQnDUA6dXNXMzo2iBnieHBYyBYGnfLsXHLIm8LH5zqA9 0ikY0JgeOZ384j0yXWx7gHFebkdUZ/lTnbQS0sBAt6/F/EeSJguVqNNKDaMDHQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1689612581; a=rsa-sha256; cv=none; b=XtvuhenDWwL8L47nw+BfDmLr7lntlcI0f8di1qlOFw8wTrzqwp5VSTmcAYkaoPnTd/TEAJ MlbQl46nw/HDm8FGYQZmSIjIQJNqZLivl/odo9j4hqoQUJ42+U8lBDIInm2pDpgisfL8ed LVsVgtGb4VJgHx35JuK7LHVX9spNa4x6/JG/FZICxGGwKbsHPWczdQlIIOmbhWn1N1SwC4 8QW9WjvNBhmROKtxRcNTB1wo8znJg9w/63w5KftBxwkg3uR7j/t6SgmmmPeXntGvpNfeIn fQnl1jUUC6OnHUXmEImMDXBe1N+59g5HAPSzI1kFLLHuQNmP5Py/tnuzRaetUg== 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 4R4Sjd1kNCzWKd; Mon, 17 Jul 2023 16:49:41 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 36HGnfYc081400; Mon, 17 Jul 2023 16:49:41 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 36HGnf4a081399; Mon, 17 Jul 2023 16:49:41 GMT (envelope-from git) Date: Mon, 17 Jul 2023 16:49:41 GMT Message-Id: <202307171649.36HGnf4a081399@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mitchell Horne Subject: git: f7df2c03753a - stable/13 - pmc: clarify and strengthen statements about API/ABI 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/stable/13 X-Git-Reftype: branch X-Git-Commit: f7df2c03753aab249c075f5895df1e6fc591eaf6 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/13 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=f7df2c03753aab249c075f5895df1e6fc591eaf6 commit f7df2c03753aab249c075f5895df1e6fc591eaf6 Author: Mitchell Horne AuthorDate: 2023-06-16 16:38:19 +0000 Commit: Mitchell Horne CommitDate: 2023-07-17 16:45:39 +0000 pmc: clarify and strengthen statements about API/ABI - Make it clear that applications are not only encouraged to use the pmc(3) library, but use of the hwpmc(4) interface directly is a use-case we do not support - Move the COMPATIBILITY section above PROGRAMMING API in hwpmc(4) - Drop statements about the driver and library being "under development" Reviewed by: jkoshy, emaste MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D40543 (cherry picked from commit 3977781b987e369a9fe23bb642b9680b0a3887c1) --- lib/libpmc/pmc.3 | 8 ++------ share/man/man4/hwpmc.4 | 27 +++++++++------------------ 2 files changed, 11 insertions(+), 24 deletions(-) diff --git a/lib/libpmc/pmc.3 b/lib/libpmc/pmc.3 index 4bf2907db129..8cc7275bc338 100644 --- a/lib/libpmc/pmc.3 +++ b/lib/libpmc/pmc.3 @@ -23,7 +23,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 10, 2021 +.Dd June 16, 2023 .Dt PMC 3 .Os .Sh NAME @@ -474,11 +474,7 @@ In order to ease forward compatibility with future versions of the driver, applications are urged to dynamically link with the .Nm pmc library. -.Pp -The -.Nm pmc -API is -.Ud +Doing otherwise is unsupported. .Sh SEE ALSO .Xr pmc.atom 3 , .Xr pmc.core 3 , diff --git a/share/man/man4/hwpmc.4 b/share/man/man4/hwpmc.4 index 6bd5d571793a..3a4be77085bc 100644 --- a/share/man/man4/hwpmc.4 +++ b/share/man/man4/hwpmc.4 @@ -28,7 +28,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 2, 2012 +.Dd June 16, 2023 .Dt HWPMC 4 .Os .Sh NAME @@ -288,14 +288,15 @@ Non-disabled hardware counters in such a row may be used for satisfying system scope allocation requests. No process scope PMCs will use hardware counters in this row. .El -.Sh PROGRAMMING API -The recommended way for application programs to use the facilities of -the -.Nm -driver is using the API provided by the +.Sh COMPATIBILITY +The API and ABI documented in this manual page may change in the future. +This interface is intended to be consumed by the .Xr pmc 3 -library. -.Pp +library; other consumers are unsupported. +Applications targeting PMCs should use the +.Xr pmc 3 +library API. +.Sh PROGRAMMING API The .Nm driver operates using a system call number that is dynamically @@ -526,16 +527,6 @@ The value for tunable .Va kern.hwpmc.nsamples was negative or greater than 65535. .El -.Sh COMPATIBILITY -The -.Nm -driver is -.Ud -The API and ABI documented in this manual page may change in -the future. -The recommended method of accessing this driver is using the -.Xr pmc 3 -API. .Sh ERRORS A command issued to the .Nm