memstat.h revision 147997
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: head/lib/libmemstat/memstat.h 147997 2005-07-14 17:40:02Z rwatson $ 27 */ 28 29#ifndef _MEMSTAT_H_ 30#define _MEMSTAT_H_ 31 32/* 33 * Number of CPU slots in library-internal data structures. This should be 34 * at least the value of MAXCPU from param.h. 35 */ 36#define MEMSTAT_MAXCPU 16 37 38/* 39 * libmemstat(3) is able to extract memory data from different allocators; 40 * when it does so, it tags which allocator it got the data from so that 41 * consumers can determine which fields are usable, as data returned varies 42 * some. 43 */ 44#define ALLOCATOR_UNKNOWN 0 45#define ALLOCATOR_MALLOC 1 46#define ALLOCATOR_UMA 2 47#define ALLOCATOR_ANY 255 48 49/* 50 * Library maximum type name. Should be max(set of name maximums over 51 * various allocators). 52 */ 53#define MEMTYPE_MAXNAME 32 54 55/* 56 * Forward declare struct memory_type, which holds per-type properties and 57 * statistics. This is an opaque type, to be frobbed only from within the 58 * library, in order to avoid building ABI assumptions into the application. 59 * Accessor methods should be used to get and sometimes set the fields from 60 * consumers of the library. 61 */ 62struct memory_type; 63 64/* 65 * struct memory_type_list is the head of a list of memory types and 66 * statistics. 67 */ 68struct memory_type_list; 69 70/* 71 * Functions for managing memory type and statistics data. 72 */ 73struct memory_type_list *memstat_mtl_alloc(void); 74struct memory_type *memstat_mtl_first(struct memory_type_list *list); 75struct memory_type *memstat_mtl_next(struct memory_type *mtp); 76struct memory_type *memstat_mtl_find(struct memory_type_list *list, 77 int allocator, const char *name); 78void memstat_mtl_free(struct memory_type_list *list); 79 80/* 81 * Functions to retrieve data from a live kernel using sysctl. 82 */ 83int memstat_sysctl_all(struct memory_type_list *list, int flags); 84int memstat_sysctl_malloc(struct memory_type_list *list, int flags); 85int memstat_sysctl_uma(struct memory_type_list *list, int flags); 86 87/* 88 * Accessor methods for struct memory_type_list. 89 */ 90const char *memstat_get_name(const struct memory_type *mtp); 91int memstat_get_allocator(const struct memory_type *mtp); 92uint64_t memstat_get_countlimit(const struct memory_type *mtp); 93uint64_t memstat_get_byteslimit(const struct memory_type *mtp); 94uint64_t memstat_get_sizemask(const struct memory_type *mtp); 95uint64_t memstat_get_size(const struct memory_type *mtp); 96uint64_t memstat_get_memalloced(const struct memory_type *mtp); 97uint64_t memstat_get_memfreed(const struct memory_type *mtp); 98uint64_t memstat_get_numallocs(const struct memory_type *mtp); 99uint64_t memstat_get_numfrees(const struct memory_type *mtp); 100uint64_t memstat_get_bytes(const struct memory_type *mtp); 101uint64_t memstat_get_count(const struct memory_type *mtp); 102uint64_t memstat_get_free(const struct memory_type *mtp); 103uint64_t memstat_get_failures(const struct memory_type *mtp); 104void *memstat_get_caller_pointer(const struct memory_type *mtp, 105 int index); 106void memstat_set_caller_pointer(struct memory_type *mtp, 107 int index, void *value); 108uint64_t memstat_get_caller_uint64(const struct memory_type *mtp, 109 int index); 110void memstat_set_caller_uint64(struct memory_type *mtp, int index, 111 uint64_t value); 112uint64_t memstat_get_zonefree(const struct memory_type *mtp); 113uint64_t memstat_get_percpu_memalloced(const struct memory_type *mtp, 114 int cpu); 115uint64_t memstat_get_percpu_memfreed(const struct memory_type *mtp, 116 int cpu); 117uint64_t memstat_get_percpu_numallocs(const struct memory_type *mtp, 118 int cpu); 119uint64_t memstat_get_percpu_numfrees(const struct memory_type *mtp, 120 int cpu); 121uint64_t memstat_get_percpu_sizemask(const struct memory_type *mtp, 122 int cpu); 123void *memstat_get_percpu_caller_pointer( 124 const struct memory_type *mtp, int cpu, int index); 125void memstat_set_percpu_caller_pointer(struct memory_type *mtp, 126 int cpu, int index, void *value); 127uint64_t memstat_get_percpu_caller_uint64( 128 const struct memory_type *mtp, int cpu, int index); 129void memstat_set_percpu_caller_uint64(struct memory_type *mtp, 130 int cpu, int index, uint64_t value); 131uint64_t memstat_get_percpu_free(const struct memory_type *mtp, 132 int cpu); 133 134#endif /* !_MEMSTAT_H_ */ 135