posix/fd: extract file descriptor into own unit

This commit is contained in:
Danny Robson 2016-10-02 15:50:13 +11:00
parent f793175fdf
commit 790728d3b1
8 changed files with 173 additions and 77 deletions

View File

@ -297,6 +297,8 @@ POSIX_FILES = \
posix/dir.cpp \ posix/dir.cpp \
posix/dir.hpp \ posix/dir.hpp \
posix/dir.ipp \ posix/dir.ipp \
posix/fd.cpp \
posix/fd.hpp \
time_posix.cpp time_posix.cpp

38
io.cpp
View File

@ -36,8 +36,9 @@ using namespace util;
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
std::vector<char> std::vector<char>
util::slurp (const boost::filesystem::path& path) { util::slurp (const char *path)
fd out (path, O_RDONLY | O_BINARY); {
posix::fd out (path, O_RDONLY | O_BINARY);
// Calculate the total file size // Calculate the total file size
off_t size = lseek (out, 0, SEEK_END); off_t size = lseek (out, 0, SEEK_END);
@ -117,7 +118,7 @@ util::slurp (FILE *stream)
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------
void void
util::write (const fd &out, util::write (const posix::fd &out,
const void *restrict data, const void *restrict data,
size_t bytes) size_t bytes)
{ {
@ -135,37 +136,6 @@ util::write (const fd &out,
} }
//////////////////////////////////////////////////////////////////////////////
fd::fd (int _fd):
m_fd (_fd)
{
if (_fd < 0)
throw std::invalid_argument ("invalid descriptor");
}
//-----------------------------------------------------------------------------
fd::fd (const char *path, int flags, mode_t mode):
m_fd (open (path, flags, mode))
{
if (m_fd < 0)
errno_error::throw_code ();
}
//-----------------------------------------------------------------------------
fd::fd (const boost::filesystem::path &path, int flags):
fd (path.string ().c_str (), flags)
{ ; }
//-----------------------------------------------------------------------------
fd::~fd () {
CHECK (m_fd >= 0);
close (m_fd);
}
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
int int
indenter::overflow (int ch) { indenter::overflow (int ch) {

26
io.hpp
View File

@ -20,6 +20,7 @@
#include "types.hpp" #include "types.hpp"
#include "platform.hpp" #include "platform.hpp"
#include "nocopy.hpp" #include "nocopy.hpp"
#include "posix/fd.hpp"
#include <sys/stat.h> #include <sys/stat.h>
@ -35,37 +36,20 @@
#endif #endif
namespace util { namespace util {
///------------------------------------------------------------------------
/// A simple RAII wrapper for file descriptors
struct fd {
public:
explicit fd (int);
fd (const char *path, int flags, mode_t mode = 0660);
fd (const boost::filesystem::path&, int flags);
~fd ();
operator int (void) const { return m_fd; }
private:
int m_fd;
};
//------------------------------------------------------------------------- //-------------------------------------------------------------------------
/// Reads an entire file into memory. /// Reads an entire file into memory.
std::vector<char> slurp (const boost::filesystem::path&); std::vector<char> slurp (const char *path);
std::vector<char> slurp (FILE *); std::vector<char> slurp (FILE *);
//------------------------------------------------------------------------- //-------------------------------------------------------------------------
void write (const fd&, const void *restrict data, size_t bytes); void write (const posix::fd&, const void *restrict data, size_t bytes);
template <typename T> template <typename T>
void write (const fd&, const T &data); void write (const posix::fd&, const T &data);
template <typename T> template <typename T>
void write (const fd&, const T *restrict first, const T *restrict last); void write (const posix::fd&, const T *restrict first, const T *restrict last);
//------------------------------------------------------------------------- //-------------------------------------------------------------------------
class indenter : public std::streambuf { class indenter : public std::streambuf {

4
io.ipp
View File

@ -26,7 +26,7 @@ namespace util {
//------------------------------------------------------------------------- //-------------------------------------------------------------------------
template <typename T> template <typename T>
void void
write (const fd &_fd, const T &data) write (const posix::fd &_fd, const T &data)
{ {
write (_fd, &data, sizeof (T)); write (_fd, &data, sizeof (T));
} }
@ -35,7 +35,7 @@ namespace util {
//------------------------------------------------------------------------- //-------------------------------------------------------------------------
template <typename T> template <typename T>
void void
write (const fd &_fd, const T *restrict first, const T *restrict last) write (const posix::fd &_fd, const T *restrict first, const T *restrict last)
{ {
write (_fd, first, (last - first) * sizeof (T)); write (_fd, first, (last - first) * sizeof (T));
} }

View File

@ -18,6 +18,7 @@
#include "debug.hpp" #include "debug.hpp"
#include "except.hpp" #include "except.hpp"
#include "posix/fd.hpp"
#include <fcntl.h> #include <fcntl.h>
#include <sys/stat.h> #include <sys/stat.h>
@ -26,11 +27,19 @@
using util::detail::posix::mapped_file; using util::detail::posix::mapped_file;
////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////
mapped_file::mapped_file (const char *_path, int fflags, int mflags): mapped_file::mapped_file (const char *_path, int fflags, int mflags)
m_fd (_path, fflags)
{ {
try { try {
load_fd (mflags); ::util::posix::fd src (_path, fflags);
struct stat meta;
if (fstat (src, &meta) < 0)
throw errno_error ();
m_size = (size_t)meta.st_size;
m_data = (uint8_t *)mmap (NULL, m_size, mflags, MAP_SHARED, src, 0);
if (m_data == MAP_FAILED)
throw errno_error ();
} catch (const errno_error &e) { } catch (const errno_error &e) {
// ignore zero length mapping error // ignore zero length mapping error
if (e.code () == EINVAL && m_size == 0) if (e.code () == EINVAL && m_size == 0)
@ -47,20 +56,6 @@ mapped_file::~mapped_file ()
} }
//----------------------------------------------------------------------------
void
mapped_file::load_fd (int mflags) {
struct stat meta;
if (fstat (m_fd, &meta) < 0)
throw errno_error ();
m_size = (size_t)meta.st_size;
m_data = (uint8_t *)mmap (NULL, m_size, mflags, MAP_SHARED, m_fd, 0);
if (m_data == MAP_FAILED)
throw errno_error ();
}
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
size_t size_t
mapped_file::size (void) const mapped_file::size (void) const

View File

@ -61,11 +61,8 @@ namespace util {
as_view () &; as_view () &;
private: private:
fd m_fd;
uint8_t *m_data; uint8_t *m_data;
size_t m_size; size_t m_size;
void load_fd (int mflags);
}; };
} } } }

99
posix/fd.cpp Normal file
View File

@ -0,0 +1,99 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright 2016 Danny Robson <danny@nerdcruft.net>
*/
#include "./fd.hpp"
#include "../except.hpp"
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
using util::posix::fd;
///////////////////////////////////////////////////////////////////////////////
fd::fd (const char *path, int flags):
m_fd (open (path, flags))
{
if (m_fd < 0)
errno_error::throw_code ();
}
//-----------------------------------------------------------------------------
fd::fd (const char *path, int flags, mode_t mode):
m_fd (open (path, flags, mode))
{
if (m_fd < 0)
errno_error::throw_code ();
}
//-----------------------------------------------------------------------------
fd::fd (fd &&rhs):
m_fd (-1)
{
std::swap (m_fd, rhs.m_fd);
}
//-----------------------------------------------------------------------------
fd::fd (const fd &rhs):
m_fd (dup (rhs.m_fd))
{
if (m_fd < 0)
errno_error::throw_code ();
}
//-----------------------------------------------------------------------------
fd::fd (int _fd):
m_fd (_fd)
{ ; }
//-----------------------------------------------------------------------------
fd::~fd ()
{
if (m_fd < 0)
return;
if (close (m_fd))
errno_error::throw_code ();
}
///////////////////////////////////////////////////////////////////////////////
struct ::stat
fd::stat (void) const
{
struct stat buf;
if (fstat (m_fd, &buf))
errno_error::throw_code ();
return buf;
}
///////////////////////////////////////////////////////////////////////////////
fd::operator int (void) const
{
return m_fd;
}
///////////////////////////////////////////////////////////////////////////////
const fd fd::INVALID (-1);

49
posix/fd.hpp Normal file
View File

@ -0,0 +1,49 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright 2016 Danny Robson <danny@nerdcruft.net>
*/
#ifndef __CRUFT_UTIL_POSIX_FD_HPP
#define __CRUFT_UTIL_POSIX_FD_HPP
#include <sys/types.h>
#include <sys/stat.h>
namespace util::posix {
///------------------------------------------------------------------------
/// A simple RAII wrapper for file descriptors
class fd {
public:
fd (const char *path, int flags);
fd (const char *path, int flags, mode_t);
fd (fd &&);
explicit fd (const fd&);
explicit fd (int);
~fd ();
struct ::stat stat (void) const;
operator int (void) const;
static const fd INVALID;
private:
int m_fd;
};
}
#endif