File: json.go

package info (click to toggle)
golang-github-checkpoint-restore-checkpointctl 1.3.0%2Bds1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 628 kB
  • sloc: ansic: 208; makefile: 172; sh: 40
file content (403 lines) | stat: -rw-r--r-- 10,156 bytes parent folder | download | duplicates (2)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
package internal

import (
	"encoding/json"
	"fmt"
	"path/filepath"
	"strings"
	"time"

	"github.com/checkpoint-restore/go-criu/v7/crit"
	spec "github.com/opencontainers/runtime-spec/specs-go"
)

type CheckpointSize struct {
	TotalSize             int64 `json:"total_size,omitempty"`
	MemoryPagesSize       int64 `json:"memory_pages_size,omitempty"`
	AmdGpuMemoryPagesSize int64 `json:"amd_gpu_memory_pages_size,omitempty"`
	RootFsDiffSize        int64 `json:"root_fs_diff_size,omitempty"`
}

type StatsNode struct {
	FreezingTime uint32 `json:"freezing_time,omitempty"`
	FrozenTime   uint32 `json:"frozen_time,omitempty"`
	MemdumpTime  uint32 `json:"memdump_time,omitempty"`
	MemwriteTime uint32 `json:"memwrite_time,omitempty"`
	PagesScanned uint64 `json:"pages_scanned,omitempty"`
	PagesWritten uint64 `json:"pages_written,omitempty"`
}

type PsNode struct {
	PID      uint32            `json:"pid"`
	Comm     string            `json:"command"`
	Cmdline  string            `json:"cmdline,omitempty"`
	EnvVars  map[string]string `json:"environment_variables,omitempty"`
	Children []PsNode          `json:"children,omitempty"`
}

type FdNode struct {
	PID       uint32         `json:"pid"`
	OpenFiles []OpenFileNode `json:"open_files,omitempty"`
}

type OpenFileNode struct {
	Type string `json:"type"`
	FD   string `json:"fd"`
	Path string `json:"path"`
}

type SkNode struct {
	PID         uint32       `json:"pid"`
	OpenSockets []SocketNode `json:"open_sockets,omitempty"`
}

type SkData struct {
	Type       string `json:"type,omitempty"`
	Address    string `json:"address,omitempty"`
	State      string `json:"state,omitempty"`
	Source     string `json:"src,omitempty"`
	SourcePort uint32 `json:"src_port,omitempty"`
	Dest       string `json:"dst,omitempty"`
	DestPort   uint32 `json:"dst_port,omitempty"`
	SendBuf    string `json:"send_buf,omitempty"`
	RecvBuf    string `json:"recv_buf,omitempty"`
}

type SocketNode struct {
	Protocol string `json:"protocol,omitempty"`
	Data     SkData `json:"data,omitempty"`
}

var socketDataFuncs = map[string]func(*crit.Socket) SkData{
	"UNIXSK":    getUnixSkData,
	"INETSK":    getInetSkData,
	"PACKETSK":  getPacketSkData,
	"NETLINKSK": getNetlinkSkData,
}

type DisplayNode struct {
	ContainerName      string         `json:"container_name"`
	Image              string         `json:"image"`
	ID                 string         `json:"id"`
	Runtime            string         `json:"runtime"`
	Created            string         `json:"created"`
	Checkpointed       string         `json:"checkpointed,omitempty"`
	Engine             string         `json:"engine"`
	IP                 string         `json:"ip,omitempty"`
	MAC                string         `json:"mac,omitempty"`
	CheckpointSize     CheckpointSize `json:"checkpoint_size"`
	CriuDumpStatistics *StatsNode     `json:"statistics,omitempty"`
	ProcessTree        *PsNode        `json:"process_tree,omitempty"`
	FileDescriptors    []FdNode       `json:"file_descriptors,omitempty"`
	Sockets            []SkNode       `json:"sockets,omitempty"`
	Mounts             []MountNode    `json:"mounts,omitempty"`
}

type MountNode struct {
	Destination string `json:"destination"`
	Type        string `json:"type"`
	Source      string `json:"source"`
}

func RenderJSONView(tasks []Task) error {
	var result []DisplayNode

	for _, task := range tasks {
		info, err := getCheckpointInfo(task)
		if err != nil {
			return err
		}

		node := DisplayNode{
			ContainerName: info.containerInfo.Name,
			Image:         info.configDump.RootfsImageName,
			ID:            info.configDump.ID,
			Runtime:       info.configDump.OCIRuntime,
			Created:       info.containerInfo.Created,
			Engine:        info.containerInfo.Engine,
		}

		if !info.configDump.CheckpointedAt.IsZero() {
			node.Checkpointed = info.configDump.CheckpointedAt.Format(time.RFC3339)
		}

		if info.containerInfo.IP != "" {
			node.IP = info.containerInfo.IP
		}
		if info.containerInfo.MAC != "" {
			node.MAC = info.containerInfo.MAC
		}

		checkpointSizeNode := CheckpointSize{
			TotalSize: info.archiveSizes.checkpointSize,
		}

		if info.archiveSizes.pagesSize != 0 {
			checkpointSizeNode.MemoryPagesSize = info.archiveSizes.pagesSize
		}

		if info.archiveSizes.amdgpuPagesSize != 0 {
			checkpointSizeNode.AmdGpuMemoryPagesSize = info.archiveSizes.amdgpuPagesSize
		}

		if info.archiveSizes.rootFsDiffTarSize != 0 {
			checkpointSizeNode.RootFsDiffSize = info.archiveSizes.rootFsDiffTarSize
		}

		node.CheckpointSize = checkpointSizeNode

		if Stats {
			dumpStats, err := crit.GetDumpStats(task.OutputDir)
			if err != nil {
				return fmt.Errorf("failed to get dump statistics: %w", err)
			}

			statsNode := StatsNode{
				FreezingTime: dumpStats.GetFreezingTime(),
				FrozenTime:   dumpStats.GetFrozenTime(),
				MemdumpTime:  dumpStats.GetMemdumpTime(),
				MemwriteTime: dumpStats.GetMemwriteTime(),
				PagesScanned: dumpStats.GetPagesScanned(),
				PagesWritten: dumpStats.GetPagesWritten(),
			}

			node.CriuDumpStatistics = &statsNode
		}

		if PsTree {
			psTree, err := crit.New(nil, nil, filepath.Join(task.OutputDir, "checkpoint"), false, false).ExplorePs()
			if err != nil {
				return fmt.Errorf("failed to get process tree: %w", err)
			}

			psTreeNode, err := buildJSONPsTree(psTree, task.OutputDir)
			if err != nil {
				return fmt.Errorf("failed to get process tree: %w", err)
			}

			node.ProcessTree = &psTreeNode
		}

		if Files {
			fds, err := crit.New(nil, nil, filepath.Join(task.OutputDir, "checkpoint"), false, false).ExploreFds()
			if err != nil {
				return fmt.Errorf("failed to get file descriptors: %w", err)
			}

			node.FileDescriptors = buildJSONFds(fds)
		}

		if Sockets {
			fds, err := crit.New(nil, nil, filepath.Join(task.OutputDir, "checkpoint"), false, false).ExploreSk()
			if err != nil {
				return fmt.Errorf("failed to get sockets: %w", err)
			}

			node.Sockets, err = buildJSONSks(fds)
			if err != nil {
				return fmt.Errorf("failed to build sockets: %w", err)
			}
		}

		if Mounts {
			specDump := info.specDump
			node.Mounts = buildJSONMounts(specDump)
		}

		result = append(result, node)
	}

	jsonData, err := json.MarshalIndent(result, "", "  ")
	if err != nil {
		return err
	}

	fmt.Printf("%s\n", jsonData)

	return nil
}

func buildJSONMounts(specDump *spec.Spec) []MountNode {
	var result []MountNode

	for _, data := range specDump.Mounts {
		mountNode := MountNode{
			Destination: data.Destination,
			Type:        data.Type,
			Source:      data.Source,
		}
		result = append(result, mountNode)
	}

	return result
}

func buildJSONPsTree(psTree *crit.PsTree, checkpointOutputDir string) (PsNode, error) {
	var rootNode PsNode
	var err error

	if PID != 0 {
		ps := psTree.FindPs(PID)
		if ps == nil {
			return PsNode{}, fmt.Errorf("no process with PID %d (use `inspect --ps-tree` to view all PIDs)", PID)
		}
		rootNode, err = buildJSONPsNode(ps, checkpointOutputDir)
	} else {
		rootNode, err = buildJSONPsNode(psTree, checkpointOutputDir)
	}

	if err != nil {
		return PsNode{}, fmt.Errorf("failed to build JSON process tree node: %w", err)
	}

	return rootNode, nil
}

func buildJSONPsNode(psTree *crit.PsTree, checkpointOutputDir string) (PsNode, error) {
	node := PsNode{
		PID:  psTree.PID,
		Comm: psTree.Comm,
	}

	if PsTreeCmd {
		cmdline, err := getCmdline(checkpointOutputDir, psTree.PID)
		if err != nil {
			return PsNode{}, err
		}
		node.Cmdline = cmdline
	}

	if PsTreeEnv {
		envVars, err := getPsEnvVars(checkpointOutputDir, psTree.PID)
		if err != nil {
			return PsNode{}, err
		}
		envVarMap := make(map[string]string)
		for _, envVar := range envVars {
			i := strings.IndexByte(envVar, '=')
			if i == -1 || i == 0 {
				return PsNode{}, fmt.Errorf("invalid environment variable %s", envVar)
			}
			key := envVar[:i]
			value := envVar[i+1:]
			envVarMap[key] = value
		}

		node.EnvVars = envVarMap
	}

	var children []PsNode
	for _, child := range psTree.Children {
		childNode, err := buildJSONPsNode(child, checkpointOutputDir)
		if err != nil {
			return PsNode{}, err
		}
		children = append(children, childNode)
	}

	if len(children) > 0 {
		node.Children = children
	}

	return node, nil
}

func buildJSONFds(fds []*crit.Fd) []FdNode {
	var result []FdNode

	for _, fd := range fds {
		fdNode := FdNode{
			PID: fd.PId,
		}

		var files []OpenFileNode
		for _, file := range fd.Files {
			fileNode := OpenFileNode{
				Type: file.Type,
				FD:   strings.TrimSpace(file.Type + " " + file.Fd),
				Path: file.Path,
			}
			files = append(files, fileNode)
		}

		if len(files) > 0 {
			fdNode.OpenFiles = files
		}

		result = append(result, fdNode)
	}

	return result
}

func buildJSONSks(sks []*crit.Sk) ([]SkNode, error) {
	var result []SkNode

	for _, sk := range sks {
		skNode := SkNode{
			PID: sk.PId,
		}

		var sockets []SocketNode
		for _, socket := range sk.Sockets {
			socketData, err := getDataForSocket(socket)
			if err != nil {
				return nil, fmt.Errorf("error getting data for socket: %w", err)
			}
			sockets = append(sockets, SocketNode{
				Protocol: socket.Protocol,
				Data:     socketData,
			})
		}

		if len(sockets) > 0 {
			skNode.OpenSockets = sockets
		}

		result = append(result, skNode)
	}

	return result, nil
}

func getDataForSocket(socket *crit.Socket) (SkData, error) {
	dataFunc, found := socketDataFuncs[socket.FdType]
	if !found {
		return SkData{}, fmt.Errorf("unsupported socket type: %s", socket.FdType)
	}
	return dataFunc(socket), nil
}

func getUnixSkData(socket *crit.Socket) SkData {
	return SkData{
		Type:    "UNIX",
		Address: socket.SrcAddr,
	}
}

func getInetSkData(socket *crit.Socket) SkData {
	return SkData{
		Type:       socket.Protocol,
		State:      socket.State,
		Source:     socket.SrcAddr,
		SourcePort: socket.SrcPort,
		Dest:       socket.DestAddr,
		DestPort:   socket.DestPort,
		SendBuf:    socket.SendBuf,
		RecvBuf:    socket.RecvBuf,
	}
}

func getPacketSkData(socket *crit.Socket) SkData {
	return SkData{
		SendBuf: socket.SendBuf,
		RecvBuf: socket.RecvBuf,
	}
}

func getNetlinkSkData(socket *crit.Socket) SkData {
	return SkData{
		SendBuf: socket.SendBuf,
		RecvBuf: socket.RecvBuf,
	}
}