summaryrefslogtreecommitdiffstats
path: root/src/include/util/locked/pqueue.H
blob: 94c2fba8b8dd77d750a504f2f26c4d1a3ab25690 (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/util/locked/pqueue.H $                            */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2010,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                                                     */
#ifndef __UTIL_LOCKED_PQUEUE_H
#define __UTIL_LOCKED_PQUEUE_H

#include <util/locked/queue.H>

namespace Util
{
    namespace Locked
    {
        template <typename _T, typename _K,
                 bool locked = false, typename _S = int>
            class PQueue : public Queue<_T, locked, _S>
            {
                public:
                    void insert(_T*);
                    _T* remove_if(_K&);
                    _T* front();

                private:
                    void bubbleUp(_T*);
            };

        // SFINAE template to ensure compile fails if functions which are not
        // SMP-safe are used on a 'locked' instance.
        template<bool locked>
            class __verify_pqueue_is_smp_safe
            {
                public:
                    __verify_pqueue_is_smp_safe()
                    {
                        class __util_locked_pqueue_is_not_smp_safe;
                        __util_locked_pqueue_is_not_smp_safe();
                    }
            };

        // SFINAE template implementation to allow certain functions when the
        // instance is not 'locked', assuming that caller is ensuring safety
        // in some other way.
        template<>
            class __verify_pqueue_is_smp_safe<false>
            {
                public:
                    __verify_pqueue_is_smp_safe()
                    {
                    }
            };


        template <typename _T, typename _K, bool locked, typename _S>
            void PQueue<_T,_K,locked,_S>::insert(_T* item)
            {
                this->__lock();

                if (this->head == NULL)
                {
                    item->next = item->prev = NULL;
                    this->head = this->tail = item;
                }
                else
                {
                    item->prev = NULL;
                    item->next = this->head;
                    this->head = this->head->prev = item;

                    bubbleUp(item);
                }

                this->__unlock();
            }

        template <typename _T, typename _K, bool locked, typename _S>
            _T* PQueue<_T,_K,locked,_S>::remove_if(_K& key)
            {
                _T* item = NULL;

                this->__lock();

                if ((this->tail != NULL) && (this->tail->key <= key))
                {
                    item = this->tail;
                    if (this->head == this->tail)
                        this->head = this->tail = NULL;
                    else
                        this->tail = item->prev;

                    if (item->prev)
                        item->prev->next = NULL;
                }

                this->__unlock();

                return item;
            }


        template <typename _T, typename _K, bool locked, typename _S>
            void PQueue<_T,_K,locked,_S>::bubbleUp(_T* item)
            {
                while(1)
                {

                    if (!item->next)
                        break;

                    if (item->next->key <= item->key)
                        break;

                    if (this->head == item)
                        this->head = item->next;
                    if (this->tail == item->next)
                        this->tail = item;

                    _T* temp = item->next;

                    if (temp->next)
                    {
                        temp->next->prev = item;
                        item->next = item->next->next;
                    }
                    else
                    {
                        item->next = NULL;
                    }

                    if (item->prev)
                    {
                        item->prev->next = temp;
                        temp->prev = item->prev;
                    }
                    else
                    {
                        temp->prev = NULL;
                    }

                    temp->next = item;
                    item->prev = temp;
                }
            }


        template <typename _T, typename _K, bool locked, typename _S>
        _T* PQueue<_T, _K,locked,_S>::front()
        {
            // Entirely not SMP-safe to return a pointer to a node if
            // we are a locking instance.  If we aren't locking we
            // have to assume that the caller is ensuring SMP-safety
            // globally in some other way.  Use SFINAE technique to
            // ensure front() fails on locked lists.
            __verify_pqueue_is_smp_safe<locked>();
            return this->tail;
        }
    };
};

#endif
OpenPOWER on IntegriCloud