Skip to content

refactor(filter)!: Decommission ps.child.* filter fields #551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rabbitstack merged 4 commits into from
Jan 2, 2026
Merged

refactor(filter)!: Decommission ps.child.* filter fields #551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6bb234e
refactor(filter)!: Remove ps.child filter fields
rabbitstack Dec 31, 2025
a392a06
refactor(ps)!: Adjust CreateProcess event process state attribution
rabbitstack Dec 31, 2025
a3e4638
refactor(rules)!: Transition rules from ps.child.* to ps.* fields
rabbitstack Dec 31, 2025
960e6e3
refactor(callstack): Use creator process id for callstack treatment
rabbitstack Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 25 additions & 8 deletions pkg/event/event_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ package event
import (
"encoding/binary"
"fmt"
"os"
"strings"
"sync"
"unsafe"

"github.com/rabbitstack/fibratus/pkg/event/params"
"github.com/rabbitstack/fibratus/pkg/sys"
"github.com/rabbitstack/fibratus/pkg/sys/etw"
Expand All @@ -29,10 +34,6 @@ import (
"github.com/rabbitstack/fibratus/pkg/util/hostname"
"github.com/rabbitstack/fibratus/pkg/util/ntstatus"
"golang.org/x/sys/windows"
"os"
"strings"
"sync"
"unsafe"
)

var (
Expand Down Expand Up @@ -111,9 +112,9 @@ func (e *Event) adjustPID() {
case Process:
// process start events may be logged in the context of the parent or child process.
// As a result, the ProcessId member of EVENT_TRACE_HEADER may not correspond to the
// process being created, so we set the event pid to be the one of the parent process
// process being created, so we extract the process id from the event parameters
if e.IsCreateProcess() {
e.PID, _ = e.Params.GetPpid()
e.PID, _ = e.Params.GetPid()
}
case Net:
if !e.IsDNS() {
Expand Down Expand Up @@ -266,8 +267,24 @@ func (e *Event) IsOpenDisposition() bool {
return e.IsCreateFile() && e.Params.MustGetUint32(params.FileOperation) == windows.FILE_OPEN
}

// StackID returns the integer that is used to identify the callstack present in the StackWalk event.
func (e *Event) StackID() uint64 { return uint64(e.PID + e.Tid) }
// StackID returns the integer that is used to stich the callstack present in the StackWalk event.
func (e *Event) StackID() uint64 {
if e.IsCreateProcess() {
return uint64(e.Params.MustGetPpid() + e.Tid)
}
return uint64(e.PID + e.Tid)
}

// StackPID returns the process id as seen the creator
// from the callstack execution perspective. For example,
// the pid associated with CreateProcess events is the
// parent, not the process being created.
func (e *Event) StackPID() uint32 {
if e.IsCreateProcess() {
return e.Params.MustGetPpid()
}
return e.PID
}

// RundownKey calculates the rundown event hash. The hash is
// used to determine if the rundown event was already processed.
Expand Down
141 changes: 13 additions & 128 deletions pkg/filter/accessor_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ package filter
import (
"errors"
"expvar"
"github.com/rabbitstack/fibratus/pkg/fs"
"github.com/rabbitstack/fibratus/pkg/network"
psnap "github.com/rabbitstack/fibratus/pkg/ps"
"github.com/rabbitstack/fibratus/pkg/util/cmdline"
"github.com/rabbitstack/fibratus/pkg/util/signature"
"net"
"path/filepath"
"strconv"
"strings"
"time"

"github.com/rabbitstack/fibratus/pkg/fs"
"github.com/rabbitstack/fibratus/pkg/network"
psnap "github.com/rabbitstack/fibratus/pkg/ps"
"github.com/rabbitstack/fibratus/pkg/util/signature"

"github.com/rabbitstack/fibratus/pkg/event"
"github.com/rabbitstack/fibratus/pkg/event/params"
"github.com/rabbitstack/fibratus/pkg/filter/fields"
Expand Down Expand Up @@ -91,14 +91,7 @@ func newPSAccessor(psnap psnap.Snapshotter) Accessor { return &psAccessor{psnap:
func (ps *psAccessor) Get(f Field, e *event.Event) (params.Value, error) {
switch f.Name {
case fields.PsPid:
// identifier of the process that is generating the event
return e.PID, nil
case fields.PsSiblingPid, fields.PsChildPid:
if e.Category != event.Process {
return nil, nil
}
// the id of a created child process. `e.PID` is the parent process id
return e.Params.GetPid()
case fields.PsPpid:
ps := e.PS
if ps == nil {
Expand All @@ -111,48 +104,24 @@ func (ps *psAccessor) Get(f Field, e *event.Event) (params.Value, error) {
return nil, ErrPsNil
}
return ps.Name, nil
case fields.PsSiblingName, fields.PsChildName:
if e.Category != event.Process {
return nil, nil
}
return e.Params.GetString(params.ProcessName)
case fields.PsComm, fields.PsCmdline:
ps := e.PS
if ps == nil {
return nil, ErrPsNil
}
return ps.Cmdline, nil
case fields.PsSiblingComm, fields.PsChildCmdline:
if e.Category != event.Process {
return nil, nil
}
return e.Params.GetString(params.Cmdline)
case fields.PsExe:
ps := e.PS
if ps == nil {
return nil, ErrPsNil
}
return ps.Exe, nil
case fields.PsSiblingExe, fields.PsChildExe:
if e.Category != event.Process {
return nil, nil
}
return e.Params.GetString(params.Exe)
case fields.PsArgs:
ps := e.PS
if ps == nil {
return nil, ErrPsNil
}
return ps.Args, nil
case fields.PsSiblingArgs, fields.PsChildArgs:
if e.Category != event.Process {
return nil, nil
}
cmndline, err := e.Params.GetString(params.Cmdline)
if err != nil {
return nil, err
}
return cmdline.Split(cmndline), nil
case fields.PsCwd:
ps := e.PS
if ps == nil {
Expand All @@ -165,40 +134,6 @@ func (ps *psAccessor) Get(f Field, e *event.Event) (params.Value, error) {
return nil, ErrPsNil
}
return ps.SID, nil
case fields.PsSiblingSID, fields.PsChildSID:
if e.Category != event.Process {
return nil, nil
}
sid, err := e.Params.GetSID()
if err != nil {
return nil, err
}
return sid.String(), nil
case fields.PsSiblingDomain, fields.PsChildDomain:
if e.Category != event.Process {
return nil, nil
}
return e.Params.GetString(params.Domain)
case fields.PsSiblingUsername, fields.PsChildUsername:
if e.Category != event.Process {
return nil, nil
}
return e.Params.GetString(params.Username)
case fields.PsChildIsWOW64Field:
if e.Category != event.Process {
return nil, nil
}
return (e.Params.MustGetUint32(params.ProcessFlags) & event.PsWOW64) != 0, nil
case fields.PsChildIsPackagedField:
if e.Category != event.Process {
return nil, nil
}
return (e.Params.MustGetUint32(params.ProcessFlags) & event.PsPackaged) != 0, nil
case fields.PsChildIsProtectedField:
if e.Category != event.Process {
return nil, nil
}
return (e.Params.MustGetUint32(params.ProcessFlags) & event.PsProtected) != 0, nil
case fields.PsIsWOW64Field:
ps := e.PS
if ps == nil {
Expand Down Expand Up @@ -250,11 +185,6 @@ func (ps *psAccessor) Get(f Field, e *event.Event) (params.Value, error) {
return nil, nil
}
return e.GetParamAsString(params.NTStatus), nil
case fields.PsSiblingSessionID, fields.PsChildSessionID:
if e.Category != event.Process {
return nil, nil
}
return e.Params.GetUint32(params.SessionID)
case fields.PsModuleNames:
ps := e.PS
if ps == nil {
Expand All @@ -277,25 +207,6 @@ func (ps *psAccessor) Get(f Field, e *event.Event) (params.Value, error) {
return nil, ErrPsNil
}
return ps.UUID(), nil
case fields.PsChildUUID:
if e.Category != event.Process {
return nil, nil
}

pid, err := e.Params.GetPid()
if err != nil {
return nil, err
}
if ps.psnap == nil {
return nil, nil
}

proc := ps.psnap.FindAndPut(pid)
if proc == nil {
return nil, ErrPsNil
}

return proc.UUID(), nil
case fields.PsHandleNames:
ps := e.PS
if ps == nil {
Expand Down Expand Up @@ -430,21 +341,6 @@ func (ps *psAccessor) Get(f Field, e *event.Event) (params.Value, error) {
return nil, ErrPsNil
}
return ps.IsProtected, nil
case fields.PsChildTokenIntegrityLevel:
if e.Category != event.Process {
return nil, nil
}
return e.GetParamAsString(params.ProcessTokenIntegrityLevel), nil
case fields.PsChildTokenIsElevated:
if e.Category != event.Process {
return nil, nil
}
return e.Params.GetBool(params.ProcessTokenIsElevated)
case fields.PsChildTokenElevationType:
if e.Category != event.Process {
return nil, nil
}
return e.GetParamAsString(params.ProcessTokenElevationType), nil
case fields.PsTokenIntegrityLevel:
ps := e.PS
if ps == nil {
Expand Down Expand Up @@ -667,13 +563,13 @@ func (t *threadAccessor) Get(f Field, e *event.Event) (params.Value, error) {

return e.Callstack.Symbols(), nil
case fields.ThreadCallstackAllocationSizes:
return e.Callstack.AllocationSizes(e.PID), nil
return e.Callstack.AllocationSizes(framePID(e)), nil
case fields.ThreadCallstackProtections:
return e.Callstack.Protections(e.PID), nil
return e.Callstack.Protections(framePID(e)), nil
case fields.ThreadCallstackCallsiteLeadingAssembly:
return e.Callstack.CallsiteInsns(e.PID, true), nil
return e.Callstack.CallsiteInsns(framePID(e), true), nil
case fields.ThreadCallstackCallsiteTrailingAssembly:
return e.Callstack.CallsiteInsns(e.PID, false), nil
return e.Callstack.CallsiteInsns(framePID(e), false), nil
case fields.ThreadCallstackIsUnbacked:
return e.Callstack.ContainsUnbacked(), nil
case fields.ThreadCallstack:
Expand Down Expand Up @@ -1171,18 +1067,9 @@ func (pa *peAccessor) Get(f Field, e *event.Event) (params.Value, error) {
// PE enrichment is likely disabled. Load PE data lazily
// by only requesting parsing of the PE directories that
// are relevant to the fields present in the expression.
// If the field references a child process executable
// original file name as part of the CreateProcess event,
// then the parser obtains the PE metadata for the executable
// path parameter
if (e.PS != nil && e.PS.Exe != "" && p == nil) || f.Name == fields.PePsChildFileName || f.Name == fields.PsChildPeFilename {
if e.PS != nil && e.PS.Exe != "" && p == nil {
var err error
var exe string
if (f.Name == fields.PePsChildFileName || f.Name == fields.PsChildPeFilename) && e.IsCreateProcess() {
exe = e.GetParamAsString(params.Exe)
} else {
exe = e.PS.Exe
}
exe := e.PS.Exe
p, err = pe.ParseFile(exe, pa.parserOpts()...)
if err != nil {
return nil, err
Expand Down Expand Up @@ -1228,9 +1115,7 @@ func (pa *peAccessor) Get(f Field, e *event.Event) (params.Value, error) {
p.VerifySignature()
}

if f.Name != fields.PePsChildFileName {
e.PS.PE = p
}
e.PS.PE = p

switch f.Name {
case fields.PeEntrypoint:
Expand Down Expand Up @@ -1294,7 +1179,7 @@ func (pa *peAccessor) Get(f Field, e *event.Event) (params.Value, error) {
return p.VersionResources[pe.LegalCopyright], nil
case fields.PeDescription:
return p.VersionResources[pe.FileDescription], nil
case fields.PeFileName, fields.PePsChildFileName, fields.PsChildPeFilename:
case fields.PeFileName:
return p.VersionResources[pe.OriginalFilename], nil
case fields.PeFileVersion:
return p.VersionResources[pe.FileVersion], nil
Expand Down
Loading
Loading