1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
use core::ffi::c_void;
use std::convert::TryFrom;
use std::ffi::CStr;
use std::mem::size_of;
use std::os::unix::io::AsFd;
use std::os::unix::io::AsRawFd;
use std::os::unix::io::BorrowedFd;
use std::os::unix::io::FromRawFd;
use std::os::unix::io::OwnedFd;
use std::path::Path;
use std::ptr;
use std::ptr::NonNull;
use std::slice;
use libbpf_sys::bpf_func_id;
use num_enum::TryFromPrimitive;
use strum_macros::Display;
use crate::libbpf_sys;
use crate::util;
use crate::AsRawLibbpf;
use crate::Error;
use crate::Link;
use crate::Result;
/// Options to optionally be provided when attaching to a uprobe.
#[derive(Clone, Debug, Default)]
pub struct UprobeOpts {
/// Offset of kernel reference counted USDT semaphore.
pub ref_ctr_offset: usize,
/// Custom user-provided value accessible through `bpf_get_attach_cookie`.
pub cookie: u64,
/// uprobe is return probe, invoked at function return time.
pub retprobe: bool,
/// Function name to attach to.
///
/// Could be an unqualified ("abc") or library-qualified "abc@LIBXYZ" name.
/// To specify function entry, `func_name` should be set while `func_offset`
/// argument to should be 0. To trace an offset within a function, specify
/// `func_name` and use `func_offset` argument to specify offset within the
/// function. Shared library functions must specify the shared library
/// binary_path.
pub func_name: String,
#[doc(hidden)]
pub _non_exhaustive: (),
}
/// Options to optionally be provided when attaching to a USDT.
#[derive(Clone, Debug, Default)]
pub struct UsdtOpts {
/// Custom user-provided value accessible through `bpf_usdt_cookie`.
pub cookie: u64,
#[doc(hidden)]
pub _non_exhaustive: (),
}
impl From<UsdtOpts> for libbpf_sys::bpf_usdt_opts {
fn from(opts: UsdtOpts) -> Self {
let UsdtOpts {
cookie,
_non_exhaustive,
} = opts;
libbpf_sys::bpf_usdt_opts {
sz: size_of::<Self>() as _,
usdt_cookie: cookie,
}
}
}
/// Options to optionally be provided when attaching to a tracepoint.
#[derive(Clone, Debug, Default)]
pub struct TracepointOpts {
/// Custom user-provided value accessible through `bpf_get_attach_cookie`.
pub cookie: u64,
#[doc(hidden)]
pub _non_exhaustive: (),
}
impl From<TracepointOpts> for libbpf_sys::bpf_tracepoint_opts {
fn from(opts: TracepointOpts) -> Self {
let TracepointOpts {
cookie,
_non_exhaustive,
} = opts;
libbpf_sys::bpf_tracepoint_opts {
sz: size_of::<Self>() as _,
bpf_cookie: cookie,
}
}
}
/// Represents a parsed but not yet loaded BPF program.
///
/// This object exposes operations that need to happen before the program is loaded.
#[derive(Debug)]
pub struct OpenProgram {
ptr: NonNull<libbpf_sys::bpf_program>,
section: String,
}
// TODO: Document variants.
#[allow(missing_docs)]
impl OpenProgram {
pub(crate) unsafe fn new(ptr: NonNull<libbpf_sys::bpf_program>) -> Result<Self> {
// Get the program section
// SAFETY:
// bpf_program__section_name never returns NULL, so no need to check the pointer.
let section = unsafe { libbpf_sys::bpf_program__section_name(ptr.as_ptr()) };
let section = util::c_ptr_to_string(section)?;
Ok(Self { ptr, section })
}
pub fn set_prog_type(&mut self, prog_type: ProgramType) {
unsafe {
libbpf_sys::bpf_program__set_type(self.ptr.as_ptr(), prog_type as u32);
}
}
// The `ProgramType` of this `OpenProgram`.
pub fn prog_type(&self) -> ProgramType {
match ProgramType::try_from(unsafe { libbpf_sys::bpf_program__type(self.ptr.as_ptr()) }) {
Ok(ty) => ty,
Err(_) => ProgramType::Unknown,
}
}
pub fn set_attach_type(&mut self, attach_type: ProgramAttachType) {
unsafe {
libbpf_sys::bpf_program__set_expected_attach_type(
self.ptr.as_ptr(),
attach_type as u32,
);
}
}
pub fn set_ifindex(&mut self, idx: u32) {
unsafe {
libbpf_sys::bpf_program__set_ifindex(self.ptr.as_ptr(), idx);
}
}
/// Set the log level for the bpf program.
///
/// The log level is interpreted by bpf kernel code and interpretation may
/// change with newer kernel versions. Refer to the kernel source code for
/// details.
///
/// In general, a value of `0` disables logging while values `> 0` enables
/// it.
pub fn set_log_level(&mut self, log_level: u32) -> Result<()> {
let ret = unsafe { libbpf_sys::bpf_program__set_log_level(self.ptr.as_ptr(), log_level) };
util::parse_ret(ret)
}
/// Name of the section this `OpenProgram` belongs to.
pub fn section(&self) -> &str {
&self.section
}
/// The name of this `OpenProgram`.
pub fn name(&self) -> Result<&str> {
let name_ptr = unsafe { libbpf_sys::bpf_program__name(self.ptr.as_ptr()) };
let name_c_str = unsafe { CStr::from_ptr(name_ptr) };
name_c_str.to_str().map_err(Error::with_invalid_data)
}
/// Set whether a bpf program should be automatically loaded by default
/// when the bpf object is loaded.
pub fn set_autoload(&mut self, autoload: bool) -> Result<()> {
let ret = unsafe { libbpf_sys::bpf_program__set_autoload(self.ptr.as_ptr(), autoload) };
util::parse_ret(ret)
}
pub fn set_attach_target(
&mut self,
attach_prog_fd: i32,
attach_func_name: Option<String>,
) -> Result<()> {
let ret = if let Some(name) = attach_func_name {
// NB: we must hold onto a CString otherwise our pointer dangles
let name_c = util::str_to_cstring(&name)?;
unsafe {
libbpf_sys::bpf_program__set_attach_target(
self.ptr.as_ptr(),
attach_prog_fd,
name_c.as_ptr(),
)
}
} else {
unsafe {
libbpf_sys::bpf_program__set_attach_target(
self.ptr.as_ptr(),
attach_prog_fd,
ptr::null(),
)
}
};
util::parse_ret(ret)
}
pub fn set_flags(&self, flags: u32) -> Result<()> {
let ret = unsafe { libbpf_sys::bpf_program__set_flags(self.ptr.as_ptr(), flags) };
util::parse_ret(ret)
}
/// Returns the number of instructions that form the program.
///
/// Note: Keep in mind, libbpf can modify the program's instructions
/// and consequently its instruction count, as it processes the BPF object file.
/// So [`OpenProgram::insn_cnt`] and [`Program::insn_cnt`] may return different values.
///
pub fn insn_cnt(&self) -> usize {
unsafe { libbpf_sys::bpf_program__insn_cnt(self.ptr.as_ptr()) as usize }
}
/// Gives read-only access to BPF program's underlying BPF instructions.
///
/// Keep in mind, libbpf can modify and append/delete BPF program's
/// instructions as it processes BPF object file and prepares everything for
/// uploading into the kernel. So [`OpenProgram::insns`] and [`Program::insns`] may return
/// different sets of instructions. As an example, during BPF object load phase BPF program
/// instructions will be CO-RE-relocated, BPF subprograms instructions will be appended, ldimm64
/// instructions will have FDs embedded, etc. So instructions returned before load and after it
/// might be quite different.
pub fn insns(&self) -> &[libbpf_sys::bpf_insn] {
let count = self.insn_cnt();
let ptr = unsafe { libbpf_sys::bpf_program__insns(self.ptr.as_ptr()) };
unsafe { slice::from_raw_parts(ptr, count) }
}
}
impl AsRawLibbpf for Program {
type LibbpfType = libbpf_sys::bpf_program;
/// Retrieve the underlying [`libbpf_sys::bpf_program`].
fn as_libbpf_object(&self) -> NonNull<Self::LibbpfType> {
self.ptr
}
}
/// Type of a [`Program`]. Maps to `enum bpf_prog_type` in kernel uapi.
#[non_exhaustive]
#[repr(u32)]
#[derive(Copy, Clone, TryFromPrimitive, Display, Debug)]
// TODO: Document variants.
#[allow(missing_docs)]
pub enum ProgramType {
Unspec = 0,
SocketFilter,
Kprobe,
SchedCls,
SchedAct,
Tracepoint,
Xdp,
PerfEvent,
CgroupSkb,
CgroupSock,
LwtIn,
LwtOut,
LwtXmit,
SockOps,
SkSkb,
CgroupDevice,
SkMsg,
RawTracepoint,
CgroupSockAddr,
LwtSeg6local,
LircMode2,
SkReuseport,
FlowDissector,
CgroupSysctl,
RawTracepointWritable,
CgroupSockopt,
Tracing,
StructOps,
Ext,
Lsm,
SkLookup,
Syscall,
/// See [`MapType::Unknown`][crate::MapType::Unknown]
Unknown = u32::MAX,
}
impl ProgramType {
/// Detects if host kernel supports this BPF program type
///
/// Make sure the process has required set of CAP_* permissions (or runs as
/// root) when performing feature checking.
pub fn is_supported(&self) -> Result<bool> {
let ret = unsafe { libbpf_sys::libbpf_probe_bpf_prog_type(*self as u32, ptr::null()) };
match ret {
0 => Ok(false),
1 => Ok(true),
_ => Err(Error::from_raw_os_error(-ret)),
}
}
/// Detects if host kernel supports the use of a given BPF helper from this BPF program type.
/// * `helper_id` - BPF helper ID (enum bpf_func_id) to check support for
///
/// Make sure the process has required set of CAP_* permissions (or runs as
/// root) when performing feature checking.
pub fn is_helper_supported(&self, helper_id: bpf_func_id) -> Result<bool> {
let ret =
unsafe { libbpf_sys::libbpf_probe_bpf_helper(*self as u32, helper_id, ptr::null()) };
match ret {
0 => Ok(false),
1 => Ok(true),
_ => Err(Error::from_raw_os_error(-ret)),
}
}
}
/// Attach type of a [`Program`]. Maps to `enum bpf_attach_type` in kernel uapi.
#[non_exhaustive]
#[repr(u32)]
#[derive(Clone, TryFromPrimitive, Display, Debug)]
// TODO: Document variants.
#[allow(missing_docs)]
pub enum ProgramAttachType {
CgroupInetIngress,
CgroupInetEgress,
CgroupInetSockCreate,
CgroupSockOps,
SkSkbStreamParser,
SkSkbStreamVerdict,
CgroupDevice,
SkMsgVerdict,
CgroupInet4Bind,
CgroupInet6Bind,
CgroupInet4Connect,
CgroupInet6Connect,
CgroupInet4PostBind,
CgroupInet6PostBind,
CgroupUdp4Sendmsg,
CgroupUdp6Sendmsg,
LircMode2,
FlowDissector,
CgroupSysctl,
CgroupUdp4Recvmsg,
CgroupUdp6Recvmsg,
CgroupGetsockopt,
CgroupSetsockopt,
TraceRawTp,
TraceFentry,
TraceFexit,
ModifyReturn,
LsmMac,
TraceIter,
CgroupInet4Getpeername,
CgroupInet6Getpeername,
CgroupInet4Getsockname,
CgroupInet6Getsockname,
XdpDevmap,
CgroupInetSockRelease,
XdpCpumap,
SkLookup,
Xdp,
SkSkbVerdict,
SkReuseportSelect,
SkReuseportSelectOrMigrate,
PerfEvent,
/// See [`MapType::Unknown`][crate::MapType::Unknown]
Unknown = u32::MAX,
}
/// Represents a loaded [`Program`].
///
/// This struct is not safe to clone because the underlying libbpf resource cannot currently
/// be protected from data races.
///
/// If you attempt to attach a `Program` with the wrong attach method, the `attach_*`
/// method will fail with the appropriate error.
#[derive(Debug)]
pub struct Program {
pub(crate) ptr: NonNull<libbpf_sys::bpf_program>,
name: String,
section: String,
}
impl AsFd for Program {
fn as_fd(&self) -> BorrowedFd<'_> {
let fd = unsafe { libbpf_sys::bpf_program__fd(self.ptr.as_ptr()) };
unsafe { BorrowedFd::borrow_raw(fd) }
}
}
impl Program {
/// Create a [`Program`] from a [`libbpf_sys::bpf_program`]
///
/// # Safety
/// The pointer must point to a loaded program.
pub(crate) unsafe fn new(ptr: NonNull<libbpf_sys::bpf_program>) -> Result<Self> {
// Get the program name
// bpf_program__name never returns NULL, so no need to check the pointer.
let name = unsafe { libbpf_sys::bpf_program__name(ptr.as_ptr()) };
let name = util::c_ptr_to_string(name)?;
// Get the program section
// bpf_program__section_name never returns NULL, so no need to check the pointer.
let section = unsafe { libbpf_sys::bpf_program__section_name(ptr.as_ptr()) };
let section = util::c_ptr_to_string(section)?;
Ok(Program { ptr, name, section })
}
/// Retrieve the program's name.
pub fn name(&self) -> &str {
&self.name
}
/// Name of the section this `Program` belongs to.
pub fn section(&self) -> &str {
&self.section
}
/// Retrieve the type of the program.
pub fn prog_type(&self) -> ProgramType {
match ProgramType::try_from(unsafe { libbpf_sys::bpf_program__type(self.ptr.as_ptr()) }) {
Ok(ty) => ty,
Err(_) => ProgramType::Unknown,
}
}
/// Returns program fd by id
pub fn get_fd_by_id(id: u32) -> Result<OwnedFd> {
let ret = unsafe { libbpf_sys::bpf_prog_get_fd_by_id(id) };
let fd = util::parse_ret_i32(ret)?;
// SAFETY
// A file descriptor coming from the bpf_prog_get_fd_by_id function is always suitable for
// ownership and can be cleaned up with close.
Ok(unsafe { OwnedFd::from_raw_fd(fd) })
}
/// Returns program id by fd
pub fn get_id_by_fd(fd: BorrowedFd<'_>) -> Result<u32> {
let mut prog_info = libbpf_sys::bpf_prog_info::default();
let prog_info_ptr: *mut libbpf_sys::bpf_prog_info = &mut prog_info;
let mut len = size_of::<libbpf_sys::bpf_prog_info>() as u32;
let ret = unsafe {
libbpf_sys::bpf_obj_get_info_by_fd(
fd.as_raw_fd(),
prog_info_ptr as *mut c_void,
&mut len,
)
};
util::parse_ret(ret)?;
Ok(prog_info.id)
}
/// Returns flags that have been set for the program.
pub fn flags(&self) -> u32 {
unsafe { libbpf_sys::bpf_program__flags(self.ptr.as_ptr()) }
}
/// Retrieve the attach type of the program.
pub fn attach_type(&self) -> ProgramAttachType {
match ProgramAttachType::try_from(unsafe {
libbpf_sys::bpf_program__expected_attach_type(self.ptr.as_ptr())
}) {
Ok(ty) => ty,
Err(_) => ProgramAttachType::Unknown,
}
}
/// Return `true` if the bpf program is set to autoload, `false` otherwise.
pub fn autoload(&self) -> bool {
unsafe { libbpf_sys::bpf_program__autoload(self.ptr.as_ptr()) }
}
/// Return the bpf program's log level.
pub fn log_level(&self) -> u32 {
unsafe { libbpf_sys::bpf_program__log_level(self.ptr.as_ptr()) }
}
/// [Pin](https://facebookmicrosites.github.io/bpf/blog/2018/08/31/object-lifetime.html#bpffs)
/// this program to bpffs.
pub fn pin<P: AsRef<Path>>(&mut self, path: P) -> Result<()> {
let path_c = util::path_to_cstring(path)?;
let path_ptr = path_c.as_ptr();
let ret = unsafe { libbpf_sys::bpf_program__pin(self.ptr.as_ptr(), path_ptr) };
util::parse_ret(ret)
}
/// [Unpin](https://facebookmicrosites.github.io/bpf/blog/2018/08/31/object-lifetime.html#bpffs)
/// this program from bpffs
pub fn unpin<P: AsRef<Path>>(&mut self, path: P) -> Result<()> {
let path_c = util::path_to_cstring(path)?;
let path_ptr = path_c.as_ptr();
let ret = unsafe { libbpf_sys::bpf_program__unpin(self.ptr.as_ptr(), path_ptr) };
util::parse_ret(ret)
}
/// Auto-attach based on prog section
pub fn attach(&mut self) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach(self.ptr.as_ptr())
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to a
/// [cgroup](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html).
pub fn attach_cgroup(&mut self, cgroup_fd: i32) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_cgroup(self.ptr.as_ptr(), cgroup_fd)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to a [perf event](https://linux.die.net/man/2/perf_event_open).
pub fn attach_perf_event(&mut self, pfd: i32) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_perf_event(self.ptr.as_ptr(), pfd)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to a [userspace
/// probe](https://www.kernel.org/doc/html/latest/trace/uprobetracer.html).
pub fn attach_uprobe<T: AsRef<Path>>(
&mut self,
retprobe: bool,
pid: i32,
binary_path: T,
func_offset: usize,
) -> Result<Link> {
let path = util::path_to_cstring(binary_path)?;
let path_ptr = path.as_ptr();
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_uprobe(
self.ptr.as_ptr(),
retprobe,
pid,
path_ptr,
func_offset as libbpf_sys::size_t,
)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to a [userspace
/// probe](https://www.kernel.org/doc/html/latest/trace/uprobetracer.html),
/// providing additional options.
pub fn attach_uprobe_with_opts(
&mut self,
pid: i32,
binary_path: impl AsRef<Path>,
func_offset: usize,
opts: UprobeOpts,
) -> Result<Link> {
let path = util::path_to_cstring(binary_path)?;
let path_ptr = path.as_ptr();
let UprobeOpts {
ref_ctr_offset,
cookie,
retprobe,
func_name,
_non_exhaustive,
} = opts;
let func_name = util::str_to_cstring(&func_name)?;
let opts = libbpf_sys::bpf_uprobe_opts {
sz: size_of::<libbpf_sys::bpf_uprobe_opts>() as _,
ref_ctr_offset: ref_ctr_offset as libbpf_sys::size_t,
bpf_cookie: cookie,
retprobe,
func_name: func_name.as_ptr(),
..Default::default()
};
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_uprobe_opts(
self.ptr.as_ptr(),
pid,
path_ptr,
func_offset as libbpf_sys::size_t,
&opts as *const _,
)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to a [kernel
/// probe](https://www.kernel.org/doc/html/latest/trace/kprobetrace.html).
pub fn attach_kprobe<T: AsRef<str>>(&mut self, retprobe: bool, func_name: T) -> Result<Link> {
let func_name = util::str_to_cstring(func_name.as_ref())?;
let func_name_ptr = func_name.as_ptr();
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_kprobe(self.ptr.as_ptr(), retprobe, func_name_ptr)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
fn attach_tracepoint_impl(
&mut self,
tp_category: &str,
tp_name: &str,
tp_opts: Option<TracepointOpts>,
) -> Result<Link> {
let tp_category = util::str_to_cstring(tp_category)?;
let tp_category_ptr = tp_category.as_ptr();
let tp_name = util::str_to_cstring(tp_name)?;
let tp_name_ptr = tp_name.as_ptr();
util::create_bpf_entity_checked(|| {
if let Some(tp_opts) = tp_opts {
let tp_opts = libbpf_sys::bpf_tracepoint_opts::from(tp_opts);
unsafe {
libbpf_sys::bpf_program__attach_tracepoint_opts(
self.ptr.as_ptr(),
tp_category_ptr,
tp_name_ptr,
&tp_opts as *const _,
)
}
} else {
unsafe {
libbpf_sys::bpf_program__attach_tracepoint(
self.ptr.as_ptr(),
tp_category_ptr,
tp_name_ptr,
)
}
}
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to a [kernel
/// tracepoint](https://www.kernel.org/doc/html/latest/trace/tracepoints.html).
pub fn attach_tracepoint(
&mut self,
tp_category: impl AsRef<str>,
tp_name: impl AsRef<str>,
) -> Result<Link> {
self.attach_tracepoint_impl(tp_category.as_ref(), tp_name.as_ref(), None)
}
/// Attach this program to a [kernel
/// tracepoint](https://www.kernel.org/doc/html/latest/trace/tracepoints.html),
/// providing additional options.
pub fn attach_tracepoint_with_opts(
&mut self,
tp_category: impl AsRef<str>,
tp_name: impl AsRef<str>,
tp_opts: TracepointOpts,
) -> Result<Link> {
self.attach_tracepoint_impl(tp_category.as_ref(), tp_name.as_ref(), Some(tp_opts))
}
/// Attach this program to a [raw kernel
/// tracepoint](https://lwn.net/Articles/748352/).
pub fn attach_raw_tracepoint<T: AsRef<str>>(&mut self, tp_name: T) -> Result<Link> {
let tp_name = util::str_to_cstring(tp_name.as_ref())?;
let tp_name_ptr = tp_name.as_ptr();
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_raw_tracepoint(self.ptr.as_ptr(), tp_name_ptr)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach to an [LSM](https://en.wikipedia.org/wiki/Linux_Security_Modules) hook
pub fn attach_lsm(&mut self) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_lsm(self.ptr.as_ptr())
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach to a [fentry/fexit kernel probe](https://lwn.net/Articles/801479/)
pub fn attach_trace(&mut self) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_trace(self.ptr.as_ptr())
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach a verdict/parser to a [sockmap/sockhash](https://lwn.net/Articles/731133/)
pub fn attach_sockmap(&self, map_fd: i32) -> Result<()> {
let err = unsafe {
libbpf_sys::bpf_prog_attach(
self.as_fd().as_raw_fd(),
map_fd,
self.attach_type() as u32,
0,
)
};
util::parse_ret(err)
}
/// Attach this program to [XDP](https://lwn.net/Articles/825998/)
pub fn attach_xdp(&mut self, ifindex: i32) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_xdp(self.ptr.as_ptr(), ifindex)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to [netns-based programs](https://lwn.net/Articles/819618/)
pub fn attach_netns(&mut self, netns_fd: i32) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_netns(self.ptr.as_ptr(), netns_fd)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
fn attach_usdt_impl(
&mut self,
pid: i32,
binary_path: &Path,
usdt_provider: &str,
usdt_name: &str,
usdt_opts: Option<UsdtOpts>,
) -> Result<Link> {
let path = util::path_to_cstring(binary_path)?;
let path_ptr = path.as_ptr();
let usdt_provider = util::str_to_cstring(usdt_provider)?;
let usdt_provider_ptr = usdt_provider.as_ptr();
let usdt_name = util::str_to_cstring(usdt_name)?;
let usdt_name_ptr = usdt_name.as_ptr();
let usdt_opts = usdt_opts.map(libbpf_sys::bpf_usdt_opts::from);
let usdt_opts_ptr = usdt_opts
.as_ref()
.map(|opts| opts as *const _)
.unwrap_or_else(ptr::null);
util::create_bpf_entity_checked(|| unsafe {
libbpf_sys::bpf_program__attach_usdt(
self.ptr.as_ptr(),
pid,
path_ptr,
usdt_provider_ptr,
usdt_name_ptr,
usdt_opts_ptr,
)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Attach this program to a [USDT](https://lwn.net/Articles/753601/) probe
/// point. The entry point of the program must be defined with
/// `SEC("usdt")`.
pub fn attach_usdt(
&mut self,
pid: i32,
binary_path: impl AsRef<Path>,
usdt_provider: impl AsRef<str>,
usdt_name: impl AsRef<str>,
) -> Result<Link> {
self.attach_usdt_impl(
pid,
binary_path.as_ref(),
usdt_provider.as_ref(),
usdt_name.as_ref(),
None,
)
}
/// Attach this program to a [USDT](https://lwn.net/Articles/753601/) probe
/// point, providing additional options. The entry point of the program must
/// be defined with `SEC("usdt")`.
pub fn attach_usdt_with_opts(
&mut self,
pid: i32,
binary_path: impl AsRef<Path>,
usdt_provider: impl AsRef<str>,
usdt_name: impl AsRef<str>,
usdt_opts: UsdtOpts,
) -> Result<Link> {
self.attach_usdt_impl(
pid,
binary_path.as_ref(),
usdt_provider.as_ref(),
usdt_name.as_ref(),
Some(usdt_opts),
)
}
/// Attach this program to a
/// [BPF Iterator](https://www.kernel.org/doc/html/latest/bpf/bpf_iterators.html).
/// The entry point of the program must be defined with `SEC("iter")` or `SEC("iter.s")`.
pub fn attach_iter(&mut self, map_fd: BorrowedFd<'_>) -> Result<Link> {
util::create_bpf_entity_checked(|| unsafe {
let mut linkinfo = libbpf_sys::bpf_iter_link_info::default();
linkinfo.map.map_fd = map_fd.as_raw_fd() as _;
let attach_opt = libbpf_sys::bpf_iter_attach_opts {
link_info: &mut linkinfo as *mut libbpf_sys::bpf_iter_link_info,
link_info_len: size_of::<libbpf_sys::bpf_iter_link_info>() as _,
sz: size_of::<libbpf_sys::bpf_iter_attach_opts>() as _,
..Default::default()
};
libbpf_sys::bpf_program__attach_iter(
self.ptr.as_ptr(),
&attach_opt as *const libbpf_sys::bpf_iter_attach_opts,
)
})
.map(|ptr| unsafe {
// SAFETY: the pointer came from libbpf and has been checked for errors
Link::new(ptr)
})
}
/// Returns the number of instructions that form the program.
///
/// Please see note in [`OpenProgram::insn_cnt`].
pub fn insn_cnt(&self) -> usize {
unsafe { libbpf_sys::bpf_program__insn_cnt(self.ptr.as_ptr()) as usize }
}
/// Gives read-only access to BPF program's underlying BPF instructions.
///
/// Please see note in [`OpenProgram::insns`].
///
pub fn insns(&self) -> &[libbpf_sys::bpf_insn] {
let count = self.insn_cnt();
let ptr = unsafe { libbpf_sys::bpf_program__insns(self.ptr.as_ptr()) };
unsafe { slice::from_raw_parts(ptr, count) }
}
}