memory_breakdown.go

// Copyright (C) 2018 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package api

// MemoryBreakdown is the type implemented by APIs that can report the memory
// layout of their state.
type MemoryBreakdownProvider interface {
	// MemoryBreakdown stores an overview of the state's memory layout into
	// a MemoryBreakdown object.  The layout includes data on memory types,
	// allocations, and which resources are bound to which locations in
	// memory.
	MemoryBreakdown(*GlobalState) (*MemoryBreakdown, error)
}