summaryrefslogtreecommitdiffstats
path: root/src/common-lib/unixsignalhandler.h
blob: 2c12e35ddd709514bedf2ff6e59bdd5ad7d0b637 (plain)
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
/****************************************************************************
**
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Pelagicore Application Manager.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company.  For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/

#pragma once

#include <QtAppManCommon/global.h>
#include <QObject>
#include <QAtomicInteger>

#include <initializer_list>
#include <list>
#include <vector>
#include <functional>
#include <signal.h>

#if defined(Q_OS_UNIX)
#  include <unistd.h>
#elif defined(Q_OS_WIN)
#  include <QMutex>
#  include <QWinEventNotifier>
#endif

QT_BEGIN_NAMESPACE_AM

class UnixSignalHandler : public QObject
{
    Q_OBJECT

public:
    static UnixSignalHandler *instance();

    static const char *signalName(int sig);

    void resetToDefault(int sig);
    void resetToDefault(const std::initializer_list<int> &sigs);

    enum Type {
        RawSignalHandler,
        ForwardedToEventLoopHandler
    };

    bool install(Type handlerType, int sig, const std::function<void(int)> &handler);
    bool install(Type handlerType, const std::initializer_list<int> &sigs,
                 const std::function<void(int)> &handler);

private:
    UnixSignalHandler();
    static UnixSignalHandler *s_instance;

    struct SigHandler
    {
        SigHandler(int signal, bool qt, const std::function<void(int)> &handler);

        int m_signal;
        bool m_qt;
        std::function<void(int)> m_handler;
    };

    std::list<SigHandler> m_handlers; // we're using STL to avoid (accidental) implicit copies
    int m_currentSignal = 0;

#if defined(Q_ATOMIC_INT64_IS_SUPPORTED)
    // 64 bits are currently enough to map all Linux signals
    typedef quint64 am_sigmask_t;
#else
    // 32 bits are sufficient for Win32 (which does not support 64 bit atomics)
    typedef quint32 am_sigmask_t;
#endif
    static am_sigmask_t am_sigmask(int sig);
    QAtomicInteger<am_sigmask_t> m_resetSignalMask;
#if defined(Q_OS_UNIX)
    int m_pipe[2];
#elif defined(Q_OS_WIN)
    QMutex m_winLock;
    QWinEventNotifier *m_winEvent = nullptr;
    QList<int> m_signalsForEventLoop;
#endif
};

QT_END_NAMESPACE_AM