new(docker,pkg/driverbuilder): use `cmake` instead of makefile template to build kmod and bpf #302

FedeDP · 2023-11-10T14:37:19Z

What type of PR is this?

/kind feature

Any specific area of the project related to this PR?

/area pkg

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Docker images changes will be split to their own PR if maintainers agree this is the way to go.
Also: while testing i discovered that recent archlinux kmods fail to build (eg: against 6.6.1.arch1-1) even with master images and code.

level=DEBUG msg="\x02\x00\x00\x00\x00\x00\x00\x7f./tools/objtool/objtool: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.38' not found (required by ./tools/objtool/objtool)\n"

Will investigate further, but it seems we need a builder image with an updated glibc version.
Opened an issue to track that: #303

Does this PR introduce a user-facing change?:

new(docker,pkg/driverbuilder): use cmake instead of makefile template to build kmod and bpf

FedeDP · 2023-11-10T14:38:46Z

docker/builders/builder-centos-x86_64_gcc4.8.5.Dockerfile

+    git
+
+# Install cmake3.x (on centos7 `cmake` package installs cmake2.x)
+RUN curl -L -o /tmp/cmake.tar.gz https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-linux-$(uname -m).tar.gz; \


We need to manually install a cmake 3.x on centos:7.

FedeDP · 2023-11-10T14:41:25Z

pkg/driverbuilder/builder/templates/alinux.sh

-
-cp /driverkit/module-Makefile {{ .DriverBuildDir }}/Makefile
-bash /driverkit/fill-driver-config.sh {{ .DriverBuildDir }}
+mv /tmp/module-download/*/* {{ .DriverBuildDir }}


Scripts are a bit different now:

we move all the stuff under the download libs repo to{{ .DriverBuildDir }} now, not only the driver subfolder

we run cmake with lots of things disabled. Unfortunately, given that libs only recently gained the ability to build the bpf probe in MINIMAL_BUILD mode, we need to configure the project in full mode, and this requires git because grpc and protobuf deps need to be fetched/cloned.

Then, building is just a matter of calling make driver and make bpf with the correct CC and KERNELDIR.

I actually really like how much this all simplifies the code, and I think the trade offs are worth it.

FedeDP · 2023-11-15T14:12:15Z

cc @falcosecurity/driverkit-maintainers

EXONER4TED · 2023-12-01T13:54:19Z

I think this is awesome! Which would you prefer though - we can put this through now, or do #308 first and then rebase this?

FedeDP · 2023-12-01T13:57:42Z

Let's go with #308 first! I will split the docker images cmake part from this so that we can actually test that this works perfectly fine using --builderimage auto:master

FedeDP · 2023-12-01T14:25:09Z

I will also need to update the new local builder to use cmake when downloading sources. (this is a reminder for myself!)

FedeDP · 2023-12-01T14:35:55Z

Split #309 out of this !

FedeDP · 2023-12-12T16:19:18Z

Need more fixes to the new local (as in "internal to containers") module and probe paths (that will now be /tmp/driver/build/driver/$drivername.ko and /tmp/driver/build/driver/bpf/probe.o).
Everything else seems working fine though ;)

FedeDP · 2023-12-12T16:28:42Z

pkg/driverbuilder/builder/builders.go

@@ -55,6 +43,14 @@ type Config struct {
 	*Build
 }

+func (c Config) ToDriverFullPath() string {
+	return path.Join(DriverDirectory, "build", "driver", fmt.Sprintf("%s.ko", c.DriverName))


We expect the built kmod with cmake to be under /tmp/driver/build/driver/$drivername.ko.

FedeDP · 2023-12-12T16:29:01Z

pkg/driverbuilder/builder/builders.go

+	return path.Join(DriverDirectory, "build", "driver", fmt.Sprintf("%s.ko", c.DriverName))
+}
+
+func (c Config) ToProbeFullPath() string {


We expect the built probe with cmake to be under /tmp/driver/build/driver/bpf/probe.o.

FedeDP · 2023-12-12T16:29:35Z

pkg/driverbuilder/builder/templates/alinux.sh

 {{ if .BuildModule }}
 # Build the module
-cd {{ .DriverBuildDir }}
-make CC=/usr/bin/gcc-{{ .GCCVersion }} KERNELDIR=/tmp/kernel
-mv {{ .ModuleDriverName }}.ko {{ .ModuleFullPath }}


We don't need the mv anymore since ModuleFullPath is already the correct path.

FedeDP · 2023-12-12T16:31:34Z

pkg/driverbuilder/kubernetes.go

@@ -102,11 +102,11 @@ func (bp *KubernetesBuildProcessor) buildModule(b *builder.Build) error {
 		return err
 	}

-	if builder.ModuleFullPath != "" {
+	if c.ModuleFilePath != "" {


The following are small fixes in the kubernetes builder. cc @Lowaiz

FedeDP · 2023-12-12T16:31:54Z

pkg/driverbuilder/kubernetes.go

@@ -275,15 +255,15 @@ func (bp *KubernetesBuildProcessor) copyModuleAndProbeFromPodWithUID(ctx context
 			}
 			if p.Status.Phase == corev1.PodRunning {
 				slog.With(falcoBuilderUIDLabel, falcoBuilderUID).Info("start downloading module and probe from pod")
-				if builder.ModuleFullPath != "" {
-					err = copySingleFileFromPod(build.ModuleFilePath, bp.coreV1Client, bp.clientConfig, p.Namespace, p.Name, builder.ModuleFullPath, moduleLockFile)
+				if c.ModuleFilePath != "" {


Same fix as above.

FedeDP · 2023-12-12T16:31:58Z

pkg/driverbuilder/kubernetes.go

 					if err != nil {
 						return err
 					}
 					slog.Info("Kernel Module extraction successful")
 				}
-				if builder.ProbeFullPath != "" {
-					err = copySingleFileFromPod(build.ProbeFilePath, bp.coreV1Client, bp.clientConfig, p.Namespace, p.Name, builder.ProbeFullPath, probeLockFile)
+				if c.ProbeFilePath != "" {


Same fix as above.

FedeDP · 2023-12-13T08:32:26Z

TODO: i need to also fix the local builder with local sources case; there, we won't need to configure anything since the project is already configured.

FedeDP · 2023-12-19T08:06:38Z

/hold for review

EXONER4TED · 2024-02-28T15:04:30Z

So my vote here is to merge this, try it downstream, and then report back. I love this change, and we're ready to merge it. If something breaks downstream, we can handle it in a separate MR/release

FedeDP · 2024-02-28T15:05:11Z

Nice! I will make sure to rebase asap and let the flow go on :)

EXONER4TED

/approve

… to build kmod and bpf. Signed-off-by: Federico Di Pierro <[email protected]>

Signed-off-by: Federico Di Pierro <[email protected]>

…` in template scripts. Signed-off-by: Federico Di Pierro <[email protected]>

…ute existing dir path. Moreover, take into account srcDir in local builder: when src-dir is specified, sources do not need to be configured through cmake. Signed-off-by: Federico Di Pierro <[email protected]>

Signed-off-by: Federico Di Pierro <[email protected]>

…e driverversions. In CI, enable multiple driverversions to test that we do not break against old driver versions. Signed-off-by: Federico Di Pierro <[email protected]>

Moreover, add back some now unused cmake variables, ie: * PROBE_NAME * PROBE_VERSION * PROBE_DEVICE_NAME Signed-off-by: Federico Di Pierro <[email protected]>

Signed-off-by: Federico Di Pierro <[email protected]>

…l` cmd. Moreover, properly fill CmakeCmd for local target too. Signed-off-by: Federico Di Pierro <[email protected]>

EXONER4TED

Approve again :)

poiana · 2024-02-28T15:45:21Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: EXONER4TED, FedeDP

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [EXONER4TED,FedeDP]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

FedeDP · 2024-02-28T15:50:34Z

/unhold

poiana added kind/feature New feature or request do-not-merge/work-in-progress dco-signoff: yes area/pkg labels Nov 10, 2023

poiana requested review from leodido and Lowaiz November 10, 2023 14:37

poiana added approved size/XL labels Nov 10, 2023

FedeDP commented Nov 10, 2023

View reviewed changes

FedeDP mentioned this pull request Nov 15, 2023

new(driver): kmod configure system falcosecurity/libs#1452

Merged

FedeDP mentioned this pull request Nov 29, 2023

wip: fix(pkg/driverbuilder): fixed bpf probe build for new libs. #283

Closed

FedeDP mentioned this pull request Dec 1, 2023

new(docker): add cmake and git packages to builders images. #309

Merged

FedeDP force-pushed the new/use_cmake branch from 6d65cb8 to 826307a Compare December 12, 2023 15:50

poiana added size/XXL and removed size/XL labels Dec 12, 2023

FedeDP commented Dec 12, 2023

View reviewed changes

FedeDP force-pushed the new/use_cmake branch from 0ea2552 to 6a7fde7 Compare December 12, 2023 16:32

FedeDP mentioned this pull request Dec 14, 2023

chore(cmake): allow user to override GIT_COMMIT from cmake. falcosecurity/libs#1576

Merged

FedeDP force-pushed the new/use_cmake branch 2 times, most recently from 6306d33 to 33d576c Compare December 18, 2023 16:21

poiana added the do-not-merge/hold label Dec 19, 2023

FedeDP mentioned this pull request Feb 7, 2024

fix(build): don't write to source directory during build falcosecurity/libs#1034

Open

FedeDP mentioned this pull request Feb 27, 2024

chore(driver): allow kmod and bpf drivers different components falcosecurity/libs#1709

Merged

EXONER4TED previously approved these changes Feb 28, 2024

View reviewed changes

poiana assigned EXONER4TED Feb 28, 2024

poiana added the lgtm label Feb 28, 2024

FedeDP added 8 commits February 28, 2024 16:07

new(docker,pkg/driverbuilder): use cmake instead of makefile template…

a2cab38

… to build kmod and bpf. Signed-off-by: Federico Di Pierro <[email protected]>

fix(pkg): ported local builder to use cmake.

ecf2951

Signed-off-by: Federico Di Pierro <[email protected]>

chore(pkg/driver): fixed up builder templates.

c63a417

Signed-off-by: Federico Di Pierro <[email protected]>

fix(pkg): use correct {Module,Probe}FullPath so that we do save a `mv…

2dedbfb

…` in template scripts. Signed-off-by: Federico Di Pierro <[email protected]>

chore(pkg,cmd,validate): properly validate that src-dir is an absol…

054333e

…ute existing dir path. Moreover, take into account srcDir in local builder: when src-dir is specified, sources do not need to be configured through cmake. Signed-off-by: Federico Di Pierro <[email protected]>

chore(pkg/driverbuilder): small refactor in local template script.

e6eab8d

Signed-off-by: Federico Di Pierro <[email protected]>

chore(build,ci): allow users to run integration tests against multipl…

cb2c45b

…e driverversions. In CI, enable multiple driverversions to test that we do not break against old driver versions. Signed-off-by: Federico Di Pierro <[email protected]>

fix(pkg/driverbuilder): use a single constant for the Cmake command.

13171b6

Moreover, add back some now unused cmake variables, ie: * PROBE_NAME * PROBE_VERSION * PROBE_DEVICE_NAME Signed-off-by: Federico Di Pierro <[email protected]>

FedeDP dismissed EXONER4TED’s stale review via 13171b6 February 28, 2024 15:11

FedeDP force-pushed the new/use_cmake branch from 33d576c to 13171b6 Compare February 28, 2024 15:11

FedeDP added 2 commits February 28, 2024 16:20

chore(pkg/driverbuilder): small fixes for local builder.

2d58a7c

Signed-off-by: Federico Di Pierro <[email protected]>

fix(cmd,pkg,validate): src-dir is not a mandatory parameter for `loca…

784f575

…l` cmd. Moreover, properly fill CmakeCmd for local target too. Signed-off-by: Federico Di Pierro <[email protected]>

EXONER4TED approved these changes Feb 28, 2024

View reviewed changes

poiana removed the do-not-merge/hold label Feb 28, 2024

poiana merged commit 31c7e6a into master Feb 28, 2024
5 checks passed

poiana deleted the new/use_cmake branch February 28, 2024 15:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new(docker,pkg/driverbuilder): use `cmake` instead of makefile template to build kmod and bpf #302

new(docker,pkg/driverbuilder): use `cmake` instead of makefile template to build kmod and bpf #302

FedeDP commented Nov 10, 2023 •

edited

Loading

FedeDP Nov 10, 2023

FedeDP Nov 10, 2023

EXONER4TED Dec 1, 2023

FedeDP commented Nov 15, 2023

EXONER4TED commented Dec 1, 2023

FedeDP commented Dec 1, 2023

FedeDP commented Dec 1, 2023

FedeDP commented Dec 1, 2023

FedeDP commented Dec 12, 2023

FedeDP Dec 12, 2023 •

edited

Loading

FedeDP Dec 12, 2023

FedeDP Dec 12, 2023 •

edited

Loading

FedeDP Dec 12, 2023

FedeDP Dec 12, 2023

FedeDP Dec 12, 2023

FedeDP commented Dec 13, 2023 •

edited

Loading

FedeDP commented Dec 19, 2023

EXONER4TED commented Feb 28, 2024

FedeDP commented Feb 28, 2024

EXONER4TED left a comment

EXONER4TED left a comment

poiana commented Feb 28, 2024

FedeDP commented Feb 28, 2024

new(docker,pkg/driverbuilder): use cmake instead of makefile template to build kmod and bpf #302

new(docker,pkg/driverbuilder): use cmake instead of makefile template to build kmod and bpf #302

Conversation

FedeDP commented Nov 10, 2023 • edited Loading

FedeDP Nov 10, 2023

Choose a reason for hiding this comment

FedeDP Nov 10, 2023

Choose a reason for hiding this comment

EXONER4TED Dec 1, 2023

Choose a reason for hiding this comment

FedeDP commented Nov 15, 2023

EXONER4TED commented Dec 1, 2023

FedeDP commented Dec 1, 2023

FedeDP commented Dec 1, 2023

FedeDP commented Dec 1, 2023

FedeDP commented Dec 12, 2023

FedeDP Dec 12, 2023 • edited Loading

Choose a reason for hiding this comment

FedeDP Dec 12, 2023

Choose a reason for hiding this comment

FedeDP Dec 12, 2023 • edited Loading

Choose a reason for hiding this comment

FedeDP Dec 12, 2023

Choose a reason for hiding this comment

FedeDP Dec 12, 2023

Choose a reason for hiding this comment

FedeDP Dec 12, 2023

Choose a reason for hiding this comment

FedeDP commented Dec 13, 2023 • edited Loading

FedeDP commented Dec 19, 2023

EXONER4TED commented Feb 28, 2024

FedeDP commented Feb 28, 2024

EXONER4TED left a comment

Choose a reason for hiding this comment

EXONER4TED left a comment

Choose a reason for hiding this comment

poiana commented Feb 28, 2024

FedeDP commented Feb 28, 2024

new(docker,pkg/driverbuilder): use `cmake` instead of makefile template to build kmod and bpf #302

new(docker,pkg/driverbuilder): use `cmake` instead of makefile template to build kmod and bpf #302

FedeDP commented Nov 10, 2023 •

edited

Loading

FedeDP Dec 12, 2023 •

edited

Loading

FedeDP Dec 12, 2023 •

edited

Loading

FedeDP commented Dec 13, 2023 •

edited

Loading