File size: 6,850 Bytes
5a600cf | 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 222 223 224 225 226 227 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM 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 General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::OFstreamCollator
Description
Threaded file writer.
Collects all data from all processors and writes as single
'decomposedBlockData' file. The operation is determined by the
buffer size (maxThreadFileBufferSize setting):
- local size of data is larger than buffer: receive and write processor
by processor (i.e. 'scheduled'). Does not use a thread, no file size
limit.
- total size of data is larger than buffer (but local is not):
thread does all the collecting and writing of the processors. No file
size limit.
- total size of data is less than buffer:
collecting is done locally; the thread only does the writing
(since the data has already been collected)
Operation determine
SourceFiles
OFstreamCollator.C
\*---------------------------------------------------------------------------*/
#ifndef OFstreamCollator_H
#define OFstreamCollator_H
#include <thread>
#include <mutex>
#include "IOstream.H"
#include "labelList.H"
#include "FIFOStack.H"
#include "SubList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class OFstreamCollator Declaration
\*---------------------------------------------------------------------------*/
class OFstreamCollator
{
// Private class
class writeData
{
public:
const label comm_;
const word typeName_;
const fileName filePath_;
const string data_;
const labelList sizes_;
PtrList<List<char>> slaveData_;
const IOstream::streamFormat format_;
const IOstream::versionNumber version_;
const IOstream::compressionType compression_;
const bool append_;
writeData
(
const label comm,
const word& typeName,
const fileName& filePath,
const string& data,
const labelList& sizes,
IOstream::streamFormat format,
IOstream::versionNumber version,
IOstream::compressionType compression,
const bool append
)
:
comm_(comm),
typeName_(typeName),
filePath_(filePath),
data_(data),
sizes_(sizes),
slaveData_(0),
format_(format),
version_(version),
compression_(compression),
append_(append)
{}
//- (approximate) size of master + any optional slave data
off_t size() const
{
off_t sz = data_.size();
forAll(slaveData_, i)
{
if (slaveData_.set(i))
{
sz += slaveData_[i].size();
}
}
return sz;
}
};
// Private Data
//- Total amount of storage to use for object stack below
const off_t maxBufferSize_;
mutable std::mutex mutex_;
autoPtr<std::thread> thread_;
//- Stack of files to write + contents
FIFOStack<writeData*> objects_;
//- Whether thread is running (and not exited)
bool threadRunning_;
//- Communicator to use for all parallel ops (in simulation thread)
label localComm_;
//- Communicator to use for all parallel ops (in write thread)
label threadComm_;
// Private Member Functions
//- Write actual file
static bool writeFile
(
const label comm,
const word& typeName,
const fileName& fName,
const string& masterData,
const labelUList& recvSizes,
const PtrList<SubList<char>>& slaveData,
IOstream::streamFormat fmt,
IOstream::versionNumber ver,
IOstream::compressionType cmp,
const bool append
);
//- Write all files in stack
static void* writeAll(void *threadarg);
//- Wait for total size of objects_ (master + optional slave data)
// to be wantedSize less than overall maxBufferSize.
void waitForBufferSpace(const off_t wantedSize) const;
public:
// Declare name of the class and its debug switch
TypeName("OFstreamCollator");
// Constructors
//- Construct from buffer size. 0 = do not use thread
OFstreamCollator(const off_t maxBufferSize);
//- Construct from buffer size (0 = do not use thread) and local
// thread
OFstreamCollator(const off_t maxBufferSize, const label comm);
//- Destructor
virtual ~OFstreamCollator();
// Member Functions
//- Write file with contents. Blocks until writethread has space
// available (total file sizes < maxBufferSize)
bool write
(
const word& typeName,
const fileName&,
const string& data,
IOstream::streamFormat,
IOstream::versionNumber,
IOstream::compressionType,
const bool append,
const bool useThread = true
);
//- Wait for all thread actions to have finished
void waitAll();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|