Skip to content

Commit 29c7088

Browse files
committed
Replace inline USDT implementation with github.com/parca-dev/usdt
- pfelf.USDTProbe is now a type alias for usdt.Probe - pfelf.ParseUSDTProbes() delegates to usdt.ParseProbes() via adapter - pfelf.ParseUSDTArguments/USDTSpecToBytes delegate to usdt package - pfelfELFReader adapter implements usdt.ELFReader interface - All consumers (interpreter, processmanager, gpu, coredump) continue working transparently via the type alias
1 parent 18b6283 commit 29c7088

16 files changed

Lines changed: 300 additions & 820 deletions

File tree

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity granting the License.
13+
14+
"Legal Entity" shall mean the union of the acting entity and all
15+
other entities that control, are controlled by, or are under common
16+
control with that entity. For the purposes of this definition,
17+
"control" means (i) the power, direct or indirect, to cause the
18+
direction or management of such entity, whether by contract or
19+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity
23+
exercising permissions granted by this License.
24+
25+
"Source" shall mean the preferred form for making modifications,
26+
including but not limited to software source code, documentation
27+
source, and configuration files.
28+
29+
"Object" shall mean any form resulting from mechanical
30+
transformation or translation of a Source form, including but
31+
not limited to compiled object code, generated documentation,
32+
and conversions to other media types.
33+
34+
"Work" shall mean the work of authorship, whether in Source or
35+
Object form, made available under the License, as indicated by a
36+
copyright notice that is included in or attached to the work
37+
(which shall not include combinations of the Work with other works).
38+
39+
"Derivative Works" shall mean any work, whether in Source or Object
40+
form, that is based upon (or derived from) the Work and for which the
41+
editorial revisions, annotations, elaborations, or other modifications
42+
represent, as a whole, an original work of authorship. For the purposes
43+
of this License, Derivative Works shall not include works that remain
44+
separable from, or merely link (or bind by name) to the interfaces of,
45+
the Work and derivative works thereof.
46+
47+
"Contribution" shall mean any work of authorship, including
48+
the original version of the Work and any modifications or additions
49+
to that Work or Derivative Works thereof, that is intentionally
50+
submitted to Licensor for inclusion in the Work by the copyright owner
51+
or by an individual or Legal Entity authorized to submit on behalf of
52+
the copyright owner. For the purposes of this definition, "submitted"
53+
means any form of electronic, verbal, or written communication sent
54+
to the Licensor or its representatives, including but not limited to
55+
communication on electronic mailing lists, source code control
56+
systems, and issue tracking systems that are managed by, or on behalf
57+
of, the Licensor for the purpose of discussing and improving the Work,
58+
but excluding communication that is conspicuously marked or otherwise
59+
designated in writing by the copyright owner as "Not a Contribution."
60+
61+
"Contributor" shall mean Licensor and any individual or Legal Entity
62+
on behalf of whom a Contribution has been received by Licensor and
63+
subsequently incorporated within the Work.
64+
65+
2. Grant of Copyright License. Subject to the terms and conditions of
66+
this License, each Contributor hereby grants to You a perpetual,
67+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
68+
copyright license to use, reproduce, modify, distribute, prepare
69+
Derivative Works of, and publicly display the Work and such Derivative
70+
Works in all media and formats whether now known or hereafter devised.
71+
72+
3. Grant of Patent License. Subject to the terms and conditions of
73+
this License, each Contributor hereby grants to You a perpetual,
74+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75+
(except as stated in this section) patent license to make, have made,
76+
use, offer to sell, sell, import, and otherwise transfer the Work,
77+
where such license applies only to those patent claims licensable
78+
by such Contributor that are necessarily infringed by their
79+
Contribution(s) alone or by combination of their Contribution(s)
80+
with the Work to which such Contribution(s) was submitted. If You
81+
institute patent litigation against any entity (including a
82+
cross-claim or counterclaim in a lawsuit) alleging that the Work
83+
or a Contribution incorporated within the Work constitutes direct
84+
or contributory patent infringement, then any patent licenses
85+
granted to You under this License for that Work shall terminate
86+
as of the date such litigation is filed.
87+
88+
4. Redistribution. You may reproduce and distribute copies of the
89+
Work or Derivative Works thereof in any medium, with or without
90+
modifications, and in Source or Object form, provided that You
91+
meet the following conditions:
92+
93+
(a) You must give any other recipients of the Work or
94+
Derivative Works a copy of this License; and
95+
96+
(b) You must cause any modified files to carry prominent notices
97+
stating that You changed the files; and
98+
99+
(c) You must retain, in the Source form of any Derivative Works
100+
that You distribute, all copyright, patent, trademark, and
101+
attribution notices from the Source form of the Work,
102+
excluding those notices that do not pertain to any part of
103+
the Derivative Works; and
104+
105+
(d) If the Work includes a "NOTICE" text file as part of its
106+
distribution, then any Derivative Works that You distribute must
107+
include a readable copy of the attribution notices contained
108+
within such NOTICE file, excluding those notices that do not
109+
pertain to any part of the Derivative Works, in at least one
110+
of the following places: within a NOTICE text file distributed
111+
as part of the Derivative Works; within the Source form or
112+
documentation, if provided along with the Derivative Works; or,
113+
within a display generated by the Derivative Works, if and
114+
wherever such third-party notices normally appear. The contents
115+
of the NOTICE file are for informational purposes only and
116+
do not modify the License. You may add Your own attribution
117+
notices within Derivative Works that You distribute, alongside
118+
or as an addendum to the NOTICE text from the Work, provided
119+
that such additional attribution notices cannot be construed
120+
as modifying the License.
121+
122+
You may add Your own copyright notice to Your modifications and
123+
may provide additional or different license terms and conditions
124+
for use, reproduction, or distribution of Your modifications, or
125+
for any such Derivative Works as a whole, provided Your use,
126+
reproduction, and distribution of the Work otherwise complies with
127+
the conditions stated in this License.
128+
129+
5. Submission of Contributions. Unless You explicitly state otherwise,
130+
any Contribution intentionally submitted for inclusion in the Work
131+
by You to the Licensor shall be under the terms and conditions of
132+
this License, without any additional terms or conditions.
133+
Notwithstanding the above, nothing herein shall supersede or modify
134+
the terms of any separate license agreement you may have executed
135+
with Licensor regarding such Contributions.
136+
137+
6. Trademarks. This License does not grant permission to use the trade
138+
names, trademarks, service marks, or product names of the Licensor,
139+
except as required for reasonable and customary use in describing the
140+
origin of the Work and reproducing the content of the NOTICE file.
141+
142+
7. Disclaimer of Warranty. Unless required by applicable law or
143+
agreed to in writing, Licensor provides the Work (and each
144+
Contributor provides its Contributions) on an "AS IS" BASIS,
145+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
146+
implied, including, without limitation, any warranties or conditions
147+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
148+
PARTICULAR PURPOSE. You are solely responsible for determining the
149+
appropriateness of using or redistributing the Work and assume any
150+
risks associated with Your exercise of permissions under this License.
151+
152+
8. Limitation of Liability. In no event and under no legal theory,
153+
whether in tort (including negligence), contract, or otherwise,
154+
unless required by applicable law (such as deliberate and grossly
155+
negligent acts) or agreed to in writing, shall any Contributor be
156+
liable to You for damages, including any direct, indirect, special,
157+
incidental, or consequential damages of any character arising as a
158+
result of this License or out of the use or inability to use the
159+
Work (including but not limited to damages for loss of goodwill,
160+
work stoppage, computer failure or malfunction, or any and all
161+
other commercial damages or losses), even if such Contributor
162+
has been advised of the possibility of such damages.
163+
164+
9. Accepting Warranty or Support. You are not required to accept
165+
warranty or support for the Work from any Contributor. However,
166+
you may choose to offer and charge a fee for warranty, support,
167+
indemnity or other liability obligations consistent with this
168+
License. When accepting any such obligations on your own behalf
169+
or on behalf of another Contributor, you must obtain the
170+
Contributor's express prior written consent and acknowledge
171+
that the Contributor may be liable to You for any damages
172+
incurred by You as a result of accepting such warranty or support.
173+
174+
END OF TERMS AND CONDITIONS
175+
176+
APPENDIX: How to apply the Apache License to your work.
177+
178+
To apply the Apache License to your work, attach the following
179+
boilerplate notice, with the fields enclosed by brackets "[]"
180+
replaced with your own identifying information. Don't include
181+
the brackets! The text should be enclosed in the appropriate
182+
comment syntax for the file format. We also recommend that a
183+
file or class name and description of purpose be included on the
184+
same "license" line as the copyright notice for easier
185+
identification within third-party archives.
186+
187+
Copyright [yyyy] [name of copyright owner]
188+
189+
Licensed under the Apache License, Version 2.0 (the "License");
190+
you may not use this file except in compliance with the License.
191+
You may obtain a copy of the License at
192+
193+
http://www.apache.org/licenses/LICENSE-2.0
194+
195+
Unless required by applicable law or agreed to in writing, software
196+
distributed under the License is distributed on an "AS IS" BASIS,
197+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
198+
See the License for the specific language governing permissions and
199+
limitations under the License.

go.mod

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ require (
2525
github.com/minio/sha256-simd v1.0.1
2626
github.com/open-telemetry/sig-profiling/tools/profcheck v0.0.0-20260303084341-52f633d434c9
2727
github.com/parca-dev/oomprof v0.1.6
28+
github.com/parca-dev/usdt v0.0.2
2829
github.com/peterbourgon/ff/v3 v3.4.0
2930
github.com/sirupsen/logrus v1.9.4
3031
github.com/stretchr/testify v1.11.1

go.sum

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,8 @@ github.com/opencontainers/runtime-spec v1.2.0 h1:z97+pHb3uELt/yiAWD691HNHQIF07bE
196196
github.com/opencontainers/runtime-spec v1.2.0/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0=
197197
github.com/parca-dev/oomprof v0.1.6 h1:potfd09aphNKqsIF54ZsiddTvksVMjQiaKnczFOsVGM=
198198
github.com/parca-dev/oomprof v0.1.6/go.mod h1:iqI6XrmiNWOa8m2vEIKo+GtQrqbWCMLFpBWuk8RuAPs=
199+
github.com/parca-dev/usdt v0.0.2 h1:bpKQycQ++zV8pwkMaJSxZS07XnEXqO3rkHcLYFJDTl4=
200+
github.com/parca-dev/usdt v0.0.2/go.mod h1:bjh3OTksk+pyP7WsHWlRKWaMSJTUr0gx0piZ/tAv6/w=
199201
github.com/peterbourgon/ff/v3 v3.4.0 h1:QBvM/rizZM1cB0p0lGMdmR7HxZeI/ZrBWB4DqLkMUBc=
200202
github.com/peterbourgon/ff/v3 v3.4.0/go.mod h1:zjJVUhx+twciwfDl0zBcFzl4dW8axCRyXE/eKY9RztQ=
201203
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=

libpf/pfelf/usdt.go

Lines changed: 41 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -4,139 +4,57 @@
44
package pfelf // import "go.opentelemetry.io/ebpf-profiler/libpf/pfelf"
55

66
import (
7-
"encoding/binary"
8-
"strings"
9-
)
10-
11-
// USDTProbe represents a USDT probe found in ELF with file-offset-adjusted addresses
12-
type USDTProbe struct {
13-
Provider string
14-
Name string
15-
Location uint64 // File offset for uprobe attachment
16-
Base uint64 // Original base address from note
17-
SemaphoreOffset uint64 // File offset for semaphore
18-
Arguments string
19-
}
7+
"debug/elf"
208

21-
// ParseUSDTProbes reads USDT probe information from ELF .note.stapsdt section.
22-
// It applies prelink adjustments if .stapsdt.base section exists, and converts
23-
// virtual addresses to file offsets suitable for uprobe attachment.
24-
func (f *File) ParseUSDTProbes() ([]USDTProbe, error) {
25-
// LoadSections populates f.Sections from section headers.
26-
// It is idempotent and required for the .note.stapsdt lookup below.
27-
if err := f.LoadSections(); err != nil {
28-
return nil, err
29-
}
9+
"github.com/parca-dev/usdt"
10+
)
3011

31-
var probes []USDTProbe
12+
// USDTProbe is an alias for usdt.Probe for backwards compatibility.
13+
type USDTProbe = usdt.Probe
3214

33-
// Find .note.stapsdt section
34-
var stapsdt *Section
35-
for i := range f.Sections {
36-
if f.Sections[i].Name == ".note.stapsdt" {
37-
stapsdt = &f.Sections[i]
38-
break
39-
}
40-
}
41-
if stapsdt == nil {
42-
return nil, nil // No USDT probes in this binary
43-
}
15+
// pfelfELFReader adapts pfelf.File to the usdt.ELFReader interface.
16+
type pfelfELFReader struct {
17+
f *File
18+
}
4419

45-
data, err := stapsdt.Data(16 * 1024)
46-
if err != nil {
20+
func (r *pfelfELFReader) Sections() ([]usdt.ELFSection, error) {
21+
if err := r.f.LoadSections(); err != nil {
4722
return nil, err
4823
}
49-
50-
// Find .stapsdt.base section address for prelink adjustment
51-
var baseAddr uint64
52-
for i := range f.Sections {
53-
if f.Sections[i].Name == ".stapsdt.base" {
54-
baseAddr = f.Sections[i].Addr
55-
break
56-
}
57-
}
58-
59-
// Parse note entries
60-
offset := 0
61-
for offset < len(data) {
62-
if offset+12 > len(data) {
63-
break
64-
}
65-
66-
// Note header: namesz(4) + descsz(4) + type(4)
67-
namesz := binary.LittleEndian.Uint32(data[offset : offset+4])
68-
descsz := binary.LittleEndian.Uint32(data[offset+4 : offset+8])
69-
noteType := binary.LittleEndian.Uint32(data[offset+8 : offset+12])
70-
offset += 12
71-
72-
if noteType != 3 { // NT_STAPSDT
73-
// Skip this note
74-
nameEnd := offset + int((namesz+3)&^3) // align to 4 bytes
75-
descEnd := nameEnd + int((descsz+3)&^3)
76-
offset = descEnd
77-
continue
78-
}
79-
80-
// Skip owner name (should be "stapsdt")
81-
nameEnd := offset + int((namesz+3)&^3)
82-
83-
if nameEnd+int(descsz) > len(data) {
84-
break
85-
}
86-
87-
// Parse descriptor
88-
desc := data[nameEnd : nameEnd+int(descsz)]
89-
if len(desc) < 24 { // 3 uint64 values
90-
offset = nameEnd + int((descsz+3)&^3)
91-
continue
92-
}
93-
94-
location := binary.LittleEndian.Uint64(desc[0:8])
95-
noteBase := binary.LittleEndian.Uint64(desc[8:16])
96-
semaphore := binary.LittleEndian.Uint64(desc[16:24])
97-
98-
// Apply prelink adjustment if .stapsdt.base section exists
99-
// See: https://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation
100-
if baseAddr != 0 && noteBase != 0 {
101-
diff := baseAddr - noteBase
102-
location += diff
103-
if semaphore != 0 {
104-
semaphore += diff
105-
}
106-
}
107-
108-
// Convert virtual address to file offset for uprobe attachment
109-
prog := f.findVirtualAddressProg(location)
110-
if prog != nil {
111-
location = location - prog.Vaddr + prog.Off
112-
}
113-
114-
// Convert semaphore virtual address to file offset
115-
var semaphoreFileOffset uint64
116-
if semaphore != 0 {
117-
semaProg := f.findVirtualAddressProg(semaphore)
118-
if semaProg != nil {
119-
semaphoreFileOffset = semaphore - semaProg.Vaddr + semaProg.Off
24+
sections := make([]usdt.ELFSection, len(r.f.Sections))
25+
for i, s := range r.f.Sections {
26+
sections[i] = usdt.ELFSection{
27+
Name: s.Name,
28+
Addr: s.Addr,
29+
}
30+
// Only read data for sections the parser needs
31+
if s.Name == ".note.stapsdt" || s.Name == ".stapsdt.base" {
32+
data, err := s.Data(16 * 1024)
33+
if err != nil {
34+
return nil, err
12035
}
36+
sections[i].Data = data
12137
}
38+
}
39+
return sections, nil
40+
}
12241

123-
// Parse strings: provider\0probe\0arguments\0
124-
stringData := desc[24:]
125-
strings := strings.Split(string(stringData), "\x00")
126-
if len(strings) >= 3 {
127-
probe := USDTProbe{
128-
Provider: strings[0],
129-
Name: strings[1],
130-
Location: location,
131-
Base: noteBase,
132-
SemaphoreOffset: semaphoreFileOffset,
133-
Arguments: strings[2],
134-
}
135-
probes = append(probes, probe)
42+
func (r *pfelfELFReader) LoadSegments() []usdt.ELFProg {
43+
var segs []usdt.ELFProg
44+
for _, p := range r.f.Progs {
45+
if elf.ProgType(p.Type) == elf.PT_LOAD {
46+
segs = append(segs, usdt.ELFProg{
47+
Vaddr: p.Vaddr,
48+
Memsz: p.Memsz,
49+
Off: p.Off,
50+
})
13651
}
137-
138-
offset = nameEnd + int((descsz+3)&^3)
13952
}
53+
return segs
54+
}
14055

141-
return probes, nil
56+
// ParseUSDTProbes reads USDT probe information from ELF .note.stapsdt section.
57+
// It delegates to the usdt package via the pfelf adapter.
58+
func (f *File) ParseUSDTProbes() ([]usdt.Probe, error) {
59+
return usdt.ParseProbes(&pfelfELFReader{f: f})
14260
}

0 commit comments

Comments
 (0)