blob: ed8de699fbc07a509df367086e99782c037ca74b (
plain)
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/devicefw/assoccontain.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
/** @file assoccontain.H
* @brief Provides a memory pool container for allocating blocks of
* associations for the device driver framework.
*
* This class exists because storing the information in a normal map or
* vector would be exceptionally big for the expected sparseness of the
* device driver associations.
*/
#ifndef __DEVICEFW_ASSOCCONTAIN_H
#define __DEVICEFW_ASSOCCONTAIN_H
#include <stdint.h>
#include <builtins.h>
namespace DeviceFW
{
/** @struct AssociationData
* @brief Data about a particular association.
*
* Typically this is a offset (pointer) to another association and an
* optional flag for the associator to use. This allows a user to
* construct a light-weight multi-dimensional sparse array.
*
* The purpose of the flag field is left to the user.
*/
struct AssociationData
{
bool flag:1;
size_t offset:15;
AssociationData() : flag(false), offset(0) { };
AssociationData(bool i_flag, size_t i_off)
: flag(i_flag), offset(i_off) { };
} PACKED;
/** @class AssociationContainer
* @brief The memory pool container of AssociationData blocks.
*
* The typical usage of this will be to create a multi-dimensional sparse
* associative array (map). The first block allocated will be the first
* dimension of the array. Each AssociationData entry in the block is the
* offset of the block containing the AssociationData for the next
* dimension. At the lowest level this offset might be used as an offset
* into another container, such as an std::vector.
*/
class AssociationContainer
{
public:
/**
* @brief Constructor for AssociationContainer.
*
* Initializes internal members to clean values.
*/
AssociationContainer();
/**
* @brief Destructor for AssociationContainer.
*
* Releases memory associated with container. After this call
* all pointers previously obtained through operator[] are invalid.
*/
~AssociationContainer();
/**
* @brief Look up a particular association entry by offset.
* @return A pointer to the requested association block.
*
* @note Will return a NULL pointer if an invalid offset is given.
*/
AssociationData* operator[](size_t) const;
/**
* @brief Allocate a new block into the pool.
* @return A offset to the newly allocated block.
*
* The blocks allocated will all be erased to 0's.
*
* @note This function can change the pointers previously
* returned by the operator[]. Treat this function
* as though all previous pointers are invalidated.
*/
size_t allocate(size_t);
private:
AssociationData* iv_data;
size_t iv_size;
};
};
#endif
|
