mlPageRequestProcessorBase.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2009, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_PAGE_REQUEST_PROCESSOR_BASE_H
#define ML_PAGE_REQUEST_PROCESSOR_BASE_H
 
#include "mlInitSystemML.h"
 
#include "mlPageRequestProcessor.h"
#include "mlProcessingTimeLine.h"
 
#include <deque>
#include <map>
#include <vector>
 
 
ML_START_NAMESPACE
 
class Host;
class PagedImage;
class UserThreadData;
 
//-------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------
class MLEXPORT PageRequestProcessorBase : public PageRequestProcessor
{
public:
  PageRequestProcessorBase(Host* host);
  ~PageRequestProcessorBase() override;

  virtual bool supportsMultiThreading() = 0;

  void removeCancelledRequests() override;

  ProcessingTimeLine& getProcessingTimeLine() { return _profile; }

  ProcessingTimeLine::TimeLine* getOverviewTimeLine() { return _useTimeLineProfiling?_overviewTimeLine:nullptr; }

  void enableTimeLineProfiling(bool flag);

  bool isTimeLineProfilingEnabled() const { return _useTimeLineProfiling; }

  int getProcessingScope() const { return _processingScope; }

  void enterProcessingScope() override;

  void leaveProcessingScope() override;
 
protected:
  bool createMoreWork(bool sleepWhenBlocked, bool* allBlocked = nullptr, MLint pageRequestLimit = 100000, MLint* resultPageRequestCount = nullptr);

  void setupCurrentProcessingScope();

  virtual void handleErrorsInGUIThread();

  void terminateAllRequestsInGUIThread();

  void addNewCursor(PageRequestCursor* cursor);

  virtual void getAllPageRequestQueues(std::vector< std::deque<PageRequest*>* >& queues);

  Host* _host;

  bool _terminated;

  int _rootTileRequests;

  std::vector< std::vector<PageRequestCursor*> > _cursors;

  bool _useTimeLineProfiling;
  ProcessingTimeLine _profile;
  ProcessingTimeLine::TimeLine* _guiThreadTimeLine;
  ProcessingTimeLine::TimeLine* _overviewTimeLine;

  int _processingScope;
  int _producerProcessingScope;
  int _producerCursorCounter;
  int _guiThreadRecursionCounter;

  struct ScopeStackEntry
  {
    ScopeStackEntry() {
      rootTilesToWaitFor = 0;
      errorOccurred = false;
    }

    std::deque<PageRequest*> guiQueue;
    int rootTilesToWaitFor;

    bool errorOccurred;

    std::vector<PageRequest*> pageRequestsWithErrors;
  };

  ScopeStackEntry* _currentScope;

  std::vector<ScopeStackEntry> _scopeStack;

  TimeCounter _progressUpdateTimer;

  struct PerThreadStorage {
    ~PerThreadStorage() { clear(); }

    void clear();

    std::map<PagedImage*, UserThreadData*> userThreadDataMap;
  };

  PerThreadStorage _guiPerThreadStorage;

  UserThreadData* getUserThreadData(PageRequest* request, PerThreadStorage& perThreadStorage);
 
};
 
ML_END_NAMESPACE
 
#endif