github.com/cilium/ebpf@v0.15.1-0.20240517100537-8079b37aa138/features/doc.go (about)

     1  // Package features allows probing for BPF features available to the calling process.
     2  //
     3  // In general, the error return values from feature probes in this package
     4  // all have the following semantics unless otherwise specified:
     5  //
     6  //	err == nil: The feature is available.
     7  //	errors.Is(err, ebpf.ErrNotSupported): The feature is not available.
     8  //	err != nil: Any errors encountered during probe execution, wrapped.
     9  //
    10  // Note that the latter case may include false negatives, and that resource
    11  // creation may succeed despite an error being returned. For example, some
    12  // map and program types cannot reliably be probed and will return an
    13  // inconclusive error.
    14  //
    15  // As a rule, only `nil` and `ebpf.ErrNotSupported` are conclusive.
    16  //
    17  // Probe results are cached by the library and persist throughout any changes
    18  // to the process' environment, like capability changes.
    19  package features