projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
1 | .. Copyright (C) 2004-2008 The Trustees of Indiana University. |
| 2 | Use, modification and distribution is subject to the Boost Software | |
| 3 | License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at | |
| 4 | http://www.boost.org/LICENSE_1_0.txt) | |
| 5 | ||
| 6 | ================================ | |
| 7 | |Logo| Concept Global Descriptor | |
| 8 | ================================ | |
| 9 | ||
| 10 | .. contents:: | |
| 11 | ||
| 12 | Description | |
| 13 | ----------- | |
| 14 | ||
| 15 | A global descriptor is an object that represents an entity that is | |
| 16 | owned by some process and may reside in an address space not | |
| 17 | accessible to the currently-executing process. The global descriptor | |
| 18 | consists of two parts: the *owner* of the entity, which is the | |
| 19 | identifier of that process in which the entity resides, and a *local | |
| 20 | descriptor*, that uniquely identifies the entity with the address | |
| 21 | space of the owner. | |
| 22 | ||
| 23 | Refinement of | |
| 24 | ------------- | |
| 25 | ||
| 26 | - `Default Constructible`_ | |
| 27 | - Assignable_ | |
| 28 | ||
| 29 | Notation | |
| 30 | -------- | |
| 31 | X | |
| 32 | A type that models the Global Descriptor concept. | |
| 33 | ||
| 34 | x | |
| 35 | Object of type X | |
| 36 | ||
| 37 | ||
| 38 | Associated types | |
| 39 | ---------------- | |
| 40 | ||
| 41 | +----------------+--------------------+---------------------------------+ | |
| 42 | |Process ID type |``process_id_type`` |Determined by the process group | | |
| 43 | | | |associated with type X. | | |
| 44 | +----------------+--------------------+---------------------------------+ | |
| 45 | |Local descriptor|``local_type`` |Determined by the data structure | | |
| 46 | |type | |the descriptor accesses. | | |
| 47 | | | |Must model `Equality Comparable`_| | |
| 48 | | | |and `Copy Constructible`_. | | |
| 49 | +----------------+--------------------+---------------------------------+ | |
| 50 | ||
| 51 | Valid Expressions | |
| 52 | ----------------- | |
| 53 | ||
| 54 | +----------------+---------------------+---------------------+-------------------------------------+ | |
| 55 | |Name |Expression |Type |Semantics | | |
| 56 | +================+=====================+=====================+=====================================+ | |
| 57 | |Owner |``owner(x)`` |``process_id_type`` |Returns the owner of ``x``. | | |
| 58 | +----------------+---------------------+---------------------+-------------------------------------+ | |
| 59 | |Local descriptor|``local(x)`` |``local_type`` |Returns the local descriptor | | |
| 60 | | | | |uniquely identifying ``x``. | | |
| 61 | +----------------+---------------------+---------------------+-------------------------------------+ | |
| 62 | ||
| 63 | ||
| 64 | ----------------------------------------------------------------------------- | |
| 65 | ||
| 66 | Copyright (C) 2005 The Trustees of Indiana University. | |
| 67 | ||
| 68 | Authors: Douglas Gregor and Andrew Lumsdaine | |
| 69 | ||
| 70 | .. |Logo| image:: pbgl-logo.png | |
| 71 | :align: middle | |
| 72 | :alt: Parallel BGL | |
| 73 | :target: http://www.osl.iu.edu/research/pbgl | |
| 74 | ||
| 75 | .. _Assignable: http://www.sgi.com/tech/stl/Assignable.html | |
| 76 | .. _Copy constructible: http://www.sgi.com/tech/stl/CopyConstructible.html | |
| 77 | .. _Default constructible: http://www.sgi.com/tech/stl/DefaultConstructible.html | |
| 78 | .. _Equality comparable: http://www.sgi.com/tech/stl/EqualityComparable.html |