Skip to content

Developing an extension outside the eBPF repo has unclear steps #3021

@mtfriesen

Description

@mtfriesen
Contributor

Describe the bug

The documentation in epfExtensions.md does not describe how the following fields should be defined when creating a new hook point:

  1. bpf_attach_type
  2. bpf_link_type
  3. bpf_prog_type

It is not clear whether these should be defined in the eBPF repo or only in the codebase of the new extension. It is also not clear how the bpf_link_type enum should be used.

At a higher level, the sample code referenced in the documentation should ideally provide an example that would work outside of the eBPF repo. Finally, ideally the steps to build the sample code would rely only on the nuget package produced by the build, and the sample would be built and tested in automation, providing confidence that the sample is a good reference point for third party developers.

OS information

N/A.

Steps taken to reproduce bug

  1. Read the docs
  2. Read the sample extension
  3. Have several open questions, and separately, observe the sample could not even be compiled outside of the repo (see ebpf_store_helper.h includes non-exported (internal) eBPF header #3020)

Expected behavior

The docs should provide clear guidance for various scenarios, and the sample code should be able to be copied into a standalone codebase and work with minimal changes.

Actual outcome

The docs and sample code led to confusion and some mild frustration.

Additional details

No response

Activity

modified the milestones: 2310, 2311 on Nov 6, 2023
modified the milestones: 2311, 2312 on Dec 5, 2023
modified the milestones: 2312, 2401 on Dec 11, 2023
modified the milestones: 2401, 2402 on Jan 10, 2024

32 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P2documentationImprovements or additions to documentationtriagedDiscussed in a triage meeting

Type

No type

Projects

No projects

Relationships

None yet

    Participants

    @mtfriesen@dthaler@Alan-Jowett@gtrevi@saxena-anurag

    Issue actions

      Developing an extension outside the eBPF repo has unclear steps · Issue #3021 · microsoft/ebpf-for-windows