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 // nolint:golint
37	// Virtual memory size.
38	VmSize uint64 // nolint:golint
39	// Locked memory size.
40	VmLck uint64 // nolint:golint
41	// Pinned memory size.
42	VmPin uint64 // nolint:golint
43	// Peak resident set size.
44	VmHWM uint64 // nolint:golint
45	// Resident set size (sum of RssAnnon RssFile and RssShmem).
46	VmRSS uint64 // nolint:golint
47	// Size of resident anonymous memory.
48	RssAnon uint64 // nolint:golint
49	// Size of resident file mappings.
50	RssFile uint64 // nolint:golint
51	// Size of resident shared memory.
52	RssShmem uint64 // nolint:golint
53	// Size of data segments.
54	VmData uint64 // nolint:golint
55	// Size of stack segments.
56	VmStk uint64 // nolint:golint
57	// Size of text segments.
58	VmExe uint64 // nolint:golint
59	// Shared library code size.
60	VmLib uint64 // nolint:golint
61	// Page table entries size.
62	VmPTE uint64 // nolint:golint
63	// Size of second-level page tables.
64	VmPMD uint64 // nolint:golint
65	// Swapped-out virtual memory size by anonymous private.
66	VmSwap uint64 // nolint:golint
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	// UIDs of the process (Real, effective, saved set, and filesystem UIDs)
76	UIDs [4]string
77	// GIDs of the process (Real, effective, saved set, and filesystem GIDs)
78	GIDs [4]string
79}
80
81// NewStatus returns the current status information of the process.
82func (p Proc) NewStatus() (ProcStatus, error) {
83	data, err := util.ReadFileNoStat(p.path("status"))
84	if err != nil {
85		return ProcStatus{}, err
86	}
87
88	s := ProcStatus{PID: p.PID}
89
90	lines := strings.Split(string(data), "\n")
91	for _, line := range lines {
92		if !bytes.Contains([]byte(line), []byte(":")) {
93			continue
94		}
95
96		kv := strings.SplitN(line, ":", 2)
97
98		// removes spaces
99		k := string(strings.TrimSpace(kv[0]))
100		v := string(strings.TrimSpace(kv[1]))
101		// removes "kB"
102		v = string(bytes.Trim([]byte(v), " kB"))
103
104		// value to int when possible
105		// we can skip error check here, 'cause vKBytes is not used when value is a string
106		vKBytes, _ := strconv.ParseUint(v, 10, 64)
107		// convert kB to B
108		vBytes := vKBytes * 1024
109
110		s.fillStatus(k, v, vKBytes, vBytes)
111	}
112
113	return s, nil
114}
115
116func (s *ProcStatus) fillStatus(k string, vString string, vUint uint64, vUintBytes uint64) {
117	switch k {
118	case "Tgid":
119		s.TGID = int(vUint)
120	case "Name":
121		s.Name = vString
122	case "Uid":
123		copy(s.UIDs[:], strings.Split(vString, "\t"))
124	case "Gid":
125		copy(s.GIDs[:], strings.Split(vString, "\t"))
126	case "VmPeak":
127		s.VmPeak = vUintBytes
128	case "VmSize":
129		s.VmSize = vUintBytes
130	case "VmLck":
131		s.VmLck = vUintBytes
132	case "VmPin":
133		s.VmPin = vUintBytes
134	case "VmHWM":
135		s.VmHWM = vUintBytes
136	case "VmRSS":
137		s.VmRSS = vUintBytes
138	case "RssAnon":
139		s.RssAnon = vUintBytes
140	case "RssFile":
141		s.RssFile = vUintBytes
142	case "RssShmem":
143		s.RssShmem = vUintBytes
144	case "VmData":
145		s.VmData = vUintBytes
146	case "VmStk":
147		s.VmStk = vUintBytes
148	case "VmExe":
149		s.VmExe = vUintBytes
150	case "VmLib":
151		s.VmLib = vUintBytes
152	case "VmPTE":
153		s.VmPTE = vUintBytes
154	case "VmPMD":
155		s.VmPMD = vUintBytes
156	case "VmSwap":
157		s.VmSwap = vUintBytes
158	case "HugetlbPages":
159		s.HugetlbPages = vUintBytes
160	case "voluntary_ctxt_switches":
161		s.VoluntaryCtxtSwitches = vUint
162	case "nonvoluntary_ctxt_switches":
163		s.NonVoluntaryCtxtSwitches = vUint
164	}
165}
166
167// TotalCtxtSwitches returns the total context switch.
168func (s ProcStatus) TotalCtxtSwitches() uint64 {
169	return s.VoluntaryCtxtSwitches + s.NonVoluntaryCtxtSwitches
170}
171