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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/**
* @file llqueuedthread.h
* @brief
*
* Copyright (c) 2004-2007, Linden Research, Inc.
*
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlife.com/developers/opensource/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at http://secondlife.com/developers/opensource/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
*/
#ifndef LL_LLQUEUEDTHREAD_H
#define LL_LLQUEUEDTHREAD_H
#include <queue>
#include <string>
#include <map>
#include <set>
#include "llapr.h"
#include "llthread.h"
#include "llsimplehash.h"
//============================================================================
// Note: ~LLQueuedThread is O(N) N=# of queued threads, assumed to be small
// It is assumed that LLQueuedThreads are rarely created/destroyed.
class LLQueuedThread : public LLThread
{
//------------------------------------------------------------------------
public:
enum priority_t {
PRIORITY_IMMEDIATE = 0x7FFFFFFF,
PRIORITY_URGENT = 0x40000000,
PRIORITY_HIGH = 0x30000000,
PRIORITY_NORMAL = 0x20000000,
PRIORITY_LOW = 0x10000000,
PRIORITY_LOWBITS = 0x0FFFFFFF
};
enum status_t {
STATUS_EXPIRED = -1,
STATUS_UNKNOWN = 0,
STATUS_QUEUED = 1,
STATUS_INPROGRESS = 2,
STATUS_COMPLETE = 3,
STATUS_ABORT = 4,
STATUS_ABORTED = 5,
STATUS_DELETE = 6
};
enum flags_t {
AUTO_COMPLETE = 1,
AUTO_DELETE = 2 // child-class dependent
};
typedef U32 handle_t;
//------------------------------------------------------------------------
public:
class QueuedRequest : public LLSimpleHashEntry<handle_t>
{
friend class LLQueuedThread;
protected:
~QueuedRequest(); // use deleteRequest()
public:
QueuedRequest(handle_t handle, U32 priority, U32 flags = 0);
status_t getStatus()
{
return mStatus;
}
U32 getPriority() const
{
return mPriority;
}
U32 getFlags() const
{
return mFlags;
}
bool higherPriority(const QueuedRequest& second) const
{
if ( mPriority == second.mPriority)
return mHashKey < second.mHashKey;
else
return mPriority > second.mPriority;
}
protected:
status_t setStatus(status_t newstatus)
{
status_t oldstatus = mStatus;
mStatus = newstatus;
return oldstatus;
}
status_t abortRequest(U32 flags)
{
// NOTE: flags are |'d
if (mStatus == STATUS_QUEUED)
{
setStatus(STATUS_ABORT);
}
mFlags |= flags;
status_t status = mStatus;
return status;
}
status_t setFlags(U32 flags)
{
// NOTE: flags are |'d
mFlags |= flags;
status_t status = mStatus;
return status;
}
virtual void finishRequest(); // Always called when after has been processed
virtual void deleteRequest(); // Only method to delete a request
void setPriority(U32 pri)
{
// Only do this on a request that is not in a queued list!
mPriority = pri;
};
protected:
LLAtomic32<status_t> mStatus;
U32 mPriority;
U32 mFlags;
};
protected:
struct queued_request_less
{
bool operator()(const QueuedRequest* lhs, const QueuedRequest* rhs) const
{
return lhs->higherPriority(*rhs); // higher priority in front of queue (set)
}
};
//------------------------------------------------------------------------
public:
static handle_t nullHandle() { return handle_t(0); }
public:
LLQueuedThread(const std::string& name, bool threaded = TRUE, bool runalways = TRUE);
virtual ~LLQueuedThread();
private:
// No copy constructor or copy assignment
LLQueuedThread(const LLQueuedThread&);
LLQueuedThread& operator=(const LLQueuedThread&);
virtual bool runCondition(void);
virtual void run(void);
protected:
handle_t generateHandle();
bool addRequest(QueuedRequest* req);
int processNextRequest(void);
virtual bool processRequest(QueuedRequest* req) = 0;
public:
bool waitForResult(handle_t handle, bool auto_complete = true);
void update(U32 ms_elapsed);
void updateQueue(S32 inc);
void waitOnPending();
void printQueueStats();
S32 getPending(bool child_thread = false);
bool getThreaded() { return mThreaded ? true : false; }
bool getRunAlways() { return mRunAlways ? true : false; }
// Request accessors
status_t getRequestStatus(handle_t handle);
status_t abortRequest(handle_t handle, U32 flags = 0);
status_t setFlags(handle_t handle, U32 flags);
void setPriority(handle_t handle, U32 priority);
bool completeRequest(handle_t handle);
// This is public for support classes like LLWorkerThread,
// but generally the methods above should be used.
QueuedRequest* getRequest(handle_t handle);
// debug (see source)
bool check();
protected:
BOOL mThreaded; // if false, run on main thread and do updates during update()
BOOL mRunAlways; // if false, only wake the threads when updateClass() is called
LLAtomic32<BOOL> mIdleThread; // request queue is empty (or we are quitting) and the thread is idle
typedef std::set<QueuedRequest*, queued_request_less> request_queue_t;
request_queue_t mRequestQueue;
enum { REQUEST_HASH_SIZE = 512 }; // must be power of 2
typedef LLSimpleHash<handle_t, REQUEST_HASH_SIZE> request_hash_t;
request_hash_t mRequestHash;
handle_t mNextHandle;
};
#endif // LL_LLQUEUEDTHREAD_H
|