327 lines
9.0 KiB
C++
327 lines
9.0 KiB
C++
/**
|
|
* @file lltexturefetch.h
|
|
* @brief Object for managing texture fetches.
|
|
*
|
|
* $LicenseInfo:firstyear=2000&license=viewerlgpl$
|
|
* Second Life Viewer Source Code
|
|
* Copyright (C) 2012, 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_LLTEXTUREFETCH_H
|
|
#define LL_LLTEXTUREFETCH_H
|
|
|
|
#include "lldir.h"
|
|
#include "llimage.h"
|
|
#include "lluuid.h"
|
|
#include "llworkerthread.h"
|
|
#include "lltextureinfo.h"
|
|
#include "llapr.h"
|
|
#include "httprequest.h"
|
|
#include "httpoptions.h"
|
|
#include "httpheaders.h"
|
|
|
|
class LLViewerTexture;
|
|
class LLTextureFetchWorker;
|
|
class LLTextureCache;
|
|
class LLImageDecodeThread;
|
|
class LLHost;
|
|
class LLViewerAssetStats;
|
|
|
|
// Interface class
|
|
|
|
class LLTextureFetch : public LLWorkerThread
|
|
{
|
|
friend class LLTextureFetchWorker;
|
|
|
|
public:
|
|
LLTextureFetch(LLTextureCache* cache, LLImageDecodeThread* imagedecodethread, bool threaded, bool qa_mode);
|
|
~LLTextureFetch();
|
|
|
|
class TFRequest;
|
|
|
|
// Threads: Tmain
|
|
/*virtual*/ S32 update(F32 max_time_ms);
|
|
|
|
// called in the main thread after the TextureCacheThread shuts down.
|
|
// Threads: Tmain
|
|
void shutDownTextureCacheThread();
|
|
|
|
//called in the main thread after the ImageDecodeThread shuts down.
|
|
// Threads: Tmain
|
|
void shutDownImageDecodeThread();
|
|
|
|
// Threads: T* (but Tmain mostly)
|
|
bool createRequest(const std::string& url, const LLUUID& id, const LLHost& host, F32 priority,
|
|
S32 w, S32 h, S32 c, S32 discard, bool needs_aux, bool can_use_http);
|
|
|
|
// Requests that a fetch operation be deleted from the queue.
|
|
// If @cancel is true, also stops any I/O operations pending.
|
|
// Actual delete will be scheduled and performed later.
|
|
//
|
|
// Note: This *looks* like an override/variant of the
|
|
// base class's deleteRequest() but is functionally quite
|
|
// different.
|
|
//
|
|
// Threads: T*
|
|
void deleteRequest(const LLUUID& id, bool cancel);
|
|
|
|
// Threads: T*
|
|
bool getRequestFinished(const LLUUID& id, S32& discard_level,
|
|
LLPointer<LLImageRaw>& raw, LLPointer<LLImageRaw>& aux);
|
|
|
|
// Threads: T*
|
|
bool updateRequestPriority(const LLUUID& id, F32 priority);
|
|
|
|
// Threads: T*
|
|
bool receiveImageHeader(const LLHost& host, const LLUUID& id, U8 codec, U16 packets, U32 totalbytes, U16 data_size, U8* data);
|
|
|
|
// Threads: T*
|
|
bool receiveImagePacket(const LLHost& host, const LLUUID& id, U16 packet_num, U16 data_size, U8* data);
|
|
|
|
// Threads: T* (but not safe)
|
|
void setTextureBandwidth(F32 bandwidth) { mTextureBandwidth = bandwidth; }
|
|
|
|
// Threads: T* (but not safe)
|
|
F32 getTextureBandwidth() { return mTextureBandwidth; }
|
|
|
|
// Threads: T*
|
|
BOOL isFromLocalCache(const LLUUID& id);
|
|
|
|
// @return Magic number giving the internal state of the
|
|
// request. We should make these codes public if we're
|
|
// going to return them as a status value.
|
|
//
|
|
// Threads: T*
|
|
S32 getFetchState(const LLUUID& id, F32& decode_progress_p, F32& requested_priority_p,
|
|
U32& fetch_priority_p, F32& fetch_dtime_p, F32& request_dtime_p, bool& can_use_http);
|
|
|
|
// Debug utility - generally not safe
|
|
void dump();
|
|
|
|
// Threads: T*
|
|
S32 getNumRequests();
|
|
|
|
// Threads: T*
|
|
S32 getNumHTTPRequests();
|
|
|
|
// Threads: T*
|
|
U32 getTotalNumHTTPRequests();
|
|
|
|
// Threads: T*
|
|
S32 getPending();
|
|
|
|
// Threads: T*
|
|
void lockQueue() { mQueueMutex.lock(); }
|
|
|
|
// Threads: T*
|
|
void unlockQueue() { mQueueMutex.unlock(); }
|
|
|
|
// Threads: T*
|
|
LLTextureFetchWorker* getWorker(const LLUUID& id);
|
|
|
|
// Threads: T*
|
|
// Locks: Mfq
|
|
LLTextureFetchWorker* getWorkerAfterLock(const LLUUID& id);
|
|
|
|
// Commands available to other threads to control metrics gathering operations.
|
|
|
|
// Threads: T*
|
|
void commandSetRegion(U64 region_handle);
|
|
|
|
// Threads: T*
|
|
void commandSendMetrics(const std::string & caps_url,
|
|
const LLUUID & session_id,
|
|
const LLUUID & agent_id,
|
|
LLViewerAssetStats * main_stats);
|
|
|
|
// Threads: T*
|
|
void commandDataBreak();
|
|
|
|
// Threads: T*
|
|
LLCore::HttpRequest & getHttpRequest() { return *mHttpRequest; }
|
|
|
|
bool isQAMode() const { return mQAMode; }
|
|
|
|
// ----------------------------------
|
|
// HTTP resource waiting methods
|
|
|
|
// Threads: T*
|
|
void addHttpWaiter(const LLUUID & tid);
|
|
|
|
// Threads: T*
|
|
void removeHttpWaiter(const LLUUID & tid);
|
|
|
|
// If there are slots, release one or more LLTextureFetchWorker
|
|
// requests from resource wait state (WAIT_HTTP_RESOURCE) to
|
|
// active (SEND_HTTP_REQ).
|
|
//
|
|
// Because this will modify state of many workers, you may not
|
|
// hold any Mw lock while calling. This makes it a little
|
|
// inconvenient to use but that's the rule.
|
|
//
|
|
// Threads: T*
|
|
// Locks: -Mw (must not hold any worker when called)
|
|
void releaseHttpWaiters();
|
|
|
|
// Threads: T*
|
|
void cancelHttpWaiters();
|
|
|
|
// Threads: T*
|
|
int getHttpWaitersCount();
|
|
// ----------------------------------
|
|
|
|
protected:
|
|
// Threads: T* (but Ttf in practice)
|
|
void addToNetworkQueue(LLTextureFetchWorker* worker);
|
|
|
|
// Threads: T*
|
|
void removeFromNetworkQueue(LLTextureFetchWorker* worker, bool cancel);
|
|
|
|
// Threads: T*
|
|
void addToHTTPQueue(const LLUUID& id);
|
|
|
|
// Threads: T*
|
|
void removeFromHTTPQueue(const LLUUID& id, S32 received_size = 0);
|
|
|
|
// Identical to @deleteRequest but with different arguments
|
|
// (caller already has the worker pointer).
|
|
//
|
|
// Threads: T*
|
|
void removeRequest(LLTextureFetchWorker* worker, bool cancel);
|
|
|
|
// Overrides from the LLThread tree
|
|
// Locks: Ct
|
|
bool runCondition();
|
|
|
|
private:
|
|
// Threads: Tmain
|
|
void sendRequestListToSimulators();
|
|
|
|
// Threads: Ttf
|
|
/*virtual*/ void startThread(void);
|
|
|
|
// Threads: Ttf
|
|
/*virtual*/ void endThread(void);
|
|
|
|
// Threads: Ttf
|
|
/*virtual*/ void threadedUpdate(void);
|
|
|
|
// Threads: Ttf
|
|
void commonUpdate();
|
|
|
|
// Metrics command helpers
|
|
/**
|
|
* Enqueues a command request at the end of the command queue
|
|
* and wakes up the thread as needed.
|
|
*
|
|
* Takes ownership of the TFRequest object.
|
|
*
|
|
* Method locks the command queue.
|
|
*
|
|
* Threads: T*
|
|
*/
|
|
void cmdEnqueue(TFRequest *);
|
|
|
|
/**
|
|
* Returns the first TFRequest object in the command queue or
|
|
* NULL if none is present.
|
|
*
|
|
* Caller acquires ownership of the object and must dispose of it.
|
|
*
|
|
* Method locks the command queue.
|
|
*
|
|
* Threads: T*
|
|
*/
|
|
TFRequest * cmdDequeue();
|
|
|
|
/**
|
|
* Processes the first command in the queue disposing of the
|
|
* request on completion. Successive calls are needed to perform
|
|
* additional commands.
|
|
*
|
|
* Method locks the command queue.
|
|
*
|
|
* Threads: Ttf
|
|
*/
|
|
void cmdDoWork();
|
|
|
|
public:
|
|
LLUUID mDebugID;
|
|
S32 mDebugCount;
|
|
BOOL mDebugPause;
|
|
S32 mPacketCount;
|
|
S32 mBadPacketCount;
|
|
|
|
private:
|
|
LLMutex mQueueMutex; //to protect mRequestMap and mCommands only
|
|
LLMutex mNetworkQueueMutex; //to protect mNetworkQueue, mHTTPTextureQueue and mCancelQueue.
|
|
|
|
LLTextureCache* mTextureCache;
|
|
LLImageDecodeThread* mImageDecodeThread;
|
|
|
|
// Map of all requests by UUID
|
|
typedef std::map<LLUUID,LLTextureFetchWorker*> map_t;
|
|
map_t mRequestMap; // Mfq
|
|
|
|
// Set of requests that require network data
|
|
typedef std::set<LLUUID> queue_t;
|
|
queue_t mNetworkQueue; // Mfnq
|
|
queue_t mHTTPTextureQueue; // Mfnq
|
|
typedef std::map<LLHost,std::set<LLUUID> > cancel_queue_t;
|
|
cancel_queue_t mCancelQueue; // Mfnq
|
|
F32 mTextureBandwidth; // <none>
|
|
F32 mMaxBandwidth; // Mfnq
|
|
LLTextureInfo mTextureInfo;
|
|
|
|
U32 mHTTPTextureBits; // Mfnq
|
|
|
|
//debug use
|
|
U32 mTotalHTTPRequests;
|
|
|
|
// Out-of-band cross-thread command queue. This command queue
|
|
// is logically tied to LLQueuedThread's list of
|
|
// QueuedRequest instances and so must be covered by the
|
|
// same locks.
|
|
typedef std::vector<TFRequest *> command_queue_t;
|
|
command_queue_t mCommands; // Mfq
|
|
|
|
// If true, modifies some behaviors that help with QA tasks.
|
|
const bool mQAMode;
|
|
|
|
// Interfaces and objects into the core http library used
|
|
// to make our HTTP requests. These replace the various
|
|
// LLCurl interfaces used in the past.
|
|
LLCore::HttpRequest * mHttpRequest; // Ttf
|
|
LLCore::HttpOptions * mHttpOptions; // Ttf
|
|
LLCore::HttpHeaders * mHttpHeaders; // Ttf
|
|
|
|
typedef std::set<LLUUID> wait_http_res_queue_t;
|
|
wait_http_res_queue_t mHttpWaitResource; // Mfnq
|
|
|
|
public:
|
|
// A probabilistically-correct indicator that the current
|
|
// attempt to log metrics follows a break in the metrics stream
|
|
// reporting due to either startup or a problem POSTing data.
|
|
static volatile bool svMetricsDataBreak;
|
|
};
|
|
|
|
#endif // LL_LLTEXTUREFETCH_H
|
|
|