chore: give breath to the code putting spaces

This adds spaces to the code to make it more readable.

This also puts RingBuffer.Stop() and PerfBuffer.Stop() happy path
out of the branching logic.

Author: geyslan

buf-perf.go

@@ -41,45 +41,48 @@ func (pb *PerfBuffer) Start() {
 }
 
 func (pb *PerfBuffer) Stop() {
-	if pb.stop != nil {
-		// Tell the poll goroutine that it's time to exit
-		close(pb.stop)
-
-		// The event and lost channels should be drained here since the consumer
-		// may have stopped at this point. Failure to drain it will
-		// result in a deadlock: the channel will fill up and the poll
-		// goroutine will block in the callback.
-		go func() {
-			// revive:disable:empty-block
-			for range pb.eventsChan {
-			}
+	if pb.stop == nil {
+		return
+	}
 
-			if pb.lostChan != nil {
-				for range pb.lostChan {
-				}
-			}
-			// revive:enable:empty-block
-		}()
+	// Signal the poll goroutine to exit
+	close(pb.stop)
 
-		// Wait for the poll goroutine to exit
-		pb.wg.Wait()
+	// The event and lost channels should be drained here since the consumer
+	// may have stopped at this point. Failure to drain it will
+	// result in a deadlock: the channel will fill up and the poll
+	// goroutine will block in the callback.
+	go func() {
+		// revive:disable:empty-block
+		for range pb.eventsChan {
+		}
 
-		// Close the channel -- this is useful for the consumer but
-		// also to terminate the drain goroutine above.
-		close(pb.eventsChan)
 		if pb.lostChan != nil {
-			close(pb.lostChan)
+			for range pb.lostChan {
+			}
 		}
+		// revive:enable:empty-block
+	}()
+
+	// Wait for the poll goroutine to exit
+	pb.wg.Wait()
 
-		// This allows Stop() to be called multiple times safely
-		pb.stop = nil
+	// Close the channel -- this is useful for the consumer but
+	// also to terminate the drain goroutine above.
+	close(pb.eventsChan)
+	if pb.lostChan != nil {
+		close(pb.lostChan)
 	}
+
+	// Reset pb.stop to allow multiple safe calls to Stop()
+	pb.stop = nil
 }
 
 func (pb *PerfBuffer) Close() {
 	if pb.closed {
 		return
 	}
+
 	pb.Stop()
 	C.perf_buffer__free(pb.pb)
 	eventChannels.remove(pb.slot)
@@ -101,6 +104,7 @@ func (pb *PerfBuffer) poll(timeout int) error {
 				if errno == syscall.EINTR {
 					continue
 				}
+
 				return fmt.Errorf("error polling perf buffer: %w", errno)
 			}
 		}

buf-ring.go

@@ -39,38 +39,41 @@ func (rb *RingBuffer) Start() {
 }
 
 func (rb *RingBuffer) Stop() {
-	if rb.stop != nil {
-		// Tell the poll goroutine that it's time to exit
-		close(rb.stop)
-
-		// The event channel should be drained here since the consumer
-		// may have stopped at this point. Failure to drain it will
-		// result in a deadlock: the channel will fill up and the poll
-		// goroutine will block in the callback.
-		eventChan := eventChannels.get(rb.slot).(chan []byte)
-		go func() {
-			// revive:disable:empty-block
-			for range eventChan {
-			}
-			// revive:enable:empty-block
-		}()
+	if rb.stop == nil {
+		return
+	}
 
-		// Wait for the poll goroutine to exit
-		rb.wg.Wait()
+	// Signal the poll goroutine to exit
+	close(rb.stop)
+
+	// The event channel should be drained here since the consumer
+	// may have stopped at this point. Failure to drain it will
+	// result in a deadlock: the channel will fill up and the poll
+	// goroutine will block in the callback.
+	eventChan := eventChannels.get(rb.slot).(chan []byte)
+	go func() {
+		// revive:disable:empty-block
+		for range eventChan {
+		}
+		// revive:enable:empty-block
+	}()
 
-		// Close the channel -- this is useful for the consumer but
-		// also to terminate the drain goroutine above.
-		close(eventChan)
+	// Wait for the poll goroutine to exit
+	rb.wg.Wait()
 
-		// This allows Stop() to be called multiple times safely
-		rb.stop = nil
-	}
+	// Close the channel -- this is useful for the consumer but
+	// also to terminate the drain goroutine above.
+	close(eventChan)
+
+	// Reset pb.stop to allow multiple safe calls to Stop()
+	rb.stop = nil
 }
 
 func (rb *RingBuffer) Close() {
 	if rb.closed {
 		return
 	}
+
 	rb.Stop()
 	C.ring_buffer__free(rb.rb)
 	eventChannels.remove(rb.slot)
@@ -100,8 +103,10 @@ func (rb *RingBuffer) poll(timeout int) error {
 			if errno == syscall.EINTR {
 				continue
 			}
+
 			return fmt.Errorf("error polling ring buffer: %w", errno)
 		}
 	}
+
 	return nil
 }

elf.go

@@ -57,5 +57,6 @@ func isGlobalVariableSection(sectionName string) bool {
 		strings.HasPrefix(sectionName, ".rodata.") {
 		return true
 	}
+
 	return false
 }

libbpf_cb.go

@@ -28,6 +28,7 @@ func perfLostCallback(ctx unsafe.Pointer, cpu C.int, cnt C.ulonglong) {
 func ringbufferCallback(ctx unsafe.Pointer, data unsafe.Pointer, size C.int) C.int {
 	ch := eventChannels.get(uint(uintptr(ctx))).(chan []byte)
 	ch <- C.GoBytes(data, size)
+
 	return C.int(0)
 }
 

libbpfgo.go

@@ -65,6 +65,7 @@ func (b LibbpfStrictMode) String() (str string) {
 	if !ok {
 		str = LibbpfStrictModeNone.String()
 	}
+
 	return str
 }
 
@@ -82,6 +83,7 @@ func BPFProgramTypeIsSupported(progType BPFProgType) (bool, error) {
 	if supportedC < 1 {
 		return false, syscall.Errno(-supportedC)
 	}
+
 	return supportedC == 1, nil
 }
 
@@ -90,6 +92,7 @@ func BPFMapTypeIsSupported(mapType MapType) (bool, error) {
 	if supportedC < 1 {
 		return false, syscall.Errno(-supportedC)
 	}
+
 	return supportedC == 1, nil
 }
 
@@ -102,5 +105,6 @@ func NumPossibleCPUs() (int, error) {
 	if nCPUsC < 0 {
 		return 0, fmt.Errorf("failed to retrieve the number of CPUs: %w", syscall.Errno(-nCPUsC))
 	}
+
 	return int(nCPUsC), nil
 }

link.go

@@ -60,6 +60,7 @@ func (l *BPFLink) DestroyLegacy(linkType LinkType) error {
 			l.legacy.attachType,
 		)
 	}
+
 	return fmt.Errorf("unable to destroy legacy link")
 }
 
@@ -70,7 +71,9 @@ func (l *BPFLink) Destroy() error {
 	if retC := C.bpf_link__destroy(l.link); retC < 0 {
 		return syscall.Errno(-retC)
 	}
+
 	l.link = nil
+
 	return nil
 }
 
@@ -91,6 +94,7 @@ func (l *BPFLink) Pin(pinPath string) error {
 	if retC < 0 {
 		return fmt.Errorf("failed to pin link %s to path %s: %w", l.eventName, pinPath, syscall.Errno(-retC))
 	}
+
 	return nil
 }
 
@@ -99,6 +103,7 @@ func (l *BPFLink) Unpin() error {
 	if retC < 0 {
 		return fmt.Errorf("failed to unpin link %s: %w", l.eventName, syscall.Errno(-retC))
 	}
+
 	return nil
 }
 
@@ -111,6 +116,7 @@ func (l *BPFLink) Reader() (*BPFLinkReader, error) {
 	if fdC < 0 {
 		return nil, fmt.Errorf("failed to create reader: %w", syscall.Errno(-fdC))
 	}
+
 	return &BPFLinkReader{
 		l:  l,
 		fd: int(fdC),

module-iterator.go

@@ -72,6 +72,8 @@ func (it *BPFObjectIterator) NextProgram() *BPFProg {
 		prog:   progC,
 		module: it.m,
 	}
+
 	it.prevProg = prog
+
 	return prog
 }

module.go

@@ -349,6 +349,7 @@ func (m *Module) InitPerfBuf(mapName string, eventsChan chan []byte, lostChan ch
 	if err != nil {
 		return nil, fmt.Errorf("failed to init perf buffer: %v", err)
 	}
+
 	if eventsChan == nil {
 		return nil, fmt.Errorf("failed to init perf buffer: events channel can not be nil")
 	}