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
|
package internal
import (
"encoding/json"
"fmt"
"path/filepath"
"strings"
"time"
metadata "github.com/checkpoint-restore/checkpointctl/lib"
"github.com/checkpoint-restore/go-criu/v7/crit"
stats_pb "github.com/checkpoint-restore/go-criu/v7/crit/images/stats"
spec "github.com/opencontainers/runtime-spec/specs-go"
"github.com/xlab/treeprint"
)
func RenderTreeView(tasks []Task) error {
for _, task := range tasks {
info, err := getCheckpointInfo(task)
if err != nil {
return err
}
tree := buildTree(info.containerInfo, info.configDump, info.archiveSizes)
checkpointDirectory := filepath.Join(task.OutputDir, metadata.CheckpointDirectory)
if Stats {
dumpStats, err := crit.GetDumpStats(task.OutputDir)
if err != nil {
return fmt.Errorf("failed to get dump statistics: %w", err)
}
addDumpStatsToTree(tree, dumpStats)
}
if Metadata {
addPodInfoToTree(tree, info)
}
if PsTree {
c := crit.New(nil, nil, checkpointDirectory, false, false)
psTree, err := c.ExplorePs()
if err != nil {
return fmt.Errorf("failed to get process tree: %w", err)
}
if PsTreeCmd {
if err := updatePsTreeCommToCmdline(task.OutputDir, psTree); err != nil {
return fmt.Errorf("failed to process command line arguments: %w", err)
}
}
fds, err := func() ([]*crit.Fd, error) {
if !Files {
return nil, nil
}
c := crit.New(nil, nil, checkpointDirectory, false, false)
fds, err := c.ExploreFds()
if err != nil {
return nil, fmt.Errorf("failed to get file descriptors: %w", err)
}
return fds, nil
}()
if err != nil {
return err
}
sks, err := func() ([]*crit.Sk, error) {
if !Sockets {
return nil, nil
}
c := crit.New(nil, nil, checkpointDirectory, false, false)
sks, err := c.ExploreSk()
if err != nil {
return nil, fmt.Errorf("failed to get sockets: %w", err)
}
return sks, nil
}()
if err != nil {
return err
}
if err = addPsTreeToTree(tree, psTree, fds, sks, task.OutputDir); err != nil {
return fmt.Errorf("failed to get process tree: %w", err)
}
}
if Mounts {
addMountsToTree(tree, info.specDump)
}
fmt.Printf("\nDisplaying container checkpoint tree view from %s\n\n", task.CheckpointFilePath)
fmt.Println(tree.String())
}
return nil
}
func buildTree(ci *containerInfo, containerConfig *metadata.ContainerConfig, archiveSizes *archiveSizes) treeprint.Tree {
if ci.Name == "" {
ci.Name = "Container"
}
tree := treeprint.NewWithRoot(ci.Name)
tree.AddBranch(fmt.Sprintf("Image: %s", containerConfig.RootfsImageName))
tree.AddBranch(fmt.Sprintf("ID: %s", containerConfig.ID))
tree.AddBranch(fmt.Sprintf("Runtime: %s", containerConfig.OCIRuntime))
tree.AddBranch(fmt.Sprintf("Created: %s", ci.Created))
if !containerConfig.CheckpointedAt.IsZero() {
tree.AddBranch(fmt.Sprintf("Checkpointed: %s", containerConfig.CheckpointedAt.Format(time.RFC3339)))
}
tree.AddBranch(fmt.Sprintf("Engine: %s", ci.Engine))
if ci.IP != "" {
tree.AddBranch(fmt.Sprintf("IP: %s", ci.IP))
}
if ci.MAC != "" {
tree.AddBranch(fmt.Sprintf("MAC: %s", ci.MAC))
}
checkpointSize := tree.AddBranch(fmt.Sprintf("Checkpoint size: %s", metadata.ByteToString(archiveSizes.checkpointSize)))
if archiveSizes.pagesSize != 0 {
checkpointSize.AddNode(fmt.Sprintf("Memory pages size: %s", metadata.ByteToString(archiveSizes.pagesSize)))
}
if archiveSizes.amdgpuPagesSize != 0 {
checkpointSize.AddNode(fmt.Sprintf("AMD GPU memory pages size: %s", metadata.ByteToString(archiveSizes.amdgpuPagesSize)))
}
if archiveSizes.rootFsDiffTarSize != 0 {
tree.AddBranch(fmt.Sprintf("Root FS diff size: %s", metadata.ByteToString(archiveSizes.rootFsDiffTarSize)))
}
return tree
}
func addMountsToTree(tree treeprint.Tree, specDump *spec.Spec) {
mountsTree := tree.AddBranch("Overview of mounts")
for _, data := range specDump.Mounts {
mountTree := mountsTree.AddBranch(fmt.Sprintf("Destination: %s", data.Destination))
mountTree.AddBranch(fmt.Sprintf("Type: %s", data.Type))
mountTree.AddBranch(fmt.Sprintf("Source: %s", func() string {
return data.Source
}()))
}
}
func addDumpStatsToTree(tree treeprint.Tree, dumpStats *stats_pb.DumpStatsEntry) {
statsTree := tree.AddBranch("CRIU dump statistics")
statsTree.AddBranch(fmt.Sprintf("Freezing time: %s", FormatTime(dumpStats.GetFreezingTime())))
statsTree.AddBranch(fmt.Sprintf("Frozen time: %s", FormatTime(dumpStats.GetFrozenTime())))
statsTree.AddBranch(fmt.Sprintf("Memdump time: %s", FormatTime(dumpStats.GetMemdumpTime())))
statsTree.AddBranch(fmt.Sprintf("Memwrite time: %s", FormatTime(dumpStats.GetMemwriteTime())))
statsTree.AddBranch(fmt.Sprintf("Pages scanned: %d", dumpStats.GetPagesScanned()))
statsTree.AddBranch(fmt.Sprintf("Pages written: %d", dumpStats.GetPagesWritten()))
}
func addPsTreeToTree(
tree treeprint.Tree,
psTree *crit.PsTree,
fds []*crit.Fd,
sks []*crit.Sk,
checkpointOutputDir string,
) error {
psRoot := psTree
if PID != 0 {
ps := psTree.FindPs(PID)
if ps == nil {
return fmt.Errorf("no process with PID %d (use `inspect --ps-tree` to view all PIDs)", PID)
}
psRoot = ps
}
// processNodes is a recursive function to create
// a new branch for each process and add its child
// processes as child nodes of the branch.
var processNodes func(treeprint.Tree, *crit.PsTree) error
processNodes = func(tree treeprint.Tree, root *crit.PsTree) error {
node := tree.AddMetaBranch(root.PID, root.Comm)
// attach environment variables to process
if PsTreeEnv {
envVars, err := getPsEnvVars(checkpointOutputDir, root.PID)
if err != nil {
return err
}
if len(envVars) > 0 {
nodeSubtree := node.AddBranch("Environment variables")
for _, env := range envVars {
nodeSubtree.AddBranch(env)
}
}
}
if err := showFiles(fds, node, root); err != nil {
return err
}
if err := showSockets(sks, node, root); err != nil {
return err
}
for _, child := range root.Children {
if err := processNodes(node, child); err != nil {
return err
}
}
return nil
}
psTreeNode := tree.AddBranch("Process tree")
return processNodes(psTreeNode, psRoot)
}
func showFiles(fds []*crit.Fd, node treeprint.Tree, root *crit.PsTree) error {
if !Files {
return nil
}
if fds == nil {
return fmt.Errorf("failed to get file descriptors")
}
for _, fd := range fds {
var nodeSubtree treeprint.Tree
if fd.PId != root.PID {
continue
} else {
nodeSubtree = node.AddBranch("Open files")
}
for _, file := range fd.Files {
nodeSubtree.AddMetaBranch(strings.TrimSpace(file.Type+" "+file.Fd), file.Path)
}
}
return nil
}
func showSockets(sks []*crit.Sk, node treeprint.Tree, root *crit.PsTree) error {
if !Sockets {
return nil
}
if sks == nil {
return fmt.Errorf("failed to get sockets")
}
for _, sk := range sks {
var nodeSubtree treeprint.Tree
if sk.PId != root.PID {
continue
} else {
nodeSubtree = node.AddBranch("Open sockets")
}
var data string
var protocol string
for _, socket := range sk.Sockets {
protocol = socket.Protocol
switch socket.FdType {
case "UNIXSK":
// UNIX sockets do not have a protocol assigned.
// Hence, the meta value for the socket is just
// the socket type.
protocol = fmt.Sprintf("UNIX (%s)", socket.Type)
data = socket.SrcAddr
if len(data) == 0 {
// Use an abstract socket address
data = "@"
}
case "INETSK":
if protocol == "TCP" {
protocol = fmt.Sprintf("%s (%s)", socket.Protocol, socket.State)
}
data = fmt.Sprintf(
"%s:%d -> %s:%d (↑ %s ↓ %s)",
socket.SrcAddr, socket.SrcPort,
socket.DestAddr, socket.DestPort,
socket.SendBuf, socket.RecvBuf,
)
case "PACKETSK":
data = fmt.Sprintf("↑ %s ↓ %s", socket.SendBuf, socket.RecvBuf)
case "NETLINKSK":
data = fmt.Sprintf("↑ %s ↓ %s", socket.SendBuf, socket.RecvBuf)
}
nodeSubtree.AddMetaBranch(protocol, data)
}
}
return nil
}
// Recursively updates the Comm field of the psTree struct with the command line arguments
// from process memory pages
func updatePsTreeCommToCmdline(checkpointOutputDir string, psTree *crit.PsTree) error {
cmdline, err := getCmdline(checkpointOutputDir, psTree.PID)
if err != nil {
return err
}
if cmdline != "" {
psTree.Comm = cmdline
}
for _, child := range psTree.Children {
if err := updatePsTreeCommToCmdline(checkpointOutputDir, child); err != nil {
return err
}
}
return nil
}
// Taken from the CRI API
type mountAnnotations struct {
ContainerPath string `json:"container_path,omitempty"`
HostPath string `json:"host_path,omitempty"`
Readonly bool `json:"readonly,omitempty"`
SelinuxRelabel bool `json:"selinux_relabel,omitempty"`
Propagation int `json:"propagation,omitempty"`
UidMappings []*int `json:"uidMappings,omitempty"`
GidMappings []*int `json:"gidMappings,omitempty"`
RecursiveReadOnly bool `json:"recursive_read_only,omitempty"`
}
func addPodInfoToTree(tree treeprint.Tree, info *checkpointInfo) {
podTree := tree.AddBranch("Metadata")
if len(info.containerInfo.Pod) > 0 {
podTree.AddBranch(fmt.Sprintf("Pod name: %s", info.containerInfo.Pod))
}
if len(info.containerInfo.Namespace) > 0 {
podTree.AddBranch(fmt.Sprintf("Kubernetes namespace: %s", info.containerInfo.Namespace))
}
if len(info.specDump.Annotations) > 0 {
annotationTree := podTree.AddBranch("Annotations")
for key := range info.specDump.Annotations {
switch key {
case "io.kubernetes.cri-o.Labels",
"io.kubernetes.cri-o.Annotations",
"io.kubernetes.cri-o.Metadata",
"kubectl.kubernetes.io/last-applied-configuration":
// We know that some annotations contain a JSON string we can pretty print
local := make(map[string]interface{})
if err := json.Unmarshal([]byte(info.specDump.Annotations[key]), &local); err != nil {
continue
}
localTree := annotationTree.AddBranch(key)
// Recursively add array/map JSON fields to the tree
addMapToTree(localTree, local)
case "io.kubernetes.cri-o.Volumes":
// We know that some annotations contain a JSON string we can pretty print
var local []mountAnnotations
if err := json.Unmarshal([]byte(info.specDump.Annotations[key]), &local); err != nil {
fmt.Printf("error: %s", err)
}
localTree := annotationTree.AddBranch(key)
for _, mount := range local {
containerPath := localTree.AddBranch(mount.ContainerPath)
containerPath.AddBranch(fmt.Sprintf("host path: %s", mount.HostPath))
containerPath.AddBranch(fmt.Sprintf("read-only: %t", mount.Readonly))
containerPath.AddBranch(fmt.Sprintf("selinux relabel: %t", mount.SelinuxRelabel))
containerPath.AddBranch(fmt.Sprintf("recursive read-only: %t", mount.RecursiveReadOnly))
containerPath.AddBranch(fmt.Sprintf("propagation: %d", mount.Propagation))
}
default:
annotationTree.AddBranch(fmt.Sprintf("%s: %s", key, info.specDump.Annotations[key]))
}
}
}
}
func addMapToTree(tree treeprint.Tree, data map[string]interface{}) {
for key, value := range data {
switch v := value.(type) {
case map[string]interface{}:
// Recursively add nested maps
subTree := tree.AddBranch(fmt.Sprintf("%s:", key))
addMapToTree(subTree, v)
case []interface{}:
// Handle arrays recursively
arrayTree := tree.AddBranch(fmt.Sprintf("%s: ", key))
addArrayToTree(arrayTree, v)
default:
tree.AddBranch(fmt.Sprintf("%s: %v", key, v))
}
}
}
func addArrayToTree(tree treeprint.Tree, data []interface{}) {
for i, value := range data {
switch v := value.(type) {
case map[string]interface{}:
// Recursively add maps inside arrays
subTree := tree.AddBranch(fmt.Sprintf("[%d]:", i))
addMapToTree(subTree, v)
case []interface{}:
// Recursively add arrays inside arrays
subArrayTree := tree.AddBranch(fmt.Sprintf("[%d]: ", i))
addArrayToTree(subArrayTree, v)
default:
tree.AddBranch(fmt.Sprintf("[%d]: %v", i, v))
}
}
}
|