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
.. _topic-platform:

Platforms
=========

.. index::
   pair: platform; code

Platform codes
--------------

The MPS uses a six-character platform code to express a combination of
operating system, CPU architecture, and compiler toolchain. Each
six-character code breaks down into three pairs of characters:
``OSARCT``. The first pair of characters names the operating system:

======  ================  ====================
``OS``  Operating system  Constant
======  ================  ====================
``fr``  FreeBSD           :c:macro:`MPS_OS_FR`
``li``  Linux             :c:macro:`MPS_OS_LI`
``w3``  Windows           :c:macro:`MPS_OS_W3`
``xc``  OS X              :c:macro:`MPS_OS_XC`
======  ================  ====================

The second pair of characters names the processor architecture:

======  ======================  ======================
``AR``  Processor architecture  Constant
======  ======================  ======================
``i3``  Intel/AMD IA-32         :c:macro:`MPS_ARCH_I3`
``i6``  Intel/AMD x86-64        :c:macro:`MPS_ARCH_I6`
======  ======================  ======================

The third pair of characters names the compiler toolchain:

======  =======================  =======================
``CT``  Compiler toolchain       Constant
======  =======================  =======================
``gc``  GNU Compiler collection  :c:macro:`MPS_BUILD_GC`
``ll``  Clang/LLVM               :c:macro:`MPS_BUILD_LL`
``mv``  Microsoft Visual C/C++   :c:macro:`MPS_BUILD_MV`
======  =======================  =======================

In each case the aspect of the platform can be tested by checking
whether the preprocessor constant in the third column in the table
is defined, and the full platform can be tested by checking
whether the corresponding ``MPS_PF_`` preprocessor constant is
defined. For example, "``xci6ll``" platform corresponds to the
:c:macro:`MPS_PF_XCI6LL` preprocessor constant.

Not all combinations of operating system, processor architecture,
and compiler are supported.


.. index::
   single: platform; interface

Platform interface
------------------

::

    #include "mpstd.h"


.. c:macro:: MPS_ARCH_I3

    A :term:`C` preprocessor macro that indicates, if defined, that
    the target processor architecture of the compilation is a member
    of the IA-32 Intel/AMD family of 32-bit processors.


.. c:macro:: MPS_ARCH_I6

    A :term:`C` preprocessor macro that indicates, if defined, that
    the target processor architecture of the compilation is a member
    of the x86-64 Intel/AMD family of 64-bit processors.

    .. note::

        The MPS is not supported on IA-64 (Itanium).


.. c:macro:: MPS_BUILD_GC

    A :term:`C` preprocessor macro that indicates, if defined, that
    the MPS was compiled by the C compiler from the GNU Compiler
    Collection (GCC).


.. c:macro:: MPS_BUILD_LL

    A :term:`C` preprocessor macro that indicates, if defined, that
    the MPS was compiled by Clang, the C compiler from the LLVM (Low
    Level Virtual Machine) system.


.. c:macro:: MPS_BUILD_MV

    A :term:`C` preprocessor macro that indicates, if defined, that
    the MPS was compiled by the C compiler from Microsoft Visual
    Studio.


.. c:macro:: MPS_OS_FR

    A :term:`C` preprocessor macro that indicates, if defined, that
    the MPS was compiled on a FreeBSD operating system.


.. c:macro:: MPS_OS_LI

    A :term:`C` preprocessor macro that indicates, if defined, that
    the MPS was compiled on a Linux operating system.


.. c:macro:: MPS_OS_W3

    A :term:`C` preprocessor macro that indicates, if defined, that
    the MPS was compiled on a Windows operating system.


.. c:macro:: MPS_OS_XC

    A :term:`C` preprocessor macro that indicates, if defined, that
    the MPS was compiled on an OS X operating system.


.. c:macro:: MPS_PF_ALIGN

    A :term:`C` preprocessor macro that expands to an integer giving
    the :term:`natural alignment` of the :term:`platform`.


.. c:macro:: MPS_PF_FRI3GC

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the FreeBSD operating system, the
    IA-32 processor architecture, and the GCC compiler.


.. c:macro:: MPS_PF_FRI6GC

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the FreeBSD operating system, the
    x86-64 processor architecture, and the GCC compiler.


.. c:macro:: MPS_PF_LII3GC

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the Linux operating system, the
    IA-32 processor architecture, and the GCC compiler.


.. c:macro:: MPS_PF_LII6GC

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the Linux operating system, the
    x86-64 processor architecture, and the GCC compiler.


.. c:macro:: MPS_PF_STRING

    A :term:`C` preprocessor macro that names the :term:`platform` for
    which the MPS was built.


.. c:macro:: MPS_PF_W3I3MV

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the Windows operating system, the
    IA-32 processor architecture, and the Microsoft Visual C/C++
    compiler.


.. c:macro:: MPS_PF_W3I6MV

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the Windows operating system, the
    x86-64 processor architecture, and the Microsoft Visual C/C++
    compiler.


.. c:macro:: MPS_PF_XCI3GC

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the OS X operating system, the
    IA-32 processor architecture, and the GCC compiler.


.. c:macro:: MPS_PF_XCI3LL

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the OS X operating system, the
    IA-32 processor architecture, and the Clang/LLVM compiler.


.. c:macro:: MPS_PF_XCI6LL

    A :term:`C` preprocessor macro that indicates, if defined, that
    the :term:`platform` consists of the OS X operating system, the
    x86-64 processor architecture, and the Clang/LLVM compiler.


.. c:macro:: MPS_T_ULONGEST

    A :term:`C` preprocessor macro that expands to the name of the
    largest unsigned integral type.

    The exact identity of this type is
    :term:`platform`\-dependent. Typical identities are ``unsigned
    long`` and ``unsigned __int_64``.


.. c:macro:: MPS_T_WORD

    A :term:`C` preprocessor macro that expands to the name of an
    unsigned integral type that is the same size as an :term:`object
    pointer`, so that ``sizeof(MPS_T_WORD) == sizeof(void*)``.

    The exact identity of this type is
    :term:`platform`\-dependent. Typical identities are ``unsigned
    long`` and ``unsigned __int_64``.


.. c:macro:: MPS_WORD_SHIFT

    A :term:`C` preprocessor macro that expands to the logarithm to
    base 2 of the constant :c:macro:`MPS_WORD_WIDTH`, so that ``1 <<
    MPS_WORD_SHIFT == MPS_WORD_WIDTH``.

    The value is platform-dependent. Typical values are 5 and 6.


.. c:macro:: MPS_WORD_WIDTH

    A :term:`C` preprocessor macro that expands to the width in bits
    of the type :c:type:`MPS_T_WORD`, so that ``MPS_WORD_WIDTH ==
    sizeof(MPS_T_WORD) * CHAR_BIT``.

    This value is platform-dependent. It is always a power of 2:
    typical values are 32 and 64.


.. index::
   single: platform; historical codes

Historical platform codes
-------------------------

The platform codes in the tables below were in use in older versions
of the Memory Pool System, but are not currently supported.

Formerly supported operating systems:

======  ===========================  =============
``OS``  Operating system             Constant            
======  ===========================  =============
``i5``  Irix 5 or 6 (old ABI)        ``MPS_OS_I5``
``ia``  Irix 6 (new ABI)             ``MPS_OS_IA``
``o1``  OSF/1 aka Tru64              ``MPS_OS_O1``
``s7``  Macintosh System 7, 8, or 9  ``MPS_OS_S7``
``so``  Solaris                      ``MPS_OS_SO``
``su``  SunOS                        ``MPS_OS_SU``
======  ===========================  =============

Formerly supported processor architectures:

======  ======================  ===============
``AR``  Processor architecture  Constant     
======  ======================  ===============
``i4``  Intel/AMD IA-32 [1]_    ``MPS_ARCH_I4``
``al``  Digital Alpha           ``MPS_ARCH_AL``
``m2``  MIPS R2000              ``MPS_ARCH_M2``
``m4``  MIPS R4000              ``MPS_ARCH_M4``
``m6``  Motorola 68000          ``MPS_ARCH_M6``
``pp``  PowerPC                 ``MPS_ARCH_PP``
``s8``  SPARC V8                ``MPS_ARCH_S8``
``s9``  SPARC V9 (32-bit)       ``MPS_ARCH_S9``
======  ======================  ===============

Formerly supported compiler toolchains:

======  =======================================  ================
``CT``  Compiler toolchain                       Constant       
======  =======================================  ================
``ac``  Macintosh Programmer's Workshop C/C++    ``MPS_BUILD_AC``
``cc``  The "native" C compiler [2]_             ``MPS_BUILD_CC``
``cx``  SunPro C CXREF tool                      ``MPS_BUILD_CX``
``eg``  Experimental GNU Compiler System (EGCS)  ``MPS_BUILD_EG``
``gp``  GCC with profiling                       ``MPS_BUILD_GP``
``lc``  LCC                                      ``MPS_BUILD_LC``
``mw``  Metrowerks CodeWarrior                   ``MPS_BUILD_MW``
``sc``  SunPro C                                 ``MPS_BUILD_SC``
======  =======================================  ================

.. note::

    .. [1] Obsolete: the MPS used to make a distinction between the
           80386 and 80486 processor architectures.

    .. [2] This was the MIPSpro C compiler on IRIX; and the Digital C
           Compiler on OSF/1.


.. index::
   single: platform; historical list

Historical platform list
------------------------

This is the full list of platforms that have ever been supported by
the Memory Pool System, with their current status.

==========  =======================
Platform    Status
==========  =======================
``fri3gc``  Supported
``fri4gc``  Corrected to ``fri3gc``
``fri6gc``  Supported
``i5m2cc``  *Not supported*
``iam4cc``  *Not supported*
``lii3eg``  *Not supported*
``lii3gc``  Supported
``lii4gc``  Corrected to ``lii3gc``
``lii6gc``  Supported
``lippgc``  *Not supported*
``o1alcc``  *Not supported*
``o1algc``  *Not supported*
``s7m6mw``  *Not supported*
``s7ppac``  *Not supported*
``s7ppmw``  *Not supported*
``sos8cx``  *Not supported*
``sos8gc``  *Not supported*
``sos8gp``  *Not supported*
``sos9sc``  *Not supported*
``sus8gc``  *Not supported*
``w3almv``  *Not supported*
``w3i3m9``  *Not supported*
``w3i3mv``  Supported
``w3i6mv``  Supported
``w3ppmv``  *Not supported*
``xci3gc``  *Not supported*
``xci3ll``  Supported
``xci6ll``  Supported
``xcppgc``  *Not supported*
==========  =======================