/indra/llcommon/llqueuedthread.h
C++ Header | 213 lines | 140 code | 35 blank | 38 comment | 2 complexity | f652f978bc1c8c6e1955eeaee9193215 MD5 | raw file
Possible License(s): LGPL-2.1
- /**
- * @file llqueuedthread.h
- * @brief
- *
- * $LicenseInfo:firstyear=2004&license=viewerlgpl$
- * Second Life Viewer Source Code
- * Copyright (C) 2010, Linden Research, Inc.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation;
- * version 2.1 of the License only.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- *
- * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
- * $/LicenseInfo$
- */
- #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 LL_COMMON_API 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,
- PRIORITY_HIGHBITS = 0x70000000
- };
- enum status_t {
- STATUS_EXPIRED = -1,
- STATUS_UNKNOWN = 0,
- STATUS_QUEUED = 1,
- STATUS_INPROGRESS = 2,
- STATUS_COMPLETE = 3,
- STATUS_ABORTED = 4,
- STATUS_DELETE = 5
- };
- enum flags_t {
- FLAG_AUTO_COMPLETE = 1,
- FLAG_AUTO_DELETE = 2, // child-class dependent
- FLAG_ABORT = 4
- };
- typedef U32 handle_t;
-
- //------------------------------------------------------------------------
- public:
- class LL_COMMON_API QueuedRequest : public LLSimpleHashEntry<handle_t>
- {
- friend class LLQueuedThread;
-
- protected:
- virtual ~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;
- }
- void setFlags(U32 flags)
- {
- // NOTE: flags are |'d
- mFlags |= flags;
- }
-
- virtual bool processRequest() = 0; // Return true when request has completed
- virtual void finishRequest(bool completed); // Always called from thread after request has completed or aborted
- 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 should_pause = false);
- virtual ~LLQueuedThread();
- virtual void shutdown();
-
- private:
- // No copy constructor or copy assignment
- LLQueuedThread(const LLQueuedThread&);
- LLQueuedThread& operator=(const LLQueuedThread&);
- virtual bool runCondition(void);
- virtual void run(void);
- virtual void startThread(void);
- virtual void endThread(void);
- virtual void threadedUpdate(void);
- protected:
- handle_t generateHandle();
- bool addRequest(QueuedRequest* req);
- S32 processNextRequest(void);
- void incQueue();
- public:
- bool waitForResult(handle_t handle, bool auto_complete = true);
- virtual S32 update(F32 max_time_ms);
- S32 updateQueue(F32 max_time_ms);
-
- void waitOnPending();
- void printQueueStats();
- virtual S32 getPending();
- bool getThreaded() { return mThreaded ? true : false; }
- // Request accessors
- status_t getRequestStatus(handle_t handle);
- void abortRequest(handle_t handle, bool autocomplete);
- void 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 mStarted; // required when mThreaded is false to call startThread() from update()
- 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