diff --git a/containers_cpp/include/embb/containers/blocking_queue.h b/containers_cpp/include/embb/containers/blocking_queue.h new file mode 100755 index 0000000..2fce38f --- /dev/null +++ b/containers_cpp/include/embb/containers/blocking_queue.h @@ -0,0 +1,88 @@ + /* + * Copyright (c) 2014-2015, Siemens AG. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef EMBB_CONTAINERS_BLOCKING_QUEUE_H_ +#define EMBB_CONTAINERS_BLOCKING_QUEUE_H_ + +#include + +#include + +namespace embb { +namespace containers { + +/** +* Wrapper for the standard library queue. +* +* \tparam T Element type +*/ +template< typename Type> +class BlockingQueue : public BlockingContainer { + private: + /** + * Internal queue from the standard library. + */ + std::queue internalQueue; + public: + /** + * Enqueues an element in the internal queue. + */ + void Enqueue( + const Type& element + /**< [IN] Constant reference to element to enqueue*/); + + void Dequeue( + Type& element + /**< [IN] Reference to dequeued element*/); + + protected: + /* + * Wrapper for the push method in the standard queue. + */ + virtual void SpecializedPush( + const Type& element + /**< [IN] Constant reference to element to push.*/); + + /** + * Wrapper for the pop method in the standard queue. + */ + virtual void SpecializedPop( + Type& element + /**< [IN,OUT] Reference to element to the popped element*/); + + /** + * Wrapper for the empty method in the standard queue. + */ + virtual bool IsEmpty(); + +}; + +} // namespace containers +} // namespace embb + +#include + +#endif // EMBB_CONTAINERS_BLOCKING_QUEUE_H_ \ No newline at end of file diff --git a/containers_cpp/include/embb/containers/internal/blocking_queue-inl.h b/containers_cpp/include/embb/containers/internal/blocking_queue-inl.h new file mode 100755 index 0000000..fb627c4 --- /dev/null +++ b/containers_cpp/include/embb/containers/internal/blocking_queue-inl.h @@ -0,0 +1,64 @@ +#include "..\blocking_queue.h" +/* + * Copyright (c) 2014-2015, Siemens AG. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef EMBB_CONTAINERS_INTERNAL_BLOCKING_QUEUE_INL_H_ +#define EMBB_CONTAINERS_INTERNAL_BLOCKING_QUEUE_INL_H_ + + +namespace embb { +namespace containers { + +template +void BlockingQueue::SpecializedPush(const T& element) { + internalQueue.push(element); +} + +template +void BlockingQueue::SpecializedPop(T& element) { + element = internalQueue.front(); + internalQueue.pop(); +} + +template +bool BlockingQueue::IsEmpty() { + return internalQueue.empty(); +} + +template +void BlockingQueue::Enqueue(const T& element) { + PushAndWakeUp(element); +} + +template +void BlockingQueue::Dequeue(T& element) { + BlockingPop(element); +} + +} // namespace containers +} // namespace embb + +#endif // EMBB_CONTAINERS_INTERNAL_BLOCKING_QUEUE_INL_H_ diff --git a/containers_cpp/test/blocking_queue_test-inl.h b/containers_cpp/test/blocking_queue_test-inl.h new file mode 100755 index 0000000..1dbccd5 --- /dev/null +++ b/containers_cpp/test/blocking_queue_test-inl.h @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2014-2016, Siemens AG. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_INL_H_ +#define CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_INL_H_ + +#include +#include + +namespace embb { +namespace containers { +namespace test { + +template +void BlockingQueueTest::SpecializedPush(const int& element){ + container.Enqueue(element); +} + +template +void BlockingQueueTest::SpecializedPop(int& element){ + container.Dequeue(element); +} + +} // namespace test +} // namespace containers +} // namespace embb + +#endif // CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_INL_H_ diff --git a/containers_cpp/test/blocking_queue_test.h b/containers_cpp/test/blocking_queue_test.h new file mode 100755 index 0000000..6bc773f --- /dev/null +++ b/containers_cpp/test/blocking_queue_test.h @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2014-2016, Siemens AG. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_H_ +#define CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_H_ + +#include +#include +#include +#include <./blocking_container_test.h> + +namespace embb { +namespace containers { +namespace test { +template +class BlockingQueueTest : public BlockingContainerTest { + protected: + virtual void SpecializedPush(const int& element); + + virtual void SpecializedPop(int& element); +}; +} // namespace test +} // namespace containers +} // namespace embb + +#include "./blocking_queue_test-inl.h" + +#endif // CONTAINERS_CPP_TEST_BLOCKING_QUEUE_TEST_H_ diff --git a/containers_cpp/test/main.cc b/containers_cpp/test/main.cc index d21dede..4f6f224 100644 --- a/containers_cpp/test/main.cc +++ b/containers_cpp/test/main.cc @@ -30,6 +30,7 @@ #include #include #include +#include #include #include @@ -37,6 +38,7 @@ #include "./pool_test.h" #include "./queue_test.h" +#include "./blocking_queue_test.h" #include "./stack_test.h" #include "./hazard_pointer_test.h" #include "./object_pool_test.h" @@ -47,12 +49,14 @@ using embb::containers::WaitFreeArrayValuePool; using embb::containers::LockFreeTreeValuePool; using embb::containers::WaitFreeSPSCQueue; using embb::containers::LockFreeMPMCQueue; +using embb::containers::BlockingQueue; using embb::containers::LockFreeStack; using embb::containers::LockFreeTreeValuePool; using embb::containers::WaitFreeArrayValuePool; using embb::containers::test::PoolTest; using embb::containers::test::HazardPointerTest; using embb::containers::test::QueueTest; +using embb::containers::test::BlockingQueueTest; using embb::containers::test::StackTest; using embb::containers::test::ObjectPoolTest; using embb::containers::test::HazardPointerTest2; @@ -69,6 +73,7 @@ PT_MAIN("Data Structures C++") { PT_RUN(QueueTest< WaitFreeSPSCQueue< ::std::pair > >); PT_RUN(QueueTest< LockFreeMPMCQueue< ::std::pair > COMMA true COMMA true >); + PT_RUN(BlockingQueueTest< BlockingQueue >); PT_RUN(StackTest< LockFreeStack >); PT_RUN(ObjectPoolTest< LockFreeTreeValuePool >); PT_RUN(ObjectPoolTest< WaitFreeArrayValuePool >);