1 /* <!-- copyright */
2 /*
3  * aria2 - The high speed download utility
4  *
5  * Copyright (C) 2006 Tatsuhiro Tsujikawa
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  * In addition, as a special exception, the copyright holders give
22  * permission to link the code of portions of this program with the
23  * OpenSSL library under certain conditions as described in each
24  * individual source file, and distribute linked combinations
25  * including the two.
26  * You must obey the GNU General Public License in all respects
27  * for all of the code used other than OpenSSL.  If you modify
28  * file(s) with this exception, you may extend this exception to your
29  * version of the file(s), but you are not obligated to do so.  If you
30  * do not wish to do so, delete this exception statement from your
31  * version.  If you delete this exception statement from all source
32  * files in the program, then also delete it here.
33  */
34 /* copyright --> */
35 #ifndef D_ABSTRACT_DISK_WRITER_H
36 #define D_ABSTRACT_DISK_WRITER_H
37 
38 #include "DiskWriter.h"
39 #include <string>
40 
41 namespace aria2 {
42 
43 class AbstractDiskWriter : public DiskWriter {
44 private:
45   std::string filename_;
46 
47 #ifdef __MINGW32__
48   HANDLE fd_;
49   // The handle for memory mapped file. mmap equivalent in Windows.
50   HANDLE mapView_;
51 #else  // !__MINGW32__
52   int fd_;
53 #endif // !__MINGW32__
54 
55   bool readOnly_;
56 
57   bool enableMmap_;
58   unsigned char* mapaddr_;
59   int64_t maplen_;
60 
61   ssize_t writeDataInternal(const unsigned char* data, size_t len,
62                             int64_t offset);
63   ssize_t readDataInternal(unsigned char* data, size_t len, int64_t offset);
64 
65   void seek(int64_t offset);
66 
67   void ensureMmapWrite(size_t len, int64_t offset);
68 
69 protected:
70   void createFile(int addFlags = 0);
71 
72 public:
73   AbstractDiskWriter(const std::string& filename);
74   virtual ~AbstractDiskWriter();
75 
76   virtual void openFile(int64_t totalLength = 0) CXX11_OVERRIDE;
77 
78   virtual void closeFile() CXX11_OVERRIDE;
79 
80   virtual void openExistingFile(int64_t totalLength = 0) CXX11_OVERRIDE;
81 
82   virtual void writeData(const unsigned char* data, size_t len,
83                          int64_t offset) CXX11_OVERRIDE;
84 
85   virtual ssize_t readData(unsigned char* data, size_t len,
86                            int64_t offset) CXX11_OVERRIDE;
87 
88   virtual void truncate(int64_t length) CXX11_OVERRIDE;
89 
90   // File must be opened before calling this function.
91   virtual void allocate(int64_t offset, int64_t length,
92                         bool sparse) CXX11_OVERRIDE;
93 
94   virtual int64_t size() CXX11_OVERRIDE;
95 
96   virtual void enableReadOnly() CXX11_OVERRIDE;
97 
98   virtual void disableReadOnly() CXX11_OVERRIDE;
99 
100   virtual void enableMmap() CXX11_OVERRIDE;
101 
102   virtual void dropCache(int64_t len, int64_t offset) CXX11_OVERRIDE;
103 
104   virtual void flushOSBuffers() CXX11_OVERRIDE;
105 };
106 
107 } // namespace aria2
108 
109 #endif // D_ABSTRACT_DISK_WRITER_H
110