1aa773500a4aefba7d737d1428b434af38334f409Colin Cross/* 2aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Copyright (C) 2013 The Android Open Source Project 3aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 4aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Licensed under the Apache License, Version 2.0 (the "License"); 5aa773500a4aefba7d737d1428b434af38334f409Colin Cross * you may not use this file except in compliance with the License. 6aa773500a4aefba7d737d1428b434af38334f409Colin Cross * You may obtain a copy of the License at 7aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 8aa773500a4aefba7d737d1428b434af38334f409Colin Cross * http://www.apache.org/licenses/LICENSE-2.0 9aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 10aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Unless required by applicable law or agreed to in writing, software 11aa773500a4aefba7d737d1428b434af38334f409Colin Cross * distributed under the License is distributed on an "AS IS" BASIS, 12aa773500a4aefba7d737d1428b434af38334f409Colin Cross * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13aa773500a4aefba7d737d1428b434af38334f409Colin Cross * See the License for the specific language governing permissions and 14aa773500a4aefba7d737d1428b434af38334f409Colin Cross * limitations under the License. 15aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 16aa773500a4aefba7d737d1428b434af38334f409Colin Cross 17aa773500a4aefba7d737d1428b434af38334f409Colin Cross#ifndef ANDROID_INCLUDE_HARDWARE_MEMTRACK_H 18aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define ANDROID_INCLUDE_HARDWARE_MEMTRACK_H 19aa773500a4aefba7d737d1428b434af38334f409Colin Cross 20aa773500a4aefba7d737d1428b434af38334f409Colin Cross#include <stdint.h> 21aa773500a4aefba7d737d1428b434af38334f409Colin Cross#include <sys/cdefs.h> 22aa773500a4aefba7d737d1428b434af38334f409Colin Cross#include <sys/types.h> 23aa773500a4aefba7d737d1428b434af38334f409Colin Cross 24aa773500a4aefba7d737d1428b434af38334f409Colin Cross#include <hardware/hardware.h> 25aa773500a4aefba7d737d1428b434af38334f409Colin Cross 26aa773500a4aefba7d737d1428b434af38334f409Colin Cross__BEGIN_DECLS 27aa773500a4aefba7d737d1428b434af38334f409Colin Cross 28aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_MODULE_API_VERSION_0_1 HARDWARE_MODULE_API_VERSION(0, 1) 29aa773500a4aefba7d737d1428b434af38334f409Colin Cross 30aa773500a4aefba7d737d1428b434af38334f409Colin Cross/** 31aa773500a4aefba7d737d1428b434af38334f409Colin Cross * The id of this module 32aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 33aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_HARDWARE_MODULE_ID "memtrack" 34aa773500a4aefba7d737d1428b434af38334f409Colin Cross 35aa773500a4aefba7d737d1428b434af38334f409Colin Cross/* 36aa773500a4aefba7d737d1428b434af38334f409Colin Cross * The Memory Tracker HAL is designed to return information about device-specific 37aa773500a4aefba7d737d1428b434af38334f409Colin Cross * memory usage. The primary goal is to be able to track memory that is not 38aa773500a4aefba7d737d1428b434af38334f409Colin Cross * trackable in any other way, for example texture memory that is allocated by 39aa773500a4aefba7d737d1428b434af38334f409Colin Cross * a process, but not mapped in to that process' address space. 40aa773500a4aefba7d737d1428b434af38334f409Colin Cross * A secondary goal is to be able to categorize memory used by a process into 41aa773500a4aefba7d737d1428b434af38334f409Colin Cross * GL, graphics, etc. All memory sizes should be in real memory usage, 42aa773500a4aefba7d737d1428b434af38334f409Colin Cross * accounting for stride, bit depth, rounding up to page size, etc. 43aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 44aa773500a4aefba7d737d1428b434af38334f409Colin Cross * A process collecting memory statistics will call getMemory for each 45aa773500a4aefba7d737d1428b434af38334f409Colin Cross * combination of pid and memory type. For each memory type that it recognizes 46aa773500a4aefba7d737d1428b434af38334f409Colin Cross * the HAL should fill out an array of memtrack_record structures breaking 47aa773500a4aefba7d737d1428b434af38334f409Colin Cross * down the statistics of that memory type as much as possible. For example, 48aa773500a4aefba7d737d1428b434af38334f409Colin Cross * getMemory(<pid>, MEMTRACK_TYPE_GL) might return: 49aa773500a4aefba7d737d1428b434af38334f409Colin Cross * { { 4096, ACCOUNTED | PRIVATE | SYSTEM }, 50aa773500a4aefba7d737d1428b434af38334f409Colin Cross * { 40960, UNACCOUNTED | PRIVATE | SYSTEM }, 51aa773500a4aefba7d737d1428b434af38334f409Colin Cross * { 8192, ACCOUNTED | PRIVATE | DEDICATED }, 52aa773500a4aefba7d737d1428b434af38334f409Colin Cross * { 8192, UNACCOUNTED | PRIVATE | DEDICATED } } 53aa773500a4aefba7d737d1428b434af38334f409Colin Cross * If the HAL could not differentiate between SYSTEM and DEDICATED memory, it 54aa773500a4aefba7d737d1428b434af38334f409Colin Cross * could return: 55aa773500a4aefba7d737d1428b434af38334f409Colin Cross * { { 12288, ACCOUNTED | PRIVATE }, 56aa773500a4aefba7d737d1428b434af38334f409Colin Cross * { 49152, UNACCOUNTED | PRIVATE } } 57aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 58aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Memory should not overlap between types. For example, a graphics buffer 59aa773500a4aefba7d737d1428b434af38334f409Colin Cross * that has been mapped into the GPU as a surface should show up when 60aa773500a4aefba7d737d1428b434af38334f409Colin Cross * MEMTRACK_TYPE_GRAPHICS is requested, and not when MEMTRACK_TYPE_GL 61aa773500a4aefba7d737d1428b434af38334f409Colin Cross * is requested. 62aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 63aa773500a4aefba7d737d1428b434af38334f409Colin Cross 64aa773500a4aefba7d737d1428b434af38334f409Colin Crossenum memtrack_type { 65aa773500a4aefba7d737d1428b434af38334f409Colin Cross MEMTRACK_TYPE_OTHER = 0, 66aa773500a4aefba7d737d1428b434af38334f409Colin Cross MEMTRACK_TYPE_GL = 1, 67aa773500a4aefba7d737d1428b434af38334f409Colin Cross MEMTRACK_TYPE_GRAPHICS = 2, 68aa773500a4aefba7d737d1428b434af38334f409Colin Cross MEMTRACK_TYPE_MULTIMEDIA = 3, 69aa773500a4aefba7d737d1428b434af38334f409Colin Cross MEMTRACK_TYPE_CAMERA = 4, 70aa773500a4aefba7d737d1428b434af38334f409Colin Cross MEMTRACK_NUM_TYPES, 71aa773500a4aefba7d737d1428b434af38334f409Colin Cross}; 72aa773500a4aefba7d737d1428b434af38334f409Colin Cross 73aa773500a4aefba7d737d1428b434af38334f409Colin Crossstruct memtrack_record { 74aa773500a4aefba7d737d1428b434af38334f409Colin Cross size_t size_in_bytes; 75aa773500a4aefba7d737d1428b434af38334f409Colin Cross unsigned int flags; 76aa773500a4aefba7d737d1428b434af38334f409Colin Cross}; 77aa773500a4aefba7d737d1428b434af38334f409Colin Cross 78aa773500a4aefba7d737d1428b434af38334f409Colin Cross/** 79aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Flags to differentiate memory that can already be accounted for in 80aa773500a4aefba7d737d1428b434af38334f409Colin Cross * /proc/<pid>/smaps, 81aa773500a4aefba7d737d1428b434af38334f409Colin Cross * (Shared_Clean + Shared_Dirty + Private_Clean + Private_Dirty = Size). 82aa773500a4aefba7d737d1428b434af38334f409Colin Cross * In general, memory mapped in to a userspace process is accounted unless 83aa773500a4aefba7d737d1428b434af38334f409Colin Cross * it was mapped with remap_pfn_range. 84aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Exactly one of these should be set. 85aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 86aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_SMAPS_ACCOUNTED (1 << 1) 87aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_SMAPS_UNACCOUNTED (1 << 2) 88aa773500a4aefba7d737d1428b434af38334f409Colin Cross 89aa773500a4aefba7d737d1428b434af38334f409Colin Cross/** 90aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Flags to differentiate memory shared across multiple processes vs. memory 91aa773500a4aefba7d737d1428b434af38334f409Colin Cross * used by a single process. Only zero or one of these may be set in a record. 92aa773500a4aefba7d737d1428b434af38334f409Colin Cross * If none are set, record is assumed to count shared + private memory. 93aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 94aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_SHARED (1 << 3) 95aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_SHARED_PSS (1 << 4) /* shared / num_procesess */ 96aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_PRIVATE (1 << 5) 97aa773500a4aefba7d737d1428b434af38334f409Colin Cross 98aa773500a4aefba7d737d1428b434af38334f409Colin Cross/** 99aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Flags to differentiate memory taken from the kernel's allocation pool vs. 100aa773500a4aefba7d737d1428b434af38334f409Colin Cross * memory that is dedicated to non-kernel allocations, for example a carveout 101aa773500a4aefba7d737d1428b434af38334f409Colin Cross * or separate video memory. Only zero or one of these may be set in a record. 102aa773500a4aefba7d737d1428b434af38334f409Colin Cross * If none are set, record is assumed to count system + dedicated memory. 103aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 104aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_SYSTEM (1 << 6) 105aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_DEDICATED (1 << 7) 106aa773500a4aefba7d737d1428b434af38334f409Colin Cross 107aa773500a4aefba7d737d1428b434af38334f409Colin Cross/** 108aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Flags to differentiate memory accessible by the CPU in non-secure mode vs. 109aa773500a4aefba7d737d1428b434af38334f409Colin Cross * memory that is protected. Only zero or one of these may be set in a record. 110aa773500a4aefba7d737d1428b434af38334f409Colin Cross * If none are set, record is assumed to count secure + nonsecure memory. 111aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 112aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_NONSECURE (1 << 8) 113aa773500a4aefba7d737d1428b434af38334f409Colin Cross#define MEMTRACK_FLAG_SECURE (1 << 9) 114aa773500a4aefba7d737d1428b434af38334f409Colin Cross 115aa773500a4aefba7d737d1428b434af38334f409Colin Cross/** 116aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 117aa773500a4aefba7d737d1428b434af38334f409Colin Cross * and the fields of this data structure must begin with hw_module_t 118aa773500a4aefba7d737d1428b434af38334f409Colin Cross * followed by module specific information. 119aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 120aa773500a4aefba7d737d1428b434af38334f409Colin Crosstypedef struct memtrack_module { 121aa773500a4aefba7d737d1428b434af38334f409Colin Cross struct hw_module_t common; 122aa773500a4aefba7d737d1428b434af38334f409Colin Cross 123aa773500a4aefba7d737d1428b434af38334f409Colin Cross /** 124aa773500a4aefba7d737d1428b434af38334f409Colin Cross * (*init)() performs memtrack management setup actions and is called 125aa773500a4aefba7d737d1428b434af38334f409Colin Cross * once before any calls to getMemory(). 126aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Returns 0 on success, -errno on error. 127aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 128aa773500a4aefba7d737d1428b434af38334f409Colin Cross int (*init)(const struct memtrack_module *module); 129aa773500a4aefba7d737d1428b434af38334f409Colin Cross 130aa773500a4aefba7d737d1428b434af38334f409Colin Cross /** 131aa773500a4aefba7d737d1428b434af38334f409Colin Cross * (*getMemory)() expects an array of record objects and populates up to 132aa773500a4aefba7d737d1428b434af38334f409Colin Cross * *num_record structures with the sizes of memory plus associated flags for 133aa773500a4aefba7d737d1428b434af38334f409Colin Cross * that memory. It also updates *num_records with the total number of 134aa773500a4aefba7d737d1428b434af38334f409Colin Cross * records it could return if *num_records was large enough when passed in. 135aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Returning records with size 0 is expected, the number of records should 136aa773500a4aefba7d737d1428b434af38334f409Colin Cross * not vary between calls to getMemory for the same memory type, even 137aa773500a4aefba7d737d1428b434af38334f409Colin Cross * for different pids. 138aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 139aa773500a4aefba7d737d1428b434af38334f409Colin Cross * The caller will often call getMemory for a type and pid with 140aa773500a4aefba7d737d1428b434af38334f409Colin Cross * *num_records == 0 to determine how many records to allocate room for, 141aa773500a4aefba7d737d1428b434af38334f409Colin Cross * this case should be a fast-path in the HAL, returning a constant and 142aa773500a4aefba7d737d1428b434af38334f409Colin Cross * not querying any kernel files. If *num_records passed in is 0, 143aa773500a4aefba7d737d1428b434af38334f409Colin Cross * then records may be NULL. 144aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 145aa773500a4aefba7d737d1428b434af38334f409Colin Cross * This function must be thread-safe, it may get called from multiple 146aa773500a4aefba7d737d1428b434af38334f409Colin Cross * threads at the same time. 147aa773500a4aefba7d737d1428b434af38334f409Colin Cross * 148aa773500a4aefba7d737d1428b434af38334f409Colin Cross * Returns 0 on success, -ENODEV if the type is not supported, -errno 149aa773500a4aefba7d737d1428b434af38334f409Colin Cross * on other errors. 150aa773500a4aefba7d737d1428b434af38334f409Colin Cross */ 151aa773500a4aefba7d737d1428b434af38334f409Colin Cross int (*getMemory)(const struct memtrack_module *module, 152aa773500a4aefba7d737d1428b434af38334f409Colin Cross pid_t pid, 153aa773500a4aefba7d737d1428b434af38334f409Colin Cross int type, 154aa773500a4aefba7d737d1428b434af38334f409Colin Cross struct memtrack_record *records, 155aa773500a4aefba7d737d1428b434af38334f409Colin Cross size_t *num_records); 156aa773500a4aefba7d737d1428b434af38334f409Colin Cross} memtrack_module_t; 157aa773500a4aefba7d737d1428b434af38334f409Colin Cross 158aa773500a4aefba7d737d1428b434af38334f409Colin Cross__END_DECLS 159aa773500a4aefba7d737d1428b434af38334f409Colin Cross 160aa773500a4aefba7d737d1428b434af38334f409Colin Cross#endif // ANDROID_INCLUDE_HARDWARE_MEMTRACK_H 161