cppu/source/threadpool/threadpool.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <vector>
  23 #include <unordered_map>
  24
  25 #include <osl/conditn.hxx>
  26 #include <osl/mutex.hxx>
  27 #include <rtl/byteseq.hxx>
  28 #include <rtl/ref.hxx>
  29 #include <salhelper/simplereferenceobject.hxx>
  30
  31 #include "jobqueue.hxx"
  32
  33
  34 namespace cppu_threadpool {
  35     class ORequestThread;
  36
  37     struct EqualThreadId
  38     {
  39         bool operator () ( const ::rtl::ByteSequence &a , const ::rtl::ByteSequence &b ) const
  40             {
  41                 return a == b;
  42             }
  43     };
  44
  45     struct HashThreadId
  46     {
  47         sal_Int32 operator () ( const ::rtl::ByteSequence &a  )  const
  48             {
  49                 if( a.getLength() >= 4 )
  50                 {
  51                     return *reinterpret_cast<sal_Int32 const *>(a.getConstArray());
  52                 }
  53                 return 0;
  54             }
  55     };
  56
  57     typedef std::unordered_map
  58     <
  59         ::rtl::ByteSequence, // ThreadID
  60         std::pair < JobQueue * , JobQueue * >,
  61         HashThreadId,
  62         EqualThreadId
  63     > ThreadIdHashMap;
  64
  65     struct WaitingThread
  66     {
  67         osl::Condition condition;
  68         rtl::Reference< ORequestThread > thread;
  69
  70         explicit WaitingThread(
  71             rtl::Reference<ORequestThread> const & theThread);
  72     };
  73
  74     typedef std::deque< struct ::cppu_threadpool::WaitingThread * > WaitingThreadDeque;
  75
  76     class DisposedCallerAdmin;
  77     typedef std::shared_ptr<DisposedCallerAdmin> DisposedCallerAdminHolder;
  78
  79     class DisposedCallerAdmin
  80     {
  81     public:
  82         ~DisposedCallerAdmin();
  83
  84         static DisposedCallerAdminHolder const & getInstance();
  85
  86         void dispose( void const * nDisposeId );
  87         void destroy( void const * nDisposeId );
  88         bool isDisposed( void const * nDisposeId );
  89
  90     private:
  91         ::osl::Mutex m_mutex;
  92         std::vector< void const * > m_vector;
  93     };
  94
  95     class ThreadAdmin
  96     {
  97     public:
  98         ThreadAdmin();
  99         ~ThreadAdmin ();
 100
 101         bool add( rtl::Reference< ORequestThread > const & );
 102         void remove( rtl::Reference< ORequestThread > const & );
 103         void join();
 104
 105         void remove_locked( rtl::Reference< ORequestThread > const & );
 106         ::osl::Mutex m_mutex;
 107
 108     private:
 109         std::deque< rtl::Reference< ORequestThread > > m_deque;
 110         bool m_disposed;
 111     };
 112
 113     class ThreadPool;
 114     typedef rtl::Reference<ThreadPool> ThreadPoolHolder;
 115
 116     class ThreadPool: public salhelper::SimpleReferenceObject
 117     {
 118     public:
 119         ThreadPool();
 120         virtual ~ThreadPool() override;
 121
 122         void dispose( void const * nDisposeId );
 123         void destroy( void const * nDisposeId );
 124
 125         bool addJob( const ::rtl::ByteSequence &aThreadId,
 126                      bool bAsynchron,
 127                      void *pThreadSpecificData,
 128                      RequestFun * doRequest,
 129                      void const * disposeId );
 130
 131         void prepare( const ::rtl::ByteSequence &aThreadId );
 132         void * enter( const ::rtl::ByteSequence &aThreadId, void const * nDisposeId );
 133
 134         /********
 135          * @return true, if queue could be successfully revoked.
 136          ********/
 137         bool revokeQueue( const ::rtl::ByteSequence & aThreadId , bool bAsynchron );
 138
 139         void waitInPool( rtl::Reference< ORequestThread > const & pThread );
 140
 141         void joinWorkers();
 142
 143         ThreadAdmin & getThreadAdmin() { return m_aThreadAdmin; }
 144
 145     private:
 146         bool createThread( JobQueue *pQueue, const ::rtl::ByteSequence &aThreadId, bool bAsynchron);
 147
 148
 149         ThreadIdHashMap m_mapQueue;
 150         ::osl::Mutex m_mutex;
 151
 152         ::osl::Mutex m_mutexWaitingThreadList;
 153         WaitingThreadDeque m_dequeThreads;
 154
 155         DisposedCallerAdminHolder m_DisposedCallerAdmin;
 156         ThreadAdmin m_aThreadAdmin;
 157     };
 158
 159 } // end namespace cppu_threadpool
 160
 161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */