Received-SPF: pass (google.com: domain of linux-kernel+bounces-47477-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Received-SPF: Pass (protection.outlook.com: domain of opensynergy.com
 designates 217.66.60.4 as permitted sender) receiver=protection.outlook.com;
 client-ip=217.66.60.4; helo=SR-MAIL-03.open-synergy.com; pr=C
From: Peter Hilber <peter.hilber@opensynergy.com>
To: linux-kernel@vger.kernel.org
Cc: Peter Hilber <peter.hilber@opensynergy.com>,
	"D, Lakshmi Sowjanya" <lakshmi.sowjanya.d@intel.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	jstultz@google.com,
	giometti@enneenne.com,
	corbet@lwn.net,
	"Dong, Eddie" <eddie.dong@intel.com>,
	"Hall, Christopher S" <christopher.s.hall@intel.com>,
	Simon Horman <horms@kernel.org>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Marc Zyngier <maz@kernel.org>,
	linux-arm-kernel@lists.infradead.org,
	Sean Christopherson <seanjc@google.com>,
	Paolo Bonzini <pbonzini@redhat.com>,
	Ingo Molnar <mingo@redhat.com>,
	Borislav Petkov <bp@alien8.de>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	x86@kernel.org,
	"H. Peter Anvin" <hpa@zytor.com>,
	Wanpeng Li <wanpengli@tencent.com>,
	Vitaly Kuznetsov <vkuznets@redhat.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Daniel Lezcano <daniel.lezcano@linaro.org>,
	Richard Cochran <richardcochran@gmail.com>,
	kvm@vger.kernel.org,
	netdev@vger.kernel.org,
	Stephen Boyd <sboyd@kernel.org>
Subject: [PATCH v3 0/8] treewide: Use clocksource ID for get_device_system_crosststamp()
Date: Thu,  1 Feb 2024 02:04:45 +0100
Message-Id: <20240201010453.2212371-1-peter.hilber@opensynergy.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 01 Feb 2024 01:05:42.7163
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: aa9a9031-901c-43ea-7678-08dc22c1e9ea
X-MS-Exchange-CrossTenant-Id: 800fae25-9b1b-4edc-993d-c939c4e84a64
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=800fae25-9b1b-4edc-993d-c939c4e84a64;Ip=[217.66.60.4];Helo=[SR-MAIL-03.open-synergy.com]
X-MS-Exchange-CrossTenant-AuthSource:
	DB8EUR05FT034.eop-eur05.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BEZP281MB3106
X-TM-AS-ERS: 104.47.7.169-0.0.0.0
X-TMASE-Version: StarCloud-1.3-9.1.1015-28152.007
X-TMASE-Result: 10--9.655700-4.000000
X-TMASE-MatchedRID: kU+oJxJqVp+UP+0hdpOx0lmcWIT2GKzJi9V1e7G8XUijN1SoAtAGxtsH
	8mvO8CBHCRqqhJm8rIn5mjPOVI6+s/oKZK4fc4pdc6MQph12+/qgn19QHAlOzICpIfHsTRJvaQX
	O0KwCdXrdTrmsiWLAxD3Dhol2PU5Lmbpduk4zUf/BcAkkfZSxiKJDaGSlxWd0nFPS5wCjpHZ01t
	kgbj61ndpXJMrozGW3YpESvCL4it1Y7t9efcoDgI/LriVzPuf5wgrtnQK+MOoY5qQDqF7ovmDbt
	ijTkWnp3MnltAZSB6WDdsVaS6GBxzFZ+rmPiUkrsZIjJc0QK/bVLrJfyVWkTeEZbxf3Zciyh21E
	BzIb6ox/PBbU24mRsJqKJrV3x9ZQXV7SCcp2kYuSHQtEOSQwHEXzYX/dCbSfMHiMmW0ZUNss3nA
	Y9fdM9dh5c4TN8zbZ7PVkFWMnCn8N5Rk4kJccyAwdv/u39cUHoli4ZoiOHT9+ICquNi0WJL0Rdj
	vdXSTSc1mnLhfpPYG9EGEki1p2D9gS00QqA5oUftwZ3X11IV0=
X-TMASE-XGENCLOUD: 46464346-aa41-412c-9459-3adbed66af2e-0-0-200-0
X-TM-Deliver-Signature: E53744A90FEB612068C1A10663A0D405
X-TM-Addin-Auth: Hn48YxJdqloKVmrtONTaujT6J+gMYyewEsscs5FseHrjAJvx7khCR8Wm7KA
	QNofComxEaSLqfZNWdFZJliRP+mjmcNc5kQnc+Km0tYSXLzok3OoglhTQH/1D0V1T7udt/gWBaq
	AHiYwLLbR+HnPN8YXGRsXhXgPDO50H5IDvTrKmqYtGlldTcOFI500JFgFVNsBqET0nsHlhuRKsw
	516DlGeblvX7JS1Oz3s8mHDTQ5FUSYAUZt6KUMa0yKhHVtqkmw8jm8y0km88gRj7wtjg+qxP/ef
	5e92o+LihlmRTVJTBAOyDrq1jZbFFrqL2Ek1.bBD+JSCJ8cycENkHPM45HyFYal1+LCHEFbTwRh
	qFtutrcdZJQf8vvJOYtIZbT57MYOE7nKsOKvJrnB0zcRBLhMRa0ZzRyKHIvQlViXhOFZfR1m7ZB
	FGn/kYNORK1a3JI0xYJ2h/A6PaBJ2//EBvSyEZJ2ojua7JT7rw7c9FR4aAsBiVO9BN8PSuEw0UK
	w5EgfcvyhvmaB9D6BLnJPtmZUKPnkJMH9dryP4WftTqTkuJsO6VI3sdF924CgF8uDaB46nSZHpp
	gFYgzi6alLz6yqK/RFgzA06EPpjIcFlXZ24pFUIRJ0ff2aRCdkTDQ++gs/mtM1hhWwZZqyAzz+c
	i+JQ==
X-TM-Addin-ProductCode: EMS
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=opensynergy.com;
	s=TM-DKIM-20210503141657; t=1706749713;
	bh=oohEjQrzvapv0uR3lS9rKQZ5S5PGY1gElpFaIbQC5+w=; l=5321;
	h=From:To:Date;
	b=vY+1udhHfDmjfepIYBPpZVPzmT5c82H6cOcSB+pTNjU7Zu63qtFX2KDbl3bGlIM34
	 a3HOtEwNIlTgFgRekkKZwXheDhTdXayNXtS/zTvyWB2zZGHEO9sMbkmVBY43CQdxYg
	 jldYuu1054YMVY9KBgSbEBEV8g4eJnPnDk18mFubq83YFqvArNsN8HBYTAaOoK9jiK
	 Jse7qJQZ0zyoWGLJypYVCY576b0KidBzzY+y6kqFsznfLNPukg/I28l47yXlpRQv9u
	 362BsgrkJyIkVr0WQS+7tAZ3GMsMH1gqiMPsMxQaMYRUDI78+DJhZS7ietRI/Vy4kV
	 MekQ/7SgvBT5g==

Overview
--------

This patch series changes struct system_counterval_t to identify the
clocksource through enum clocksource_ids, rather than through struct
clocksource *. The net effect of the patch series is that
get_device_system_crosststamp() callers can supply clocksource ids instead
of clocksource pointers. The pointers can be problematic to get hold of.

The series is also available at

        https://github.com/OpenSynergy/linux clocksource-id-for-xtstamp-v3

Motivation
----------

The immediate motivation for this patch series is to enable the virtio_rtc
RFC driver (v3 cf. [1]) to refer to the Arm Generic Timer clocksource
without requiring new helper functions in the arm_arch_timer driver. Other
future get_device_system_crosststamp() users may profit from this change as
well.

Clocksource structs are normally private to clocksource drivers. Therefore,
get_device_system_crosststamp() callers require that clocksource drivers
expose the clocksource of interest in some way.

Drivers such as virtio_rtc could obtain all information for calling
get_device_system_crosststamp() from their bound device, except for
clocksource identification. Often, such drivers' only direct relation with
the clocksource driver is clocksource identification. So using the
clocksource enum, rather than obtaining pointers in a clocksource driver
specific way, would reduce the coupling between the
get_device_system_crosststamp() callers and clocksource drivers.

Affected Code
-------------

This series modifies code which is relevant to
get_device_system_crosststamp(), in timekeeping, ptp/kvm, x86/kvm, and
x86/tsc.

There are two sorts of get_device_system_crosststamp() callers in the
current kernel:

1) On Intel platforms, some PTP hardware clocks, and the HDA controller,
obtain the clocksource pointer for get_device_system_crosststamp() using
convert_art_to_tsc() or convert_art_ns_to_tsc() from arch/x86.

2) The ptp_kvm driver uses kvm_arch_ptp_get_crosststamp(), which is
implemented for platforms with kvm_clock (x86) or arm_arch_timer.
Amongst other things, kvm_arch_ptp_get_crosststamp() returns a clocksource
pointer. The Arm implementation is in the arm_arch_timer driver.

Changes
-------

The series does the following:

- add clocksource ID to the get_device_system_crosststamp() param type

- add required clocksource ids and set them in
  get_device_system_crosststamp() users

- evaluate clocksource ID in get_device_system_crosststamp(), rather than
  clocksource pointer

- remove now obsolete clocksource pointer field and related code

This series should not alter any behavior. This series is a prerequisite
for the virtio_rtc driver [1].

Verification
------------

Out of the existing get_device_system_crosststamp() users, only ptp_kvm has
been tested (on x86-64 and arm64).

For each patch, with next-20240131 and mainline 1bbb19b6eb1b, on x86-64 and
arm64:

- built allmodconfig, allyesconfig, tinyconfig with GCC and LLVM (with a
  few unrelated features turned off)

- runtime-tested ptp_kvm, checking ioctl PTP_SYS_OFFSET_PRECISE return
  codes and clock synchronization success (reverted unrelated 
  "tty: serial: amba-pl011: Remove QDF2xxx workarounds" from linux-next
  on arm64, to get QEMU with console working)

Changelog
---------

v3:

- Drop RFC.

- Omit redundant clocksource_ids.h includes (Andy Shevchenko).

- Fix tsc.c kernel-doc warnings, omitting some redundant documentation
  (Simon Horman).

- Document relevant verification.

- Improve commit message wording.

v2:

- Align existing changes with sketch [2] by Thomas Gleixner (omitting
  additional clocksource base changes from [2]).

- Add follow-up improvements in ptp_kvm and kvmclock.

- Split patches differently (Thomas Gleixner).

- Refer to clocksource IDs as such in comments (Thomas Gleixner).

- Update comments which were still referring to clocksource pointers.

[1] https://lore.kernel.org/lkml/20231218073849.35294-1-peter.hilber@opensynergy.com/
[2] https://lore.kernel.org/lkml/87lec15i4b.ffs@tglx/


Peter Hilber (8):
  x86/tsc: Fix major kernel-doc warnings for tsc.c
  timekeeping: Add clocksource ID to struct system_counterval_t
  x86/tsc: Add clocksource ID, set system_counterval_t.cs_id
  x86/kvm, ptp/kvm: Add clocksource ID, set system_counterval_t.cs_id
  ptp/kvm, arm_arch_timer: Set system_counterval_t.cs_id to constant
  timekeeping: Evaluate system_counterval_t.cs_id instead of .cs
  treewide: Remove system_counterval_t.cs, which is never read
  kvmclock: Unexport kvmclock clocksource

 arch/x86/include/asm/kvmclock.h      |  2 --
 arch/x86/kernel/kvmclock.c           |  4 ++--
 arch/x86/kernel/tsc.c                | 28 +++++++++++++++-------------
 drivers/clocksource/arm_arch_timer.c |  6 +++---
 drivers/ptp/ptp_kvm_common.c         | 10 +++++-----
 drivers/ptp/ptp_kvm_x86.c            |  4 ++--
 include/linux/clocksource_ids.h      |  3 +++
 include/linux/ptp_kvm.h              |  4 ++--
 include/linux/timekeeping.h          | 10 ++++++----
 kernel/time/timekeeping.c            |  9 +++++----
 10 files changed, 43 insertions(+), 37 deletions(-)


base-commit: 06f658aadff0e483ee4f807b0b46c9e5cba62bfa
-- 
2.40.1