1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2005 Robert N. M. Watson
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _MEMSTAT_INTERNAL_H_
30#define	_MEMSTAT_INTERNAL_H_
31
32/*
33 * memstat maintains its own internal notion of statistics on each memory
34 * type, common across UMA and kernel malloc.  Some fields are straight from
35 * the allocator statistics, others are derived when extracted from the
36 * kernel.  A struct memory_type will describe each type supported by an
37 * allocator.  memory_type structures can be chained into lists.
38 */
39struct memory_type {
40	/*
41	 * Static properties of type.
42	 */
43	int	 mt_allocator;		/* malloc(9), uma(9), etc. */
44	char	 mt_name[MEMTYPE_MAXNAME];	/* name of memory type. */
45
46	/*
47	 * (Relatively) static zone settings, that don't uniquely identify
48	 * the zone, but also don't change much.
49	 */
50	uint64_t	 mt_countlimit;	/* 0, or maximum allocations. */
51	uint64_t	 mt_byteslimit;	/* 0, or maximum bytes. */
52	uint64_t	 mt_sizemask;	/* malloc: allocated size bitmask. */
53	uint64_t	 mt_size;	/* uma: size of objects. */
54	uint64_t	 mt_rsize;	/* uma: real size of objects. */
55
56	/*
57	 * Zone or type information that includes all caches and any central
58	 * zone state.  Depending on the allocator, this may be synthesized
59	 * from several sources, or directly measured.
60	 */
61	uint64_t	 mt_memalloced;	/* Bytes allocated over life time. */
62	uint64_t	 mt_memfreed;	/* Bytes freed over life time. */
63	uint64_t	 mt_numallocs;	/* Allocations over life time. */
64	uint64_t	 mt_numfrees;	/* Frees over life time. */
65	uint64_t	 mt_bytes;	/* Bytes currently allocated. */
66	uint64_t	 mt_count;	/* Number of current allocations. */
67	uint64_t	 mt_free;	/* Number of cached free items. */
68	uint64_t	 mt_failures;	/* Number of allocation failures. */
69	uint64_t	 mt_sleeps;	/* Number of allocation sleeps. */
70	uint64_t	 mt_xdomain;	/* Number of cross domain sleeps. */
71
72	/*
73	 * Caller-owned memory.
74	 */
75	void		*mt_caller_pointer[MEMSTAT_MAXCALLER];	/* Pointers. */
76	uint64_t	 mt_caller_uint64[MEMSTAT_MAXCALLER];	/* Integers. */
77
78	/*
79	 * For allocators making use of per-CPU caches, we also provide raw
80	 * statistics from the central allocator and each per-CPU cache,
81	 * which (combined) sometimes make up the above general statistics.
82	 *
83	 * First, central zone/type state, all numbers excluding any items
84	 * cached in per-CPU caches.
85	 *
86	 * XXXRW: Might be desirable to separately expose allocation stats
87	 * from zone, which should (combined with per-cpu) add up to the
88	 * global stats above.
89	 */
90	uint64_t	 mt_zonefree;	/* Free items in zone. */
91	uint64_t	 mt_kegfree;	/* Free items in keg. */
92
93	/*
94	 * Per-CPU measurements fall into two categories: per-CPU allocation,
95	 * and per-CPU cache state.
96	 */
97	struct mt_percpu_alloc_s {
98		uint64_t	 mtp_memalloced;/* Per-CPU mt_memalloced. */
99		uint64_t	 mtp_memfreed;	/* Per-CPU mt_memfreed. */
100		uint64_t	 mtp_numallocs;	/* Per-CPU mt_numallocs. */
101		uint64_t	 mtp_numfrees;	/* Per-CPU mt_numfrees. */
102		uint64_t	 mtp_sizemask;	/* Per-CPU mt_sizemask. */
103		void		*mtp_caller_pointer[MEMSTAT_MAXCALLER];
104		uint64_t	 mtp_caller_uint64[MEMSTAT_MAXCALLER];
105	}	*mt_percpu_alloc;
106
107	struct mt_percpu_cache_s {
108		uint64_t	 mtp_free;	/* Per-CPU cache free items. */
109	}	*mt_percpu_cache;
110
111	LIST_ENTRY(memory_type)	mt_list;	/* List of types. */
112};
113
114/*
115 * Description of struct memory_type_list is in memstat.h.
116 */
117struct memory_type_list {
118	LIST_HEAD(, memory_type)	mtl_list;
119	int				mtl_error;
120};
121
122void			 _memstat_mtl_empty(struct memory_type_list *list);
123struct memory_type	*_memstat_mt_allocate(struct memory_type_list *list,
124			    int allocator, const char *name, int maxcpus);
125void			 _memstat_mt_reset_stats(struct memory_type *mtp,
126			    int maxcpus);
127
128#endif /* !_MEMSTAT_INTERNAL_H_ */
129