openPMD-api
AbstractIOHandlerImpl.hpp
1 /* Copyright 2018-2021 Fabian Koller
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 #include "openPMD/IO/AbstractIOHandler.hpp"
24 #include "openPMD/IO/IOTask.hpp"
25 #include "openPMD/auxiliary/DerefDynamicCast.hpp"
26 
27 #include <future>
28 #include <iostream>
29 
30 
31 namespace openPMD
32 {
33 // class AbstractIOHandler;
34 class Writable;
35 
37 {
38 public:
40  : m_handler{handler}
41  { }
42 
43  virtual ~AbstractIOHandlerImpl() = default;
44 
45  virtual std::future< void > flush()
46  {
47  using namespace auxiliary;
48 
49  while( !(*m_handler).m_work.empty() )
50  {
51  IOTask& i = (*m_handler).m_work.front();
52  try
53  {
54  switch( i.operation )
55  {
56  using O = Operation;
57  case O::CREATE_FILE:
58  createFile(i.writable, deref_dynamic_cast< Parameter< Operation::CREATE_FILE > >(i.parameter.get()));
59  break;
60  case O::CREATE_PATH:
61  createPath(i.writable, deref_dynamic_cast< Parameter< O::CREATE_PATH > >(i.parameter.get()));
62  break;
63  case O::CREATE_DATASET:
64  createDataset(i.writable, deref_dynamic_cast< Parameter< O::CREATE_DATASET > >(i.parameter.get()));
65  break;
66  case O::EXTEND_DATASET:
67  extendDataset(i.writable, deref_dynamic_cast< Parameter< O::EXTEND_DATASET > >(i.parameter.get()));
68  break;
69  case O::OPEN_FILE:
70  openFile(i.writable, deref_dynamic_cast< Parameter< O::OPEN_FILE > >(i.parameter.get()));
71  break;
72  case O::CLOSE_FILE:
73  closeFile(i.writable, deref_dynamic_cast< Parameter< O::CLOSE_FILE > >(i.parameter.get()));
74  break;
75  case O::OPEN_PATH:
76  openPath(i.writable, deref_dynamic_cast< Parameter< O::OPEN_PATH > >(i.parameter.get()));
77  break;
78  case O::CLOSE_PATH:
79  closePath(i.writable, deref_dynamic_cast< Parameter< O::CLOSE_PATH > >(i.parameter.get()));
80  break;
81  case O::OPEN_DATASET:
82  openDataset(i.writable, deref_dynamic_cast< Parameter< O::OPEN_DATASET > >(i.parameter.get()));
83  break;
84  case O::DELETE_FILE:
85  deleteFile(i.writable, deref_dynamic_cast< Parameter< O::DELETE_FILE > >(i.parameter.get()));
86  break;
87  case O::DELETE_PATH:
88  deletePath(i.writable, deref_dynamic_cast< Parameter< O::DELETE_PATH > >(i.parameter.get()));
89  break;
90  case O::DELETE_DATASET:
91  deleteDataset(i.writable, deref_dynamic_cast< Parameter< O::DELETE_DATASET > >(i.parameter.get()));
92  break;
93  case O::DELETE_ATT:
94  deleteAttribute(i.writable, deref_dynamic_cast< Parameter< O::DELETE_ATT > >(i.parameter.get()));
95  break;
96  case O::WRITE_DATASET:
97  writeDataset(i.writable, deref_dynamic_cast< Parameter< O::WRITE_DATASET > >(i.parameter.get()));
98  break;
99  case O::WRITE_ATT:
100  writeAttribute(i.writable, deref_dynamic_cast< Parameter< O::WRITE_ATT > >(i.parameter.get()));
101  break;
102  case O::READ_DATASET:
103  readDataset(i.writable, deref_dynamic_cast< Parameter< O::READ_DATASET > >(i.parameter.get()));
104  break;
105  case O::GET_BUFFER_VIEW:
106  getBufferView(i.writable, deref_dynamic_cast< Parameter< O::GET_BUFFER_VIEW > >(i.parameter.get()));
107  break;
108  case O::READ_ATT:
109  readAttribute(i.writable, deref_dynamic_cast< Parameter< O::READ_ATT > >(i.parameter.get()));
110  break;
111  case O::LIST_PATHS:
112  listPaths(i.writable, deref_dynamic_cast< Parameter< O::LIST_PATHS > >(i.parameter.get()));
113  break;
114  case O::LIST_DATASETS:
115  listDatasets(i.writable, deref_dynamic_cast< Parameter< O::LIST_DATASETS > >(i.parameter.get()));
116  break;
117  case O::LIST_ATTS:
118  listAttributes(i.writable, deref_dynamic_cast< Parameter< O::LIST_ATTS > >(i.parameter.get()));
119  break;
120  case O::ADVANCE:
121  advance(i.writable, deref_dynamic_cast< Parameter< O::ADVANCE > >(i.parameter.get()));
122  break;
123  case O::AVAILABLE_CHUNKS:
124  availableChunks(i.writable, deref_dynamic_cast< Parameter< O::AVAILABLE_CHUNKS > >(i.parameter.get()));
125  break;
126  }
127  } catch (...)
128  {
129  std::cerr
130  << "[AbstractIOHandlerImpl] IO Task "
131  << internal::operationAsString( i.operation )
132  << " failed with exception. Removing task"
133  << " from IO queue and passing on the exception."
134  << std::endl;
135  (*m_handler).m_work.pop();
136  throw;
137  }
138  (*m_handler).m_work.pop();
139  }
140  return std::future< void >();
141  }
142 
147  virtual void
149 
165  virtual void
167  {}
168 
181  virtual void
183  {}
184 
191  virtual void
193 
204  virtual void createFile(Writable*, Parameter< Operation::CREATE_FILE > const&) = 0;
212  virtual void createPath(Writable*, Parameter< Operation::CREATE_PATH > const&) = 0;
246  virtual void openFile(Writable*, Parameter< Operation::OPEN_FILE > const&) = 0;
255  virtual void openPath(Writable*, Parameter< Operation::OPEN_PATH > const&) = 0;
276  virtual void deleteFile(Writable*, Parameter< Operation::DELETE_FILE > const&) = 0;
286  virtual void deletePath(Writable*, Parameter< Operation::DELETE_PATH > const&) = 0;
317 
335  {
336  // default implementation: operation unsupported by backend
337  parameters.out->backendManagedBuffer = false;
338  }
348  virtual void writeAttribute(Writable*, Parameter< Operation::WRITE_ATT > const&) = 0;
391 
392  AbstractIOHandler* m_handler;
393 }; //AbstractIOHandlerImpl
394 } // openPMD
virtual void writeDataset(Writable *, Parameter< Operation::WRITE_DATASET > const &)=0
Write a chunk of data into an existing dataset.
virtual void deleteAttribute(Writable *, Parameter< Operation::DELETE_ATT > const &)=0
Delete an existing attribute.
virtual void writeAttribute(Writable *, Parameter< Operation::WRITE_ATT > const &)=0
Create a single attribute and fill the value, possibly overwriting an existing attribute.
Self-contained description of a single IO operation.
Definition: IOTask.hpp:598
virtual void deleteDataset(Writable *, Parameter< Operation::DELETE_DATASET > const &)=0
Delete an existing dataset.
virtual void createDataset(Writable *, Parameter< Operation::CREATE_DATASET > const &)=0
Create a new dataset of given type, extent and storage properties.
virtual void listPaths(Writable *, Parameter< Operation::LIST_PATHS > &)=0
List all paths/sub-groups inside a group, non-recursively.
virtual void createFile(Writable *, Parameter< Operation::CREATE_FILE > const &)=0
Create a new file in physical storage, possibly overriding an existing file.
virtual void extendDataset(Writable *, Parameter< Operation::EXTEND_DATASET > const &)=0
Increase the extent of an existing dataset.
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:98
virtual void deleteFile(Writable *, Parameter< Operation::DELETE_FILE > const &)=0
Delete an existing file from physical storage.
Public definitions of openPMD-api.
Definition: Date.cpp:29
Layer to mirror structure of logical data and persistent data in file.
Definition: Writable.hpp:64
virtual void readDataset(Writable *, Parameter< Operation::READ_DATASET > &)=0
Read a chunk of data from an existing dataset.
virtual void listAttributes(Writable *, Parameter< Operation::LIST_ATTS > &)=0
List all attributes associated with an object.
Typesafe description of all required arguments for a specified Operation.
Definition: IOTask.hpp:109
virtual void openDataset(Writable *, Parameter< Operation::OPEN_DATASET > &)=0
Open an existing dataset and determine its datatype and extent.
virtual void closeFile(Writable *, Parameter< Operation::CLOSE_FILE > const &)=0
Close the file corresponding with the writable and release file handles.
virtual void openFile(Writable *, Parameter< Operation::OPEN_FILE > const &)=0
Open an existing file assuming it conforms to openPMD.
virtual void closePath(Writable *, Parameter< Operation::CLOSE_PATH > const &)
Close an openPMD group.
Definition: AbstractIOHandlerImpl.hpp:182
virtual void getBufferView(Writable *, Parameter< Operation::GET_BUFFER_VIEW > &parameters)
Get a view into a dataset buffer that can be filled by a user.
Definition: AbstractIOHandlerImpl.hpp:334
virtual void deletePath(Writable *, Parameter< Operation::DELETE_PATH > const &)=0
Delete all objects within an existing path.
virtual void listDatasets(Writable *, Parameter< Operation::LIST_DATASETS > &)=0
List all datasets inside a group, non-recursively.
virtual void availableChunks(Writable *, Parameter< Operation::AVAILABLE_CHUNKS > &)=0
Report chunks that are available for loading from the dataset represented by this writable...
Definition: AbstractIOHandlerImpl.hpp:36
virtual void createPath(Writable *, Parameter< Operation::CREATE_PATH > const &)=0
Create all necessary groups for a path, possibly recursively.
virtual void readAttribute(Writable *, Parameter< Operation::READ_ATT > &)=0
Read the value of an existing attribute.
virtual void advance(Writable *, Parameter< Operation::ADVANCE > &)
Advance the file/stream that this writable belongs to.
Definition: AbstractIOHandlerImpl.hpp:166
virtual void openPath(Writable *, Parameter< Operation::OPEN_PATH > const &)=0
Open all contained groups in a path, possibly recursively.