Windows: Build tetragon on Windows (Part -2) #3488

ExceptionalHandler · 2025-03-10T21:58:12Z

Description

This change attempts to port ktime, constants and pkg/sensors package to Windows following changes made via #3445. This is the strategy

1. Windows specific .go files are added in this PR for ktime, constants and sensors package
2. We bring back `pkg/sensors/unloader/unloader.go` , `pkg/sensors/tracing/policyhandler.go` and `pkg/sensors/sensors.go` and separate only platform specific code in these listings. 
3. Lot of code, we know not used on Windows is removed. Examples include LSM, multi kprobes etc. 
4. Functions required to build on Windows, but are not supported return "not supported on windows" error

Caveats

This is a change to prepare for Windows build and port. This does not compile on Windows yet, as more changes to dependent packages will be added in subsequent PR.

Changelog

Add windows implementation to ktime, constants and sensor packages.

kkourt

Thanks! Please find some comments bellow.

Generally, let's try to avoid code duplication as much as possible. If it's not possible, then let's at least document why.

pkg/ktime/ktime_test_windows.go

pkg/ktime/ktime_windows.go

pkg/sensors/tracing/lists_windows.go

pkg/sensors/tracing/loader_windows.go

pkg/sensors/tracing/policyhandler_windows.go

pkg/sensors/exec/exec_windows.go

pkg/sensors/program/loader_windows.go

pkg/sensors/load_windows.go

pkg/sensors/sensors_windows.go

pkg/sensors/tracing/policyhandler_windows.go

pkg/sensors/exec/config/config_windows.go

pkg/sensors/program/loader_windows.go

pkg/sensors/exec/config/config_windows.go

pkg/sensors/program/loader_windows.go

pkg/sensors/sensors_windows.go

pkg/sensors/load_windows.go

pkg/constants/constants_windows.go

pkg/sensors/load_windows.go

netlify · 2025-03-20T16:24:38Z

✅ Deploy Preview for tetragon ready!

Name	Link
🔨 Latest commit	`dcf79cc`
🔍 Latest deploy log	https://app.netlify.com/sites/tetragon/deploys/67dc4105e3ac9a00086c941e
😎 Deploy Preview	https://deploy-preview-3488--tetragon.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

kkourt · 2025-03-21T08:03:07Z

pkg/sensors/tracing/lists_windows.go

+)
+
+// isList checks if a value specifies a list, and if so it returns it (or nil if list does not exist)
+func isList(val string, lists []v1alpha1.ListSpec) (bool, *v1alpha1.ListSpec) {


Is this needed? I feel that it can be either removed or use a common version for both windows/linux

kkourt · 2025-03-21T08:31:24Z

pkg/sensors/tracing/loader_windows.go

+
+func createLoaderEvents() error {
+
+	return nil


Shouldn't we return an error (e.g., not supported) here?

kkourt

Apologies, I misclicked and some text was not submitted in the review.
Adding it here.

It seems to me that there is a lot of code duplication between the linux and the windows version. For example, looking at load_windows.go and load_linux.go, there are 15 and 17 functions, respectively. Out of those only 3 seem to have differences. Can we just add all the common code in a load.go file?

$ git grep ^func pkg/sensors/load_windows.go | wc -l
15
$ git grep ^func pkg/sensors/load_linux.go | wc -l
17
$  diff -u pkg/sensors/load_linux.go pkg/sensors/load_windows.go | grep func
-func (s *Sensor) setMapPinPath(m *program.Map) {
-func (s *Sensor) loadMap(bpfDir string, m *program.Map) error {
 func mergeSensors(sensors []*Sensor) *Sensor {
 func observerMinReqs() (bool, error) {

ExceptionalHandler · 2025-03-21T14:47:04Z

It seems to me that there is a lot of code duplication between the linux and the windows version. For example, looking at load_windows.go and load_linux.go, there are 15 and 17 functions, respectively. Out of those only 3 seem to have differences. Can we just add all the common code in a load.go file?

'load.go' is added in latest commit.

olsajiri

looks good, left one minor comment, thanks

olsajiri · 2025-03-24T13:46:49Z

pkg/sensors/load_windows.go

+	return nil
+}
+
+func observerLoadInstance(bpfDir string, load *program.Program, maps []*program.Map) error {


note, linux version has some additional code (with unload for tracepoint),
but I think it can be removed (need to check) and we could move observerLoadInstance to load.go,
but I'll put this on my todo and submit that as follow up

olsajiri · 2025-03-24T13:48:20Z

pkg/sensors/sensor_types_windows.go

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: Apache-2.0


nit, could you plz rename rename 'sensor' to 'sensors' in the path, so we'd have:

pkg/sensors/sensors_types_linux.go pkg/sensors/sensors_types_windows.go

kkourt

Just a couple of nits.

LGTM, thanks!

pkg/sensors/tracing/policyhandler_windows.go

pkg/ktime/ktime_windows.go

Use Win32 API QueryPerformanceCounter to implement the ktime package on Windows. monotonic version uses time package Signed-off-by: Anadi Anadi <[email protected]>

Add constants_windows.go to allow access to constants to windows specific code. Some windows constants are same as those defined in sys/unix package, their values are hardcoded. Some windows constants are specific to Windows and are imported from sys/windows package Signed-off-by: Anadi Anadi <[email protected]>

Add platform specific and platform common code in sensors/tracing package Signed-off-by: Anadi Anadi <[email protected]>

In order to port sensor package on Windows, adding exec parser and loader / unloader for Windows Tried to keep common functions between two OS in pkg/sensors/load.go. The windows implementation of some functions in load_windows.go looks like Linux implementation but is different because of unavailability of some features on windows like bpffs and btf. Also, the sensors.load() function in Windows is a work in progress and we might deprioritize code-reuse in favour of an ability to make future changes independently. Signed-off-by: Anadi Anadi <[email protected]>

ExceptionalHandler requested a review from a team as a code owner March 10, 2025 21:58

ExceptionalHandler requested a review from tixxdz March 10, 2025 21:58

ExceptionalHandler changed the title ~~Windows build 2~~ Windows: Build tetragon on Windows (Part -2) Mar 10, 2025

ExceptionalHandler force-pushed the windows_build_2 branch 4 times, most recently from cafb9c1 to 5cf27cb Compare March 10, 2025 22:35

kkourt requested changes Mar 11, 2025

View reviewed changes

olsajiri reviewed Mar 11, 2025

View reviewed changes

ExceptionalHandler force-pushed the windows_build_2 branch 2 times, most recently from f905fc6 to 0cc7f7c Compare March 17, 2025 22:27

ExceptionalHandler requested review from kkourt, olsajiri and lmb March 18, 2025 14:06

mtardy reviewed Mar 19, 2025

View reviewed changes

pkg/constants/constants_windows.go Outdated Show resolved Hide resolved

olsajiri reviewed Mar 20, 2025

View reviewed changes

pkg/sensors/load_windows.go Outdated Show resolved Hide resolved

pkg/sensors/load_windows.go Outdated Show resolved Hide resolved

ExceptionalHandler force-pushed the windows_build_2 branch from 0cc7f7c to dcf79cc Compare March 20, 2025 16:23

ExceptionalHandler force-pushed the windows_build_2 branch from dcf79cc to b18d1e0 Compare March 20, 2025 17:38

kkourt requested changes Mar 21, 2025

View reviewed changes

ExceptionalHandler force-pushed the windows_build_2 branch from b18d1e0 to 556b8cf Compare March 21, 2025 14:40

ExceptionalHandler force-pushed the windows_build_2 branch from 556b8cf to d650737 Compare March 21, 2025 14:54

olsajiri approved these changes Mar 24, 2025

View reviewed changes

olsajiri added the release-note/minor This PR introduces a minor user-visible change label Mar 24, 2025

kkourt approved these changes Mar 26, 2025

View reviewed changes

pkg/sensors/tracing/policyhandler_windows.go Show resolved Hide resolved

pkg/ktime/ktime_windows.go Outdated Show resolved Hide resolved

ExceptionalHandler added 3 commits March 26, 2025 12:43

Port ktime package to Windows

8464728

Use Win32 API QueryPerformanceCounter to implement the ktime package on Windows. monotonic version uses time package Signed-off-by: Anadi Anadi <[email protected]>

Port the sensors/tracing package on Windows.

b5dd0bb

Add platform specific and platform common code in sensors/tracing package Signed-off-by: Anadi Anadi <[email protected]>

ExceptionalHandler force-pushed the windows_build_2 branch from d650737 to 8f3eaa8 Compare March 26, 2025 16:47

ExceptionalHandler merged commit b3dc538 into cilium:main Mar 26, 2025
39 checks passed

Windows: Build tetragon on Windows (Part -2) #3488

Windows: Build tetragon on Windows (Part -2) #3488

Uh oh!

Conversation

ExceptionalHandler commented Mar 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Caveats

Changelog

Uh oh!

kkourt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Mar 20, 2025

✅ Deploy Preview for tetragon ready!

Uh oh!

kkourt Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

kkourt Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

kkourt left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ExceptionalHandler commented Mar 21, 2025

Uh oh!

olsajiri left a comment

Choose a reason for hiding this comment

Uh oh!

olsajiri Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

olsajiri Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

kkourt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ExceptionalHandler commented Mar 10, 2025 •

edited

Loading

kkourt left a comment •

edited

Loading