github.com/google/pprof v0.0.0-20200708004538-1a94d8640e99: profile.Location

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify github.com/google/pprof/profile.Location in pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99
Demonstrate these symbols/APIs:
  - github.com/google/pprof/profile.Location
Required runtime conditions:
  - ecosystem: golang
  - language: go
  - packageManager: go@1.26.6
  - runtime: go@1.26.6

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:d039c899084f8eb77c7cc28a30593b4de9bab9e4851c914e2867b6dc9ee3f6bc","contract":["profile.Location can be constructed with ID, Address, Mapping, and IsFolded fields.","profile.Location can hold multiple inlined Line frames referencing Functions.","profile.Location instances can be associated with Samples and registered in a Profile.","A Profile containing structured Locations passes CheckValid verification.","Profile Write and Parse round-trip preserves Location fields, Mappings, and Line associations."],"goal":"verify github.com/google/pprof/profile.Location in pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99","kind":"HOW","packages":["pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99"],"schemaVersion":1,"symbols":["github.com/google/pprof/profile.Location"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26.6","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99"],"schemaVersion":1,"subject":"pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99","symbols":["github.com/google/pprof/profile.Location"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/google/pprof v0.0.0-20200708004538-1a94d8640e99

github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
github.com/google/pprof v0.0.0-20200708004538-1a94d8640e99 h1:Ak8CrdlwwXwAZxzS66vgPt4U8yUZX7JwLvVR58FN5jM=
github.com/google/pprof v0.0.0-20200708004538-1a94d8640e99/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM=
github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

package main

import (
	"fmt"

	"github.com/google/pprof/profile"
)

func main() {
	fn := &profile.Function{
		ID:         1,
		Name:       "compute",
		SystemName: "compute",
		Filename:   "compute.go",
		StartLine:  1,
	}

	mapping := &profile.Mapping{
		ID:    1,
		Start: 0x1000,
		Limit: 0x2000,
		File:  "app",
	}

	loc := &profile.Location{
		ID:       1,
		Mapping:  mapping,
		Address:  0x1020,
		IsFolded: false,
		Line: []profile.Line{
			{
				Function: fn,
				Line:     42,
			},
		},
	}

	fmt.Printf("Location ID: %d, Address: 0x%x, Lines: %d\n", loc.ID, loc.Address, len(loc.Line))
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/google/pprof/profile.Location in pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/google/pprof@v0.0.0-20200708004538-1a94d8640e99"
  ],
  "symbols": [
    "github.com/google/pprof/profile.Location"
  ],
  "runtimeConditions": {
    "ecosystem": "golang",
    "language": "go",
    "packageManager": "go@1.26.6",
    "runtime": "go@1.26.6"
  }
}

package main

import (
	"bytes"
	"fmt"
	"os"

	"github.com/google/pprof/profile"
)

func main() {
	// Assertion 1: profile.Location can be constructed with ID, Address, Mapping, and IsFolded fields.
	mapping := &profile.Mapping{
		ID:    1,
		Start: 0x1000,
		Limit: 0x2000,
		File:  "app",
	}

	loc := &profile.Location{
		ID:       1,
		Mapping:  mapping,
		Address:  0x1020,
		IsFolded: false,
	}

	if loc.ID != 1 {
		fmt.Fprintf(os.Stderr, "FAIL: expected ID 1, got %d\n", loc.ID)
		os.Exit(1)
	}
	if loc.Address != 0x1020 {
		fmt.Fprintf(os.Stderr, "FAIL: expected Address 0x1020, got 0x%x\n", loc.Address)
		os.Exit(1)
	}
	if loc.Mapping != mapping {
		fmt.Fprintf(os.Stderr, "FAIL: expected Mapping pointer equality\n")
		os.Exit(1)
	}
	if loc.IsFolded {
		fmt.Fprintf(os.Stderr, "FAIL: expected IsFolded false\n")
		os.Exit(1)
	}

	// Assertion 2: profile.Location can hold multiple inlined Line frames referencing Functions.
	fn1 := &profile.Function{
		ID:         1,
		Name:       "outer",
		SystemName: "outer",
		Filename:   "compute.go",
		StartLine:  10,
	}
	fn2 := &profile.Function{
		ID:         2,
		Name:       "inlinedInner",
		SystemName: "inlinedInner",
		Filename:   "compute.go",
		StartLine:  20,
	}

	loc.Line = []profile.Line{
		{Function: fn1, Line: 12},
		{Function: fn2, Line: 25},
	}

	if len(loc.Line) != 2 {
		fmt.Fprintf(os.Stderr, "FAIL: expected 2 lines, got %d\n", len(loc.Line))
		os.Exit(1)
	}
	if loc.Line[0].Function.Name != "outer" || loc.Line[0].Line != 12 {
		fmt.Fprintf(os.Stderr, "FAIL: line 0 mismatch\n")
		os.Exit(1)
	}
	if loc.Line[1].Function.Name != "inlinedInner" || loc.Line[1].Line != 25 {
		fmt.Fprintf(os.Stderr, "FAIL: line 1 mismatch\n")
		os.Exit(1)
	}

	// Assertion 3: profile.Location instances can be associated with Samples and registered in a Profile.
	sample := &profile.Sample{
		Location: []*profile.Location{loc},
		Value:    []int64{100},
	}

	prof := &profile.Profile{
		SampleType: []*profile.ValueType{
			{Type: "samples", Unit: "count"},
		},
		PeriodType: &profile.ValueType{
			Type: "cpu", Unit: "nanoseconds",
		},
		Mapping:  []*profile.Mapping{mapping},
		Function: []*profile.Function{fn1, fn2},
		Location: []*profile.Location{loc},
		Sample:   []*profile.Sample{sample},
	}

	if len(sample.Location) != 1 || sample.Location[0] != loc {
		fmt.Fprintf(os.Stderr, "FAIL: sample location mismatch\n")
		os.Exit(1)
	}
	if len(prof.Location) != 1 || prof.Location[0] != loc {
		fmt.Fprintf(os.Stderr, "FAIL: profile location mismatch\n")
		os.Exit(1)
	}

	// Assertion 4: A Profile containing structured Locations passes CheckValid verification.
	if err := prof.CheckValid(); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: CheckValid failed: %v\n", err)
		os.Exit(1)
	}

	// Assertion 5: Profile Write and Parse round-trip preserves Location fields, Mappings, and Line associations.
	var buf bytes.Buffer
	if err := prof.Write(&buf); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: Write failed: %v\n", err)
		os.Exit(1)
	}

	parsed, err := profile.Parse(&buf)
	if err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: Parse failed: %v\n", err)
		os.Exit(1)
	}

	if len(parsed.Location) != 1 {
		fmt.Fprintf(os.Stderr, "FAIL: parsed locations length %d\n", len(parsed.Location))
		os.Exit(1)
	}
	parsedLoc := parsed.Location[0]
	if parsedLoc.ID != 1 || parsedLoc.Address != 0x1020 || parsedLoc.IsFolded {
		fmt.Fprintf(os.Stderr, "FAIL: parsed location fields mismatch\n")
		os.Exit(1)
	}
	if len(parsedLoc.Line) != 2 {
		fmt.Fprintf(os.Stderr, "FAIL: parsed location lines length %d\n", len(parsedLoc.Line))
		os.Exit(1)
	}
	if parsedLoc.Line[0].Function.Name != "outer" || parsedLoc.Line[1].Function.Name != "inlinedInner" {
		fmt.Fprintf(os.Stderr, "FAIL: parsed function names mismatch\n")
		os.Exit(1)
	}

	fmt.Println("PASS: all Location contract assertions passed.")
}