File: helper.go

package info (click to toggle)
golang-github-juju-loggo 2.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 260 kB
  • sloc: makefile: 10
file content (63 lines) | stat: -rw-r--r-- 1,316 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Copyright 2025 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.

package loggo

import (
	"runtime"
	"sync"
)

var (
	helperMutex sync.RWMutex
	helpers     map[uintptr]struct{}
)

// Helper passed 1 marks the caller as a helper function and will skip it when
// capturing the callsite location.
func Helper(skip int) {
	helper(skip + 1)
}

func helper(skip int) {
	callers := [1]uintptr{}
	if runtime.Callers(skip+2, callers[:]) == 0 {
		panic("failed to get caller information")
	}
	pc := callers[0]
	helperMutex.RLock()
	if _, ok := helpers[pc]; ok {
		helperMutex.RUnlock()
		return
	}
	helperMutex.RUnlock()
	helperMutex.Lock()
	defer helperMutex.Unlock()
	if helpers == nil {
		helpers = make(map[uintptr]struct{})
	}
	helpers[pc] = struct{}{}
}

// caller behaves like runtime.Caller but skips functions marked by helper.
func caller(skip int) (uintptr, string, int, bool) {
	pc := [8]uintptr{}
	n := runtime.Callers(skip+2, pc[:])
	if n == 0 {
		return 0, "", 0, false
	}
	helperMutex.RLock()
	pcs := pc[:]
	for i := n - 1; i >= 0; i-- {
		if _, ok := helpers[pc[i]]; ok {
			pcs = pc[i:]
			break
		}
	}
	helperMutex.RUnlock()
	frames := runtime.CallersFrames(pcs)
	if frame, ok := frames.Next(); ok {
		return frame.PC, frame.File, frame.Line, true
	}
	return 0, "", 0, false
}