summaryrefslogtreecommitdiff
path: root/AudioManagerUtilities/src/CAmDbusWrapper.cpp
blob: 504bf3887df570da21e1701358b7df053996da34 (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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
/**
 *  SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2012, BMW AG
 *
 * This file is part of GENIVI Project AudioManager.
 *
 * Contributions are licensed to the GENIVI Alliance under one or more
 * Contribution License Agreements.
 *
 * \copyright
 * 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/.
 *
 *
 * \author Christian Linke, christian.linke@bmw.de BMW 2011,2012
 *
 * \file CAmDbusWrapper.cpp
 * For further information see http://www.genivi.org/.
 *
 */

#include "CAmDbusWrapper.h"
#include <audiomanagerconfig.h>
#include <fstream>
#include <sstream>
#include <string>
#include <cassert>
#include <cstdlib>
#include <stdexcept>
#include "CAmDltWrapper.h"
#include "CAmSocketHandler.h"

namespace am
{

/**
 * introspectio header
 */
#define ROOT_INTROSPECT_XML                                               \
    DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE                             \
    "<node>"                                                              \
    "<interface name='org.AudioManager.freedesktop.DBus.Introspectable'>" \
    "<method name='Introspect'>"                                          \
    "	<arg name='xml_data' type='s' direction='out'/>"                  \
    "</method>"                                                           \
    "</interface>"                                                        \

CAmDbusWrapper *CAmDbusWrapper::mpReference = NULL;

CAmDbusWrapper::CAmDbusWrapper(CAmSocketHandler *socketHandler, DBusBusType type, const std::string &prefix, const std::string &objectPath)
    : pDbusPrepareCallback(this, &CAmDbusWrapper::dbusPrepareCallback)
    , pDbusDispatchCallback(this, &CAmDbusWrapper::dbusDispatchCallback)
    , pDbusFireCallback(this, &CAmDbusWrapper::dbusFireCallback)
    , pDbusCheckCallback(this, &CAmDbusWrapper::dbusCheckCallback)
    , pDbusTimerCallback(this, &CAmDbusWrapper::dbusTimerCallback)
    , mpDbusConnection(0)
    , mDBusError()
    , mListNodes()
    , mpListTimerhandles()
    , mpSocketHandler(socketHandler)
    , mDbusType(type)
{
    assert(mpSocketHandler != 0);

    dbus_error_init(&mDBusError);

    if (!dbus_threads_init_default())
    {
        logError("CAmDbusWrapper::CAmDbusWrapper threads init call failed");
    }

    logInfo("DBusWrapper::DBusWrapper Opening DBus connection of:", prefix, objectPath);
    mpDbusConnection = dbus_bus_get(mDbusType, &mDBusError);
    if (dbus_error_is_set(&mDBusError))
    {
        logError("DBusWrapper::DBusWrapper Error while getting the DBus");
        dbus_error_free(&mDBusError);
    }

    if (NULL == mpDbusConnection)
    {
        logError("DBusWrapper::DBusWrapper DBus Connection is null");
    }
    else
    {
        logInfo("DBusWrapper::DBusWrapper DBus Connection is", mpDbusConnection);
    }

    // then we need to adopt the dbus to our mainloop:
    // first, we are old enought to live longer then the connection:
    dbus_connection_set_exit_on_disconnect(mpDbusConnection, FALSE);

    // we do not need the manual dispatching, since it is not allowed to call from a different thread. So leave it uncommented:
    // dbus_connection_set_dispatch_status_function

    // add watch functions:
    dbus_bool_t watch = dbus_connection_set_watch_functions(mpDbusConnection, addWatch, removeWatch, toogleWatch, this, NULL);
    if (!watch)
    {
        logError("DBusWrapper::DBusWrapper Registering of watch functions failed");
    }

    // add timer functions:
    dbus_bool_t timer = dbus_connection_set_timeout_functions(mpDbusConnection, addTimeout, removeTimeout, toggleTimeout, this, NULL);
    if (!timer)
    {
        logError("DBusWrapper::DBusWrapper Registering of timer functions failed");
    }

    if (prefix.empty() && objectPath.empty())
    {
        logInfo("DBusWrapper::DBusWrapper We don't register a connection object!");
        return;
    }

    // register callback for Introspectio
    mObjectPathVTable.message_function = CAmDbusWrapper::cbRootIntrospection;
    dbus_connection_register_object_path(mpDbusConnection, objectPath.c_str(), &mObjectPathVTable, this);
    int ret = dbus_bus_request_name(mpDbusConnection, prefix.c_str(), DBUS_NAME_FLAG_DO_NOT_QUEUE, &mDBusError);
    if (DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER == ret)
    {
        logInfo("DBusWrapper::DBusWrapper We own", prefix);
    }
    else
    {
        std::ostringstream sserror("DBusWrapper::DBusWrapper ");
        switch (ret)
        {
        case -1:
            sserror << "Couldn't acquire name " << prefix << ". DBus message: " << mDBusError.message;
            dbus_error_free(&mDBusError);
            break;
        case DBUS_REQUEST_NAME_REPLY_IN_QUEUE:
            sserror << "We are queued for " << prefix;
            break;
        case DBUS_REQUEST_NAME_REPLY_EXISTS:
            sserror << ":-( " << prefix << " already exists!";
            break;
        case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER:
            sserror << "Eh? We already own " << prefix;
            break;
        default:
            sserror << "Unknown result = " << ret;
            break;
        }

        logError(sserror.str());
        throw std::runtime_error(sserror.str().c_str());
    }
}

CAmDbusWrapper::~CAmDbusWrapper()
{
    // close the connection again
    logInfo("DBusWrapper::~DBusWrapper Closing DBus connection");
    dbus_connection_unref(mpDbusConnection);

    // clean up all timerhandles we created but did not delete before
    std::vector<sh_timerHandle_t *>::iterator it = mpListTimerhandles.begin();
    for (; it != mpListTimerhandles.end(); ++it)
    {
        delete *it;
    }
}

/**
 * registers a callback that is entered as path below the main path.
 * The configuration of the mainpath is done via DBusConfiguration.h
 * @param vtable the vtable that holds a pointer to the callback that is called when the path is called from the dbus
 * @param path the name of the path
 * @param userdata pointer to the class that will handle the callback
 * @param prefix before the path which is optional
 */
void CAmDbusWrapper::registerCallback(const DBusObjectPathVTable *vtable, const std::string &path, void *userdata, const std::string &prefix)
{
    logInfo("DBusWrapper::registerCallback register callback:", path);

    std::string completePath = prefix + "/" + path;
    dbus_error_init(&mDBusError);
    dbus_connection_register_object_path(mpDbusConnection, completePath.c_str(), vtable, userdata);
    if (dbus_error_is_set(&mDBusError))
    {
        logError("DBusWrapper::registerCallack error: ", mDBusError.message);
        dbus_error_free(&mDBusError);
    }

    mListNodes.push_back(path);
}

/**
 * register signal watch callback to matching rule
 * @param handler pointer to the callback function
 * @param rule signal watch rule like "type='signal',interface='org.genivi.audiomanager.something'"
 * @param userdata userdata
 */
void CAmDbusWrapper::registerSignalWatch(DBusHandleMessageFunction handler, const std::string &rule, void *userdata)
{
    logInfo("DBusWrapper::registerSignalWatch register callback:", rule);
    dbus_error_init(&mDBusError);
    dbus_bus_add_match(mpDbusConnection, rule.c_str(), &mDBusError);
    dbus_connection_flush(mpDbusConnection);
    dbus_connection_add_filter(mpDbusConnection, handler, userdata, 0);

    if (dbus_error_is_set(&mDBusError))
    {
        logError("DBusWrapper::registerCallack error: ", mDBusError.message);
        dbus_error_free(&mDBusError);
    }
}

/**
 * internal callback for the root introspection
 * @param conn
 * @param msg
 * @param reference
 * @return
 */
DBusHandlerResult CAmDbusWrapper::cbRootIntrospection(DBusConnection *conn, DBusMessage *msg, void *reference)
{
    // logInfo("DBusWrapper::~cbRootIntrospection called:");

    mpReference = (CAmDbusWrapper *)reference;
    std::vector<std::string> nodesList = mpReference->mListNodes;
    DBusMessage             *reply;
    DBusMessageIter          args;
    dbus_uint32_t            serial = 0;
    if (dbus_message_is_method_call(msg, DBUS_INTERFACE_INTROSPECTABLE, "Introspect"))
    {
        std::vector<std::string>::iterator nodeIter = nodesList.begin();
        const char                        *xml      = ROOT_INTROSPECT_XML;
        std::stringstream                  introspect;
        introspect << std::string(xml);
        for (; nodeIter != nodesList.end(); ++nodeIter)
        {
            introspect << "<node name='" << nodeIter->c_str() << "'/>";
        }

        introspect << "</node>";

        reply = dbus_message_new_method_return(msg);
        std::string s      = introspect.str();
        const char *string = s.c_str();

        // add the arguments to the reply
        dbus_message_iter_init_append(reply, &args);
        if (!dbus_message_iter_append_basic(&args, DBUS_TYPE_STRING, &string))
        {
            logError("DBusWrapper::~cbRootIntrospection DBUS Out Of Memory!");
        }

        // send the reply && flush the connection
        if (!dbus_connection_send(conn, reply, &serial))
        {
            logError("DBusWrapper::~cbRootIntrospection DBUS Out Of Memory!");
        }

        dbus_connection_flush(conn);
        // free the reply
        dbus_message_unref(reply);

        return (DBUS_HANDLER_RESULT_HANDLED);
    }
    else
    {
        return (DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
    }
}

/**
 * returns the dbus connection
 * @param connection pointer to the connection
 */
void CAmDbusWrapper::getDBusConnection(DBusConnection * &connection) const
{
    connection = mpDbusConnection;
}

dbus_bool_t CAmDbusWrapper::addWatch(DBusWatch *watch, void *userData)
{
    mpReference = (CAmDbusWrapper *)userData;
    assert(mpReference != 0);
    return (mpReference->addWatchDelegate(watch, userData));
}

dbus_bool_t CAmDbusWrapper::addWatchDelegate(DBusWatch *watch, void *userData)
{
    (void)userData;
    int16_t         event  = 0;
    sh_pollHandle_t handle = 0;
    uint            flags  = dbus_watch_get_flags(watch);

    /* no watch flags for disabled watches */
    if (dbus_watch_get_enabled(watch))
    {
        if (flags & DBUS_WATCH_READABLE)
        {
            event |= POLLIN;
        }

        if (flags & DBUS_WATCH_WRITABLE)
        {
            event |= POLLOUT;
        }

        logInfo("DBusWrapper::addWatchDelegate entered new watch, fd=", dbus_watch_get_unix_fd(watch), "event flag=", event);
        am_Error_e error = mpSocketHandler->addFDPoll(dbus_watch_get_unix_fd(watch), event, &pDbusPrepareCallback, &pDbusFireCallback, &pDbusCheckCallback, &pDbusDispatchCallback, watch, handle);

        // if everything is alright, add the watch and the handle to our map so we know this relationship
        if (error == E_OK && handle != 0)
        {
            mMapHandleWatch.insert(std::make_pair(watch, handle));
            return (true);
        }

        logError("DBusWrapper::addWatchDelegate entering watch failed");
    }

    return (true);
}

void CAmDbusWrapper::removeWatch(DBusWatch *watch, void *userData)
{
    mpReference = (CAmDbusWrapper *)userData;
    assert(mpReference != 0);
    mpReference->removeWatchDelegate(watch, userData);
}

void CAmDbusWrapper::removeWatchDelegate(DBusWatch *watch, void *userData)
{
    (void)userData;
    std::map<DBusWatch *, sh_pollHandle_t>::iterator iterator = mMapHandleWatch.begin();
    iterator = mMapHandleWatch.find(watch);
    if (iterator != mMapHandleWatch.end())
    {
        mpSocketHandler->removeFDPoll(iterator->second);
        logInfo("DBusWrapper::removeWatch removed watch with handle", iterator->second);
        mMapHandleWatch.erase(iterator);
    }
    else
    {
        logError("DBusWrapper::removeWatch could not find handle !");
    }
}

void CAmDbusWrapper::toogleWatch(DBusWatch *watch, void *userData)
{
    mpReference = (CAmDbusWrapper *)userData;
    assert(mpReference != 0);
    mpReference->toogleWatchDelegate(watch, userData);
}

void CAmDbusWrapper::toogleWatchDelegate(DBusWatch *watch, void *userData)
{
    (void)userData;
    int16_t event = 0;
    dbus_watch_get_unix_fd(watch);
    uint flags = dbus_watch_get_flags(watch);
    /* no watch flags for disabled watches */
    if (dbus_watch_get_enabled(watch))
    {
        if (flags & DBUS_WATCH_READABLE)
        {
            event |= POLLIN;
        }

        if (flags & DBUS_WATCH_WRITABLE)
        {
            event |= POLLOUT;
        }
    }

    std::map<DBusWatch *, sh_pollHandle_t>::iterator iterator = mMapHandleWatch.begin();
    iterator = mMapHandleWatch.find(watch);
    if (iterator != mMapHandleWatch.end())
    {
        mpSocketHandler->updateEventFlags(iterator->second, event);
    }
}

dbus_bool_t CAmDbusWrapper::addTimeout(DBusTimeout *timeout, void *userData)
{
    mpReference = (CAmDbusWrapper *)userData;
    assert(mpReference != 0);
    return (mpReference->addTimeoutDelegate(timeout, userData));
}

dbus_bool_t CAmDbusWrapper::addTimeoutDelegate(DBusTimeout *timeout, void *userData)
{
    (void)userData;

    if (!dbus_timeout_get_enabled(timeout))
    {
        return (false);
    }

    // calculate the timeout in timeval
    timespec pollTimeout;
    int      localTimeout = dbus_timeout_get_interval(timeout);
    pollTimeout.tv_sec  = localTimeout / 1000;
    pollTimeout.tv_nsec = (localTimeout % 1000) * 1000000;

    // prepare handle and callback. new is eval, but there is no other choice because we need the pointer!
    sh_timerHandle_t *handle = new sh_timerHandle_t;
    mpListTimerhandles.push_back(handle);

    // add the timer to the pollLoop
    mpSocketHandler->addTimer(pollTimeout, &pDbusTimerCallback, *handle, timeout);

    // save the handle with dbus context
    dbus_timeout_set_data(timeout, handle, NULL);

    return (true);
}

void CAmDbusWrapper::removeTimeout(DBusTimeout *timeout, void *userData)
{
    mpReference = (CAmDbusWrapper *)userData;
    assert(mpReference != 0);
    mpReference->removeTimeoutDelegate(timeout, userData);
}

void CAmDbusWrapper::removeTimeoutDelegate(DBusTimeout *timeout, void *userData)
{
    (void)userData;
    // get the pointer to the handle and remove the timer
    sh_timerHandle_t *handle = (sh_timerHandle_t *)dbus_timeout_get_data(timeout);
    mpSocketHandler->removeTimer(*handle);

    // now go throught the timerlist and remove the pointer, free memory
    std::vector<sh_timerHandle_t *>::iterator it = mpListTimerhandles.begin();
    for (; it != mpListTimerhandles.end(); ++it)
    {
        if (*it == handle)
        {
            mpListTimerhandles.erase(it);
            break;
        }
    }

    delete handle;
}

void CAmDbusWrapper::toggleTimeout(DBusTimeout *timeout, void *userData)
{
    mpReference = (CAmDbusWrapper *)userData;
    assert(mpReference != 0);
    mpReference->toggleTimeoutDelegate(timeout, userData);
}

bool am::CAmDbusWrapper::dbusDispatchCallback(const sh_pollHandle_t handle, void *userData)
{
    (void)handle;
    (void)userData;
    bool returnVal = true;
    dbus_connection_ref(mpDbusConnection);
    if (dbus_connection_dispatch(mpDbusConnection) == DBUS_DISPATCH_COMPLETE)
    {
        returnVal = false;
    }

    dbus_connection_unref(mpDbusConnection);
    // logInfo("DBusWrapper::dbusDispatchCallback was called");
    return (returnVal);
}

bool am::CAmDbusWrapper::dbusCheckCallback(const sh_pollHandle_t handle, void *userData)
{
    (void)handle;
    (void)userData;
    bool returnVal = false;
    dbus_connection_ref(mpDbusConnection);
    if (dbus_connection_get_dispatch_status(mpDbusConnection) == DBUS_DISPATCH_DATA_REMAINS)
    {
        returnVal = true;
    }

    dbus_connection_unref(mpDbusConnection);
    // logInfo("DBusWrapper::dbusCheckCallback was called");
    return (returnVal);
}

void am::CAmDbusWrapper::dbusFireCallback(const pollfd pollfd, const sh_pollHandle_t handle, void *userData)
{
    (void)handle;
    (void)userData;
    assert(userData != NULL);
    uint flags = 0;

    if (pollfd.revents & POLLIN)
    {
        flags |= DBUS_WATCH_READABLE;
    }

    if (pollfd.revents & POLLOUT)
    {
        flags |= DBUS_WATCH_WRITABLE;
    }

    if (pollfd.revents & POLLHUP)
    {
        flags |= DBUS_WATCH_HANGUP;
    }

    if (pollfd.revents & POLLERR)
    {
        flags |= DBUS_WATCH_ERROR;
    }

    DBusWatch *watch = (DBusWatch *)userData;

    dbus_connection_ref(mpDbusConnection);
    dbus_watch_handle(watch, flags);
    dbus_connection_unref(mpDbusConnection);
    // logInfo("DBusWrapper::dbusFireCallback was called");
}

void CAmDbusWrapper::dbusPrepareCallback(const sh_pollHandle_t handle, void *userData)
{
    (void)handle;
    (void)userData;
    dbus_connection_ref(mpDbusConnection);
    while (dbus_connection_get_dispatch_status(mpDbusConnection) == DBUS_DISPATCH_DATA_REMAINS)
    {
        dbus_connection_dispatch(mpDbusConnection);
        // logInfo("prepare was neccessary!");
    }

    dbus_connection_unref(mpDbusConnection);
}

void CAmDbusWrapper::toggleTimeoutDelegate(DBusTimeout *timeout, void *userData)
{
    (void)userData;
    // get the pointer to the handle and remove the timer
    sh_timerHandle_t *handle = (sh_timerHandle_t *)dbus_timeout_get_data(timeout);

    // stop or restart?
    if (dbus_timeout_get_enabled(timeout))
    {
        // calculate the timeout in timeval
        timespec pollTimeout;
        int      localTimeout = dbus_timeout_get_interval(timeout);
        pollTimeout.tv_sec  = localTimeout / 1000;
        pollTimeout.tv_nsec = (localTimeout % 1000) * 1000000;
        mpSocketHandler->updateTimer(*handle, pollTimeout);
    }
    else
    {
        mpSocketHandler->stopTimer(*handle);
    }
}

void CAmDbusWrapper::dbusTimerCallback(sh_timerHandle_t handle, void *userData)
{
    assert(userData != NULL);
    for (auto &&timerHandle : mpListTimerhandles)
    {
        if (*timerHandle == handle)
        {
            if (dbus_timeout_get_enabled((DBusTimeout *)userData))
            {
                mpSocketHandler->restartTimer(handle);
            }

            dbus_timeout_handle((DBusTimeout *)userData);
            return;
        }
    }

    logWarning("CAmDbusWrapper::dbusTimerCallback Unknown timer handle");
}

}