mirror of
				https://github.com/torvalds/linux.git
				synced 2025-11-04 02:30:34 +02:00 
			
		
		
		
	Documentation/rtla: Include BPF sample collection
Add dependencies needed to build rtla with BPF sample collection support to README, and document both ways of sample collection in the manpages. Signed-off-by: Tomas Glozar <tglozar@redhat.com> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org> Reviewed-by: Luis Claudio R. Goncalves <lgoncalv@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250311114936.148012-5-tglozar@redhat.com
This commit is contained in:
		
							parent
							
								
									e7d3b24e34
								
							
						
					
					
						commit
						770840a0e7
					
				
					 2 changed files with 15 additions and 0 deletions
				
			
		| 
						 | 
				
			
			@ -8,3 +8,11 @@ The *timerlat* tracer outputs information in two ways. It periodically
 | 
			
		|||
prints the timer latency at the timer *IRQ* handler and the *Thread*
 | 
			
		||||
handler. It also enables the trace of the most relevant information via
 | 
			
		||||
**osnoise:** tracepoints.
 | 
			
		||||
 | 
			
		||||
The **rtla timerlat** tool sets the options of the *timerlat* tracer
 | 
			
		||||
and collects and displays a summary of the results. By default,
 | 
			
		||||
the collection is done synchronously in kernel space using a dedicated
 | 
			
		||||
BPF program attached to the *timerlat* tracer. If either BPF or
 | 
			
		||||
the **osnoise:timerlat_sample** tracepoint it attaches to is
 | 
			
		||||
unavailable, the **rtla timerlat** tool falls back to using tracefs to
 | 
			
		||||
process the data asynchronously in user space.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -13,6 +13,13 @@ RTLA depends on the following libraries and tools:
 | 
			
		|||
 - libtraceevent
 | 
			
		||||
 - libcpupower (optional, for --deepest-idle-state)
 | 
			
		||||
 | 
			
		||||
For BPF sample collection support, the following extra dependencies are
 | 
			
		||||
required:
 | 
			
		||||
 | 
			
		||||
 - libbpf 1.0.0 or later
 | 
			
		||||
 - bpftool with skeleton support
 | 
			
		||||
 - clang with BPF CO-RE support
 | 
			
		||||
 | 
			
		||||
It also depends on python3-docutils to compile man pages.
 | 
			
		||||
 | 
			
		||||
For development, we suggest the following steps for compiling rtla:
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in a new issue