Add common process consumer

pkg/eventmonitor/consumers/doc.go

@@ -0,0 +1,11 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2024-present Datadog, Inc.
+
+//go:build linux || windows
+
+// Package consumers contains consumer that can be readily used by other packages without
+// having to implement the EventConsumerHandler interface manually:
+// - ProcessConsumer (process.go): a consumer of process exec/exit events that can be subscribed to via callbacks
+package consumers

pkg/eventmonitor/consumers/process.go

@@ -0,0 +1,171 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2024-present Datadog, Inc.
+
+//go:build linux || windows
+
+package consumers
+
+import (
+	"fmt"
+	"sync"
+	"sync/atomic"
+
+	"github.com/DataDog/datadog-agent/pkg/eventmonitor"
+	"github.com/DataDog/datadog-agent/pkg/security/secl/model"
+)
+
+// ProcessCallback is a callback function that will be called when a process exec/exit event is received
+// Defined as an alias to avoid type incompatibilities
+type ProcessCallback = func(uint32)
+
+// ProcessConsumer represents a consumer of process exec/exit events that can be subscribed to
+// via callbacks
+type ProcessConsumer struct {
+	// id is the identification of this consumer in the event data stream
+	id string
+
+	// chanSize is the channel size that will be used to send events to this consumer from the event data stream
+	chanSize int
+
+	// execCallbacks holds all subscriptors to process exec events
+	execCallbacks callbackMap
+
+	// exitCallbacks holds all subscriptors to process exit events
+	exitCallbacks callbackMap
+}
+
+// event represents the attributes of the generic eventmonitor type that we will copy and use in our process consumer
+type event struct {
+	eventType model.EventType
+	pid       uint32
+}
+
+// ProcessConsumer should implement the EventConsumerHandler and EventConsumer interfaces
+var _ eventmonitor.EventConsumerHandler = &ProcessConsumer{}
+var _ eventmonitor.EventConsumer = &ProcessConsumer{}
+
+// NewProcessConsumer creates a new ProcessConsumer, registering itself with the
+// given event monitor. This function should be called with the EventMonitor
+// instance created in cmd/system-probe/modules/eventmonitor.go:createEventMonitorModule.
+// For tests, use consumers/testutil.NewTestProcessConsumer, which also initializes the event stream for testing accordingly
+func NewProcessConsumer(id string, chanSize int, evm *eventmonitor.EventMonitor) (*ProcessConsumer, error) {
+	pc := &ProcessConsumer{
+		id:            id,
+		chanSize:      chanSize,
+		execCallbacks: callbackMap{callbacks: make(map[*ProcessCallback]struct{})},
+		exitCallbacks: callbackMap{callbacks: make(map[*ProcessCallback]struct{})},
+	}
+
+	if err := evm.AddEventConsumerHandler(pc); err != nil {
+		return nil, fmt.Errorf("cannot add event consumer handler: %w", err)
+	}
+
+	evm.RegisterEventConsumer(pc)
+
+	return pc, nil
+}
+
+// --- eventmonitor.EventConsumer interface methods
+
+// Start starts the consumer, this is a no-op for this implementation
+func (p *ProcessConsumer) Start() error {
+	return nil
+}
+
+// Stop stops the consumer, this is a no-op for this implementation
+func (p *ProcessConsumer) Stop() {
+}
+
+// ID returns the ID of the consumer
+func (p *ProcessConsumer) ID() string {
+	return p.id
+}
+
+// --- eventmonitor.EventConsumerHandler interface methods
+
+// ChanSize returns the size of the channel that the event monitor will use to send events to this handler
+func (p *ProcessConsumer) ChanSize() int {
+	return p.chanSize
+}
+
+// EventTypes returns the event types that this handler is interested in
+func (p *ProcessConsumer) EventTypes() []model.EventType {
+	return []model.EventType{model.ExecEventType, model.ExitEventType}
+}
+
+// Copy copies the event from the eventmonitor type to the one we use in this struct
+func (p *ProcessConsumer) Copy(ev *model.Event) any {
+	return &event{
+		eventType: ev.GetEventType(),
+		pid:       ev.GetProcessPid(),
+	}
+}
+
+// HandleEvent handles the event from the event monitor
+func (p *ProcessConsumer) HandleEvent(ev any) {
+	sevent, ok := ev.(*event)
+	if !ok {
+		return
+	}
+
+	switch sevent.eventType {
+	case model.ExecEventType:
+		p.execCallbacks.call(sevent.pid)
+	case model.ExitEventType:
+		p.exitCallbacks.call(sevent.pid)
+	}
+}
+
+// SubscribeExec subscribes to process exec events, and returns the function
+// that needs to be called to unsubscribe
+func (p *ProcessConsumer) SubscribeExec(callback ProcessCallback) func() {
+	return p.execCallbacks.add(callback)
+}
+
+// SubscribeExit subscribes to process exit events, and returns the function
+// that needs to be called to unsubscribe
+func (p *ProcessConsumer) SubscribeExit(callback ProcessCallback) func() {
+	return p.exitCallbacks.add(callback)
+}
+
+// callbackMap is a helper struct that holds a map of callbacks and a mutex to protect it
+type callbackMap struct {
+	// callbacks holds the set of callbacks
+	callbacks map[*ProcessCallback]struct{}
+
+	// mutex is the mutex that protects the callbacks map
+	mutex sync.RWMutex
+
+	// hasCallbacks is a flag that indicates if there are any callbacks subscribed, used
+	// to avoid locking/unlocking the mutex if there are no callbacks
+	hasCallbacks atomic.Bool
+}
+
+// add adds a callback to the callback map and returns a function that can be called to remove it
+func (c *callbackMap) add(cb ProcessCallback) func() {
+	c.mutex.Lock()
+	defer c.mutex.Unlock()
+	c.callbacks[&cb] = struct{}{}
+	c.hasCallbacks.Store(true)
+
+	return func() {
+		c.mutex.Lock()
+		defer c.mutex.Unlock()
+		delete(c.callbacks, &cb)
+		c.hasCallbacks.Store(len(c.callbacks) > 0)
+	}
+}
+
+func (c *callbackMap) call(pid uint32) {
+	if !c.hasCallbacks.Load() {
+		return
+	}
+
+	c.mutex.RLock()
+	defer c.mutex.RUnlock()
+	for cb := range c.callbacks {
+		(*cb)(pid)
+	}
+}

pkg/eventmonitor/consumers/testutil/testutil.go

@@ -0,0 +1,35 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2024-present Datadog, Inc.
+
+//go:build (linux || windows) && test
+
+// Package testutil provides utilities for using the event monitor in tests
+package testutil
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/DataDog/datadog-agent/pkg/eventmonitor"
+	"github.com/DataDog/datadog-agent/pkg/eventmonitor/consumers"
+
+	eventtestutil "github.com/DataDog/datadog-agent/pkg/eventmonitor/testutil"
+)
+
+const defaultChanSize = 100
+
+// NewTestProcessConsumer creates a new ProcessConsumer for testing, registering itself with an event monitor
+// created for testing. This function should be called in tests that require a ProcessConsumer.
+func NewTestProcessConsumer(t *testing.T) *consumers.ProcessConsumer {
+	var pc *consumers.ProcessConsumer
+	eventtestutil.StartEventMonitor(t, func(t *testing.T, evm *eventmonitor.EventMonitor) {
+		var err error
+		pc, err = consumers.NewProcessConsumer("test", defaultChanSize, evm)
+		require.NoError(t, err, "failed to create process consumer")
+	})
+
+	return pc
+}