weave-scope/probe/process/walker_linux.go

package process

import (
	"bytes"
	"encoding/binary"
	"errors"
	"fmt"
	"os"
	"path"
	"strconv"
	"strings"

	linuxproc "github.com/c9s/goprocinfo/linux"
	"github.com/coocood/freecache"

	"github.com/weaveworks/common/fs"
	"github.com/weaveworks/scope/probe/host"
)

type walker struct {
	procRoot                 string
	gatheringWaitingInAccept bool
}

var (
	// limitsCache caches /proc/<pid>/limits
	// key: filename in /proc. Example: "42"
	// value: max open files (soft limit) stored in a [8]byte (uint64, little endian)
	limitsCache = freecache.NewCache(1024 * 16)

	// cmdlineCache caches /proc/<pid>/cmdline and /proc/<pid>/name
	// key: filename in /proc. Example: "42"
	// value: two strings separated by a '\0'
	cmdlineCache = freecache.NewCache(1024 * 16)

	errDeadProcess = errors.New("The process is dead")
)

const (
	limitsCacheTimeout  = 60
	cmdlineCacheTimeout = 60
)

// NewWalker creates a new process Walker.
func NewWalker(procRoot string, gatheringWaitingInAccept bool) Walker {
	return &walker{
		procRoot:                 procRoot,
		gatheringWaitingInAccept: gatheringWaitingInAccept,
	}
}

// skipNSpaces skips nSpaces in buf and updates the cursor 'pos'
func skipNSpaces(buf *[]byte, pos *int, nSpaces int) {
	for spaceCount := 0; *pos < len(*buf) && spaceCount < nSpaces; *pos++ {
		if (*buf)[*pos] == ' ' {
			spaceCount++
		}
	}
}

// parseUint64WithSpaces is similar to strconv.ParseUint64 but stops parsing
// when reading a space instead of returning an error
func parseUint64WithSpaces(buf *[]byte, pos *int) (ret uint64) {
	for ; *pos < len(*buf) && (*buf)[*pos] != ' '; *pos++ {
		ret = ret*10 + uint64((*buf)[*pos]-'0')
	}
	return
}

// parseIntWithSpaces is similar to strconv.ParseInt but stops parsing when
// reading a space instead of returning an error
func parseIntWithSpaces(buf *[]byte, pos *int) (ret int) {
	return int(parseUint64WithSpaces(buf, pos))
}

// readStats reads and parses '/proc/<pid>/stat' files
func readStats(path string) (ppid, threads int, jiffies, rss, rssLimit uint64, err error) {
	const (
		// /proc/<pid>/stat field positions, counting from zero
		// see "man 5 proc"
		procStatFieldState       int = 2
		procStatFieldPpid        int = 3
		procStatFieldUserJiffies int = 13
		procStatFieldSysJiffies  int = 14
		procStatFieldThreads     int = 19
		procStatFieldRssPages    int = 23
		procStatFieldRssLimit    int = 24
	)
	var (
		buf                               []byte
		userJiffies, sysJiffies, rssPages uint64
	)
	buf, err = fs.ReadFile(path)
	if err != nil {
		return
	}

	// Parse the file without using expensive extra string allocations

	pos := 0
	skipNSpaces(&buf, &pos, procStatFieldState)

	// Error on processes which are in zombie (defunct) or dead state, so they will be skipped
	switch buf[pos] {
	case 'Z', 'X', 'x':
		err = errDeadProcess
		return
	}

	pos += 2 // Move past state and space after state
	ppid = parseIntWithSpaces(&buf, &pos)

	skipNSpaces(&buf, &pos, procStatFieldUserJiffies-procStatFieldPpid)
	userJiffies = parseUint64WithSpaces(&buf, &pos)

	pos++ // 1 space between userJiffies and sysJiffies
	sysJiffies = parseUint64WithSpaces(&buf, &pos)

	skipNSpaces(&buf, &pos, procStatFieldThreads-procStatFieldSysJiffies)
	threads = parseIntWithSpaces(&buf, &pos)

	skipNSpaces(&buf, &pos, procStatFieldRssPages-procStatFieldThreads)
	rssPages = parseUint64WithSpaces(&buf, &pos)

	pos++ // 1 space between rssPages and rssLimit
	rssLimit = parseUint64WithSpaces(&buf, &pos)

	jiffies = userJiffies + sysJiffies
	rss = rssPages * uint64(os.Getpagesize())
	return
}

func readLimits(path string) (openFilesLimit uint64, err error) {
	buf, err := fs.ReadFile(path)
	if err != nil {
		return 0, err
	}
	content := string(buf)

	// File format: one line header + one line per limit
	//
	// Limit                     Soft Limit           Hard Limit           Units
	// ...
	// Max open files            1024                 4096                 files
	// ...
	delim := "\nMax open files"
	pos := strings.Index(content, delim)

	if pos < 0 {
		// Tests such as TestWalker can synthetise empty files
		return 0, nil
	}
	pos += len(delim)

	for pos < len(content) && content[pos] == ' ' {
		pos++
	}

	var softLimit uint64
	softLimit = parseUint64WithSpaces(&buf, &pos)

	return softLimit, nil
}

func (w *walker) readCmdline(filename string) (cmdline, name string) {
	if cmdlineBuf, err := fs.ReadFile(path.Join(w.procRoot, filename, "cmdline")); err == nil {
		// like proc, treat name as the first element of command line
		i := bytes.IndexByte(cmdlineBuf, '\000')
		if i == -1 {
			i = len(cmdlineBuf)
		}
		name = string(cmdlineBuf[:i])
		cmdlineBuf = bytes.Replace(cmdlineBuf, []byte{'\000'}, []byte{' '}, -1)
		cmdline = string(cmdlineBuf)
	}
	if name == "" {
		if commBuf, err := fs.ReadFile(path.Join(w.procRoot, filename, "comm")); err == nil {
			name = "[" + strings.TrimSpace(string(commBuf)) + "]"
		} else {
			name = "(unknown)"
		}
	}
	return
}

// IsProcInAccept returns true if the process has a at least one thread
// blocked on the accept() system call
func IsProcInAccept(procRoot, pid string) (ret bool) {
	tasks, err := fs.ReadDirNames(path.Join(procRoot, pid, "task"))
	if err != nil {
		// if the process has terminated, it is obviously not blocking
		// on the accept system call
		return false
	}

	for _, tid := range tasks {
		buf, err := fs.ReadFile(path.Join(procRoot, pid, "task", tid, "wchan"))
		if err != nil {
			// if a thread has terminated, it is obviously not
			// blocking on the accept system call
			continue
		}
		if strings.TrimSpace(string(buf)) == "inet_csk_accept" {
			return true
		}
	}
	return false
}

// Walk walks the supplied directory (expecting it to look like /proc)
// and marshalls the files into instances of Process, which it then
// passes one-by-one to the supplied function. Walk is only made public
// so that is can be tested.
func (w *walker) Walk(f func(Process, Process)) error {
	dirEntries, err := fs.ReadDirNames(w.procRoot)
	if err != nil {
		return err
	}

	for _, filename := range dirEntries {
		pid, err := strconv.Atoi(filename)
		if err != nil {
			continue
		}

		ppid, threads, jiffies, rss, rssLimit, err := readStats(path.Join(w.procRoot, filename, "stat"))
		if err != nil {
			continue
		}

		openFilesCount, err := fs.ReadDirCount(path.Join(w.procRoot, filename, "fd"))
		if err != nil {
			continue
		}

		var openFilesLimit uint64
		if v, err := limitsCache.Get([]byte(filename)); err == nil {
			openFilesLimit = binary.LittleEndian.Uint64(v)
		} else {
			openFilesLimit, err = readLimits(path.Join(w.procRoot, filename, "limits"))
			if err != nil {
				continue
			}
			buf := make([]byte, 8)
			binary.LittleEndian.PutUint64(buf, openFilesLimit)
			limitsCache.Set([]byte(filename), buf, limitsCacheTimeout)
		}

		cmdline, name := "", ""
		if v, err := cmdlineCache.Get([]byte(filename)); err == nil {
			separatorPos := strings.Index(string(v), "\x00")
			cmdline = string(v[:separatorPos])
			name = string(v[separatorPos+1:])
		} else {
			cmdline, name = w.readCmdline(filename)
			cmdlineCache.Set([]byte(filename), []byte(fmt.Sprintf("%s\x00%s", cmdline, name)), cmdlineCacheTimeout)
		}

		isWaitingInAccept := false
		if w.gatheringWaitingInAccept {
			isWaitingInAccept = IsProcInAccept(w.procRoot, filename)
		}

		f(Process{
			PID:               pid,
			PPID:              ppid,
			Name:              name,
			Cmdline:           cmdline,
			Threads:           threads,
			Jiffies:           jiffies,
			RSSBytes:          rss,
			RSSBytesLimit:     rssLimit,
			OpenFilesCount:    openFilesCount,
			OpenFilesLimit:    openFilesLimit,
			IsWaitingInAccept: isWaitingInAccept,
		}, Process{})
	}

	return nil
}

var previousStat = linuxproc.CPUStat{}

// GetDeltaTotalJiffies returns the number of jiffies that have passed since it
// was last called.  In that respect, it is side-effect-ful.
func GetDeltaTotalJiffies() (uint64, float64, error) {
	stat, err := linuxproc.ReadStat(host.ProcStat)
	if err != nil {
		return 0, 0.0, err
	}

	var (
		currentStat = stat.CPUStatAll
		prevTotal   = (previousStat.Idle + previousStat.IOWait + previousStat.User +
			previousStat.Nice + previousStat.System + previousStat.IRQ +
			previousStat.SoftIRQ + previousStat.Steal)
		currentTotal = (currentStat.Idle + currentStat.IOWait + currentStat.User +
			currentStat.Nice + currentStat.System + currentStat.IRQ +
			currentStat.SoftIRQ + currentStat.Steal)
	)
	previousStat = currentStat
	return currentTotal - prevTotal, float64(len(stat.CPUStats)) * 100., nil
}