1// Copyright 2018 The Prometheus Authors
2// Licensed under the Apache License, Version 2.0 (the "License");
3// you may not use this file except in compliance with the License.
4// You may obtain a copy of the License at
5//
6// http://www.apache.org/licenses/LICENSE-2.0
7//
8// Unless required by applicable law or agreed to in writing, software
9// distributed under the License is distributed on an "AS IS" BASIS,
10// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11// See the License for the specific language governing permissions and
12// limitations under the License.
13
14package procfs
15
16import (
17	"bytes"
18	"strconv"
19	"strings"
20
21	"github.com/prometheus/procfs/internal/util"
22)
23
24// ProcStatus provides status information about the process,
25// read from /proc/[pid]/stat.
26type ProcStatus struct {
27	// The process ID.
28	PID int
29	// The process name.
30	Name string
31
32	// Thread group ID.
33	TGID int
34
35	// Peak virtual memory size.
36	VmPeak uint64
37	// Virtual memory size.
38	VmSize uint64
39	// Locked memory size.
40	VmLck uint64
41	// Pinned memory size.
42	VmPin uint64
43	// Peak resident set size.
44	VmHWM uint64
45	// Resident set size (sum of RssAnnon RssFile and RssShmem).
46	VmRSS uint64
47	// Size of resident anonymous memory.
48	RssAnon uint64
49	// Size of resident file mappings.
50	RssFile uint64
51	// Size of resident shared memory.
52	RssShmem uint64
53	// Size of data segments.
54	VmData uint64
55	// Size of stack segments.
56	VmStk uint64
57	// Size of text segments.
58	VmExe uint64
59	// Shared library code size.
60	VmLib uint64
61	// Page table entries size.
62	VmPTE uint64
63	// Size of second-level page tables.
64	VmPMD uint64
65	// Swapped-out virtual memory size by anonymous private.
66	VmSwap uint64
67	// Size of hugetlb memory portions
68	HugetlbPages uint64
69
70	// Number of voluntary context switches.
71	VoluntaryCtxtSwitches uint64
72	// Number of involuntary context switches.
73	NonVoluntaryCtxtSwitches uint64
74}
75
76// NewStatus returns the current status information of the process.
77func (p Proc) NewStatus() (ProcStatus, error) {
78	data, err := util.ReadFileNoStat(p.path("status"))
79	if err != nil {
80		return ProcStatus{}, err
81	}
82
83	s := ProcStatus{PID: p.PID}
84
85	lines := strings.Split(string(data), "\n")
86	for _, line := range lines {
87		if !bytes.Contains([]byte(line), []byte(":")) {
88			continue
89		}
90
91		kv := strings.SplitN(line, ":", 2)
92
93		// removes spaces
94		k := string(strings.TrimSpace(kv[0]))
95		v := string(strings.TrimSpace(kv[1]))
96		// removes "kB"
97		v = string(bytes.Trim([]byte(v), " kB"))
98
99		// value to int when possible
100		// we can skip error check here, 'cause vKBytes is not used when value is a string
101		vKBytes, _ := strconv.ParseUint(v, 10, 64)
102		// convert kB to B
103		vBytes := vKBytes * 1024
104
105		s.fillStatus(k, v, vKBytes, vBytes)
106	}
107
108	return s, nil
109}
110
111func (s *ProcStatus) fillStatus(k string, vString string, vUint uint64, vUintBytes uint64) {
112	switch k {
113	case "Tgid":
114		s.TGID = int(vUint)
115	case "Name":
116		s.Name = vString
117	case "VmPeak":
118		s.VmPeak = vUintBytes
119	case "VmSize":
120		s.VmSize = vUintBytes
121	case "VmLck":
122		s.VmLck = vUintBytes
123	case "VmPin":
124		s.VmPin = vUintBytes
125	case "VmHWM":
126		s.VmHWM = vUintBytes
127	case "VmRSS":
128		s.VmRSS = vUintBytes
129	case "RssAnon":
130		s.RssAnon = vUintBytes
131	case "RssFile":
132		s.RssFile = vUintBytes
133	case "RssShmem":
134		s.RssShmem = vUintBytes
135	case "VmData":
136		s.VmData = vUintBytes
137	case "VmStk":
138		s.VmStk = vUintBytes
139	case "VmExe":
140		s.VmExe = vUintBytes
141	case "VmLib":
142		s.VmLib = vUintBytes
143	case "VmPTE":
144		s.VmPTE = vUintBytes
145	case "VmPMD":
146		s.VmPMD = vUintBytes
147	case "VmSwap":
148		s.VmSwap = vUintBytes
149	case "HugetlbPages":
150		s.HugetlbPages = vUintBytes
151	case "voluntary_ctxt_switches":
152		s.VoluntaryCtxtSwitches = vUint
153	case "nonvoluntary_ctxt_switches":
154		s.NonVoluntaryCtxtSwitches = vUint
155	}
156}
157
158// TotalCtxtSwitches returns the total context switch.
159func (s ProcStatus) TotalCtxtSwitches() uint64 {
160	return s.VoluntaryCtxtSwitches + s.NonVoluntaryCtxtSwitches
161}
162