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
|
// SPDX-License-Identifier: Apache-2.0
// This file is used to handle memory pages analysis of container checkpoints
package cmd
import (
"bytes"
"fmt"
"io"
"os"
"path/filepath"
"github.com/checkpoint-restore/checkpointctl/internal"
metadata "github.com/checkpoint-restore/checkpointctl/lib"
"github.com/checkpoint-restore/go-criu/v7/crit"
"github.com/olekukonko/tablewriter"
"github.com/spf13/cobra"
)
// chunkSize represents the default size of memory chunk (in bytes)
// to read for each output line when printing memory pages content in hexdump-like format.
const chunkSize = 16
var pageSize = os.Getpagesize()
func MemParse() *cobra.Command {
cmd := &cobra.Command{
Use: "memparse",
Short: "Analyze container checkpoint memory",
RunE: memparse,
Args: cobra.MinimumNArgs(1),
}
flags := cmd.Flags()
flags.Uint32VarP(
pID,
"pid",
"p",
0,
"Specify the PID of a process to analyze",
)
flags.StringVarP(
outputFilePath,
"output",
"o",
"",
"Specify the output file to be written to",
)
flags.StringVarP(
searchPattern,
"search",
"s",
"",
"Search for a string pattern in memory pages",
)
flags.StringVarP(
searchRegexPattern,
"search-regex",
"r",
"",
"Search for a regex pattern in memory pages",
)
flags.IntVarP(
searchContext,
"context",
"c",
0,
"Print the specified number of bytes surrounding each match",
)
return cmd
}
func memparse(cmd *cobra.Command, args []string) error {
requiredFiles := []string{
metadata.SpecDumpFile, metadata.ConfigDumpFile,
filepath.Join(metadata.CheckpointDirectory, "pstree.img"),
filepath.Join(metadata.CheckpointDirectory, "core-"),
}
if *pID == 0 {
requiredFiles = append(
requiredFiles,
filepath.Join(metadata.CheckpointDirectory, "pagemap-"),
filepath.Join(metadata.CheckpointDirectory, "mm-"),
)
} else {
requiredFiles = append(
requiredFiles,
filepath.Join(metadata.CheckpointDirectory, fmt.Sprintf("pagemap-%d.img", *pID)),
filepath.Join(metadata.CheckpointDirectory, fmt.Sprintf("mm-%d.img", *pID)),
)
}
tasks, err := internal.CreateTasks(args, requiredFiles)
if err != nil {
return err
}
defer internal.CleanupTasks(tasks)
if *searchPattern != "" || *searchRegexPattern != "" {
return printMemorySearchResultForPID(tasks[0])
}
if *pID != 0 {
return printProcessMemoryPages(tasks[0])
}
return showProcessMemorySizeTables(tasks)
}
// Display processes memory sizes within the given container checkpoints.
func showProcessMemorySizeTables(tasks []internal.Task) error {
// Initialize the table
table := tablewriter.NewWriter(os.Stdout)
header := []string{
"PID",
"Process name",
"Memory size",
"Shared memory size",
}
table.SetHeader(header)
table.SetAutoMergeCells(false)
table.SetRowLine(true)
// Function to recursively traverse the process tree and populate the table rows
var traverseTree func(*crit.PsTree, string) error
traverseTree = func(root *crit.PsTree, checkpointOutputDir string) error {
memReader, err := crit.NewMemoryReader(
filepath.Join(checkpointOutputDir, metadata.CheckpointDirectory),
root.PID, pageSize,
)
if err != nil {
return err
}
pagemapEntries := memReader.GetPagemapEntries()
var memSize int64
for _, entry := range pagemapEntries {
memSize += int64(*entry.NrPages) * int64(pageSize)
}
shmemSize, err := memReader.GetShmemSize()
if err != nil {
return err
}
table.Append([]string{
fmt.Sprintf("%d", root.PID),
root.Comm,
metadata.ByteToString(memSize),
metadata.ByteToString(shmemSize),
})
for _, child := range root.Children {
if err := traverseTree(child, checkpointOutputDir); err != nil {
return err
}
}
return nil
}
for _, task := range tasks {
// Clear the table before processing each checkpoint task
table.ClearRows()
c := crit.New(nil, nil, filepath.Join(task.OutputDir, "checkpoint"), false, false)
psTree, err := c.ExplorePs()
if err != nil {
return fmt.Errorf("failed to get process tree: %w", err)
}
// Populate the table rows
if err := traverseTree(psTree, task.OutputDir); err != nil {
return err
}
fmt.Printf("\nDisplaying processes memory sizes from %s\n\n", task.CheckpointFilePath)
table.Render()
}
return nil
}
func printProcessMemoryPages(task internal.Task) error {
c := crit.New(nil, nil, filepath.Join(task.OutputDir, metadata.CheckpointDirectory), false, false)
psTree, err := c.ExplorePs()
if err != nil {
return fmt.Errorf("failed to get process tree: %w", err)
}
// Check if PID exist within the checkpoint
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)
}
}
memReader, err := crit.NewMemoryReader(
filepath.Join(task.OutputDir, metadata.CheckpointDirectory),
*pID, pageSize,
)
if err != nil {
return err
}
// Unpack pages-[pagesID].img file for the given PID
if err := internal.UntarFiles(
task.CheckpointFilePath, task.OutputDir,
[]string{filepath.Join(metadata.CheckpointDirectory, fmt.Sprintf("pages-%d.img", memReader.GetPagesID()))},
); err != nil {
return err
}
// Write the output to stdout by default
var output io.Writer = os.Stdout
var compact bool
if *outputFilePath != "" {
// Write output to file if --output is specified
f, err := os.Create(*outputFilePath)
if err != nil {
return err
}
defer f.Close()
output = f
fmt.Printf("\nWriting memory pages content for process ID %d from checkpoint: %s to file: %s...\n",
*pID, task.CheckpointFilePath, *outputFilePath,
)
} else {
compact = true // Use a compact format when writing the output to stdout
fmt.Printf("\nDisplaying memory pages content for process ID %d from checkpoint: %s\n\n", *pID, task.CheckpointFilePath)
}
fmt.Fprintln(output, "Address Hexadecimal ASCII ")
fmt.Fprintln(output, "-------------------------------------------------------------------------------------")
pagemapEntries := memReader.GetPagemapEntries()
for _, entry := range pagemapEntries {
start := entry.GetVaddr()
end := start + (uint64(pageSize) * uint64(entry.GetNrPages()))
buf, err := memReader.GetMemPages(start, end)
if err != nil {
return err
}
hexdump(output, buf, start, compact)
}
return nil
}
// hexdump generates a hexdump of the buffer 'buf' starting at the virtual address 'start'
// and writes the output to 'out'. If compact is true, consecutive duplicate rows will be represented
// with an asterisk (*).
func hexdump(out io.Writer, buf *bytes.Buffer, vaddr uint64, compact bool) {
var prevAscii string
var isDuplicate bool
for buf.Len() > 0 {
row := buf.Next(chunkSize)
hex, ascii := generateHexAndAscii(row)
if compact {
if prevAscii == ascii {
if !isDuplicate {
fmt.Fprint(out, "*\n")
}
isDuplicate = true
} else {
fmt.Fprintf(out, "%016x %s |%s|\n", vaddr, hex, ascii)
isDuplicate = false
}
} else {
fmt.Fprintf(out, "%016x %s |%s|\n", vaddr, hex, ascii)
}
vaddr += chunkSize
prevAscii = ascii
}
}
// generateHexAndAscii takes a byte slice and generates its hexadecimal and ASCII representations.
func generateHexAndAscii(data []byte) (string, string) {
var hex, ascii string
for i := 0; i < len(data); i++ {
if data[i] < 32 || data[i] >= 127 {
ascii += "."
hex += fmt.Sprintf("%02x ", data[i])
} else {
ascii += string(data[i])
hex += fmt.Sprintf("%02x ", data[i])
}
}
return hex, ascii
}
// Searches for a pattern in the memory of a given PID and prints the results.
func printMemorySearchResultForPID(task internal.Task) error {
c := crit.New(nil, nil, filepath.Join(task.OutputDir, metadata.CheckpointDirectory), false, false)
psTree, err := c.ExplorePs()
if err != nil {
return fmt.Errorf("failed to get process tree: %w", err)
}
// Check if PID exist within the checkpoint
ps := psTree.FindPs(*pID)
if ps == nil {
return fmt.Errorf("no process with PID %d (use `inspect --ps-tree` to view all PIDs)", *pID)
}
memReader, err := crit.NewMemoryReader(
filepath.Join(task.OutputDir, metadata.CheckpointDirectory),
*pID, pageSize,
)
if err != nil {
return fmt.Errorf("failed to create memory reader: %w", err)
}
if err := internal.UntarFiles(
task.CheckpointFilePath, task.OutputDir,
[]string{filepath.Join(metadata.CheckpointDirectory, fmt.Sprintf("pages-%d.img", memReader.GetPagesID()))},
); err != nil {
return fmt.Errorf("failed to extract pages file: %w", err)
}
pattern := *searchPattern
escapeRegExpCharacters := true
if pattern == "" {
pattern = *searchRegexPattern
escapeRegExpCharacters = false
}
results, err := memReader.SearchPattern(pattern, escapeRegExpCharacters, *searchContext, 0)
if err != nil {
return fmt.Errorf("failed to search pattern in memory: %w", err)
}
if len(results) == 0 {
fmt.Printf("No matches for pattern \"%s\" in the memory of PID %d\n", pattern, *pID)
return nil
}
table := tablewriter.NewWriter(os.Stdout)
table.SetHeader([]string{"Address", "Match", "Instance"})
table.SetAutoMergeCells(false)
table.SetRowLine(true)
for i, result := range results {
table.Append([]string{
fmt.Sprintf(
"%016x", result.Vaddr),
result.Match,
fmt.Sprintf("%d", i+1),
})
}
table.Render()
return nil
}
|