File: locker.cpp

package info (click to toggle)
dnf5 5.4.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 17,960 kB
  • sloc: cpp: 94,312; python: 3,370; xml: 1,073; ruby: 600; sql: 250; ansic: 232; sh: 104; perl: 62; makefile: 30
file content (154 lines) | stat: -rw-r--r-- 4,184 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Copyright Contributors to the DNF5 project.
// Copyright Contributors to the libdnf project.
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This file is part of libdnf: https://github.com/rpm-software-management/libdnf/
//
// Libdnf is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// Libdnf is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with libdnf.  If not, see <https://www.gnu.org/licenses/>.


#include "libdnf5/utils/locker.hpp"

#include "libdnf5/common/exception.hpp"
#include "libdnf5/utils/bgettext/bgettext-mark-domain.h"

#include <fcntl.h>
#include <string.h>
#include <unistd.h>

constexpr const int MODE = 0664;

namespace libdnf5::utils {

class Locker::Impl {
public:
    Impl(const std::filesystem::path & path, const bool keep_file) : path{path}, keep_file{keep_file} {};
    ~Impl();
    void unlock();

private:
    friend Locker;
    const std::filesystem::path path;
    int lock_fd{-1};
    bool keep_file{false};
};

Locker::Locker(const std::filesystem::path & path, const bool keep_file) : p_impl{new Impl{path, keep_file}} {};

const std::filesystem::path & Locker::get_path() const noexcept {
    return p_impl->path;
}

bool Locker::read_lock() {
    return lock(LockAccess::READ, LockBlocking::NON_BLOCKING);
}

bool Locker::write_lock() {
    return lock(LockAccess::WRITE, LockBlocking::NON_BLOCKING);
}

bool Locker::lock(LockAccess access, LockBlocking blocking) {
    int fcntl_flags = 0;
    short type = 0;
    switch (access) {
        case LockAccess::READ: {
            type = F_RDLCK;
        } break;
        case LockAccess::WRITE: {
            type = F_WRLCK;
        } break;
    }
    switch (blocking) {
        case LockBlocking::BLOCKING: {
            fcntl_flags |= F_SETLKW;
        } break;
        case LockBlocking::NON_BLOCKING: {
            fcntl_flags |= F_SETLK;
        } break;
    }

    if (p_impl->lock_fd == -1) {
        open_file(access);
    }

    struct flock fl;
    memset(&fl, 0, sizeof(fl));
    fl.l_type = type;
    fl.l_whence = SEEK_SET;
    fl.l_start = 0;
    fl.l_len = 0;
    fl.l_pid = 0;
    auto rc = fcntl(p_impl->lock_fd, fcntl_flags, &fl);
    if (rc == -1) {
        if (errno == EACCES || errno == EAGAIN) {
            return false;
        } else {
            throw SystemError(errno, M_("Failed to obtain lock \"{}\""), p_impl->path.string());
        }
    }

    return true;
}

void Locker::open_file(LockAccess access) {
    if (p_impl->lock_fd != -1) {
        throw libdnf5::RuntimeError(M_("File is already open."));
    }
    int open_flags = O_CREAT | O_CLOEXEC;
    switch (access) {
        case LockAccess::READ: {
            open_flags |= O_RDONLY;
        } break;
        case LockAccess::WRITE: {
            open_flags |= O_RDWR;
        } break;
    }
    p_impl->lock_fd = open(p_impl->path.c_str(), open_flags, MODE);
    if (p_impl->lock_fd == -1) {
        throw SystemError(errno, M_("Failed to open lock file \"{}\""), p_impl->path.string());
    }
}

void Locker::Impl::unlock() {
    if (lock_fd != -1) {
        if (close(lock_fd) == -1) {
            throw SystemError(errno, M_("Failed to close lock file \"{}\""), path.string());
        }
        if (!keep_file) {
            if (unlink(path.c_str()) == -1) {
                throw SystemError(errno, M_("Failed to delete lock file \"{}\""), path.string());
            }
        }
        lock_fd = -1;
    }
}

void Locker::unlock() {
    return p_impl->unlock();
}

Locker::Impl::~Impl() {
    try {
        unlock();
    } catch (...) {
    }
}

Locker::~Locker() = default;

Locker::Locker(Locker &&) noexcept = default;

Locker & Locker::operator=(Locker &&) noexcept = default;

}  // namespace libdnf5::utils