1/* Prototypes of memory model helper functions.
2 Copyright (C) 2011-2017 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20#ifndef GCC_MEMMODEL_H
21#define GCC_MEMMODEL_H
22
23/* Suppose that higher bits are target dependent. */
24#define MEMMODEL_MASK ((1<<16)-1)
25
26/* Legacy sync operations set this upper flag in the memory model. This allows
27 targets that need to do something stronger for sync operations to
28 differentiate with their target patterns and issue a more appropriate insn
29 sequence. See bugzilla 65697 for background. */
30#define MEMMODEL_SYNC (1<<15)
31
32/* Memory model without SYNC bit for targets/operations that do not care. */
33#define MEMMODEL_BASE_MASK (MEMMODEL_SYNC-1)
34
35/* Memory model types for the __atomic* builtins.
36 This must match the order in libstdc++-v3/include/bits/atomic_base.h. */
37enum memmodel
38{
39 MEMMODEL_RELAXED = 0,
40 MEMMODEL_CONSUME = 1,
41 MEMMODEL_ACQUIRE = 2,
42 MEMMODEL_RELEASE = 3,
43 MEMMODEL_ACQ_REL = 4,
44 MEMMODEL_SEQ_CST = 5,
45 MEMMODEL_LAST = 6,
46 MEMMODEL_SYNC_ACQUIRE = MEMMODEL_ACQUIRE | MEMMODEL_SYNC,
47 MEMMODEL_SYNC_RELEASE = MEMMODEL_RELEASE | MEMMODEL_SYNC,
48 MEMMODEL_SYNC_SEQ_CST = MEMMODEL_SEQ_CST | MEMMODEL_SYNC
49};
50
51/* Return the memory model from a host integer. */
52static inline enum memmodel
53memmodel_from_int (unsigned HOST_WIDE_INT val)
54{
55 return (enum memmodel) (val & MEMMODEL_MASK);
56}
57
58/* Return the base memory model from a host integer. */
59static inline enum memmodel
60memmodel_base (unsigned HOST_WIDE_INT val)
61{
62 return (enum memmodel) (val & MEMMODEL_BASE_MASK);
63}
64
65/* Return TRUE if the memory model is RELAXED. */
66static inline bool
67is_mm_relaxed (enum memmodel model)
68{
69 return (model & MEMMODEL_BASE_MASK) == MEMMODEL_RELAXED;
70}
71
72/* Return TRUE if the memory model is CONSUME. */
73static inline bool
74is_mm_consume (enum memmodel model)
75{
76 return (model & MEMMODEL_BASE_MASK) == MEMMODEL_CONSUME;
77}
78
79/* Return TRUE if the memory model is ACQUIRE. */
80static inline bool
81is_mm_acquire (enum memmodel model)
82{
83 return (model & MEMMODEL_BASE_MASK) == MEMMODEL_ACQUIRE;
84}
85
86/* Return TRUE if the memory model is RELEASE. */
87static inline bool
88is_mm_release (enum memmodel model)
89{
90 return (model & MEMMODEL_BASE_MASK) == MEMMODEL_RELEASE;
91}
92
93/* Return TRUE if the memory model is ACQ_REL. */
94static inline bool
95is_mm_acq_rel (enum memmodel model)
96{
97 return (model & MEMMODEL_BASE_MASK) == MEMMODEL_ACQ_REL;
98}
99
100/* Return TRUE if the memory model is SEQ_CST. */
101static inline bool
102is_mm_seq_cst (enum memmodel model)
103{
104 return (model & MEMMODEL_BASE_MASK) == MEMMODEL_SEQ_CST;
105}
106
107/* Return TRUE if the memory model is a SYNC variant. */
108static inline bool
109is_mm_sync (enum memmodel model)
110{
111 return (model & MEMMODEL_SYNC);
112}
113
114#endif /* GCC_MEMMODEL_H */
115