← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/src/platforms/atomic-operations.qdoc

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/platforms/atomic-operations.qdoc
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
 
4
** All rights reserved.
 
5
** Contact: Nokia Corporation (qt-info@nokia.com)
 
6
**
 
7
** This file is part of the documentation of the Qt Toolkit.
 
8
**
 
9
** $QT_BEGIN_LICENSE:LGPL$
 
10
** No Commercial Usage
 
11
** This file contains pre-release code and may not be distributed.
 
12
** You may use this file in accordance with the terms and conditions
 
13
** contained in the Technology Preview License Agreement accompanying
 
14
** this package.
 
15
**
 
16
** GNU Lesser General Public License Usage
 
17
** Alternatively, this file may be used under the terms of the GNU Lesser
 
18
** General Public License version 2.1 as published by the Free Software
 
19
** Foundation and appearing in the file LICENSE.LGPL included in the
 
20
** packaging of this file.  Please review the following information to
 
21
** ensure the GNU Lesser General Public License version 2.1 requirements
 
22
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
23
**
 
24
** In addition, as a special exception, Nokia gives you certain additional
 
25
** rights.  These rights are described in the Nokia Qt LGPL Exception
 
26
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 
27
**
 
28
** If you have questions regarding the use of this file, please contact
 
29
** Nokia at qt-info@nokia.com.
 
30
**
 
31
**
 
32
**
 
33
**
 
34
**
 
35
**
 
36
**
 
37
**
 
38
** $QT_END_LICENSE$
 
39
**
 
40
****************************************************************************/
 
41
 
 
42
/*!
 
43
    \page atomic-operations.html
 
44
    \title Implementing Atomic Operations
 
45
    \brief A guide to implementing atomic operations on new architectures.
 
46
 
 
47
    \ingroup best-practices
 
48
    \ingroup qt-embedded-linux
 
49
 
 
50
    Qt uses an optimization called \l {Implicitly Shared
 
51
    Classes}{implicit sharing} for many of its value classes.
 
52
 
 
53
    Starting with Qt 4, all of Qt's implicitly shared classes can
 
54
    safely be copied across threads like any other value classes,
 
55
    i.e., they are fully \l {Reentrancy and Thread-Safety}{reentrant}.
 
56
    This is accomplished by implementing reference counting
 
57
    operations using atomic hardware instructions on all the
 
58
    different platforms supported by Qt.
 
59
 
 
60
    To support a new architecture, it is important to ensure that
 
61
    these platform-specific atomic operations are implemented in a
 
62
    corresponding header file (\c qatomic_ARCH.h), and that this file
 
63
    is located in Qt's \c src/corelib/arch directory. For example, the
 
64
    Intel 80386 implementation is located in \c
 
65
    src/corelib/arch/qatomic_i386.h.
 
66
 
 
67
    Currently, Qt provides two classes providing several atomic
 
68
    operations, QAtomicInt and QAtomicPointer. These classes inherit
 
69
    from QBasicAtomicInt and QBasicAtomicPointer, respectively.
 
70
 
 
71
    When porting Qt to a new architecture, the QBasicAtomicInt and
 
72
    QBasicAtomicPointer classes must be implemented, \e not QAtomicInt
 
73
    and QAtomicPointer. The former classes do not have constructors,
 
74
    which makes them POD (plain-old-data). Both classes only have a
 
75
    single member variable called \c _q_value, which stores the
 
76
    value. This is the value that all of the atomic operations read
 
77
    and modify.
 
78
 
 
79
    All of the member functions mentioned in the QAtomicInt and
 
80
    QAtomicPointer API documentation must be implemented. Note that
 
81
    these the implementations of the atomic operations in these
 
82
    classes must be atomic with respect to both interrupts and
 
83
    multiple processors.
 
84
 
 
85
    \warning The QBasicAtomicInt and QBasicAtomicPointer classes
 
86
    mentioned in this document are used internally by Qt and are not
 
87
    part of the public API. They may change in future versions of
 
88
    Qt. The purpose of this document is to aid people interested in
 
89
    porting Qt to a new architecture.
 
90
*/