1147997Srwatson/*- 2147997Srwatson * Copyright (c) 2005 Robert N. M. Watson 3147997Srwatson * All rights reserved. 4147997Srwatson * 5147997Srwatson * Redistribution and use in source and binary forms, with or without 6147997Srwatson * modification, are permitted provided that the following conditions 7147997Srwatson * are met: 8147997Srwatson * 1. Redistributions of source code must retain the above copyright 9147997Srwatson * notice, this list of conditions and the following disclaimer. 10147997Srwatson * 2. Redistributions in binary form must reproduce the above copyright 11147997Srwatson * notice, this list of conditions and the following disclaimer in the 12147997Srwatson * documentation and/or other materials provided with the distribution. 13147997Srwatson * 14147997Srwatson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15147997Srwatson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16147997Srwatson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17147997Srwatson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18147997Srwatson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19147997Srwatson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20147997Srwatson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21147997Srwatson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22147997Srwatson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23147997Srwatson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24147997Srwatson * SUCH DAMAGE. 25147997Srwatson * 26147997Srwatson * $FreeBSD: releng/10.3/lib/libmemstat/memstat.h 224569 2011-08-01 09:43:35Z pluknet $ 27147997Srwatson */ 28147997Srwatson 29147997Srwatson#ifndef _MEMSTAT_H_ 30147997Srwatson#define _MEMSTAT_H_ 31147997Srwatson 32147997Srwatson/* 33148041Srwatson * Amount of caller data to maintain for each caller data slot. Applications 34148041Srwatson * must not request more than this number of caller save data, or risk 35148041Srwatson * corrupting internal libmemstat(3) data structures. A compile time check 36148041Srwatson * in the application is probably appropriate. 37148041Srwatson */ 38148121Srwatson#define MEMSTAT_MAXCALLER 16 39148041Srwatson 40148041Srwatson/* 41147997Srwatson * libmemstat(3) is able to extract memory data from different allocators; 42147997Srwatson * when it does so, it tags which allocator it got the data from so that 43147997Srwatson * consumers can determine which fields are usable, as data returned varies 44147997Srwatson * some. 45147997Srwatson */ 46147997Srwatson#define ALLOCATOR_UNKNOWN 0 47147997Srwatson#define ALLOCATOR_MALLOC 1 48147997Srwatson#define ALLOCATOR_UMA 2 49147997Srwatson#define ALLOCATOR_ANY 255 50147997Srwatson 51147997Srwatson/* 52147997Srwatson * Library maximum type name. Should be max(set of name maximums over 53147997Srwatson * various allocators). 54147997Srwatson */ 55147997Srwatson#define MEMTYPE_MAXNAME 32 56147997Srwatson 57147997Srwatson/* 58148357Srwatson * Library error conditions, mostly from the underlying data sources. On 59148357Srwatson * failure, functions typically return (-1) or (NULL); on success, (0) or a 60148357Srwatson * valid data pointer. The error from the last operation is stored in 61167597Srwatson * struct memory_type_list, and accessed via memstat_get_error(list). 62148357Srwatson */ 63148357Srwatson#define MEMSTAT_ERROR_UNDEFINED 0 /* Initialization value. */ 64148357Srwatson#define MEMSTAT_ERROR_NOMEMORY 1 /* Out of memory. */ 65148357Srwatson#define MEMSTAT_ERROR_VERSION 2 /* Unsupported version. */ 66148357Srwatson#define MEMSTAT_ERROR_PERMISSION 3 /* Permission denied. */ 67148357Srwatson#define MEMSTAT_ERROR_DATAERROR 5 /* Error in stat data. */ 68148627Srwatson#define MEMSTAT_ERROR_KVM 6 /* See kvm_geterr() for err. */ 69148627Srwatson#define MEMSTAT_ERROR_KVM_NOSYMBOL 7 /* Symbol not available. */ 70148627Srwatson#define MEMSTAT_ERROR_KVM_SHORTREAD 8 /* Short kvm_read return. */ 71148357Srwatson 72148357Srwatson/* 73147997Srwatson * Forward declare struct memory_type, which holds per-type properties and 74147997Srwatson * statistics. This is an opaque type, to be frobbed only from within the 75147997Srwatson * library, in order to avoid building ABI assumptions into the application. 76147997Srwatson * Accessor methods should be used to get and sometimes set the fields from 77147997Srwatson * consumers of the library. 78147997Srwatson */ 79147997Srwatsonstruct memory_type; 80147997Srwatson 81147997Srwatson/* 82147997Srwatson * struct memory_type_list is the head of a list of memory types and 83147997Srwatson * statistics. 84147997Srwatson */ 85147997Srwatsonstruct memory_type_list; 86147997Srwatson 87148094Srwatson__BEGIN_DECLS 88147997Srwatson/* 89148359Srwatson * Functions that operate without memory type or memory type list context. 90148359Srwatson */ 91148359Srwatsonconst char *memstat_strerror(int error); 92148359Srwatson 93148359Srwatson/* 94147997Srwatson * Functions for managing memory type and statistics data. 95147997Srwatson */ 96147997Srwatsonstruct memory_type_list *memstat_mtl_alloc(void); 97147997Srwatsonstruct memory_type *memstat_mtl_first(struct memory_type_list *list); 98147997Srwatsonstruct memory_type *memstat_mtl_next(struct memory_type *mtp); 99147997Srwatsonstruct memory_type *memstat_mtl_find(struct memory_type_list *list, 100147997Srwatson int allocator, const char *name); 101147997Srwatsonvoid memstat_mtl_free(struct memory_type_list *list); 102148357Srwatsonint memstat_mtl_geterror(struct memory_type_list *list); 103147997Srwatson 104147997Srwatson/* 105147997Srwatson * Functions to retrieve data from a live kernel using sysctl. 106147997Srwatson */ 107147997Srwatsonint memstat_sysctl_all(struct memory_type_list *list, int flags); 108147997Srwatsonint memstat_sysctl_malloc(struct memory_type_list *list, int flags); 109147997Srwatsonint memstat_sysctl_uma(struct memory_type_list *list, int flags); 110147997Srwatson 111147997Srwatson/* 112148627Srwatson * Functions to retrieve data from a kernel core (or /dev/kmem). 113148627Srwatson */ 114148627Srwatsonint memstat_kvm_all(struct memory_type_list *list, void *kvm_handle); 115148789Srwatsonint memstat_kvm_malloc(struct memory_type_list *list, void *kvm_handle); 116148627Srwatsonint memstat_kvm_uma(struct memory_type_list *list, void *kvm_handle); 117148627Srwatson 118148627Srwatson/* 119148357Srwatson * Accessor methods for struct memory_type. 120147997Srwatson */ 121147997Srwatsonconst char *memstat_get_name(const struct memory_type *mtp); 122147997Srwatsonint memstat_get_allocator(const struct memory_type *mtp); 123147997Srwatsonuint64_t memstat_get_countlimit(const struct memory_type *mtp); 124147997Srwatsonuint64_t memstat_get_byteslimit(const struct memory_type *mtp); 125147997Srwatsonuint64_t memstat_get_sizemask(const struct memory_type *mtp); 126147997Srwatsonuint64_t memstat_get_size(const struct memory_type *mtp); 127147997Srwatsonuint64_t memstat_get_memalloced(const struct memory_type *mtp); 128147997Srwatsonuint64_t memstat_get_memfreed(const struct memory_type *mtp); 129147997Srwatsonuint64_t memstat_get_numallocs(const struct memory_type *mtp); 130147997Srwatsonuint64_t memstat_get_numfrees(const struct memory_type *mtp); 131147997Srwatsonuint64_t memstat_get_bytes(const struct memory_type *mtp); 132147997Srwatsonuint64_t memstat_get_count(const struct memory_type *mtp); 133147997Srwatsonuint64_t memstat_get_free(const struct memory_type *mtp); 134147997Srwatsonuint64_t memstat_get_failures(const struct memory_type *mtp); 135209215Ssbrunouint64_t memstat_get_sleeps(const struct memory_type *mtp); 136147997Srwatsonvoid *memstat_get_caller_pointer(const struct memory_type *mtp, 137147997Srwatson int index); 138147997Srwatsonvoid memstat_set_caller_pointer(struct memory_type *mtp, 139147997Srwatson int index, void *value); 140147997Srwatsonuint64_t memstat_get_caller_uint64(const struct memory_type *mtp, 141147997Srwatson int index); 142147997Srwatsonvoid memstat_set_caller_uint64(struct memory_type *mtp, int index, 143147997Srwatson uint64_t value); 144147997Srwatsonuint64_t memstat_get_zonefree(const struct memory_type *mtp); 145148170Srwatsonuint64_t memstat_get_kegfree(const struct memory_type *mtp); 146147997Srwatsonuint64_t memstat_get_percpu_memalloced(const struct memory_type *mtp, 147147997Srwatson int cpu); 148147997Srwatsonuint64_t memstat_get_percpu_memfreed(const struct memory_type *mtp, 149147997Srwatson int cpu); 150147997Srwatsonuint64_t memstat_get_percpu_numallocs(const struct memory_type *mtp, 151147997Srwatson int cpu); 152147997Srwatsonuint64_t memstat_get_percpu_numfrees(const struct memory_type *mtp, 153147997Srwatson int cpu); 154147997Srwatsonuint64_t memstat_get_percpu_sizemask(const struct memory_type *mtp, 155147997Srwatson int cpu); 156147997Srwatsonvoid *memstat_get_percpu_caller_pointer( 157147997Srwatson const struct memory_type *mtp, int cpu, int index); 158147997Srwatsonvoid memstat_set_percpu_caller_pointer(struct memory_type *mtp, 159147997Srwatson int cpu, int index, void *value); 160147997Srwatsonuint64_t memstat_get_percpu_caller_uint64( 161147997Srwatson const struct memory_type *mtp, int cpu, int index); 162147997Srwatsonvoid memstat_set_percpu_caller_uint64(struct memory_type *mtp, 163147997Srwatson int cpu, int index, uint64_t value); 164147997Srwatsonuint64_t memstat_get_percpu_free(const struct memory_type *mtp, 165147997Srwatson int cpu); 166148094Srwatson__END_DECLS 167147997Srwatson 168147997Srwatson#endif /* !_MEMSTAT_H_ */ 169