summaryrefslogtreecommitdiffstats
path: root/src/gui/embedded/qlock.cpp
blob: d4ccef3da565efee9c8b3024311b63d316350513 (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
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qlock_p.h"

#ifdef QT_NO_QWS_MULTIPROCESS

QT_BEGIN_NAMESPACE

/* no multiprocess - use a dummy */

QLock::QLock(const QString & /*filename*/, char /*id*/, bool /*create*/)
    : type(Read), data(0)
{
}

QLock::~QLock()
{
}

bool QLock::isValid() const
{
    return true;
}

void QLock::lock(Type t)
{
    data = (QLockData *)-1;
    type = t;
}

void QLock::unlock()
{
    data = 0;
}

bool QLock::locked() const
{
    return data;
}

QT_END_NAMESPACE

#else // QT_NO_QWS_MULTIPROCESS

#if defined(Q_OS_DARWIN)
#  define QT_NO_SEMAPHORE
#endif

#include "qwssignalhandler_p.h"

#include <unistd.h>
#include <sys/types.h>
#include <sys/ipc.h>
#if defined(QT_NO_SEMAPHORE)
#  include <sys/stat.h>
#  include <sys/file.h>
#elif !defined(QT_POSIX_IPC)
#  include <sys/sem.h>
#else
#  include <semaphore.h>
#endif
#include <string.h>
#include <errno.h>

#include <private/qcore_unix_p.h> // overrides QT_OPEN

QT_BEGIN_NAMESPACE

#define MAX_LOCKS   200            // maximum simultaneous read locks

class QLockData
{
public:
#if defined(QT_NO_SEMAPHORE) || defined(QT_POSIX_IPC)
    QByteArray file;
#endif
#if !defined(QT_POSIX_IPC)
    int id;
#else
    sem_t *id;    // Read mode resource counter
    sem_t *rsem;  // Read mode lock
    sem_t *wsem;  // Write mode lock
#endif
    int count;
    bool owned;
};


/*!
    \class QLock
    \brief The QLock class is a wrapper for a system shared semaphore.

    \ingroup qws

    \internal

    It is used by \l{Qt for Embedded Linux} for synchronizing access to the graphics
    card and shared memory region between processes.
*/

/*!
    \enum QLock::Type

    \value Read
    \value Write
*/

/*!
    Creates a lock. \a filename is the file path of the Unix-domain
    socket the \l{Qt for Embedded Linux} client is using. \a id is the name of the
    particular lock to be created on that socket. If \a create is true
    the lock is to be created (as the Qt for Embedded Linux server does); if \a
    create is false the lock should exist already (as the Qt for Embedded Linux
    client expects).
*/
QLock::QLock(const QString &filename, char id, bool create)
{
    data = new QLockData;
    data->count = 0;
#if defined(QT_NO_SEMAPHORE)
    data->file = filename.toLocal8Bit() + id;
    for (int x = 0; x < 2; ++x) {
        data->id = QT_OPEN(data->file.constData(), O_RDWR | (x ? O_CREAT : 0), S_IRWXU);
        if (data->id != -1 || !create) {
            data->owned = x;
            break;
        }
    }
#elif !defined(QT_POSIX_IPC)
    key_t semkey = ftok(filename.toLocal8Bit().constData(), id);
    data->id = semget(semkey, 0, 0);
    data->owned = create;
    if (create) {
        qt_semun arg;
        arg.val = 0;
        if (data->id != -1)
            semctl(data->id, 0, IPC_RMID, arg);
        data->id = semget(semkey, 1, IPC_CREAT | 0600);
        arg.val = MAX_LOCKS;
        semctl(data->id, 0, SETVAL, arg);
    }
#else
    data->file = filename.toLocal8Bit() + id;
    data->owned = create;

    char ids[3] = { 'c', 'r', 'w' };
    sem_t **sems[3] = { &data->id, &data->rsem, &data->wsem };
    unsigned short initialValues[3] = { MAX_LOCKS, 1, 1 };
    for (int i = 0; i < 3; ++i) {
        QByteArray file = data->file + ids[i];
        do {
            *sems[i] = sem_open(file.constData(), 0, 0666, 0);
        } while (*sems[i] == SEM_FAILED && errno == EINTR);
        if (create) {
            if (*sems[i] != SEM_FAILED) {
                sem_close(*sems[i]);
                sem_unlink(file.constData());
            }
            do {
                *sems[i] = sem_open(file.constData(), O_CREAT, 0666, initialValues[i]);
            } while (*sems[i] == SEM_FAILED && errno == EINTR);
        }
    }
#endif
    if (!isValid()) {
        qWarning("QLock::QLock: Cannot %s semaphore %s '%c' (%d, %s)",
                 (create ? "create" : "get"), qPrintable(filename), id,
                 errno, strerror(errno));
    }

#ifndef QT_NO_QWS_SIGNALHANDLER
    QWSSignalHandler::instance()->addLock(this);
#endif
}

/*!
    Destroys a lock
*/
QLock::~QLock()
{
#ifndef QT_NO_QWS_SIGNALHANDLER
    QWSSignalHandler::instance()->removeLock(this);
#endif

    while (locked())
        unlock();

#if defined(QT_NO_SEMAPHORE)
    if (isValid())
        QT_CLOSE(data->id);
#elif defined(QT_POSIX_IPC)
    if (data->id != SEM_FAILED)
        sem_close(data->id);
    if (data->rsem != SEM_FAILED)
        sem_close(data->rsem);
    if (data->wsem != SEM_FAILED)
        sem_close(data->wsem);
#endif

    if (data->owned) {
#if defined(QT_NO_SEMAPHORE)
        unlink(data->file.constData());
#elif !defined(QT_POSIX_IPC)
        qt_semun semval;
        semval.val = 0;
        semctl(data->id, 0, IPC_RMID, semval);
#else
        char ids[3] = { 'c', 'r', 'w' };
        for (int i = 0; i < 3; ++i) {
            QByteArray file = data->file + ids[i];
            sem_unlink(file.constData());
        }
#endif
    }
    delete data;
    data = 0;
}

/*!
    Returns true if the lock constructor was successful; returns false if
    the lock could not be created or was not available to connect to.
*/
bool QLock::isValid() const
{
#if !defined(QT_POSIX_IPC)
    return data && data->id != -1;
#else
    return data && data->id != SEM_FAILED && data->rsem != SEM_FAILED && data->wsem != SEM_FAILED;
#endif
}

/*!
    Locks the semaphore with a lock of type \a t. Locks can either be
    \c Read or \c Write. If a lock is \c Read, attempts by other
    processes to obtain \c Read locks will succeed, and \c Write
    attempts will block until the lock is unlocked. If locked as \c
    Write, all attempts to lock by other processes will block until
    the lock is unlocked. Locks are stacked: i.e. a given QLock can be
    locked multiple times by the same process without blocking, and
    will only be unlocked after a corresponding number of unlock()
    calls.
*/
void QLock::lock(Type t)
{
    if (!isValid())
        return;

    if (!data->count) {
        type = t;

        int rv;
#if defined(QT_NO_SEMAPHORE)
        int op = type == Write ? LOCK_EX : LOCK_SH;

        EINTR_LOOP(rv, flock(data->id, op));
#elif !defined(QT_POSIX_IPC)
        sembuf sops;
        sops.sem_num = 0;
        sops.sem_op = type == Write ? -MAX_LOCKS : -1;
        sops.sem_flg = SEM_UNDO;

        EINTR_LOOP(rv, semop(data->id, &sops, 1));
#else
        if (type == Write) {
            EINTR_LOOP(rv, sem_wait(data->rsem));
            if (rv != -1) {
                EINTR_LOOP(rv, sem_wait(data->wsem));
                if (rv == -1)
                    sem_post(data->rsem);
            }
        } else {
            EINTR_LOOP(rv, sem_wait(data->wsem));
            if (rv != -1) {
                EINTR_LOOP(rv, sem_trywait(data->rsem));
                if (rv != -1 || errno == EAGAIN) {
                    EINTR_LOOP(rv, sem_wait(data->id));
                    if (rv == -1) {
                        int semval;
                        sem_getvalue(data->id, &semval);
                        if (semval == MAX_LOCKS)
                            sem_post(data->rsem);
                    }
                }
                rv = sem_post(data->wsem);
            }
        }
#endif
        if (rv == -1) {
            qDebug("QLock::lock(): %s", strerror(errno));
            return;
        }
    } else if (type == Read && t == Write) {
        qDebug("QLock::lock(): Attempt to lock for write while locked for read");
    }
    data->count++;
}

/*!
    Unlocks the semaphore. If other processes were blocking waiting to
    lock() the semaphore, one of them will wake up and succeed in
    locking.
*/
void QLock::unlock()
{
    if (!isValid())
        return;

    if (data->count > 0) {
        data->count--;
        if (!data->count) {
            int rv;
#if defined(QT_NO_SEMAPHORE)
            EINTR_LOOP(rv, flock(data->id, LOCK_UN));
#elif !defined(QT_POSIX_IPC)
            sembuf sops;
            sops.sem_num = 0;
            sops.sem_op = type == Write ? MAX_LOCKS : 1;
            sops.sem_flg = SEM_UNDO;

            EINTR_LOOP(rv, semop(data->id, &sops, 1));
#else
            if (type == Write) {
                sem_post(data->wsem);
                rv = sem_post(data->rsem);
            } else {
                EINTR_LOOP(rv, sem_wait(data->wsem));
                if (rv != -1) {
                    sem_post(data->id);
                    int semval;
                    sem_getvalue(data->id, &semval);
                    if (semval == MAX_LOCKS)
                        sem_post(data->rsem);
                    rv = sem_post(data->wsem);
                }
            }
#endif
            if (rv == -1)
                qDebug("QLock::unlock(): %s", strerror(errno));
        }
    } else {
        qDebug("QLock::unlock(): Unlock without corresponding lock");
    }
}

/*!
    Returns true if the lock is currently held by the current process;
    otherwise returns false.
*/
bool QLock::locked() const
{
    return isValid() && data->count > 0;
}

QT_END_NAMESPACE

#endif // QT_NO_QWS_MULTIPROCESS