util/file_descriptor.hpp

   1 /*
   2  * Copyright (c) 2021 Arm Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 /**
  26  * @file
  27  *
  28  * @brief Contains the defintions of file descriptor utilities.
  29  */
  30
  31 #pragma once
  32
  33 #include <unistd.h>
  34 #include <utility>
  35
  36 namespace util
  37 {
  38
  39 /**
  40  * Manages a POSIX file descriptor.
  41  */
  42 class fd_owner
  43 {
  44 public:
  45
  46    fd_owner() = default;
  47    fd_owner(int fd)
  48     : fd_handle{ fd }
  49    {
  50    }
  51
  52    fd_owner(const fd_owner &) = delete;
  53    fd_owner &operator=(const fd_owner &) = delete;
  54
  55    fd_owner(fd_owner &&rhs)
  56    {
  57       *this = std::move(rhs);
  58    }
  59
  60    fd_owner &operator=(fd_owner &&rhs)
  61    {
  62       std::swap(fd_handle, rhs.fd_handle);
  63       return *this;
  64    }
  65
  66    ~fd_owner()
  67    {
  68       if (is_valid())
  69       {
  70          close(fd_handle);
  71       }
  72    }
  73
  74    int get()
  75    {
  76       return fd_handle;
  77    }
  78
  79    bool is_valid()
  80    {
  81        return fd_handle >= 0;
  82    }
  83
  84 private:
  85    int fd_handle{ -1 };
  86 };
  87
  88 } /* namespace util */