mirror of
https://github.com/varun-r-mallya/Python-BPF.git
synced 2026-02-09 22:50:56 +00:00
Merge pull request #28 from pythonbpf/vmlinux-working
Add compilation mechanism from vmlinux Still does not compile to IR. only does semantic analysis. Another PR will be opened soon for IR generation.
This commit is contained in:
3
.gitignore
vendored
3
.gitignore
vendored
@ -7,3 +7,6 @@ __pycache__/
|
|||||||
*.ll
|
*.ll
|
||||||
*.o
|
*.o
|
||||||
.ipynb_checkpoints/
|
.ipynb_checkpoints/
|
||||||
|
vmlinux.py
|
||||||
|
~*
|
||||||
|
vmlinux.h
|
||||||
|
|||||||
@ -12,7 +12,7 @@
|
|||||||
#
|
#
|
||||||
# See https://github.com/pre-commit/pre-commit
|
# See https://github.com/pre-commit/pre-commit
|
||||||
|
|
||||||
exclude: 'vmlinux.*\.py$'
|
exclude: 'vmlinux.py'
|
||||||
|
|
||||||
ci:
|
ci:
|
||||||
autoupdate_commit_msg: "chore: update pre-commit hooks"
|
autoupdate_commit_msg: "chore: update pre-commit hooks"
|
||||||
@ -41,7 +41,7 @@ repos:
|
|||||||
- id: ruff
|
- id: ruff
|
||||||
args: ["--fix", "--show-fixes"]
|
args: ["--fix", "--show-fixes"]
|
||||||
- id: ruff-format
|
- id: ruff-format
|
||||||
exclude: ^(docs)|^(tests)|^(examples)
|
# exclude: ^(docs)|^(tests)|^(examples)
|
||||||
|
|
||||||
# Checking static types
|
# Checking static types
|
||||||
- repo: https://github.com/pre-commit/mirrors-mypy
|
- repo: https://github.com/pre-commit/mirrors-mypy
|
||||||
|
|||||||
@ -308,6 +308,7 @@
|
|||||||
"def hist() -> HashMap:\n",
|
"def hist() -> HashMap:\n",
|
||||||
" return HashMap(key=c_int32, value=c_uint64, max_entries=4096)\n",
|
" return HashMap(key=c_int32, value=c_uint64, max_entries=4096)\n",
|
||||||
"\n",
|
"\n",
|
||||||
|
"\n",
|
||||||
"@bpf\n",
|
"@bpf\n",
|
||||||
"@section(\"tracepoint/syscalls/sys_enter_clone\")\n",
|
"@section(\"tracepoint/syscalls/sys_enter_clone\")\n",
|
||||||
"def hello(ctx: c_void_p) -> c_int64:\n",
|
"def hello(ctx: c_void_p) -> c_int64:\n",
|
||||||
@ -329,6 +330,7 @@
|
|||||||
"def LICENSE() -> str:\n",
|
"def LICENSE() -> str:\n",
|
||||||
" return \"GPL\"\n",
|
" return \"GPL\"\n",
|
||||||
"\n",
|
"\n",
|
||||||
|
"\n",
|
||||||
"b = BPF()"
|
"b = BPF()"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@ -357,7 +359,6 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"source": [
|
"source": [
|
||||||
"\n",
|
|
||||||
"b.load_and_attach()\n",
|
"b.load_and_attach()\n",
|
||||||
"hist = BpfMap(b, hist)\n",
|
"hist = BpfMap(b, hist)\n",
|
||||||
"print(\"Recording\")\n",
|
"print(\"Recording\")\n",
|
||||||
|
|||||||
@ -8,12 +8,14 @@ def hello_world(ctx: c_void_p) -> c_int64:
|
|||||||
print("Hello, World!")
|
print("Hello, World!")
|
||||||
return c_int64(0)
|
return c_int64(0)
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@section("kprobe/do_unlinkat")
|
@section("kprobe/do_unlinkat")
|
||||||
def hello_world2(ctx: c_void_p) -> c_int64:
|
def hello_world2(ctx: c_void_p) -> c_int64:
|
||||||
print("Hello, World!")
|
print("Hello, World!")
|
||||||
return c_int64(0)
|
return c_int64(0)
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def LICENSE() -> str:
|
def LICENSE() -> str:
|
||||||
|
|||||||
@ -27,7 +27,7 @@ def hello(ctx: c_void_p) -> c_int32:
|
|||||||
dataobj.pid = pid()
|
dataobj.pid = pid()
|
||||||
dataobj.ts = ktime()
|
dataobj.ts = ktime()
|
||||||
# dataobj.comm = strobj
|
# dataobj.comm = strobj
|
||||||
print(f"clone called at {dataobj.ts} by pid" f"{dataobj.pid}, comm {strobj}")
|
print(f"clone called at {dataobj.ts} by pid{dataobj.pid}, comm {strobj}")
|
||||||
events.output(dataobj)
|
events.output(dataobj)
|
||||||
return c_int32(0)
|
return c_int32(0)
|
||||||
|
|
||||||
|
|||||||
248446
examples/vmlinux.py
248446
examples/vmlinux.py
File diff suppressed because it is too large
Load Diff
@ -1,8 +1,8 @@
|
|||||||
from pythonbpf import bpf, map, section, bpfglobal, compile
|
from pythonbpf import bpf, map, section, bpfglobal, compile, compile_to_ir
|
||||||
from pythonbpf.helper import XDP_PASS
|
from pythonbpf.helper import XDP_PASS
|
||||||
from pythonbpf.maps import HashMap
|
from pythonbpf.maps import HashMap
|
||||||
|
from ctypes import c_int64, c_void_p
|
||||||
|
|
||||||
from ctypes import c_void_p, c_int64
|
|
||||||
|
|
||||||
# Instructions to how to run this program
|
# Instructions to how to run this program
|
||||||
# 1. Install PythonBPF: pip install pythonbpf
|
# 1. Install PythonBPF: pip install pythonbpf
|
||||||
@ -41,4 +41,5 @@ def LICENSE() -> str:
|
|||||||
return "GPL"
|
return "GPL"
|
||||||
|
|
||||||
|
|
||||||
|
compile_to_ir("xdp_pass.py", "xdp_pass.ll")
|
||||||
compile()
|
compile()
|
||||||
|
|||||||
@ -4,6 +4,7 @@ from .license_pass import license_processing
|
|||||||
from .functions import func_proc
|
from .functions import func_proc
|
||||||
from .maps import maps_proc
|
from .maps import maps_proc
|
||||||
from .structs import structs_proc
|
from .structs import structs_proc
|
||||||
|
from .vmlinux_parser import vmlinux_proc
|
||||||
from .globals_pass import (
|
from .globals_pass import (
|
||||||
globals_list_creation,
|
globals_list_creation,
|
||||||
globals_processing,
|
globals_processing,
|
||||||
@ -44,6 +45,7 @@ def processor(source_code, filename, module):
|
|||||||
for func_node in bpf_chunks:
|
for func_node in bpf_chunks:
|
||||||
logger.info(f"Found BPF function/struct: {func_node.name}")
|
logger.info(f"Found BPF function/struct: {func_node.name}")
|
||||||
|
|
||||||
|
vmlinux_proc(tree, module)
|
||||||
populate_global_symbol_table(tree, module)
|
populate_global_symbol_table(tree, module)
|
||||||
license_processing(tree, module)
|
license_processing(tree, module)
|
||||||
globals_processing(tree, module)
|
globals_processing(tree, module)
|
||||||
|
|||||||
@ -15,5 +15,8 @@ def deref(ptr):
|
|||||||
return result if result is not None else 0
|
return result if result is not None else 0
|
||||||
|
|
||||||
|
|
||||||
|
XDP_ABORTED = ctypes.c_int64(0)
|
||||||
XDP_DROP = ctypes.c_int64(1)
|
XDP_DROP = ctypes.c_int64(1)
|
||||||
XDP_PASS = ctypes.c_int64(2)
|
XDP_PASS = ctypes.c_int64(2)
|
||||||
|
XDP_TX = ctypes.c_int64(3)
|
||||||
|
XDP_REDIRECT = ctypes.c_int64(4)
|
||||||
|
|||||||
0
pythonbpf/tbaa_gen/__init__.py
Normal file
0
pythonbpf/tbaa_gen/__init__.py
Normal file
3
pythonbpf/vmlinux_parser/__init__.py
Normal file
3
pythonbpf/vmlinux_parser/__init__.py
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
from .import_detector import vmlinux_proc
|
||||||
|
|
||||||
|
__all__ = ["vmlinux_proc"]
|
||||||
167
pythonbpf/vmlinux_parser/class_handler.py
Normal file
167
pythonbpf/vmlinux_parser/class_handler.py
Normal file
@ -0,0 +1,167 @@
|
|||||||
|
import logging
|
||||||
|
from functools import lru_cache
|
||||||
|
import importlib
|
||||||
|
from .dependency_handler import DependencyHandler
|
||||||
|
from .dependency_node import DependencyNode
|
||||||
|
import ctypes
|
||||||
|
from typing import Optional, Any, Dict
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@lru_cache(maxsize=1)
|
||||||
|
def get_module_symbols(module_name: str):
|
||||||
|
imported_module = importlib.import_module(module_name)
|
||||||
|
return [name for name in dir(imported_module)], imported_module
|
||||||
|
|
||||||
|
|
||||||
|
def process_vmlinux_class(node, llvm_module, handler: DependencyHandler):
|
||||||
|
symbols_in_module, imported_module = get_module_symbols("vmlinux")
|
||||||
|
if node.name in symbols_in_module:
|
||||||
|
vmlinux_type = getattr(imported_module, node.name)
|
||||||
|
process_vmlinux_post_ast(vmlinux_type, llvm_module, handler)
|
||||||
|
else:
|
||||||
|
raise ImportError(f"{node.name} not in vmlinux")
|
||||||
|
|
||||||
|
|
||||||
|
def process_vmlinux_post_ast(
|
||||||
|
elem_type_class, llvm_handler, handler: DependencyHandler, processing_stack=None
|
||||||
|
):
|
||||||
|
# Initialize processing stack on first call
|
||||||
|
if processing_stack is None:
|
||||||
|
processing_stack = set()
|
||||||
|
symbols_in_module, imported_module = get_module_symbols("vmlinux")
|
||||||
|
|
||||||
|
current_symbol_name = elem_type_class.__name__
|
||||||
|
logger.info(f"Begin {current_symbol_name} Processing")
|
||||||
|
field_table: Dict[str, list] = {}
|
||||||
|
is_complex_type = False
|
||||||
|
containing_type: Optional[Any] = None
|
||||||
|
ctype_complex_type: Optional[Any] = None
|
||||||
|
type_length: Optional[int] = None
|
||||||
|
module_name = getattr(elem_type_class, "__module__", None)
|
||||||
|
|
||||||
|
# Check if already processed
|
||||||
|
if handler.has_node(current_symbol_name):
|
||||||
|
logger.debug(f"Node {current_symbol_name} already processed and ready")
|
||||||
|
return True
|
||||||
|
|
||||||
|
# XXX:Check it's use. It's probably not being used.
|
||||||
|
if current_symbol_name in processing_stack:
|
||||||
|
logger.debug(
|
||||||
|
f"Dependency already in processing stack for {current_symbol_name}, skipping"
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
processing_stack.add(current_symbol_name)
|
||||||
|
|
||||||
|
if module_name == "vmlinux":
|
||||||
|
if hasattr(elem_type_class, "_type_"):
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
new_dep_node = DependencyNode(name=current_symbol_name)
|
||||||
|
handler.add_node(new_dep_node)
|
||||||
|
class_obj = getattr(imported_module, current_symbol_name)
|
||||||
|
# Inspect the class fields
|
||||||
|
if hasattr(class_obj, "_fields_"):
|
||||||
|
for field_elem in class_obj._fields_:
|
||||||
|
field_name: str = ""
|
||||||
|
field_type: Optional[Any] = None
|
||||||
|
bitfield_size: Optional[int] = None
|
||||||
|
if len(field_elem) == 2:
|
||||||
|
field_name, field_type = field_elem
|
||||||
|
elif len(field_elem) == 3:
|
||||||
|
field_name, field_type, bitfield_size = field_elem
|
||||||
|
field_table[field_name] = [field_type, bitfield_size]
|
||||||
|
elif hasattr(class_obj, "__annotations__"):
|
||||||
|
for field_elem in class_obj.__annotations__.items():
|
||||||
|
if len(field_elem) == 2:
|
||||||
|
field_name, field_type = field_elem
|
||||||
|
bitfield_size = None
|
||||||
|
elif len(field_elem) == 3:
|
||||||
|
field_name, field_type, bitfield_size = field_elem
|
||||||
|
else:
|
||||||
|
raise ValueError(
|
||||||
|
"Number of fields in items() of class object unexpected"
|
||||||
|
)
|
||||||
|
field_table[field_name] = [field_type, bitfield_size]
|
||||||
|
else:
|
||||||
|
raise TypeError("Could not get required class and definition")
|
||||||
|
|
||||||
|
logger.debug(f"Extracted fields for {current_symbol_name}: {field_table}")
|
||||||
|
for elem in field_table.items():
|
||||||
|
elem_name, elem_temp_list = elem
|
||||||
|
[elem_type, elem_bitfield_size] = elem_temp_list
|
||||||
|
local_module_name = getattr(elem_type, "__module__", None)
|
||||||
|
new_dep_node.add_field(elem_name, elem_type, ready=False)
|
||||||
|
if local_module_name == ctypes.__name__:
|
||||||
|
new_dep_node.set_field_bitfield_size(elem_name, elem_bitfield_size)
|
||||||
|
new_dep_node.set_field_ready(elem_name, is_ready=True)
|
||||||
|
logger.debug(
|
||||||
|
f"Field {elem_name} is direct ctypes type: {elem_type}"
|
||||||
|
)
|
||||||
|
elif local_module_name == "vmlinux":
|
||||||
|
new_dep_node.set_field_bitfield_size(elem_name, elem_bitfield_size)
|
||||||
|
logger.debug(
|
||||||
|
f"Processing vmlinux field: {elem_name}, type: {elem_type}"
|
||||||
|
)
|
||||||
|
if hasattr(elem_type, "_type_"):
|
||||||
|
is_complex_type = True
|
||||||
|
containing_type = elem_type._type_
|
||||||
|
if hasattr(elem_type, "_length_") and is_complex_type:
|
||||||
|
type_length = elem_type._length_
|
||||||
|
|
||||||
|
if containing_type.__module__ == "vmlinux":
|
||||||
|
pass
|
||||||
|
elif containing_type.__module__ == ctypes.__name__:
|
||||||
|
if isinstance(elem_type, type):
|
||||||
|
if issubclass(elem_type, ctypes.Array):
|
||||||
|
ctype_complex_type = ctypes.Array
|
||||||
|
elif issubclass(elem_type, ctypes._Pointer):
|
||||||
|
ctype_complex_type = ctypes._Pointer
|
||||||
|
else:
|
||||||
|
raise TypeError("Unsupported ctypes subclass")
|
||||||
|
else:
|
||||||
|
raise ImportError(
|
||||||
|
f"Unsupported module of {containing_type}"
|
||||||
|
)
|
||||||
|
logger.debug(
|
||||||
|
f"{containing_type} containing type of parent {elem_name} with {elem_type} and ctype {ctype_complex_type} and length {type_length}"
|
||||||
|
)
|
||||||
|
new_dep_node.set_field_containing_type(
|
||||||
|
elem_name, containing_type
|
||||||
|
)
|
||||||
|
new_dep_node.set_field_type_size(elem_name, type_length)
|
||||||
|
new_dep_node.set_field_ctype_complex_type(
|
||||||
|
elem_name, ctype_complex_type
|
||||||
|
)
|
||||||
|
new_dep_node.set_field_type(elem_name, elem_type)
|
||||||
|
if containing_type.__module__ == "vmlinux":
|
||||||
|
process_vmlinux_post_ast(
|
||||||
|
containing_type, llvm_handler, handler, processing_stack
|
||||||
|
)
|
||||||
|
new_dep_node.set_field_ready(elem_name, True)
|
||||||
|
elif containing_type.__module__ == ctypes.__name__:
|
||||||
|
logger.debug(f"Processing ctype internal{containing_type}")
|
||||||
|
new_dep_node.set_field_ready(elem_name, True)
|
||||||
|
else:
|
||||||
|
raise TypeError(
|
||||||
|
"Module not supported in recursive resolution"
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
process_vmlinux_post_ast(
|
||||||
|
elem_type, llvm_handler, handler, processing_stack
|
||||||
|
)
|
||||||
|
new_dep_node.set_field_ready(elem_name, True)
|
||||||
|
else:
|
||||||
|
raise ValueError(
|
||||||
|
f"{elem_name} with type {elem_type} from module {module_name} not supported in recursive resolver"
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ImportError("UNSUPPORTED Module")
|
||||||
|
|
||||||
|
logging.info(
|
||||||
|
f"{current_symbol_name} processed and handler readiness {handler.is_ready}"
|
||||||
|
)
|
||||||
|
return True
|
||||||
149
pythonbpf/vmlinux_parser/dependency_handler.py
Normal file
149
pythonbpf/vmlinux_parser/dependency_handler.py
Normal file
@ -0,0 +1,149 @@
|
|||||||
|
from typing import Optional, Dict, List, Iterator
|
||||||
|
from .dependency_node import DependencyNode
|
||||||
|
|
||||||
|
|
||||||
|
class DependencyHandler:
|
||||||
|
"""
|
||||||
|
Manages a collection of DependencyNode objects with no duplicates.
|
||||||
|
|
||||||
|
Ensures that no two nodes with the same name can be added and provides
|
||||||
|
methods to check readiness and retrieve specific nodes.
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
# Create a handler
|
||||||
|
handler = DependencyHandler()
|
||||||
|
|
||||||
|
# Create some dependency nodes
|
||||||
|
node1 = DependencyNode(name="node1")
|
||||||
|
node1.add_field("field1", str)
|
||||||
|
node1.set_field_value("field1", "value1")
|
||||||
|
|
||||||
|
node2 = DependencyNode(name="node2")
|
||||||
|
node2.add_field("field1", int)
|
||||||
|
|
||||||
|
# Add nodes to the handler
|
||||||
|
handler.add_node(node1)
|
||||||
|
handler.add_node(node2)
|
||||||
|
|
||||||
|
# Check if a specific node exists
|
||||||
|
print(handler.has_node("node1")) # True
|
||||||
|
|
||||||
|
# Get a reference to a node and modify it
|
||||||
|
node = handler.get_node("node2")
|
||||||
|
node.set_field_value("field1", 42)
|
||||||
|
|
||||||
|
# Check if all nodes are ready
|
||||||
|
print(handler.is_ready) # False (node2 is ready, but node1 isn't)
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
# Using a dictionary with node names as keys ensures name uniqueness
|
||||||
|
# and provides efficient lookups
|
||||||
|
self._nodes: Dict[str, DependencyNode] = {}
|
||||||
|
|
||||||
|
def add_node(self, node: DependencyNode) -> bool:
|
||||||
|
"""
|
||||||
|
Add a dependency node to the handler.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
node: The DependencyNode to add
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if the node was added, False if a node with the same name already exists
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: If the provided object is not a DependencyNode
|
||||||
|
"""
|
||||||
|
if not isinstance(node, DependencyNode):
|
||||||
|
raise TypeError(f"Expected DependencyNode, got {type(node).__name__}")
|
||||||
|
|
||||||
|
# Check if a node with this name already exists
|
||||||
|
if node.name in self._nodes:
|
||||||
|
return False
|
||||||
|
|
||||||
|
self._nodes[node.name] = node
|
||||||
|
return True
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_ready(self) -> bool:
|
||||||
|
"""
|
||||||
|
Check if all nodes are ready.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if all nodes are ready (or if there are no nodes), False otherwise
|
||||||
|
"""
|
||||||
|
if not self._nodes:
|
||||||
|
return True
|
||||||
|
|
||||||
|
return all(node.is_ready for node in self._nodes.values())
|
||||||
|
|
||||||
|
def has_node(self, name: str) -> bool:
|
||||||
|
"""
|
||||||
|
Check if a node with the given name exists.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name: The name to check
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if a node with the given name exists, False otherwise
|
||||||
|
"""
|
||||||
|
return name in self._nodes
|
||||||
|
|
||||||
|
def get_node(self, name: str) -> Optional[DependencyNode]:
|
||||||
|
"""
|
||||||
|
Get a node by name for manipulation.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name: The name of the node to retrieve
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Optional[DependencyNode]: The node with the given name, or None if not found
|
||||||
|
"""
|
||||||
|
return self._nodes.get(name)
|
||||||
|
|
||||||
|
def remove_node(self, node_or_name) -> bool:
|
||||||
|
"""
|
||||||
|
Remove a node by name or reference.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
node_or_name: The node to remove or its name
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if the node was removed, False if not found
|
||||||
|
"""
|
||||||
|
if isinstance(node_or_name, DependencyNode):
|
||||||
|
name = node_or_name.name
|
||||||
|
else:
|
||||||
|
name = node_or_name
|
||||||
|
|
||||||
|
if name in self._nodes:
|
||||||
|
del self._nodes[name]
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def get_all_nodes(self) -> List[DependencyNode]:
|
||||||
|
"""
|
||||||
|
Get all nodes stored in the handler.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List[DependencyNode]: List of all nodes
|
||||||
|
"""
|
||||||
|
return list(self._nodes.values())
|
||||||
|
|
||||||
|
def __iter__(self) -> Iterator[DependencyNode]:
|
||||||
|
"""
|
||||||
|
Iterate over all nodes.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Iterator[DependencyNode]: Iterator over all nodes
|
||||||
|
"""
|
||||||
|
return iter(self._nodes.values())
|
||||||
|
|
||||||
|
def __len__(self) -> int:
|
||||||
|
"""
|
||||||
|
Get the number of nodes in the handler.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The number of nodes
|
||||||
|
"""
|
||||||
|
return len(self._nodes)
|
||||||
237
pythonbpf/vmlinux_parser/dependency_node.py
Normal file
237
pythonbpf/vmlinux_parser/dependency_node.py
Normal file
@ -0,0 +1,237 @@
|
|||||||
|
from dataclasses import dataclass, field
|
||||||
|
from typing import Dict, Any, Optional
|
||||||
|
|
||||||
|
|
||||||
|
# TODO: FIX THE FUCKING TYPE NAME CONVENTION.
|
||||||
|
@dataclass
|
||||||
|
class Field:
|
||||||
|
"""Represents a field in a dependency node with its type and readiness state."""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
type: type
|
||||||
|
ctype_complex_type: Optional[Any]
|
||||||
|
containing_type: Optional[Any]
|
||||||
|
type_size: Optional[int]
|
||||||
|
bitfield_size: Optional[int]
|
||||||
|
value: Any = None
|
||||||
|
ready: bool = False
|
||||||
|
|
||||||
|
def set_ready(self, is_ready: bool = True) -> None:
|
||||||
|
"""Set the readiness state of this field."""
|
||||||
|
self.ready = is_ready
|
||||||
|
|
||||||
|
def set_value(self, value: Any, mark_ready: bool = False) -> None:
|
||||||
|
"""Set the value of this field and optionally mark it as ready."""
|
||||||
|
self.value = value
|
||||||
|
if mark_ready:
|
||||||
|
self.ready = True
|
||||||
|
|
||||||
|
def set_type(self, given_type, mark_ready: bool = False) -> None:
|
||||||
|
"""Set value of the type field and mark as ready"""
|
||||||
|
self.type = given_type
|
||||||
|
if mark_ready:
|
||||||
|
self.ready = True
|
||||||
|
|
||||||
|
def set_containing_type(
|
||||||
|
self, containing_type: Optional[Any], mark_ready: bool = False
|
||||||
|
) -> None:
|
||||||
|
"""Set the containing_type of this field and optionally mark it as ready."""
|
||||||
|
self.containing_type = containing_type
|
||||||
|
if mark_ready:
|
||||||
|
self.ready = True
|
||||||
|
|
||||||
|
def set_type_size(self, type_size: Any, mark_ready: bool = False) -> None:
|
||||||
|
"""Set the type_size of this field and optionally mark it as ready."""
|
||||||
|
self.type_size = type_size
|
||||||
|
if mark_ready:
|
||||||
|
self.ready = True
|
||||||
|
|
||||||
|
def set_ctype_complex_type(
|
||||||
|
self, ctype_complex_type: Any, mark_ready: bool = False
|
||||||
|
) -> None:
|
||||||
|
"""Set the ctype_complex_type of this field and optionally mark it as ready."""
|
||||||
|
self.ctype_complex_type = ctype_complex_type
|
||||||
|
if mark_ready:
|
||||||
|
self.ready = True
|
||||||
|
|
||||||
|
def set_bitfield_size(self, bitfield_size: Any, mark_ready: bool = False) -> None:
|
||||||
|
"""Set the bitfield_size of this field and optionally mark it as ready."""
|
||||||
|
self.bitfield_size = bitfield_size
|
||||||
|
if mark_ready:
|
||||||
|
self.ready = True
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class DependencyNode:
|
||||||
|
"""
|
||||||
|
A node with typed fields and readiness tracking.
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
# Create a dependency node for a Person
|
||||||
|
somestruct = DependencyNode(name="struct_1")
|
||||||
|
|
||||||
|
# Add fields with their types
|
||||||
|
somestruct.add_field("field_1", str)
|
||||||
|
somestruct.add_field("field_2", int)
|
||||||
|
somestruct.add_field("field_3", str)
|
||||||
|
|
||||||
|
# Check if the node is ready (should be False initially)
|
||||||
|
print(f"Is node ready? {somestruct.is_ready}") # False
|
||||||
|
|
||||||
|
# Set some field values
|
||||||
|
somestruct.set_field_value("field_1", "someproperty")
|
||||||
|
somestruct.set_field_value("field_2", 30)
|
||||||
|
|
||||||
|
# Check if the node is ready (still False because email is not ready)
|
||||||
|
print(f"Is node ready? {somestruct.is_ready}") # False
|
||||||
|
|
||||||
|
# Set the last field and make the node ready
|
||||||
|
somestruct.set_field_value("field_3", "anotherproperty")
|
||||||
|
|
||||||
|
# Now the node should be ready
|
||||||
|
print(f"Is node ready? {somestruct.is_ready}") # True
|
||||||
|
|
||||||
|
# You can also mark a field as not ready
|
||||||
|
somestruct.set_field_ready("field_3", False)
|
||||||
|
|
||||||
|
# Now the node is not ready again
|
||||||
|
print(f"Is node ready? {somestruct.is_ready}") # False
|
||||||
|
|
||||||
|
# Get all field values
|
||||||
|
print(somestruct.get_field_values()) # {'field_1': 'someproperty', 'field_2': 30, 'field_3': 'anotherproperty'}
|
||||||
|
|
||||||
|
# Get only ready fields
|
||||||
|
ready_fields = somestruct.get_ready_fields()
|
||||||
|
print(f"Ready fields: {[field.name for field in ready_fields.values()]}") # ['field_1', 'field_2']
|
||||||
|
"""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
fields: Dict[str, Field] = field(default_factory=dict)
|
||||||
|
_ready_cache: Optional[bool] = field(default=None, repr=False)
|
||||||
|
|
||||||
|
def add_field(
|
||||||
|
self,
|
||||||
|
name: str,
|
||||||
|
field_type: type,
|
||||||
|
initial_value: Any = None,
|
||||||
|
containing_type: Optional[Any] = None,
|
||||||
|
type_size: Optional[int] = None,
|
||||||
|
ctype_complex_type: Optional[int] = None,
|
||||||
|
bitfield_size: Optional[int] = None,
|
||||||
|
ready: bool = False,
|
||||||
|
) -> None:
|
||||||
|
"""Add a field to the node with an optional initial value and readiness state."""
|
||||||
|
self.fields[name] = Field(
|
||||||
|
name=name,
|
||||||
|
type=field_type,
|
||||||
|
value=initial_value,
|
||||||
|
ready=ready,
|
||||||
|
containing_type=containing_type,
|
||||||
|
type_size=type_size,
|
||||||
|
ctype_complex_type=ctype_complex_type,
|
||||||
|
bitfield_size=bitfield_size,
|
||||||
|
)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
def get_field(self, name: str) -> Field:
|
||||||
|
"""Get a field by name."""
|
||||||
|
return self.fields[name]
|
||||||
|
|
||||||
|
def set_field_value(self, name: str, value: Any, mark_ready: bool = False) -> None:
|
||||||
|
"""Set a field's value and optionally mark it as ready."""
|
||||||
|
if name not in self.fields:
|
||||||
|
raise KeyError(f"Field '{name}' does not exist in node '{self.name}'")
|
||||||
|
|
||||||
|
self.fields[name].set_value(value, mark_ready)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
def set_field_type(self, name: str, type: Any, mark_ready: bool = False) -> None:
|
||||||
|
"""Set a field's type and optionally mark it as ready."""
|
||||||
|
if name not in self.fields:
|
||||||
|
raise KeyError(f"Field '{name}' does not exist in node '{self.name}'")
|
||||||
|
|
||||||
|
self.fields[name].set_type(type, mark_ready)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
def set_field_containing_type(
|
||||||
|
self, name: str, containing_type: Any, mark_ready: bool = False
|
||||||
|
) -> None:
|
||||||
|
"""Set a field's containing_type and optionally mark it as ready."""
|
||||||
|
if name not in self.fields:
|
||||||
|
raise KeyError(f"Field '{name}' does not exist in node '{self.name}'")
|
||||||
|
|
||||||
|
self.fields[name].set_containing_type(containing_type, mark_ready)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
def set_field_type_size(
|
||||||
|
self, name: str, type_size: Any, mark_ready: bool = False
|
||||||
|
) -> None:
|
||||||
|
"""Set a field's type_size and optionally mark it as ready."""
|
||||||
|
if name not in self.fields:
|
||||||
|
raise KeyError(f"Field '{name}' does not exist in node '{self.name}'")
|
||||||
|
|
||||||
|
self.fields[name].set_type_size(type_size, mark_ready)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
def set_field_ctype_complex_type(
|
||||||
|
self, name: str, ctype_complex_type: Any, mark_ready: bool = False
|
||||||
|
) -> None:
|
||||||
|
"""Set a field's ctype_complex_type and optionally mark it as ready."""
|
||||||
|
if name not in self.fields:
|
||||||
|
raise KeyError(f"Field '{name}' does not exist in node '{self.name}'")
|
||||||
|
|
||||||
|
self.fields[name].set_ctype_complex_type(ctype_complex_type, mark_ready)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
def set_field_bitfield_size(
|
||||||
|
self, name: str, bitfield_size: Any, mark_ready: bool = False
|
||||||
|
) -> None:
|
||||||
|
"""Set a field's bitfield_size and optionally mark it as ready."""
|
||||||
|
if name not in self.fields:
|
||||||
|
raise KeyError(f"Field '{name}' does not exist in node '{self.name}'")
|
||||||
|
|
||||||
|
self.fields[name].set_bitfield_size(bitfield_size, mark_ready)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
def set_field_ready(self, name: str, is_ready: bool = False) -> None:
|
||||||
|
"""Mark a field as ready or not ready."""
|
||||||
|
if name not in self.fields:
|
||||||
|
raise KeyError(f"Field '{name}' does not exist in node '{self.name}'")
|
||||||
|
|
||||||
|
self.fields[name].set_ready(is_ready)
|
||||||
|
# Invalidate readiness cache
|
||||||
|
self._ready_cache = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_ready(self) -> bool:
|
||||||
|
"""Check if the node is ready (all fields are ready)."""
|
||||||
|
# Use cached value if available
|
||||||
|
if self._ready_cache is not None:
|
||||||
|
return self._ready_cache
|
||||||
|
|
||||||
|
# Calculate readiness only when needed
|
||||||
|
if not self.fields:
|
||||||
|
self._ready_cache = True
|
||||||
|
return True
|
||||||
|
|
||||||
|
self._ready_cache = all(elem.ready for elem in self.fields.values())
|
||||||
|
return self._ready_cache
|
||||||
|
|
||||||
|
def get_field_values(self) -> Dict[str, Any]:
|
||||||
|
"""Get a dictionary of field names to their values."""
|
||||||
|
return {name: elem.value for name, elem in self.fields.items()}
|
||||||
|
|
||||||
|
def get_ready_fields(self) -> Dict[str, Field]:
|
||||||
|
"""Get all fields that are marked as ready."""
|
||||||
|
return {name: elem for name, elem in self.fields.items() if elem.ready}
|
||||||
|
|
||||||
|
def get_not_ready_fields(self) -> Dict[str, Field]:
|
||||||
|
"""Get all fields that are marked as not ready."""
|
||||||
|
return {name: elem for name, elem in self.fields.items() if not elem.ready}
|
||||||
135
pythonbpf/vmlinux_parser/import_detector.py
Normal file
135
pythonbpf/vmlinux_parser/import_detector.py
Normal file
@ -0,0 +1,135 @@
|
|||||||
|
import ast
|
||||||
|
import logging
|
||||||
|
from typing import List, Tuple, Dict
|
||||||
|
import importlib
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
from .dependency_handler import DependencyHandler
|
||||||
|
from .ir_generation import IRGenerator
|
||||||
|
from .class_handler import process_vmlinux_class
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def detect_import_statement(tree: ast.AST) -> List[Tuple[str, ast.ImportFrom]]:
|
||||||
|
"""
|
||||||
|
Parse AST and detect import statements from vmlinux.
|
||||||
|
|
||||||
|
Returns a list of tuples (module_name, imported_item) for vmlinux imports.
|
||||||
|
Raises SyntaxError for invalid import patterns.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
tree: The AST to parse
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of tuples containing (module_name, imported_item) for each vmlinux import
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
SyntaxError: If multiple imports from vmlinux are attempted or import * is used
|
||||||
|
"""
|
||||||
|
vmlinux_imports = []
|
||||||
|
|
||||||
|
for node in ast.walk(tree):
|
||||||
|
# Handle "from vmlinux import ..." statements
|
||||||
|
if isinstance(node, ast.ImportFrom):
|
||||||
|
if node.module == "vmlinux":
|
||||||
|
# Check for wildcard import: from vmlinux import *
|
||||||
|
if any(alias.name == "*" for alias in node.names):
|
||||||
|
raise SyntaxError(
|
||||||
|
"Wildcard imports from vmlinux are not supported. "
|
||||||
|
"Please import specific types explicitly."
|
||||||
|
)
|
||||||
|
|
||||||
|
# Check for multiple imports: from vmlinux import A, B, C
|
||||||
|
if len(node.names) > 1:
|
||||||
|
imported_names = [alias.name for alias in node.names]
|
||||||
|
raise SyntaxError(
|
||||||
|
f"Multiple imports from vmlinux are not supported. "
|
||||||
|
f"Found: {', '.join(imported_names)}. "
|
||||||
|
f"Please use separate import statements for each type."
|
||||||
|
)
|
||||||
|
|
||||||
|
# Check if no specific import is specified (should not happen with valid Python)
|
||||||
|
if len(node.names) == 0:
|
||||||
|
raise SyntaxError(
|
||||||
|
"Import from vmlinux must specify at least one type."
|
||||||
|
)
|
||||||
|
|
||||||
|
# Valid single import
|
||||||
|
for alias in node.names:
|
||||||
|
import_name = alias.name
|
||||||
|
# Use alias if provided, otherwise use the original name (commented)
|
||||||
|
# as_name = alias.asname if alias.asname else alias.name
|
||||||
|
vmlinux_imports.append(("vmlinux", node))
|
||||||
|
logger.info(f"Found vmlinux import: {import_name}")
|
||||||
|
|
||||||
|
# Handle "import vmlinux" statements (not typical but should be rejected)
|
||||||
|
elif isinstance(node, ast.Import):
|
||||||
|
for alias in node.names:
|
||||||
|
if alias.name == "vmlinux" or alias.name.startswith("vmlinux."):
|
||||||
|
raise SyntaxError(
|
||||||
|
"Direct import of vmlinux module is not supported. "
|
||||||
|
"Use 'from vmlinux import <type>' instead."
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(f"Total vmlinux imports detected: {len(vmlinux_imports)}")
|
||||||
|
return vmlinux_imports
|
||||||
|
|
||||||
|
|
||||||
|
def vmlinux_proc(tree: ast.AST, module):
|
||||||
|
import_statements = detect_import_statement(tree)
|
||||||
|
|
||||||
|
# initialise dependency handler
|
||||||
|
handler = DependencyHandler()
|
||||||
|
# initialise assignment dictionary of name to type
|
||||||
|
assignments: Dict[str, type] = {}
|
||||||
|
|
||||||
|
if not import_statements:
|
||||||
|
logger.info("No vmlinux imports found")
|
||||||
|
return
|
||||||
|
|
||||||
|
# Import vmlinux module directly
|
||||||
|
try:
|
||||||
|
vmlinux_mod = importlib.import_module("vmlinux")
|
||||||
|
except ImportError:
|
||||||
|
logger.warning("Could not import vmlinux module")
|
||||||
|
return
|
||||||
|
|
||||||
|
source_file = inspect.getsourcefile(vmlinux_mod)
|
||||||
|
if source_file is None:
|
||||||
|
logger.warning("Cannot find source for vmlinux module")
|
||||||
|
return
|
||||||
|
|
||||||
|
with open(source_file, "r") as f:
|
||||||
|
mod_ast = ast.parse(f.read(), filename=source_file)
|
||||||
|
|
||||||
|
for import_mod, import_node in import_statements:
|
||||||
|
for alias in import_node.names:
|
||||||
|
imported_name = alias.name
|
||||||
|
found = False
|
||||||
|
for mod_node in mod_ast.body:
|
||||||
|
if (
|
||||||
|
isinstance(mod_node, ast.ClassDef)
|
||||||
|
and mod_node.name == imported_name
|
||||||
|
):
|
||||||
|
process_vmlinux_class(mod_node, module, handler)
|
||||||
|
found = True
|
||||||
|
break
|
||||||
|
if isinstance(mod_node, ast.Assign):
|
||||||
|
for target in mod_node.targets:
|
||||||
|
if isinstance(target, ast.Name) and target.id == imported_name:
|
||||||
|
process_vmlinux_assign(mod_node, module, assignments)
|
||||||
|
found = True
|
||||||
|
break
|
||||||
|
if found:
|
||||||
|
break
|
||||||
|
if not found:
|
||||||
|
logger.info(
|
||||||
|
f"{imported_name} not found as ClassDef or Assign in vmlinux"
|
||||||
|
)
|
||||||
|
|
||||||
|
IRGenerator(module, handler)
|
||||||
|
|
||||||
|
|
||||||
|
def process_vmlinux_assign(node, module, assignments: Dict[str, type]):
|
||||||
|
raise NotImplementedError("Assignment handling has not been implemented yet")
|
||||||
14
pythonbpf/vmlinux_parser/ir_generation.py
Normal file
14
pythonbpf/vmlinux_parser/ir_generation.py
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
import logging
|
||||||
|
from .dependency_handler import DependencyHandler
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class IRGenerator:
|
||||||
|
def __init__(self, module, handler: DependencyHandler):
|
||||||
|
self.module = module
|
||||||
|
self.handler: DependencyHandler = handler
|
||||||
|
if not handler.is_ready:
|
||||||
|
raise ImportError(
|
||||||
|
"Semantic analysis of vmlinux imports failed. Cannot generate IR"
|
||||||
|
)
|
||||||
@ -1,11 +1,10 @@
|
|||||||
#include <linux/bpf.h>
|
#include "vmlinux.h"
|
||||||
#include <bpf/bpf_helpers.h>
|
#include <bpf/bpf_helpers.h>
|
||||||
#define u64 unsigned long long
|
#include <bpf/bpf_endian.h>
|
||||||
#define u32 unsigned int
|
|
||||||
|
|
||||||
SEC("xdp")
|
SEC("xdp")
|
||||||
int hello(struct xdp_md *ctx) {
|
int hello(struct xdp_md *ctx) {
|
||||||
bpf_printk("Hello, World!\n");
|
bpf_printk("Hello, World! %ud \n", ctx->data);
|
||||||
return XDP_PASS;
|
return XDP_PASS;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -3,16 +3,19 @@ import logging
|
|||||||
from pythonbpf import compile, bpf, section, bpfglobal, compile_to_ir
|
from pythonbpf import compile, bpf, section, bpfglobal, compile_to_ir
|
||||||
from ctypes import c_void_p, c_int64, c_int32
|
from ctypes import c_void_p, c_int64, c_int32
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def somevalue() -> c_int32:
|
def somevalue() -> c_int32:
|
||||||
return c_int32(42)
|
return c_int32(42)
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def somevalue2() -> c_int64:
|
def somevalue2() -> c_int64:
|
||||||
return c_int64(69)
|
return c_int64(69)
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def somevalue1() -> c_int32:
|
def somevalue1() -> c_int32:
|
||||||
@ -21,12 +24,14 @@ def somevalue1() -> c_int32:
|
|||||||
|
|
||||||
# --- Passing examples ---
|
# --- Passing examples ---
|
||||||
|
|
||||||
|
|
||||||
# Simple constant return
|
# Simple constant return
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def g1() -> c_int64:
|
def g1() -> c_int64:
|
||||||
return c_int64(42)
|
return c_int64(42)
|
||||||
|
|
||||||
|
|
||||||
# Constructor with one constant argument
|
# Constructor with one constant argument
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
@ -62,15 +67,17 @@ def g2() -> c_int64:
|
|||||||
# def g6() -> c_int64:
|
# def g6() -> c_int64:
|
||||||
# return c_int64(CONST)
|
# return c_int64(CONST)
|
||||||
|
|
||||||
|
|
||||||
# Constructor with multiple args
|
# Constructor with multiple args
|
||||||
#TODO: this is not working. should it work ?
|
# TODO: this is not working. should it work ?
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def g7() -> c_int64:
|
def g7() -> c_int64:
|
||||||
return c_int64(1)
|
return c_int64(1)
|
||||||
|
|
||||||
|
|
||||||
# Dataclass call
|
# Dataclass call
|
||||||
#TODO: fails with dataclass
|
# TODO: fails with dataclass
|
||||||
# @dataclass
|
# @dataclass
|
||||||
# class Point:
|
# class Point:
|
||||||
# x: c_int64
|
# x: c_int64
|
||||||
@ -91,6 +98,7 @@ def sometag(ctx: c_void_p) -> c_int64:
|
|||||||
print(f"{somevalue}")
|
print(f"{somevalue}")
|
||||||
return c_int64(1)
|
return c_int64(1)
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def LICENSE() -> str:
|
def LICENSE() -> str:
|
||||||
|
|||||||
@ -11,6 +11,7 @@ from ctypes import c_void_p, c_int64
|
|||||||
# We cannot allocate space for the intermediate type now.
|
# We cannot allocate space for the intermediate type now.
|
||||||
# We probably need to track the ref/deref chain for each variable.
|
# We probably need to track the ref/deref chain for each variable.
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@map
|
@map
|
||||||
def count() -> HashMap:
|
def count() -> HashMap:
|
||||||
|
|||||||
@ -3,6 +3,7 @@ import logging
|
|||||||
from pythonbpf import compile, bpf, section, bpfglobal, compile_to_ir
|
from pythonbpf import compile, bpf, section, bpfglobal, compile_to_ir
|
||||||
from ctypes import c_void_p, c_int64
|
from ctypes import c_void_p, c_int64
|
||||||
|
|
||||||
|
|
||||||
# This should not pass as somevalue is not declared at all.
|
# This should not pass as somevalue is not declared at all.
|
||||||
@bpf
|
@bpf
|
||||||
@section("tracepoint/syscalls/sys_enter_execve")
|
@section("tracepoint/syscalls/sys_enter_execve")
|
||||||
@ -11,6 +12,7 @@ def sometag(ctx: c_void_p) -> c_int64:
|
|||||||
print(f"{somevalue}") # noqa: F821
|
print(f"{somevalue}") # noqa: F821
|
||||||
return c_int64(1)
|
return c_int64(1)
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
@bpfglobal
|
@bpfglobal
|
||||||
def LICENSE() -> str:
|
def LICENSE() -> str:
|
||||||
|
|||||||
47
tests/failing_tests/xdp_pass.py
Normal file
47
tests/failing_tests/xdp_pass.py
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
from pythonbpf import bpf, map, section, bpfglobal, compile_to_ir
|
||||||
|
from pythonbpf.maps import HashMap
|
||||||
|
from pythonbpf.helper import XDP_PASS
|
||||||
|
from vmlinux import struct_xdp_md
|
||||||
|
from vmlinux import struct_xdp_buff # noqa: F401
|
||||||
|
from vmlinux import struct_ring_buffer_per_cpu # noqa: F401
|
||||||
|
|
||||||
|
from ctypes import c_int64
|
||||||
|
|
||||||
|
# Instructions to how to run this program
|
||||||
|
# 1. Install PythonBPF: pip install pythonbpf
|
||||||
|
# 2. Run the program: python examples/xdp_pass.py
|
||||||
|
# 3. Run the program with sudo: sudo tools/check.sh run examples/xdp_pass.o
|
||||||
|
# 4. Attach object file to any network device with something like ./check.sh xdp examples/xdp_pass.o tailscale0
|
||||||
|
# 5. send traffic through the device and observe effects
|
||||||
|
|
||||||
|
|
||||||
|
@bpf
|
||||||
|
@map
|
||||||
|
def count() -> HashMap:
|
||||||
|
return HashMap(key=c_int64, value=c_int64, max_entries=1)
|
||||||
|
|
||||||
|
|
||||||
|
@bpf
|
||||||
|
@section("xdp")
|
||||||
|
def hello_world(ctx: struct_xdp_md) -> c_int64:
|
||||||
|
key = 0
|
||||||
|
one = 1
|
||||||
|
prev = count().lookup(key)
|
||||||
|
if prev:
|
||||||
|
prevval = prev + 1
|
||||||
|
print(f"count: {prevval}")
|
||||||
|
count().update(key, prevval)
|
||||||
|
return XDP_PASS
|
||||||
|
else:
|
||||||
|
count().update(key, one)
|
||||||
|
|
||||||
|
return XDP_PASS
|
||||||
|
|
||||||
|
|
||||||
|
@bpf
|
||||||
|
@bpfglobal
|
||||||
|
def LICENSE() -> str:
|
||||||
|
return "GPL"
|
||||||
|
|
||||||
|
|
||||||
|
compile_to_ir("xdp_pass.py", "xdp_pass.ll")
|
||||||
@ -6,8 +6,8 @@ from ctypes import c_void_p, c_int32
|
|||||||
@section("tracepoint/syscalls/sys_enter_execve")
|
@section("tracepoint/syscalls/sys_enter_execve")
|
||||||
def hello_world(ctx: c_void_p) -> c_int32:
|
def hello_world(ctx: c_void_p) -> c_int32:
|
||||||
print("Hello, World!")
|
print("Hello, World!")
|
||||||
a = 1 # int64
|
a = 1 # int64
|
||||||
return c_int32(a) # typecast to int32
|
return c_int32(a) # typecast to int32
|
||||||
|
|
||||||
|
|
||||||
@bpf
|
@bpf
|
||||||
|
|||||||
@ -26,8 +26,13 @@ import tempfile
|
|||||||
|
|
||||||
|
|
||||||
class BTFConverter:
|
class BTFConverter:
|
||||||
def __init__(self, btf_source="/sys/kernel/btf/vmlinux", output_file="vmlinux.py",
|
def __init__(
|
||||||
keep_intermediate=False, verbose=False):
|
self,
|
||||||
|
btf_source="/sys/kernel/btf/vmlinux",
|
||||||
|
output_file="vmlinux.py",
|
||||||
|
keep_intermediate=False,
|
||||||
|
verbose=False,
|
||||||
|
):
|
||||||
self.btf_source = btf_source
|
self.btf_source = btf_source
|
||||||
self.output_file = output_file
|
self.output_file = output_file
|
||||||
self.keep_intermediate = keep_intermediate
|
self.keep_intermediate = keep_intermediate
|
||||||
@ -44,11 +49,7 @@ class BTFConverter:
|
|||||||
self.log(f"{description}...")
|
self.log(f"{description}...")
|
||||||
try:
|
try:
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
cmd,
|
cmd, shell=True, check=True, capture_output=True, text=True
|
||||||
shell=True,
|
|
||||||
check=True,
|
|
||||||
capture_output=True,
|
|
||||||
text=True
|
|
||||||
)
|
)
|
||||||
if self.verbose and result.stdout:
|
if self.verbose and result.stdout:
|
||||||
print(result.stdout)
|
print(result.stdout)
|
||||||
@ -69,51 +70,55 @@ class BTFConverter:
|
|||||||
"""Step 1.5: Preprocess enum definitions."""
|
"""Step 1.5: Preprocess enum definitions."""
|
||||||
self.log("Preprocessing enum definitions...")
|
self.log("Preprocessing enum definitions...")
|
||||||
|
|
||||||
with open(input_file, 'r') as f:
|
with open(input_file, "r") as f:
|
||||||
original_code = f.read()
|
original_code = f.read()
|
||||||
|
|
||||||
# Extract anonymous enums
|
# Extract anonymous enums
|
||||||
enums = re.findall(
|
enums = re.findall(
|
||||||
r'(?<!typedef\s)(enum\s*\{[^}]*\})\s*(\w+)\s*(?::\s*\d+)?\s*;',
|
r"(?<!typedef\s)(enum\s*\{[^}]*\})\s*(\w+)\s*(?::\s*\d+)?\s*;",
|
||||||
original_code
|
original_code,
|
||||||
)
|
)
|
||||||
enum_defs = [enum_block + ';' for enum_block, _ in enums]
|
enum_defs = [enum_block + ";" for enum_block, _ in enums]
|
||||||
|
|
||||||
# Replace anonymous enums with int declarations
|
# Replace anonymous enums with int declarations
|
||||||
processed_code = re.sub(
|
processed_code = re.sub(
|
||||||
r'(?<!typedef\s)enum\s*\{[^}]*\}\s*(\w+)\s*(?::\s*\d+)?\s*;',
|
r"(?<!typedef\s)enum\s*\{[^}]*\}\s*(\w+)\s*(?::\s*\d+)?\s*;",
|
||||||
r'int \1;',
|
r"int \1;",
|
||||||
original_code
|
original_code,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Prepend enum definitions
|
# Prepend enum definitions
|
||||||
if enum_defs:
|
if enum_defs:
|
||||||
enum_text = '\n'.join(enum_defs) + '\n\n'
|
enum_text = "\n".join(enum_defs) + "\n\n"
|
||||||
processed_code = enum_text + processed_code
|
processed_code = enum_text + processed_code
|
||||||
|
|
||||||
output_file = os.path.join(self.temp_dir, "vmlinux_processed.h")
|
output_file = os.path.join(self.temp_dir, "vmlinux_processed.h")
|
||||||
with open(output_file, 'w') as f:
|
with open(output_file, "w") as f:
|
||||||
f.write(processed_code)
|
f.write(processed_code)
|
||||||
|
|
||||||
return output_file
|
return output_file
|
||||||
|
|
||||||
def step2_5_process_kioctx(self, input_file):
|
def step2_5_process_kioctx(self, input_file):
|
||||||
#TODO: this is a very bad bug and design decision. A single struct has an issue mostly.
|
# TODO: this is a very bad bug and design decision. A single struct has an issue mostly.
|
||||||
"""Step 2.5: Process struct kioctx to extract nested anonymous structs."""
|
"""Step 2.5: Process struct kioctx to extract nested anonymous structs."""
|
||||||
self.log("Processing struct kioctx nested structs...")
|
self.log("Processing struct kioctx nested structs...")
|
||||||
|
|
||||||
with open(input_file, 'r') as f:
|
with open(input_file, "r") as f:
|
||||||
content = f.read()
|
content = f.read()
|
||||||
|
|
||||||
# Pattern to match struct kioctx with its full body (handles multiple nesting levels)
|
# Pattern to match struct kioctx with its full body (handles multiple nesting levels)
|
||||||
kioctx_pattern = r'struct\s+kioctx\s*\{(?:[^{}]|\{(?:[^{}]|\{[^{}]*\})*\})*\}\s*;'
|
kioctx_pattern = (
|
||||||
|
r"struct\s+kioctx\s*\{(?:[^{}]|\{(?:[^{}]|\{[^{}]*\})*\})*\}\s*;"
|
||||||
|
)
|
||||||
|
|
||||||
def process_kioctx_replacement(match):
|
def process_kioctx_replacement(match):
|
||||||
full_struct = match.group(0)
|
full_struct = match.group(0)
|
||||||
self.log(f"Found struct kioctx, length: {len(full_struct)} chars")
|
self.log(f"Found struct kioctx, length: {len(full_struct)} chars")
|
||||||
|
|
||||||
# Extract the struct body (everything between outermost { and })
|
# Extract the struct body (everything between outermost { and })
|
||||||
body_match = re.search(r'struct\s+kioctx\s*\{(.*)\}\s*;', full_struct, re.DOTALL)
|
body_match = re.search(
|
||||||
|
r"struct\s+kioctx\s*\{(.*)\}\s*;", full_struct, re.DOTALL
|
||||||
|
)
|
||||||
if not body_match:
|
if not body_match:
|
||||||
return full_struct
|
return full_struct
|
||||||
|
|
||||||
@ -121,7 +126,7 @@ class BTFConverter:
|
|||||||
|
|
||||||
# Find all anonymous structs within the body
|
# Find all anonymous structs within the body
|
||||||
# Pattern: struct { ... } followed by ; (not a member name)
|
# Pattern: struct { ... } followed by ; (not a member name)
|
||||||
anon_struct_pattern = r'struct\s*\{[^}]*\}'
|
# anon_struct_pattern = r"struct\s*\{[^}]*\}"
|
||||||
|
|
||||||
anon_structs = []
|
anon_structs = []
|
||||||
anon_counter = 4 # Start from 4, counting down to 1
|
anon_counter = 4 # Start from 4, counting down to 1
|
||||||
@ -131,7 +136,9 @@ class BTFConverter:
|
|||||||
anon_struct_content = m.group(0)
|
anon_struct_content = m.group(0)
|
||||||
|
|
||||||
# Extract the body of the anonymous struct
|
# Extract the body of the anonymous struct
|
||||||
anon_body_match = re.search(r'struct\s*\{(.*)\}', anon_struct_content, re.DOTALL)
|
anon_body_match = re.search(
|
||||||
|
r"struct\s*\{(.*)\}", anon_struct_content, re.DOTALL
|
||||||
|
)
|
||||||
if not anon_body_match:
|
if not anon_body_match:
|
||||||
return anon_struct_content
|
return anon_struct_content
|
||||||
|
|
||||||
@ -154,7 +161,7 @@ class BTFConverter:
|
|||||||
processed_body = body
|
processed_body = body
|
||||||
|
|
||||||
# Find all occurrences and process them
|
# Find all occurrences and process them
|
||||||
pattern_with_semicolon = r'struct\s*\{([^}]*)\}\s*;'
|
pattern_with_semicolon = r"struct\s*\{([^}]*)\}\s*;"
|
||||||
matches = list(re.finditer(pattern_with_semicolon, body, re.DOTALL))
|
matches = list(re.finditer(pattern_with_semicolon, body, re.DOTALL))
|
||||||
|
|
||||||
if not matches:
|
if not matches:
|
||||||
@ -178,14 +185,16 @@ class BTFConverter:
|
|||||||
|
|
||||||
# Replace in the body
|
# Replace in the body
|
||||||
replacement = f"struct {anon_name} {member_name};"
|
replacement = f"struct {anon_name} {member_name};"
|
||||||
processed_body = processed_body[:start_pos] + replacement + processed_body[end_pos:]
|
processed_body = (
|
||||||
|
processed_body[:start_pos] + replacement + processed_body[end_pos:]
|
||||||
|
)
|
||||||
|
|
||||||
anon_counter -= 1
|
anon_counter -= 1
|
||||||
|
|
||||||
# Rebuild the complete definition
|
# Rebuild the complete definition
|
||||||
if anon_structs:
|
if anon_structs:
|
||||||
# Prepend the anonymous struct definitions
|
# Prepend the anonymous struct definitions
|
||||||
anon_definitions = '\n'.join(anon_structs) + '\n\n'
|
anon_definitions = "\n".join(anon_structs) + "\n\n"
|
||||||
new_struct = f"struct kioctx {{{processed_body}}};"
|
new_struct = f"struct kioctx {{{processed_body}}};"
|
||||||
return anon_definitions + new_struct
|
return anon_definitions + new_struct
|
||||||
else:
|
else:
|
||||||
@ -193,14 +202,11 @@ class BTFConverter:
|
|||||||
|
|
||||||
# Apply the transformation
|
# Apply the transformation
|
||||||
processed_content = re.sub(
|
processed_content = re.sub(
|
||||||
kioctx_pattern,
|
kioctx_pattern, process_kioctx_replacement, content, flags=re.DOTALL
|
||||||
process_kioctx_replacement,
|
|
||||||
content,
|
|
||||||
flags=re.DOTALL
|
|
||||||
)
|
)
|
||||||
|
|
||||||
output_file = os.path.join(self.temp_dir, "vmlinux_kioctx_processed.h")
|
output_file = os.path.join(self.temp_dir, "vmlinux_kioctx_processed.h")
|
||||||
with open(output_file, 'w') as f:
|
with open(output_file, "w") as f:
|
||||||
f.write(processed_content)
|
f.write(processed_content)
|
||||||
|
|
||||||
self.log(f"Saved kioctx-processed output to {output_file}")
|
self.log(f"Saved kioctx-processed output to {output_file}")
|
||||||
@ -218,7 +224,7 @@ class BTFConverter:
|
|||||||
output_file = os.path.join(self.temp_dir, "vmlinux_raw.py")
|
output_file = os.path.join(self.temp_dir, "vmlinux_raw.py")
|
||||||
cmd = (
|
cmd = (
|
||||||
f"clang2py {input_file} -o {output_file} "
|
f"clang2py {input_file} -o {output_file} "
|
||||||
f"--clang-args=\"-fno-ms-extensions -I/usr/include -I/usr/include/linux\""
|
f'--clang-args="-fno-ms-extensions -I/usr/include -I/usr/include/linux"'
|
||||||
)
|
)
|
||||||
self.run_command(cmd, "Converting to Python ctypes")
|
self.run_command(cmd, "Converting to Python ctypes")
|
||||||
return output_file
|
return output_file
|
||||||
@ -234,25 +240,21 @@ class BTFConverter:
|
|||||||
data = re.sub(r"\('_[0-9]+',\s*ctypes\.[a-zA-Z0-9_]+,\s*0\),?\s*\n?", "", data)
|
data = re.sub(r"\('_[0-9]+',\s*ctypes\.[a-zA-Z0-9_]+,\s*0\),?\s*\n?", "", data)
|
||||||
|
|
||||||
# Replace ('_20', ctypes.c_uint64, 64) → ('_20', ctypes.c_uint64)
|
# Replace ('_20', ctypes.c_uint64, 64) → ('_20', ctypes.c_uint64)
|
||||||
data = re.sub(r"\('(_[0-9]+)',\s*(ctypes\.[a-zA-Z0-9_]+),\s*[0-9]+\)", r"('\1', \2)", data)
|
data = re.sub(
|
||||||
|
r"\('(_[0-9]+)',\s*(ctypes\.[a-zA-Z0-9_]+),\s*[0-9]+\)", r"('\1', \2)", data
|
||||||
|
)
|
||||||
|
|
||||||
# Replace ('_20', ctypes.c_char, 8) with ('_20', ctypes.c_uint8, 8)
|
# Replace ('_20', ctypes.c_char, 8) with ('_20', ctypes.c_uint8, 8)
|
||||||
data = re.sub(
|
data = re.sub(r"(ctypes\.c_char)(\s*,\s*\d+\))", r"ctypes.c_uint8\2", data)
|
||||||
r"(ctypes\.c_char)(\s*,\s*\d+\))",
|
|
||||||
r"ctypes.c_uint8\2",
|
|
||||||
data
|
|
||||||
)
|
|
||||||
|
|
||||||
# below to replace those c_bool with bitfield greater than 8
|
# below to replace those c_bool with bitfield greater than 8
|
||||||
def repl(m):
|
def repl(m):
|
||||||
name, bits = m.groups()
|
name, bits = m.groups()
|
||||||
return f"('{name}', ctypes.c_uint32, {bits})" if int(bits) > 8 else m.group(0)
|
return (
|
||||||
|
f"('{name}', ctypes.c_uint32, {bits})" if int(bits) > 8 else m.group(0)
|
||||||
|
)
|
||||||
|
|
||||||
data = re.sub(
|
data = re.sub(r"\('([^']+)',\s*ctypes\.c_bool,\s*(\d+)\)", repl, data)
|
||||||
r"\('([^']+)',\s*ctypes\.c_bool,\s*(\d+)\)",
|
|
||||||
repl,
|
|
||||||
data
|
|
||||||
)
|
|
||||||
|
|
||||||
# Remove ctypes. prefix from invalid entries
|
# Remove ctypes. prefix from invalid entries
|
||||||
invalid_ctypes = ["bpf_iter_state", "_cache_type", "fs_context_purpose"]
|
invalid_ctypes = ["bpf_iter_state", "_cache_type", "fs_context_purpose"]
|
||||||
@ -269,6 +271,7 @@ class BTFConverter:
|
|||||||
if not self.keep_intermediate and self.temp_dir != ".":
|
if not self.keep_intermediate and self.temp_dir != ".":
|
||||||
self.log(f"Cleaning up temporary directory: {self.temp_dir}")
|
self.log(f"Cleaning up temporary directory: {self.temp_dir}")
|
||||||
import shutil
|
import shutil
|
||||||
|
|
||||||
shutil.rmtree(self.temp_dir, ignore_errors=True)
|
shutil.rmtree(self.temp_dir, ignore_errors=True)
|
||||||
|
|
||||||
def convert(self):
|
def convert(self):
|
||||||
@ -292,6 +295,7 @@ class BTFConverter:
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
print(f"\n✗ Error during conversion: {e}", file=sys.stderr)
|
print(f"\n✗ Error during conversion: {e}", file=sys.stderr)
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
traceback.print_exc()
|
traceback.print_exc()
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
finally:
|
finally:
|
||||||
@ -304,18 +308,13 @@ class BTFConverter:
|
|||||||
dependencies = {
|
dependencies = {
|
||||||
"bpftool": "bpftool --version",
|
"bpftool": "bpftool --version",
|
||||||
"clang": "clang --version",
|
"clang": "clang --version",
|
||||||
"clang2py": "clang2py --version"
|
"clang2py": "clang2py --version",
|
||||||
}
|
}
|
||||||
|
|
||||||
missing = []
|
missing = []
|
||||||
for tool, cmd in dependencies.items():
|
for tool, cmd in dependencies.items():
|
||||||
try:
|
try:
|
||||||
subprocess.run(
|
subprocess.run(cmd, shell=True, check=True, capture_output=True)
|
||||||
cmd,
|
|
||||||
shell=True,
|
|
||||||
check=True,
|
|
||||||
capture_output=True
|
|
||||||
)
|
|
||||||
except subprocess.CalledProcessError:
|
except subprocess.CalledProcessError:
|
||||||
missing.append(tool)
|
missing.append(tool)
|
||||||
|
|
||||||
@ -337,31 +336,31 @@ Examples:
|
|||||||
%(prog)s
|
%(prog)s
|
||||||
%(prog)s -o kernel_types.py
|
%(prog)s -o kernel_types.py
|
||||||
%(prog)s --btf-source /sys/kernel/btf/custom_module -k -v
|
%(prog)s --btf-source /sys/kernel/btf/custom_module -k -v
|
||||||
"""
|
""",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--btf-source",
|
"--btf-source",
|
||||||
default="/sys/kernel/btf/vmlinux",
|
default="/sys/kernel/btf/vmlinux",
|
||||||
help="Path to BTF source (default: /sys/kernel/btf/vmlinux)"
|
help="Path to BTF source (default: /sys/kernel/btf/vmlinux)",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-o", "--output",
|
"-o",
|
||||||
|
"--output",
|
||||||
default="vmlinux.py",
|
default="vmlinux.py",
|
||||||
help="Output Python file (default: vmlinux.py)"
|
help="Output Python file (default: vmlinux.py)",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-k", "--keep-intermediate",
|
"-k",
|
||||||
|
"--keep-intermediate",
|
||||||
action="store_true",
|
action="store_true",
|
||||||
help="Keep intermediate files (vmlinux.h, vmlinux_processed.h, etc.)"
|
help="Keep intermediate files (vmlinux.h, vmlinux_processed.h, etc.)",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-v", "--verbose",
|
"-v", "--verbose", action="store_true", help="Enable verbose output"
|
||||||
action="store_true",
|
|
||||||
help="Enable verbose output"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
@ -370,7 +369,7 @@ Examples:
|
|||||||
btf_source=args.btf_source,
|
btf_source=args.btf_source,
|
||||||
output_file=args.output,
|
output_file=args.output,
|
||||||
keep_intermediate=args.keep_intermediate,
|
keep_intermediate=args.keep_intermediate,
|
||||||
verbose=args.verbose
|
verbose=args.verbose,
|
||||||
)
|
)
|
||||||
|
|
||||||
converter.convert()
|
converter.convert()
|
||||||
|
|||||||
Reference in New Issue
Block a user