1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/*
This file is part of the KDE libraries
Copyright (C) 2000 Waldo Bastian (bastian@kde.org)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
//----------------------------------------------------------------------------
//
// KDE Virtual Memory Allocator
#ifndef KVMALLOCATOR_H
#define KVMALLOCATOR_H
#include <sys/types.h>
#include "kdelibs_export.h"
class KVMAllocatorPrivate;
/**
* KVMAllocator is a virtual memory allocator.
* Memory is allocated block-wise in a tmp file.
*
* @author Waldo Bastian <bastian@kde.org>
*/
class TDECORE_EXPORT KVMAllocator
{
public:
struct Block;
/**
* Create a KVMAllocator
*/
KVMAllocator();
/**
* Destruct the KVMAllocator and release all memory.
*/
~KVMAllocator();
/**
* Allocate a virtual memory block.
* @param _size Size in bytes of the memory block.
* @return the allocated memory block
*/
Block *allocate(size_t _size);
/**
* Free a virtual memory block.
* @param block the block to free
*/
void free(Block *block);
/**
* Copy @p length bytes from @p _offset in the virtual memory block
* @p src to normal memory at address *dest.
* @param dest the destination of the data
* @param src the source block
* @param _offset the offset in the source block
* @param length the length of the data to copy
* @return true on success, false on failure, see errno for details
* @since 3.2
*/
bool copyBlock(void *dest, Block *src, int _offset = 0, size_t length = 0);
/**
* @deprecated
* @see copyBlock
*/
void copy(void *dest, Block *src, int _offset = 0, size_t length = 0) KDE_DEPRECATED;
/**
* Copy @p length bytes from normal memory at address @p src to
* @p _offset in the virtual memory block @p dest.
* @param dest the block to copy the data to
* @param src the source location of the data
* @param _offset the offset in the destination block
* @param length the length of the data to copy
* @return true on success, false on failure, see errno for details
* @since 3.2
*/
bool copyBlock(Block *dest, void *src, int _offset = 0, size_t length = 0);
/**
* @deprecated
* @see copyBlock
*/
void copy(Block *dest, void *src, int _offset = 0, size_t length = 0) KDE_DEPRECATED;
/**
* Map a virtual memory block in memory
* @param block the block to map
*/
void *map(Block *block);
/**
* Unmap a virtual memory block
* @param block the block to unmap
*/
void unmap(Block *block);
private:
KVMAllocatorPrivate *d;
};
#endif
|
