diff options
author | Gabe Black <gabeblack@google.com> | 2018-12-12 16:43:18 -0800 |
---|---|---|
committer | Gabe Black <gabeblack@google.com> | 2019-01-09 01:35:21 +0000 |
commit | e345154b19939db37fb391111d4dad190c62e81c (patch) | |
tree | 2bb6f5a3fe3a13f447f8b179337afc20e11b3648 /src/systemc/ext/tlm_core/2/generic_payload/array.hh | |
parent | 8c560b6c80e641a1937d9af98cb75588ec4eac05 (diff) | |
download | gem5-e345154b19939db37fb391111d4dad190c62e81c.tar.xz |
systemc: Rename tlm_core header files to have a .hh extentension.
This makes those files more consistent with other headers in gem5. The
top level headers (tlm and tlm.h) and the tlm_utils headers were left
alone since the user might reasonably expect those to have a well known
name. The tlm_core headers by comparison are an implementation detail,
and users shouldn't include them directly by name.
Change-Id: Ibc82e8159e47717c79d76f50ed96fdd619294a06
Reviewed-on: https://gem5-review.googlesource.com/c/15067
Reviewed-by: Anthony Gutierrez <anthony.gutierrez@amd.com>
Maintainer: Anthony Gutierrez <anthony.gutierrez@amd.com>
Diffstat (limited to 'src/systemc/ext/tlm_core/2/generic_payload/array.hh')
-rw-r--r-- | src/systemc/ext/tlm_core/2/generic_payload/array.hh | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/src/systemc/ext/tlm_core/2/generic_payload/array.hh b/src/systemc/ext/tlm_core/2/generic_payload/array.hh new file mode 100644 index 000000000..8650e6888 --- /dev/null +++ b/src/systemc/ext/tlm_core/2/generic_payload/array.hh @@ -0,0 +1,98 @@ +/***************************************************************************** + + Licensed to Accellera Systems Initiative Inc. (Accellera) under one or + more contributor license agreements. See the NOTICE file distributed + with this work for additional information regarding copyright ownership. + Accellera licenses this file to you 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. + + *****************************************************************************/ + +#ifndef __SYSTEMC_EXT_TLM_CORE_2_GENERIC_PAYLOADS_ARRAY_HH__ +#define __SYSTEMC_EXT_TLM_CORE_2_GENERIC_PAYLOADS_ARRAY_HH__ + +#include <vector> + +namespace tlm +{ + +// This implements a lean and fast array class that supports array expansion on +// request. The class is primarily used in the tlm_generic_payload class for +// storing the pointers to the extensions. +// +// Individual array elements can be accessed through the [] operators, and the +// array length is returned by the size() method. +// +// The size can be dynamically expanded using the expand(uint) method. There +// is no shrinking mechanism implemented, because the extension mechanism +// does not require this feature. Bear in mind that calling the expand method +// may invalidate all direct pointers into the array. + + +// The tlm_array shall always be used with T=tlm_extension_base*. +template <typename T> +class tlm_array : private std::vector<T> +{ + private: + typedef std::vector<T> base_type; + typedef typename base_type::size_type size_type; + + public: + tlm_array(size_type size=0) : base_type(size), m_entries() {} + + // Operators for dereferencing: + using base_type::operator []; + + // Array size: + using base_type::size; + + // Expand the array if needed: + void + expand(size_type new_size) + { + if (new_size > size()) + base_type::resize(new_size); + } + + static const char *const kind_string; + const char *kind() const { return kind_string; } + + // This function shall get a pointer to an array slot + // it stores this slot in a cache of active slots + void insert_in_cache(T *p) { m_entries.push_back(p - &(*this)[0]); } + + // This functions clears all active slots of the array. + void + free_entire_cache() + { + while (m_entries.size()) { + // We make sure no one cleared the slot manually. + if ((*this)[m_entries.back()]) { + // ...and then we call free on the content of the slot + (*this)[m_entries.back()]->free(); + } + // Afterwards we set the slot to NULL + (*this)[m_entries.back()] = nullptr; + m_entries.pop_back(); + } + } + + protected: + std::vector<size_type> m_entries; +}; + +template <typename T> +const char *const tlm_array<T>::kind_string = "tlm_array"; + +} // namespace tlm + +#endif /* __SYSTEMC_EXT_TLM_CORE_2_GENERIC_PAYLOADS_ARRAY_HH__ */ |