VirtualBox

source: vbox/trunk/include/iprt/memcache.h@ 39684

Last change on this file since 39684 was 28800, checked in by vboxsync, 15 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.0 KB
Line 
1/** @file
2 * IPRT - Memory Object Allocation Cache.
3 */
4
5/*
6 * Copyright (C) 2006-2010 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___iprt_memcache_h
27#define ___iprt_memcache_h
28
29
30#include <iprt/cdefs.h>
31#include <iprt/types.h>
32
33RT_C_DECLS_BEGIN
34
35
36/** @defgroup grp_rt_memcache RTMemCache - Memory Object Allocation Cache
37 * @ingroup grp_rt
38 *
39 * Optimized allocation, initialization, freeing and destruction of memory
40 * objects of the same kind and size.
41 *
42 * @{
43 */
44
45/** A memory cache handle. */
46typedef R3R0PTRTYPE(struct RTMEMCACHEINT *) RTMEMCACHE;
47/** Pointer to a memory cache handle. */
48typedef RTMEMCACHE *PRTMEMCACHE;
49/** Nil memory cache handle. */
50#define NIL_RTMEMCACHE ((RTMEMCACHE)0)
51
52
53/**
54 * Object constructor.
55 *
56 * This is called for when an element is allocated for the first time.
57 *
58 * @returns IPRT status code.
59 * @param hMemCache The cache handle.
60 * @param pvObj The memory object that should be initialized.
61 * @param pvUser The user argument.
62 *
63 * @remarks No serialization is performed.
64 */
65typedef DECLCALLBACK(int) FNMEMCACHECTOR(RTMEMCACHE hMemCache, void *pvObj, void *pvUser);
66/** Pointer to an object constructor for the memory cache. */
67typedef FNMEMCACHECTOR *PFNMEMCACHECTOR;
68
69/**
70 * Object destructor.
71 *
72 * This is called when we're shrinking or destroying the cache.
73 *
74 * @param hMemCache The cache handle.
75 * @param pvObj The memory object that should be initialized.
76 * @param pvUser The user argument.
77 *
78 * @remarks No serialization is performed.
79 */
80typedef DECLCALLBACK(void) FNMEMCACHEDTOR(RTMEMCACHE hMemCache, void *pvObj, void *pvUser);
81/** Pointer to an object destructor for the memory cache. */
82typedef FNMEMCACHEDTOR *PFNMEMCACHEDTOR;
83
84
85/**
86 * Create an allocation cache for fixed size memory objects.
87 *
88 * @returns IPRT status code.
89 * @param phMemCache Where to return the cache handle.
90 * @param cbObject The size of one memory object.
91 * @param cbAlignment The object alignment. This must be a power of
92 * two. The higest alignment is 64. If set to 0,
93 * a sensible alignment value will be derived from
94 * the object size.
95 * @param cMaxObjects The maximum cache size. Pass UINT32_MAX if unsure.
96 * @param pfnCtor Object constructor callback. Optional.
97 * @param pfnDtor Object destructor callback. Optional.
98 * @param pvUser User argument for the two callbacks.
99 * @param fFlags Flags reserved for future use. Must be zero.
100 */
101RTDECL(int) RTMemCacheCreate(PRTMEMCACHE phMemCache, size_t cbObject, size_t cbAlignment, uint32_t cMaxObjects,
102 PFNMEMCACHECTOR pfnCtor, PFNMEMCACHEDTOR pfnDtor, void *pvUser, uint32_t fFlags);
103
104/**
105 * Destroy a cache destroying and freeing allocated memory.
106 *
107 * @returns IPRT status code.
108 * @param hMemCache The cache handle. NIL is quietly (VINF_SUCCESS)
109 * ignored.
110 */
111RTDECL(int) RTMemCacheDestroy(RTMEMCACHE hMemCache);
112
113/**
114 * Allocate an object.
115 *
116 * @returns Pointer to the allocated cache object.
117 * @param hMemCache The cache handle.
118 */
119RTDECL(void *) RTMemCacheAlloc(RTMEMCACHE hMemCache);
120
121/**
122 * Allocate an object and return a proper status code.
123 *
124 * @returns IPRT status code.
125 * @retval VERR_MEM_CACHE_MAX_SIZE if we've reached maximum size (see
126 * RTMemCacheCreate).
127 * @retval VERR_NO_MEMORY if we failed to allocate more memory for the cache.
128 *
129 * @param hMemCache The cache handle.
130 * @param ppvObj Where to return the object.
131 */
132RTDECL(int) RTMemCacheAllocEx(RTMEMCACHE hMemCache, void **ppvObj);
133
134/**
135 * Free an object previously returned by RTMemCacheAlloc or RTMemCacheAllocEx.
136 *
137 * @param hMemCache The cache handle.
138 * @param pvObj The object to free. NULL is fine.
139 */
140RTDECL(void) RTMemCacheFree(RTMEMCACHE hMemCache, void *pvObj);
141
142/** @} */
143
144RT_C_DECLS_END
145
146#endif
147
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette