summaryrefslogtreecommitdiff
path: root/src/CommonAPI/DBus/DBusConnection.h
blob: 7550c10658c1b1866fe31db472e78889c2f08f6f (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
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/* Copyright (C) 2013 BMW Group
 * Author: Manfred Bathelt (manfred.bathelt@bmw.de)
 * Author: Juergen Gehring (juergen.gehring@bmw.de)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#error "Only <CommonAPI/CommonAPI.h> can be included directly, this file may disappear or change contents."
#endif

#ifndef COMMONAPI_DBUS_DBUS_CONNECTION_H_
#define COMMONAPI_DBUS_DBUS_CONNECTION_H_

#include "DBusProxyConnection.h"
#include "DBusDaemonProxy.h"
#include "DBusServiceRegistry.h"
#include "DBusObjectManager.h"
#include "DBusMainLoopContext.h"
#include "DBusConnectionBusType.h"

#include <dbus/dbus.h>

#include <atomic>


namespace CommonAPI {
namespace DBus {

class DBusObjectManager;

class DBusConnectionStatusEvent: public DBusProxyConnection::ConnectionStatusEvent {
    friend class DBusConnection;

 public:
    DBusConnectionStatusEvent(DBusConnection* dbusConnection);

 protected:
    virtual void onListenerAdded(const CancellableListener& listener);

    DBusConnection* dbusConnection_;
};

struct WatchContext {
    WatchContext(std::weak_ptr<MainLoopContext> mainLoopContext, DispatchSource* dispatchSource) :
            mainLoopContext_(mainLoopContext), dispatchSource_(dispatchSource) {
    }

    std::weak_ptr<MainLoopContext> mainLoopContext_;
    DispatchSource* dispatchSource_;
};

class DBusConnection: public DBusProxyConnection, public std::enable_shared_from_this<DBusConnection> {
 public:
    DBusConnection(BusType busType);

    static std::shared_ptr<DBusConnection> getBus(const BusType& dbusBusType);
    static std::shared_ptr<DBusConnection> wrapLibDBus(::DBusConnection* libDbusConnection);
    static std::shared_ptr<DBusConnection> getSessionBus();
    static std::shared_ptr<DBusConnection> getSystemBus();
    static std::shared_ptr<DBusConnection> getStarterBus();

    DBusConnection(const DBusConnection&) = delete;
    DBusConnection(::DBusConnection* libDbusConnection);

    DBusConnection& operator=(const DBusConnection&) = delete;
    virtual ~DBusConnection();

    BusType getBusType() const;

    bool connect(bool startDispatchThread = true);
    bool connect(DBusError& dbusError, bool startDispatchThread = true);
    void disconnect();

    virtual bool isConnected() const;

    virtual ConnectionStatusEvent& getConnectionStatusEvent();

    virtual bool requestServiceNameAndBlock(const std::string& serviceName) const;
    virtual bool releaseServiceName(const std::string& serviceName) const;

    bool sendDBusMessage(const DBusMessage& dbusMessage, uint32_t* allocatedSerial = NULL) const;

    static const int kDefaultSendTimeoutMs = 5000;

    std::future<CallStatus> sendDBusMessageWithReplyAsync(
            const DBusMessage& dbusMessage,
            std::unique_ptr<DBusMessageReplyAsyncHandler> dbusMessageReplyAsyncHandler,
            int timeoutMilliseconds = kDefaultSendTimeoutMs) const;

    DBusMessage sendDBusMessageWithReplyAndBlock(const DBusMessage& dbusMessage,
                                                 DBusError& dbusError,
                                                 int timeoutMilliseconds = kDefaultSendTimeoutMs) const;

    virtual bool addObjectManagerSignalMemberHandler(const std::string& dbusBusName,
                                                     DBusSignalHandler* dbusSignalHandler);
    virtual bool removeObjectManagerSignalMemberHandler(const std::string& dbusBusName,
                                                        DBusSignalHandler* dbusSignalHandler);

    DBusSignalHandlerToken addSignalMemberHandler(const std::string& objectPath,
                                                  const std::string& interfaceName,
                                                  const std::string& interfaceMemberName,
                                                  const std::string& interfaceMemberSignature,
                                                  DBusSignalHandler* dbusSignalHandler,
                                                  const bool justAddFilter = false);

    DBusProxyConnection::DBusSignalHandlerToken subscribeForSelectiveBroadcast(bool& subscriptionAccepted,
                                                                               const std::string& objectPath,
                                                                               const std::string& interfaceName,
                                                                               const std::string& interfaceMemberName,
                                                                               const std::string& interfaceMemberSignature,
                                                                               DBusSignalHandler* dbusSignalHandler,
                                                                               DBusProxy* callingProxy);

    void unsubscribeFromSelectiveBroadcast(const std::string& eventName,
                                          DBusProxyConnection::DBusSignalHandlerToken subscription,
                                          DBusProxy* callingProxy,
                                          const DBusSignalHandler* dbusSignalHandler);

    void registerObjectPath(const std::string& objectPath);
    void unregisterObjectPath(const std::string& objectPath);

    bool removeSignalMemberHandler(const DBusSignalHandlerToken& dbusSignalHandlerToken,
                                   const DBusSignalHandler* dbusSignalHandler = NULL);
    bool readWriteDispatch(int timeoutMilliseconds = -1);

    virtual const std::shared_ptr<DBusServiceRegistry> getDBusServiceRegistry();
    virtual const std::shared_ptr<DBusObjectManager> getDBusObjectManager();

    void setObjectPathMessageHandler(DBusObjectPathMessageHandler);
    bool isObjectPathMessageHandlerSet();

    virtual bool attachMainLoopContext(std::weak_ptr<MainLoopContext>);

    bool isDispatchReady();
    bool singleDispatch();

    typedef std::tuple<std::string, std::string, std::string> DBusSignalMatchRuleTuple;
    typedef std::pair<uint32_t, std::string> DBusSignalMatchRuleMapping;
    typedef std::unordered_map<DBusSignalMatchRuleTuple, DBusSignalMatchRuleMapping> DBusSignalMatchRulesMap;
 private:
    void dispatch();
    void suspendDispatching() const;
    void resumeDispatching() const;

    std::thread* dispatchThread_;
    bool stopDispatching_;

    std::weak_ptr<MainLoopContext> mainLoopContext_;
    DispatchSource* dispatchSource_;
    WatchContext* watchContext_;

    mutable bool pauseDispatching_;
    mutable std::mutex dispatchSuspendLock_;

    void addLibdbusSignalMatchRule(const std::string& objectPath,
            const std::string& interfaceName,
            const std::string& interfaceMemberName,
            const bool justAddFilter = false);

    void removeLibdbusSignalMatchRule(const std::string& objectPath,
            const std::string& interfaceName,
            const std::string& interfaceMemberName);

    void initLibdbusSignalFilterAfterConnect();
    ::DBusHandlerResult onLibdbusSignalFilter(::DBusMessage* libdbusMessage);

    void initLibdbusObjectPathHandlerAfterConnect();
    ::DBusHandlerResult onLibdbusObjectPathMessage(::DBusMessage* libdbusMessage);

    static void onLibdbusPendingCallNotifyThunk(::DBusPendingCall* libdbusPendingCall, void* userData);
    static void onLibdbusDataCleanup(void* userData);

    static ::DBusHandlerResult onLibdbusObjectPathMessageThunk(::DBusConnection* libdbusConnection,
            ::DBusMessage* libdbusMessage,
            void* userData);

    static ::DBusHandlerResult onLibdbusSignalFilterThunk(::DBusConnection* libdbusConnection,
            ::DBusMessage* libdbusMessage,
            void* userData);

    static dbus_bool_t onAddWatch(::DBusWatch* libdbusWatch, void* data);
    static void onRemoveWatch(::DBusWatch* libdbusWatch, void* data);
    static void onToggleWatch(::DBusWatch* libdbusWatch, void* data);

    static dbus_bool_t onAddTimeout(::DBusTimeout* dbus_timeout, void* data);
    static void onRemoveTimeout(::DBusTimeout* dbus_timeout, void* data);
    static void onToggleTimeout(::DBusTimeout* dbus_timeout, void* data);

    static void onWakeupMainContext(void* data);

    void enforceAsynchronousTimeouts() const;
    static const DBusObjectPathVTable* getDBusObjectPathVTable();

    ::DBusConnection* libdbusConnection_;
    mutable std::mutex libdbusConnectionGuard_;
    std::mutex signalGuard_;
    std::mutex objectManagerGuard_;
    std::mutex serviceRegistryGuard_;

    BusType busType_;

    std::weak_ptr<DBusServiceRegistry> dbusServiceRegistry_;
    std::shared_ptr<DBusObjectManager> dbusObjectManager_;

    DBusConnectionStatusEvent dbusConnectionStatusEvent_;

    DBusSignalMatchRulesMap dbusSignalMatchRulesMap_;

    DBusSignalHandlerTable dbusSignalHandlerTable_;

    std::unordered_map<std::string, size_t> dbusObjectManagerSignalMatchRulesMap_;
    std::unordered_multimap<std::string, DBusSignalHandler*> dbusObjectManagerSignalHandlerTable_;
    std::mutex dbusObjectManagerSignalGuard_;

    bool addObjectManagerSignalMatchRule(const std::string& dbusBusName);
    bool removeObjectManagerSignalMatchRule(const std::string& dbusBusName);

    bool addLibdbusSignalMatchRule(const std::string& dbusMatchRule);
    bool removeLibdbusSignalMatchRule(const std::string& dbusMatchRule);

    std::atomic_size_t libdbusSignalMatchRulesCount_;

    // objectPath, referenceCount
    typedef std::unordered_map<std::string, uint32_t> LibdbusRegisteredObjectPathHandlersTable;
    LibdbusRegisteredObjectPathHandlersTable libdbusRegisteredObjectPaths_;

    DBusObjectPathMessageHandler dbusObjectMessageHandler_;

    mutable std::unordered_map<std::string, uint16_t> connectionNameCount_;

    typedef std::pair<DBusPendingCall*, std::tuple<int, DBusMessageReplyAsyncHandler*, DBusMessage> > TimeoutMapElement;
    mutable std::map<DBusPendingCall*, std::tuple<int, DBusMessageReplyAsyncHandler*, DBusMessage>> timeoutMap_;
    mutable std::shared_ptr<std::thread> enforcerThread_;
    mutable std::mutex enforceTimeoutMutex_;
};


} // namespace DBus
} // namespace CommonAPI

#endif // COMMONAPI_DBUS_DBUS_CONNECTION_H_