1/*- 2 * Copyright (c) 2005 Robert N. M. Watson 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29#ifndef _MEMSTAT_H_ 30#define _MEMSTAT_H_ 31 32/* 33 * Amount of caller data to maintain for each caller data slot. Applications 34 * must not request more than this number of caller save data, or risk 35 * corrupting internal libmemstat(3) data structures. A compile time check 36 * in the application is probably appropriate. 37 */ 38#define MEMSTAT_MAXCALLER 16 39 40/* 41 * libmemstat(3) is able to extract memory data from different allocators; 42 * when it does so, it tags which allocator it got the data from so that 43 * consumers can determine which fields are usable, as data returned varies 44 * some. 45 */ 46#define ALLOCATOR_UNKNOWN 0 47#define ALLOCATOR_MALLOC 1 48#define ALLOCATOR_UMA 2 49#define ALLOCATOR_ANY 255 50 51/* 52 * Library maximum type name. Should be max(set of name maximums over 53 * various allocators). 54 */ 55#define MEMTYPE_MAXNAME 32 56 57/* 58 * Library error conditions, mostly from the underlying data sources. On 59 * failure, functions typically return (-1) or (NULL); on success, (0) or a 60 * valid data pointer. The error from the last operation is stored in 61 * struct memory_type_list, and accessed via memstat_get_error(list). 62 */ 63#define MEMSTAT_ERROR_UNDEFINED 0 /* Initialization value. */ 64#define MEMSTAT_ERROR_NOMEMORY 1 /* Out of memory. */ 65#define MEMSTAT_ERROR_VERSION 2 /* Unsupported version. */ 66#define MEMSTAT_ERROR_PERMISSION 3 /* Permission denied. */ 67#define MEMSTAT_ERROR_DATAERROR 5 /* Error in stat data. */ 68#define MEMSTAT_ERROR_KVM 6 /* See kvm_geterr() for err. */ 69#define MEMSTAT_ERROR_KVM_NOSYMBOL 7 /* Symbol not available. */ 70#define MEMSTAT_ERROR_KVM_SHORTREAD 8 /* Short kvm_read return. */ 71 72/* 73 * Forward declare struct memory_type, which holds per-type properties and 74 * statistics. This is an opaque type, to be frobbed only from within the 75 * library, in order to avoid building ABI assumptions into the application. 76 * Accessor methods should be used to get and sometimes set the fields from 77 * consumers of the library. 78 */ 79struct memory_type; 80 81/* 82 * struct memory_type_list is the head of a list of memory types and 83 * statistics. 84 */ 85struct memory_type_list; 86 87__BEGIN_DECLS 88/* 89 * Functions that operate without memory type or memory type list context. 90 */ 91const char *memstat_strerror(int error); 92 93/* 94 * Functions for managing memory type and statistics data. 95 */ 96struct memory_type_list *memstat_mtl_alloc(void); 97struct memory_type *memstat_mtl_first(struct memory_type_list *list); 98struct memory_type *memstat_mtl_next(struct memory_type *mtp); 99struct memory_type *memstat_mtl_find(struct memory_type_list *list, 100 int allocator, const char *name); 101void memstat_mtl_free(struct memory_type_list *list); 102int memstat_mtl_geterror(struct memory_type_list *list); 103 104/* 105 * Functions to retrieve data from a live kernel using sysctl. 106 */ 107int memstat_sysctl_all(struct memory_type_list *list, int flags); 108int memstat_sysctl_malloc(struct memory_type_list *list, int flags); 109int memstat_sysctl_uma(struct memory_type_list *list, int flags); 110 111/* 112 * Functions to retrieve data from a kernel core (or /dev/kmem). 113 */ 114int memstat_kvm_all(struct memory_type_list *list, void *kvm_handle); 115int memstat_kvm_malloc(struct memory_type_list *list, void *kvm_handle); 116int memstat_kvm_uma(struct memory_type_list *list, void *kvm_handle); 117 118/* 119 * Accessor methods for struct memory_type. 120 */ 121const char *memstat_get_name(const struct memory_type *mtp); 122int memstat_get_allocator(const struct memory_type *mtp); 123uint64_t memstat_get_countlimit(const struct memory_type *mtp); 124uint64_t memstat_get_byteslimit(const struct memory_type *mtp); 125uint64_t memstat_get_sizemask(const struct memory_type *mtp); 126uint64_t memstat_get_size(const struct memory_type *mtp); 127uint64_t memstat_get_memalloced(const struct memory_type *mtp); 128uint64_t memstat_get_memfreed(const struct memory_type *mtp); 129uint64_t memstat_get_numallocs(const struct memory_type *mtp); 130uint64_t memstat_get_numfrees(const struct memory_type *mtp); 131uint64_t memstat_get_bytes(const struct memory_type *mtp); 132uint64_t memstat_get_count(const struct memory_type *mtp); 133uint64_t memstat_get_free(const struct memory_type *mtp); 134uint64_t memstat_get_failures(const struct memory_type *mtp); 135uint64_t memstat_get_sleeps(const struct memory_type *mtp); 136void *memstat_get_caller_pointer(const struct memory_type *mtp, 137 int index); 138void memstat_set_caller_pointer(struct memory_type *mtp, 139 int index, void *value); 140uint64_t memstat_get_caller_uint64(const struct memory_type *mtp, 141 int index); 142void memstat_set_caller_uint64(struct memory_type *mtp, int index, 143 uint64_t value); 144uint64_t memstat_get_zonefree(const struct memory_type *mtp); 145uint64_t memstat_get_kegfree(const struct memory_type *mtp); 146uint64_t memstat_get_percpu_memalloced(const struct memory_type *mtp, 147 int cpu); 148uint64_t memstat_get_percpu_memfreed(const struct memory_type *mtp, 149 int cpu); 150uint64_t memstat_get_percpu_numallocs(const struct memory_type *mtp, 151 int cpu); 152uint64_t memstat_get_percpu_numfrees(const struct memory_type *mtp, 153 int cpu); 154uint64_t memstat_get_percpu_sizemask(const struct memory_type *mtp, 155 int cpu); 156void *memstat_get_percpu_caller_pointer( 157 const struct memory_type *mtp, int cpu, int index); 158void memstat_set_percpu_caller_pointer(struct memory_type *mtp, 159 int cpu, int index, void *value); 160uint64_t memstat_get_percpu_caller_uint64( 161 const struct memory_type *mtp, int cpu, int index); 162void memstat_set_percpu_caller_uint64(struct memory_type *mtp, 163 int cpu, int index, uint64_t value); 164uint64_t memstat_get_percpu_free(const struct memory_type *mtp, 165 int cpu); 166__END_DECLS 167 168#endif /* !_MEMSTAT_H_ */ 169