]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/DiskIO/Mmapped/MmappedFile.cc
2 * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 /* DEBUG: section 47 Store Directory Routines */
13 #include "DiskIO/IORequestor.h"
14 #include "DiskIO/Mmapped/MmappedFile.h"
15 #include "DiskIO/ReadRequest.h"
16 #include "DiskIO/WriteRequest.h"
28 // Some systems such as Hurd provide mmap() API but do not support MAP_NORESERVE
30 #define MAP_NORESERVE 0
33 CBDATA_CLASS_INIT(MmappedFile
);
35 // helper class to deal with mmap(2) offset alignment and other low-level specs
39 Mmapping(int fd
, size_t length
, int prot
, int flags
, off_t offset
);
42 void *map(); ///< calls mmap(2); returns usable buffer or nil on failure
43 bool unmap(); ///< unmaps previously mapped buffer, if any
46 const int fd
; ///< descriptor of the mmapped file
47 const size_t length
; ///< user-requested data length, needed for munmap
48 const int prot
; ///< mmap(2) "protection" flags
49 const int flags
; ///< other mmap(2) flags
50 const off_t offset
; ///< user-requested data offset
52 off_t delta
; ///< mapped buffer increment to hit user offset
53 void *buf
; ///< buffer returned by mmap, needed for munmap
56 MmappedFile::MmappedFile(char const *aPath
): fd(-1),
57 minOffset(0), maxOffset(-1), error_(false)
60 path_
= xstrdup(aPath
);
61 debugs(79,5, HERE
<< this << ' ' << path_
);
64 MmappedFile::~MmappedFile()
70 // XXX: almost a copy of BlockingFile::open
72 MmappedFile::open(int flags
, mode_t
, RefCount
<IORequestor
> callback
)
76 /* Simulate async calls */
77 fd
= file_open(path_
, flags
);
78 ioRequestor
= callback
;
81 debugs(79,3, HERE
<< "open error: " << xstrerror());
85 debugs(79,3, HERE
<< "FD " << fd
);
87 // setup mapping boundaries
89 if (fstat(fd
, &sb
) == 0)
90 maxOffset
= sb
.st_size
; // we do not expect it to change
93 callback
->ioCompletedNotification();
97 * Alias for MmappedFile::open(...)
98 \copydoc MmappedFile::open(int flags, mode_t mode, RefCount<IORequestor> callback)
101 MmappedFile::create(int flags
, mode_t mode
, RefCount
<IORequestor
> callback
)
103 /* We use the same logic path for open */
104 open(flags
, mode
, callback
);
107 void MmappedFile::doClose()
112 --store_open_disk_fd
;
119 debugs(79, 3, HERE
<< this << " closing for " << ioRequestor
);
121 assert(ioRequestor
!= NULL
);
122 ioRequestor
->closeCompleted();
126 MmappedFile::canRead() const
132 MmappedFile::canWrite() const
138 MmappedFile::error() const
144 MmappedFile::read(ReadRequest
*aRequest
)
146 debugs(79,3, HERE
<< "(FD " << fd
<< ", " << aRequest
->len
<< ", " <<
147 aRequest
->offset
<< ")");
150 assert(ioRequestor
!= NULL
);
151 assert(aRequest
->len
> 0); // TODO: work around mmap failures on zero-len?
152 assert(aRequest
->offset
>= 0);
153 assert(!error_
); // TODO: propagate instead?
155 assert(minOffset
< 0 || minOffset
<= aRequest
->offset
);
156 assert(maxOffset
< 0 || static_cast<uint64_t>(aRequest
->offset
+ aRequest
->len
) <= static_cast<uint64_t>(maxOffset
));
158 Mmapping
mapping(fd
, aRequest
->len
, PROT_READ
, MAP_PRIVATE
| MAP_NORESERVE
,
162 if (void *buf
= mapping
.map()) {
163 memcpy(aRequest
->buf
, buf
, aRequest
->len
);
164 done
= mapping
.unmap();
168 const ssize_t rlen
= error_
? -1 : (ssize_t
)aRequest
->len
;
169 const int errflag
= error_
? DISK_ERROR
:DISK_OK
;
170 ioRequestor
->readCompleted(aRequest
->buf
, rlen
, errflag
, aRequest
);
174 MmappedFile::write(WriteRequest
*aRequest
)
176 debugs(79,3, HERE
<< "(FD " << fd
<< ", " << aRequest
->len
<< ", " <<
177 aRequest
->offset
<< ")");
180 assert(ioRequestor
!= NULL
);
181 assert(aRequest
->len
> 0); // TODO: work around mmap failures on zero-len?
182 assert(aRequest
->offset
>= 0);
183 assert(!error_
); // TODO: propagate instead?
185 assert(minOffset
< 0 || minOffset
<= aRequest
->offset
);
186 assert(maxOffset
< 0 || static_cast<uint64_t>(aRequest
->offset
+ aRequest
->len
) <= static_cast<uint64_t>(maxOffset
));
188 const ssize_t written
=
189 pwrite(fd
, aRequest
->buf
, aRequest
->len
, aRequest
->offset
);
191 debugs(79, DBG_IMPORTANT
, HERE
<< "error: " << xstrerr(errno
));
193 } else if (static_cast<size_t>(written
) != aRequest
->len
) {
194 debugs(79, DBG_IMPORTANT
, HERE
<< "problem: " << written
<< " < " << aRequest
->len
);
198 if (aRequest
->free_func
)
199 (aRequest
->free_func
)(const_cast<char*>(aRequest
->buf
)); // broken API?
202 debugs(79,5, HERE
<< "wrote " << aRequest
->len
<< " to FD " << fd
<< " at " << aRequest
->offset
);
207 const ssize_t rlen
= error_
? 0 : (ssize_t
)aRequest
->len
;
208 const int errflag
= error_
? DISK_ERROR
:DISK_OK
;
209 ioRequestor
->writeCompleted(errflag
, rlen
, aRequest
);
212 /// we only support blocking I/O
214 MmappedFile::ioInProgress() const
219 Mmapping::Mmapping(int aFd
, size_t aLength
, int aProt
, int aFlags
, off_t anOffset
):
220 fd(aFd
), length(aLength
), prot(aProt
), flags(aFlags
), offset(anOffset
),
225 Mmapping::~Mmapping()
234 // mmap(2) requires that offset is a multiple of the page size
235 static const int pageSize
= getpagesize();
236 delta
= offset
% pageSize
;
238 buf
= mmap(NULL
, length
+ delta
, prot
, flags
, fd
, offset
- delta
);
240 if (buf
== MAP_FAILED
) {
241 const int errNo
= errno
;
242 debugs(79,3, HERE
<< "error FD " << fd
<< "mmap(" << length
<< '+' <<
243 delta
<< ", " << offset
<< '-' << delta
<< "): " << xstrerr(errNo
));
248 return static_cast<char*>(buf
) + delta
;
254 debugs(79,9, HERE
<< "FD " << fd
<<
255 " munmap(" << buf
<< ", " << length
<< '+' << delta
<< ')');
257 if (!buf
) // forgot or failed to map
260 const bool error
= munmap(buf
, length
+ delta
) != 0;
262 const int errNo
= errno
;
263 debugs(79,3, HERE
<< "error FD " << fd
<<
264 " munmap(" << buf
<< ", " << length
<< '+' << delta
<< "): " <<
265 "): " << xstrerr(errNo
));
271 // TODO: check MAP_NORESERVE, consider MAP_POPULATE and MAP_FIXED