1 -----------------------------------------------------------------------
3 -- (c) 2010 The University of Glasgow
5 -- Primitive Operations and Types
7 -- For more information on PrimOps, see
8 -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/PrimOps
10 -----------------------------------------------------------------------
12 -- This file is processed by the utility program genprimopcode to produce
13 -- a number of include files within the compiler and optionally to produce
14 -- human-readable documentation.
16 -- It should first be preprocessed.
18 -- Information on how PrimOps are implemented and the steps necessary to
19 -- add a new one can be found in the Commentary:
21 -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/PrimOps
23 -- This file is divided into named sections, each containing or more
24 -- primop entries. Section headers have the format:
26 -- section "section-name" {description}
28 -- This information is used solely when producing documentation; it is
29 -- otherwise ignored. The description is optional.
31 -- The format of each primop entry is as follows:
33 -- primop internal-name "name-in-program-text" type category {description} attributes
35 -- The default attribute values which apply if you don't specify
36 -- other ones. Attribute values can be True, False, or arbitrary
37 -- text between curly brackets. This is a kludge to enable
38 -- processors of this file to easily get hold of simple info
39 -- (eg, out_of_line), whilst avoiding parsing complex expressions
40 -- needed for strictness info.
43 has_side_effects = False
48 strictness = { \ arity -> mkStrictSig (mkTopDmdType (replicate arity lazyDmd) TopRes) }
50 -- Currently, documentation is produced using latex, so contents of
51 -- description fields should be legal latex. Descriptions can contain
52 -- matched pairs of embedded curly brackets.
56 -- We need platform defines (tests for mingw32 below). However, we only
57 -- test the TARGET platform, which doesn't vary between stages, so the
58 -- stage1 platform defines are fine:
59 #include "../stage1/ghc_boot_platform.h"
61 section "The word size story."
62 {Haskell98 specifies that signed integers (type {\tt Int})
63 must contain at least 30 bits. GHC always implements {\tt
64 Int} using the primitive type {\tt Int\#}, whose size equals
65 the {\tt MachDeps.h} constant {\tt WORD\_SIZE\_IN\_BITS}.
66 This is normally set based on the {\tt config.h} parameter
67 {\tt SIZEOF\_HSWORD}, i.e., 32 bits on 32-bit machines, 64
68 bits on 64-bit machines. However, it can also be explicitly
69 set to a smaller number, e.g., 31 bits, to allow the
70 possibility of using tag bits. Currently GHC itself has only
71 32-bit and 64-bit variants, but 30 or 31-bit code can be
72 exported as an external core file for use in other back ends.
74 GHC also implements a primitive unsigned integer type {\tt
75 Word\#} which always has the same number of bits as {\tt
78 In addition, GHC supports families of explicit-sized integers
79 and words at 8, 16, 32, and 64 bits, with the usual
80 arithmetic operations, comparisons, and a range of
81 conversions. The 8-bit and 16-bit sizes are always
82 represented as {\tt Int\#} and {\tt Word\#}, and the
83 operations implemented in terms of the the primops on these
84 types, with suitable range restrictions on the results (using
85 the {\tt narrow$n$Int\#} and {\tt narrow$n$Word\#} families
86 of primops. The 32-bit sizes are represented using {\tt
87 Int\#} and {\tt Word\#} when {\tt WORD\_SIZE\_IN\_BITS}
88 $\geq$ 32; otherwise, these are represented using distinct
89 primitive types {\tt Int32\#} and {\tt Word32\#}. These (when
90 needed) have a complete set of corresponding operations;
91 however, nearly all of these are implemented as external C
92 functions rather than as primops. Exactly the same story
93 applies to the 64-bit sizes. All of these details are hidden
94 under the {\tt PrelInt} and {\tt PrelWord} modules, which use
95 {\tt \#if}-defs to invoke the appropriate types and
98 Word size also matters for the families of primops for
99 indexing/reading/writing fixed-size quantities at offsets
100 from an array base, address, or foreign pointer. Here, a
101 slightly different approach is taken. The names of these
102 primops are fixed, but their {\it types} vary according to
103 the value of {\tt WORD\_SIZE\_IN\_BITS}. For example, if word
104 size is at least 32 bits then an operator like
105 \texttt{indexInt32Array\#} has type {\tt ByteArray\# -> Int\#
106 -> Int\#}; otherwise it has type {\tt ByteArray\# -> Int\# ->
107 Int32\#}. This approach confines the necessary {\tt
108 \#if}-defs to this file; no conditional compilation is needed
109 in the files that expose these primops.
111 Finally, there are strongly deprecated primops for coercing
112 between {\tt Addr\#}, the primitive type of machine
113 addresses, and {\tt Int\#}. These are pretty bogus anyway,
114 but will work on existing 32-bit and 64-bit GHC targets; they
115 are completely bogus when tag bits are used in {\tt Int\#},
116 so are not available in this case. }
118 -- Define synonyms for indexing ops.
120 #if WORD_SIZE_IN_BITS < 32
122 #define WORD32 Word32#
128 #if WORD_SIZE_IN_BITS < 64
130 #define WORD64 Word64#
136 ------------------------------------------------------------------------
138 {Operations on 31-bit characters.}
139 ------------------------------------------------------------------------
143 primop CharGtOp "gtChar#" Compare Char# -> Char# -> Bool
144 primop CharGeOp "geChar#" Compare Char# -> Char# -> Bool
146 primop CharEqOp "eqChar#" Compare
147 Char# -> Char# -> Bool
148 with commutable = True
150 primop CharNeOp "neChar#" Compare
151 Char# -> Char# -> Bool
152 with commutable = True
154 primop CharLtOp "ltChar#" Compare Char# -> Char# -> Bool
155 primop CharLeOp "leChar#" Compare Char# -> Char# -> Bool
157 primop OrdOp "ord#" GenPrimOp Char# -> Int#
159 ------------------------------------------------------------------------
161 {Operations on native-size integers (30+ bits).}
162 ------------------------------------------------------------------------
166 primop IntAddOp "+#" Dyadic
168 with commutable = True
170 primop IntSubOp "-#" Dyadic Int# -> Int# -> Int#
173 Dyadic Int# -> Int# -> Int#
174 {Low word of signed integer multiply.}
175 with commutable = True
177 primop IntMulMayOfloOp "mulIntMayOflo#"
178 Dyadic Int# -> Int# -> Int#
179 {Return non-zero if there is any possibility that the upper word of a
180 signed integer multiply might contain useful information. Return
181 zero only if you are completely sure that no overflow can occur.
182 On a 32-bit platform, the recommmended implementation is to do a
183 32 x 32 -> 64 signed multiply, and subtract result[63:32] from
184 (result[31] >>signed 31). If this is zero, meaning that the
185 upper word is merely a sign extension of the lower one, no
188 On a 64-bit platform it is not always possible to
189 acquire the top 64 bits of the result. Therefore, a recommended
190 implementation is to take the absolute value of both operands, and
191 return 0 iff bits[63:31] of them are zero, since that means that their
192 magnitudes fit within 31 bits, so the magnitude of the product must fit
195 If in doubt, return non-zero, but do make an effort to create the
196 correct answer for small args, since otherwise the performance of
197 \texttt{(*) :: Integer -> Integer -> Integer} will be poor.
199 with commutable = True
201 primop IntQuotOp "quotInt#" Dyadic
203 {Rounds towards zero.}
206 primop IntRemOp "remInt#" Dyadic
208 {Satisfies \texttt{(quotInt\# x y) *\# y +\# (remInt\# x y) == x}.}
211 primop IntNegOp "negateInt#" Monadic Int# -> Int#
212 primop IntAddCOp "addIntC#" GenPrimOp Int# -> Int# -> (# Int#, Int# #)
213 {Add with carry. First member of result is (wrapped) sum;
214 second member is 0 iff no overflow occured.}
215 primop IntSubCOp "subIntC#" GenPrimOp Int# -> Int# -> (# Int#, Int# #)
216 {Subtract with carry. First member of result is (wrapped) difference;
217 second member is 0 iff no overflow occured.}
219 primop IntGtOp ">#" Compare Int# -> Int# -> Bool
220 primop IntGeOp ">=#" Compare Int# -> Int# -> Bool
222 primop IntEqOp "==#" Compare
224 with commutable = True
226 primop IntNeOp "/=#" Compare
228 with commutable = True
230 primop IntLtOp "<#" Compare Int# -> Int# -> Bool
231 primop IntLeOp "<=#" Compare Int# -> Int# -> Bool
233 primop ChrOp "chr#" GenPrimOp Int# -> Char#
235 primop Int2WordOp "int2Word#" GenPrimOp Int# -> Word#
236 primop Int2FloatOp "int2Float#" GenPrimOp Int# -> Float#
237 primop Int2DoubleOp "int2Double#" GenPrimOp Int# -> Double#
239 primop ISllOp "uncheckedIShiftL#" GenPrimOp Int# -> Int# -> Int#
240 {Shift left. Result undefined if shift amount is not
241 in the range 0 to word size - 1 inclusive.}
242 primop ISraOp "uncheckedIShiftRA#" GenPrimOp Int# -> Int# -> Int#
243 {Shift right arithmetic. Result undefined if shift amount is not
244 in the range 0 to word size - 1 inclusive.}
245 primop ISrlOp "uncheckedIShiftRL#" GenPrimOp Int# -> Int# -> Int#
246 {Shift right logical. Result undefined if shift amount is not
247 in the range 0 to word size - 1 inclusive.}
249 ------------------------------------------------------------------------
251 {Operations on native-sized unsigned words (30+ bits).}
252 ------------------------------------------------------------------------
256 primop WordAddOp "plusWord#" Dyadic Word# -> Word# -> Word#
257 with commutable = True
259 primop WordSubOp "minusWord#" Dyadic Word# -> Word# -> Word#
261 primop WordMulOp "timesWord#" Dyadic Word# -> Word# -> Word#
262 with commutable = True
264 primop WordQuotOp "quotWord#" Dyadic Word# -> Word# -> Word#
267 primop WordRemOp "remWord#" Dyadic Word# -> Word# -> Word#
270 primop AndOp "and#" Dyadic Word# -> Word# -> Word#
271 with commutable = True
273 primop OrOp "or#" Dyadic Word# -> Word# -> Word#
274 with commutable = True
276 primop XorOp "xor#" Dyadic Word# -> Word# -> Word#
277 with commutable = True
279 primop NotOp "not#" Monadic Word# -> Word#
281 primop SllOp "uncheckedShiftL#" GenPrimOp Word# -> Int# -> Word#
282 {Shift left logical. Result undefined if shift amount is not
283 in the range 0 to word size - 1 inclusive.}
284 primop SrlOp "uncheckedShiftRL#" GenPrimOp Word# -> Int# -> Word#
285 {Shift right logical. Result undefined if shift amount is not
286 in the range 0 to word size - 1 inclusive.}
288 primop Word2IntOp "word2Int#" GenPrimOp Word# -> Int#
290 primop WordGtOp "gtWord#" Compare Word# -> Word# -> Bool
291 primop WordGeOp "geWord#" Compare Word# -> Word# -> Bool
292 primop WordEqOp "eqWord#" Compare Word# -> Word# -> Bool
293 primop WordNeOp "neWord#" Compare Word# -> Word# -> Bool
294 primop WordLtOp "ltWord#" Compare Word# -> Word# -> Bool
295 primop WordLeOp "leWord#" Compare Word# -> Word# -> Bool
297 ------------------------------------------------------------------------
299 {Explicit narrowing of native-sized ints or words.}
300 ------------------------------------------------------------------------
302 primop Narrow8IntOp "narrow8Int#" Monadic Int# -> Int#
303 primop Narrow16IntOp "narrow16Int#" Monadic Int# -> Int#
304 primop Narrow32IntOp "narrow32Int#" Monadic Int# -> Int#
305 primop Narrow8WordOp "narrow8Word#" Monadic Word# -> Word#
306 primop Narrow16WordOp "narrow16Word#" Monadic Word# -> Word#
307 primop Narrow32WordOp "narrow32Word#" Monadic Word# -> Word#
310 #if WORD_SIZE_IN_BITS < 32
311 ------------------------------------------------------------------------
313 {Operations on 32-bit integers ({\tt Int32\#}). This type is only used
314 if plain {\tt Int\#} has less than 32 bits. In any case, the operations
315 are not primops; they are implemented (if needed) as ccalls instead.}
316 ------------------------------------------------------------------------
320 ------------------------------------------------------------------------
322 {Operations on 32-bit unsigned words. This type is only used
323 if plain {\tt Word\#} has less than 32 bits. In any case, the operations
324 are not primops; they are implemented (if needed) as ccalls instead.}
325 ------------------------------------------------------------------------
332 #if WORD_SIZE_IN_BITS < 64
333 ------------------------------------------------------------------------
335 {Operations on 64-bit unsigned words. This type is only used
336 if plain {\tt Int\#} has less than 64 bits. In any case, the operations
337 are not primops; they are implemented (if needed) as ccalls instead.}
338 ------------------------------------------------------------------------
342 ------------------------------------------------------------------------
344 {Operations on 64-bit unsigned words. This type is only used
345 if plain {\tt Word\#} has less than 64 bits. In any case, the operations
346 are not primops; they are implemented (if needed) as ccalls instead.}
347 ------------------------------------------------------------------------
353 ------------------------------------------------------------------------
355 {Operations on double-precision (64 bit) floating-point numbers.}
356 ------------------------------------------------------------------------
360 primop DoubleGtOp ">##" Compare Double# -> Double# -> Bool
361 primop DoubleGeOp ">=##" Compare Double# -> Double# -> Bool
363 primop DoubleEqOp "==##" Compare
364 Double# -> Double# -> Bool
365 with commutable = True
367 primop DoubleNeOp "/=##" Compare
368 Double# -> Double# -> Bool
369 with commutable = True
371 primop DoubleLtOp "<##" Compare Double# -> Double# -> Bool
372 primop DoubleLeOp "<=##" Compare Double# -> Double# -> Bool
374 primop DoubleAddOp "+##" Dyadic
375 Double# -> Double# -> Double#
376 with commutable = True
378 primop DoubleSubOp "-##" Dyadic Double# -> Double# -> Double#
380 primop DoubleMulOp "*##" Dyadic
381 Double# -> Double# -> Double#
382 with commutable = True
384 primop DoubleDivOp "/##" Dyadic
385 Double# -> Double# -> Double#
388 primop DoubleNegOp "negateDouble#" Monadic Double# -> Double#
390 primop Double2IntOp "double2Int#" GenPrimOp Double# -> Int#
391 {Truncates a {\tt Double#} value to the nearest {\tt Int#}.
392 Results are undefined if the truncation if truncation yields
393 a value outside the range of {\tt Int#}.}
395 primop Double2FloatOp "double2Float#" GenPrimOp Double# -> Float#
397 primop DoubleExpOp "expDouble#" Monadic
399 with needs_wrapper = True
401 primop DoubleLogOp "logDouble#" Monadic
407 primop DoubleSqrtOp "sqrtDouble#" Monadic
409 with needs_wrapper = True
411 primop DoubleSinOp "sinDouble#" Monadic
413 with needs_wrapper = True
415 primop DoubleCosOp "cosDouble#" Monadic
417 with needs_wrapper = True
419 primop DoubleTanOp "tanDouble#" Monadic
421 with needs_wrapper = True
423 primop DoubleAsinOp "asinDouble#" Monadic
429 primop DoubleAcosOp "acosDouble#" Monadic
435 primop DoubleAtanOp "atanDouble#" Monadic
440 primop DoubleSinhOp "sinhDouble#" Monadic
442 with needs_wrapper = True
444 primop DoubleCoshOp "coshDouble#" Monadic
446 with needs_wrapper = True
448 primop DoubleTanhOp "tanhDouble#" Monadic
450 with needs_wrapper = True
452 primop DoublePowerOp "**##" Dyadic
453 Double# -> Double# -> Double#
455 with needs_wrapper = True
457 primop DoubleDecode_2IntOp "decodeDouble_2Int#" GenPrimOp
458 Double# -> (# Int#, Word#, Word#, Int# #)
460 First component of the result is -1 or 1, indicating the sign of the
461 mantissa. The next two are the high and low 32 bits of the mantissa
462 respectively, and the last is the exponent.}
463 with out_of_line = True
465 ------------------------------------------------------------------------
467 {Operations on single-precision (32-bit) floating-point numbers.}
468 ------------------------------------------------------------------------
472 primop FloatGtOp "gtFloat#" Compare Float# -> Float# -> Bool
473 primop FloatGeOp "geFloat#" Compare Float# -> Float# -> Bool
475 primop FloatEqOp "eqFloat#" Compare
476 Float# -> Float# -> Bool
477 with commutable = True
479 primop FloatNeOp "neFloat#" Compare
480 Float# -> Float# -> Bool
481 with commutable = True
483 primop FloatLtOp "ltFloat#" Compare Float# -> Float# -> Bool
484 primop FloatLeOp "leFloat#" Compare Float# -> Float# -> Bool
486 primop FloatAddOp "plusFloat#" Dyadic
487 Float# -> Float# -> Float#
488 with commutable = True
490 primop FloatSubOp "minusFloat#" Dyadic Float# -> Float# -> Float#
492 primop FloatMulOp "timesFloat#" Dyadic
493 Float# -> Float# -> Float#
494 with commutable = True
496 primop FloatDivOp "divideFloat#" Dyadic
497 Float# -> Float# -> Float#
500 primop FloatNegOp "negateFloat#" Monadic Float# -> Float#
502 primop Float2IntOp "float2Int#" GenPrimOp Float# -> Int#
503 {Truncates a {\tt Float#} value to the nearest {\tt Int#}.
504 Results are undefined if the truncation if truncation yields
505 a value outside the range of {\tt Int#}.}
507 primop FloatExpOp "expFloat#" Monadic
509 with needs_wrapper = True
511 primop FloatLogOp "logFloat#" Monadic
513 with needs_wrapper = True
516 primop FloatSqrtOp "sqrtFloat#" Monadic
518 with needs_wrapper = True
520 primop FloatSinOp "sinFloat#" Monadic
522 with needs_wrapper = True
524 primop FloatCosOp "cosFloat#" Monadic
526 with needs_wrapper = True
528 primop FloatTanOp "tanFloat#" Monadic
530 with needs_wrapper = True
532 primop FloatAsinOp "asinFloat#" Monadic
534 with needs_wrapper = True
537 primop FloatAcosOp "acosFloat#" Monadic
539 with needs_wrapper = True
542 primop FloatAtanOp "atanFloat#" Monadic
544 with needs_wrapper = True
546 primop FloatSinhOp "sinhFloat#" Monadic
548 with needs_wrapper = True
550 primop FloatCoshOp "coshFloat#" Monadic
552 with needs_wrapper = True
554 primop FloatTanhOp "tanhFloat#" Monadic
556 with needs_wrapper = True
558 primop FloatPowerOp "powerFloat#" Dyadic
559 Float# -> Float# -> Float#
560 with needs_wrapper = True
562 primop Float2DoubleOp "float2Double#" GenPrimOp Float# -> Double#
564 primop FloatDecode_IntOp "decodeFloat_Int#" GenPrimOp
565 Float# -> (# Int#, Int# #)
566 {Convert to integers.
567 First {\tt Int\#} in result is the mantissa; second is the exponent.}
568 with out_of_line = True
570 ------------------------------------------------------------------------
572 {Operations on {\tt Array\#}.}
573 ------------------------------------------------------------------------
577 primtype MutableArray# s a
579 primop NewArrayOp "newArray#" GenPrimOp
580 Int# -> a -> State# s -> (# State# s, MutableArray# s a #)
581 {Create a new mutable array with the specified number of elements,
582 in the specified state thread,
583 with each element containing the specified initial value.}
586 has_side_effects = True
588 primop SameMutableArrayOp "sameMutableArray#" GenPrimOp
589 MutableArray# s a -> MutableArray# s a -> Bool
591 primop ReadArrayOp "readArray#" GenPrimOp
592 MutableArray# s a -> Int# -> State# s -> (# State# s, a #)
593 {Read from specified index of mutable array. Result is not yet evaluated.}
595 has_side_effects = True
597 primop WriteArrayOp "writeArray#" GenPrimOp
598 MutableArray# s a -> Int# -> a -> State# s -> State# s
599 {Write to specified index of mutable array.}
601 has_side_effects = True
603 primop SizeofArrayOp "sizeofArray#" GenPrimOp
605 {Return the number of elements in the array.}
607 primop SizeofMutableArrayOp "sizeofMutableArray#" GenPrimOp
608 MutableArray# s a -> Int#
609 {Return the number of elements in the array.}
611 primop IndexArrayOp "indexArray#" GenPrimOp
612 Array# a -> Int# -> (# a #)
613 {Read from specified index of immutable array. Result is packaged into
614 an unboxed singleton; the result itself is not yet evaluated.}
616 primop UnsafeFreezeArrayOp "unsafeFreezeArray#" GenPrimOp
617 MutableArray# s a -> State# s -> (# State# s, Array# a #)
618 {Make a mutable array immutable, without copying.}
620 has_side_effects = True
622 primop UnsafeThawArrayOp "unsafeThawArray#" GenPrimOp
623 Array# a -> State# s -> (# State# s, MutableArray# s a #)
624 {Make an immutable array mutable, without copying.}
627 has_side_effects = True
629 primop CopyArrayOp "copyArray#" GenPrimOp
630 Array# a -> Int# -> MutableArray# s a -> Int# -> Int# -> State# s -> State# s
631 {Copy a range of the Array# to the specified region in the MutableArray#.
632 Both arrays must fully contain the specified ranges, but this is not checked.
633 The two arrays must not be the same array in different states, but this is not checked either.}
636 has_side_effects = True
638 primop CopyMutableArrayOp "copyMutableArray#" GenPrimOp
639 MutableArray# s a -> Int# -> MutableArray# s a -> Int# -> Int# -> State# s -> State# s
640 {Copy a range of the first MutableArray# to the specified region in the second MutableArray#.
641 Both arrays must fully contain the specified ranges, but this is not checked.}
644 has_side_effects = True
646 primop CloneArrayOp "cloneArray#" GenPrimOp
647 Array# a -> Int# -> Int# -> Array# a
648 {Return a newly allocated Array# with the specified subrange of the provided Array#.
649 The provided Array# should contain the full subrange specified by the two Int#s, but this is not checked.}
652 has_side_effects = True
654 primop CloneMutableArrayOp "cloneMutableArray#" GenPrimOp
655 MutableArray# s a -> Int# -> Int# -> State# s -> (# State# s, MutableArray# s a #)
656 {Return a newly allocated Array# with the specified subrange of the provided Array#.
657 The provided MutableArray# should contain the full subrange specified by the two Int#s, but this is not checked.}
660 has_side_effects = True
662 primop FreezeArrayOp "freezeArray#" GenPrimOp
663 MutableArray# s a -> Int# -> Int# -> State# s -> (# State# s, Array# a #)
664 {Return a newly allocated Array# with the specified subrange of the provided MutableArray#.
665 The provided MutableArray# should contain the full subrange specified by the two Int#s, but this is not checked.}
668 has_side_effects = True
670 primop ThawArrayOp "thawArray#" GenPrimOp
671 Array# a -> Int# -> Int# -> State# s -> (# State# s, MutableArray# s a #)
672 {Return a newly allocated Array# with the specified subrange of the provided MutableArray#.
673 The provided Array# should contain the full subrange specified by the two Int#s, but this is not checked.}
676 has_side_effects = True
678 ------------------------------------------------------------------------
679 section "Byte Arrays"
680 {Operations on {\tt ByteArray\#}. A {\tt ByteArray\#} is a just a region of
681 raw memory in the garbage-collected heap, which is not
682 scanned for pointers. It carries its own size (in bytes).
684 three sets of operations for accessing byte array contents:
685 index for reading from immutable byte arrays, and read/write
686 for mutable byte arrays. Each set contains operations for a
687 range of useful primitive data types. Each operation takes
688 an offset measured in terms of the size fo the primitive type
689 being read or written.}
691 ------------------------------------------------------------------------
695 primtype MutableByteArray# s
697 primop NewByteArrayOp_Char "newByteArray#" GenPrimOp
698 Int# -> State# s -> (# State# s, MutableByteArray# s #)
699 {Create a new mutable byte array of specified size (in bytes), in
700 the specified state thread.}
701 with out_of_line = True
702 has_side_effects = True
704 primop NewPinnedByteArrayOp_Char "newPinnedByteArray#" GenPrimOp
705 Int# -> State# s -> (# State# s, MutableByteArray# s #)
706 {Create a mutable byte array that the GC guarantees not to move.}
707 with out_of_line = True
708 has_side_effects = True
710 primop NewAlignedPinnedByteArrayOp_Char "newAlignedPinnedByteArray#" GenPrimOp
711 Int# -> Int# -> State# s -> (# State# s, MutableByteArray# s #)
712 {Create a mutable byte array, aligned by the specified amount, that the GC guarantees not to move.}
713 with out_of_line = True
714 has_side_effects = True
716 primop ByteArrayContents_Char "byteArrayContents#" GenPrimOp
718 {Intended for use with pinned arrays; otherwise very unsafe!}
720 primop SameMutableByteArrayOp "sameMutableByteArray#" GenPrimOp
721 MutableByteArray# s -> MutableByteArray# s -> Bool
723 primop UnsafeFreezeByteArrayOp "unsafeFreezeByteArray#" GenPrimOp
724 MutableByteArray# s -> State# s -> (# State# s, ByteArray# #)
725 {Make a mutable byte array immutable, without copying.}
727 has_side_effects = True
729 primop SizeofByteArrayOp "sizeofByteArray#" GenPrimOp
731 {Return the size of the array in bytes.}
733 primop SizeofMutableByteArrayOp "sizeofMutableByteArray#" GenPrimOp
734 MutableByteArray# s -> Int#
735 {Return the size of the array in bytes.}
737 primop IndexByteArrayOp_Char "indexCharArray#" GenPrimOp
738 ByteArray# -> Int# -> Char#
739 {Read 8-bit character; offset in bytes.}
741 primop IndexByteArrayOp_WideChar "indexWideCharArray#" GenPrimOp
742 ByteArray# -> Int# -> Char#
743 {Read 31-bit character; offset in 4-byte words.}
745 primop IndexByteArrayOp_Int "indexIntArray#" GenPrimOp
746 ByteArray# -> Int# -> Int#
748 primop IndexByteArrayOp_Word "indexWordArray#" GenPrimOp
749 ByteArray# -> Int# -> Word#
751 primop IndexByteArrayOp_Addr "indexAddrArray#" GenPrimOp
752 ByteArray# -> Int# -> Addr#
754 primop IndexByteArrayOp_Float "indexFloatArray#" GenPrimOp
755 ByteArray# -> Int# -> Float#
757 primop IndexByteArrayOp_Double "indexDoubleArray#" GenPrimOp
758 ByteArray# -> Int# -> Double#
760 primop IndexByteArrayOp_StablePtr "indexStablePtrArray#" GenPrimOp
761 ByteArray# -> Int# -> StablePtr# a
763 primop IndexByteArrayOp_Int8 "indexInt8Array#" GenPrimOp
764 ByteArray# -> Int# -> Int#
766 primop IndexByteArrayOp_Int16 "indexInt16Array#" GenPrimOp
767 ByteArray# -> Int# -> Int#
769 primop IndexByteArrayOp_Int32 "indexInt32Array#" GenPrimOp
770 ByteArray# -> Int# -> INT32
772 primop IndexByteArrayOp_Int64 "indexInt64Array#" GenPrimOp
773 ByteArray# -> Int# -> INT64
775 primop IndexByteArrayOp_Word8 "indexWord8Array#" GenPrimOp
776 ByteArray# -> Int# -> Word#
778 primop IndexByteArrayOp_Word16 "indexWord16Array#" GenPrimOp
779 ByteArray# -> Int# -> Word#
781 primop IndexByteArrayOp_Word32 "indexWord32Array#" GenPrimOp
782 ByteArray# -> Int# -> WORD32
784 primop IndexByteArrayOp_Word64 "indexWord64Array#" GenPrimOp
785 ByteArray# -> Int# -> WORD64
787 primop ReadByteArrayOp_Char "readCharArray#" GenPrimOp
788 MutableByteArray# s -> Int# -> State# s -> (# State# s, Char# #)
789 {Read 8-bit character; offset in bytes.}
790 with has_side_effects = True
792 primop ReadByteArrayOp_WideChar "readWideCharArray#" GenPrimOp
793 MutableByteArray# s -> Int# -> State# s -> (# State# s, Char# #)
794 {Read 31-bit character; offset in 4-byte words.}
795 with has_side_effects = True
797 primop ReadByteArrayOp_Int "readIntArray#" GenPrimOp
798 MutableByteArray# s -> Int# -> State# s -> (# State# s, Int# #)
799 with has_side_effects = True
801 primop ReadByteArrayOp_Word "readWordArray#" GenPrimOp
802 MutableByteArray# s -> Int# -> State# s -> (# State# s, Word# #)
803 with has_side_effects = True
805 primop ReadByteArrayOp_Addr "readAddrArray#" GenPrimOp
806 MutableByteArray# s -> Int# -> State# s -> (# State# s, Addr# #)
807 with has_side_effects = True
809 primop ReadByteArrayOp_Float "readFloatArray#" GenPrimOp
810 MutableByteArray# s -> Int# -> State# s -> (# State# s, Float# #)
811 with has_side_effects = True
813 primop ReadByteArrayOp_Double "readDoubleArray#" GenPrimOp
814 MutableByteArray# s -> Int# -> State# s -> (# State# s, Double# #)
815 with has_side_effects = True
817 primop ReadByteArrayOp_StablePtr "readStablePtrArray#" GenPrimOp
818 MutableByteArray# s -> Int# -> State# s -> (# State# s, StablePtr# a #)
819 with has_side_effects = True
821 primop ReadByteArrayOp_Int8 "readInt8Array#" GenPrimOp
822 MutableByteArray# s -> Int# -> State# s -> (# State# s, Int# #)
823 with has_side_effects = True
825 primop ReadByteArrayOp_Int16 "readInt16Array#" GenPrimOp
826 MutableByteArray# s -> Int# -> State# s -> (# State# s, Int# #)
827 with has_side_effects = True
829 primop ReadByteArrayOp_Int32 "readInt32Array#" GenPrimOp
830 MutableByteArray# s -> Int# -> State# s -> (# State# s, INT32 #)
831 with has_side_effects = True
833 primop ReadByteArrayOp_Int64 "readInt64Array#" GenPrimOp
834 MutableByteArray# s -> Int# -> State# s -> (# State# s, INT64 #)
835 with has_side_effects = True
837 primop ReadByteArrayOp_Word8 "readWord8Array#" GenPrimOp
838 MutableByteArray# s -> Int# -> State# s -> (# State# s, Word# #)
839 with has_side_effects = True
841 primop ReadByteArrayOp_Word16 "readWord16Array#" GenPrimOp
842 MutableByteArray# s -> Int# -> State# s -> (# State# s, Word# #)
843 with has_side_effects = True
845 primop ReadByteArrayOp_Word32 "readWord32Array#" GenPrimOp
846 MutableByteArray# s -> Int# -> State# s -> (# State# s, WORD32 #)
847 with has_side_effects = True
849 primop ReadByteArrayOp_Word64 "readWord64Array#" GenPrimOp
850 MutableByteArray# s -> Int# -> State# s -> (# State# s, WORD64 #)
851 with has_side_effects = True
853 primop WriteByteArrayOp_Char "writeCharArray#" GenPrimOp
854 MutableByteArray# s -> Int# -> Char# -> State# s -> State# s
855 {Write 8-bit character; offset in bytes.}
856 with has_side_effects = True
858 primop WriteByteArrayOp_WideChar "writeWideCharArray#" GenPrimOp
859 MutableByteArray# s -> Int# -> Char# -> State# s -> State# s
860 {Write 31-bit character; offset in 4-byte words.}
861 with has_side_effects = True
863 primop WriteByteArrayOp_Int "writeIntArray#" GenPrimOp
864 MutableByteArray# s -> Int# -> Int# -> State# s -> State# s
865 with has_side_effects = True
867 primop WriteByteArrayOp_Word "writeWordArray#" GenPrimOp
868 MutableByteArray# s -> Int# -> Word# -> State# s -> State# s
869 with has_side_effects = True
871 primop WriteByteArrayOp_Addr "writeAddrArray#" GenPrimOp
872 MutableByteArray# s -> Int# -> Addr# -> State# s -> State# s
873 with has_side_effects = True
875 primop WriteByteArrayOp_Float "writeFloatArray#" GenPrimOp
876 MutableByteArray# s -> Int# -> Float# -> State# s -> State# s
877 with has_side_effects = True
879 primop WriteByteArrayOp_Double "writeDoubleArray#" GenPrimOp
880 MutableByteArray# s -> Int# -> Double# -> State# s -> State# s
881 with has_side_effects = True
883 primop WriteByteArrayOp_StablePtr "writeStablePtrArray#" GenPrimOp
884 MutableByteArray# s -> Int# -> StablePtr# a -> State# s -> State# s
885 with has_side_effects = True
887 primop WriteByteArrayOp_Int8 "writeInt8Array#" GenPrimOp
888 MutableByteArray# s -> Int# -> Int# -> State# s -> State# s
889 with has_side_effects = True
891 primop WriteByteArrayOp_Int16 "writeInt16Array#" GenPrimOp
892 MutableByteArray# s -> Int# -> Int# -> State# s -> State# s
893 with has_side_effects = True
895 primop WriteByteArrayOp_Int32 "writeInt32Array#" GenPrimOp
896 MutableByteArray# s -> Int# -> INT32 -> State# s -> State# s
897 with has_side_effects = True
899 primop WriteByteArrayOp_Int64 "writeInt64Array#" GenPrimOp
900 MutableByteArray# s -> Int# -> INT64 -> State# s -> State# s
901 with has_side_effects = True
903 primop WriteByteArrayOp_Word8 "writeWord8Array#" GenPrimOp
904 MutableByteArray# s -> Int# -> Word# -> State# s -> State# s
905 with has_side_effects = True
907 primop WriteByteArrayOp_Word16 "writeWord16Array#" GenPrimOp
908 MutableByteArray# s -> Int# -> Word# -> State# s -> State# s
909 with has_side_effects = True
911 primop WriteByteArrayOp_Word32 "writeWord32Array#" GenPrimOp
912 MutableByteArray# s -> Int# -> WORD32 -> State# s -> State# s
913 with has_side_effects = True
915 primop WriteByteArrayOp_Word64 "writeWord64Array#" GenPrimOp
916 MutableByteArray# s -> Int# -> WORD64 -> State# s -> State# s
917 with has_side_effects = True
919 ------------------------------------------------------------------------
921 ------------------------------------------------------------------------
924 { An arbitrary machine address assumed to point outside
925 the garbage-collected heap. }
927 pseudoop "nullAddr#" Addr#
928 { The null address. }
930 primop AddrAddOp "plusAddr#" GenPrimOp Addr# -> Int# -> Addr#
931 primop AddrSubOp "minusAddr#" GenPrimOp Addr# -> Addr# -> Int#
932 {Result is meaningless if two {\tt Addr\#}s are so far apart that their
933 difference doesn't fit in an {\tt Int\#}.}
934 primop AddrRemOp "remAddr#" GenPrimOp Addr# -> Int# -> Int#
935 {Return the remainder when the {\tt Addr\#} arg, treated like an {\tt Int\#},
936 is divided by the {\tt Int\#} arg.}
937 #if (WORD_SIZE_IN_BITS == 32 || WORD_SIZE_IN_BITS == 64)
938 primop Addr2IntOp "addr2Int#" GenPrimOp Addr# -> Int#
939 {Coerce directly from address to int. Strongly deprecated.}
940 primop Int2AddrOp "int2Addr#" GenPrimOp Int# -> Addr#
941 {Coerce directly from int to address. Strongly deprecated.}
944 primop AddrGtOp "gtAddr#" Compare Addr# -> Addr# -> Bool
945 primop AddrGeOp "geAddr#" Compare Addr# -> Addr# -> Bool
946 primop AddrEqOp "eqAddr#" Compare Addr# -> Addr# -> Bool
947 primop AddrNeOp "neAddr#" Compare Addr# -> Addr# -> Bool
948 primop AddrLtOp "ltAddr#" Compare Addr# -> Addr# -> Bool
949 primop AddrLeOp "leAddr#" Compare Addr# -> Addr# -> Bool
951 primop IndexOffAddrOp_Char "indexCharOffAddr#" GenPrimOp
952 Addr# -> Int# -> Char#
953 {Reads 8-bit character; offset in bytes.}
955 primop IndexOffAddrOp_WideChar "indexWideCharOffAddr#" GenPrimOp
956 Addr# -> Int# -> Char#
957 {Reads 31-bit character; offset in 4-byte words.}
959 primop IndexOffAddrOp_Int "indexIntOffAddr#" GenPrimOp
960 Addr# -> Int# -> Int#
962 primop IndexOffAddrOp_Word "indexWordOffAddr#" GenPrimOp
963 Addr# -> Int# -> Word#
965 primop IndexOffAddrOp_Addr "indexAddrOffAddr#" GenPrimOp
966 Addr# -> Int# -> Addr#
968 primop IndexOffAddrOp_Float "indexFloatOffAddr#" GenPrimOp
969 Addr# -> Int# -> Float#
971 primop IndexOffAddrOp_Double "indexDoubleOffAddr#" GenPrimOp
972 Addr# -> Int# -> Double#
974 primop IndexOffAddrOp_StablePtr "indexStablePtrOffAddr#" GenPrimOp
975 Addr# -> Int# -> StablePtr# a
977 primop IndexOffAddrOp_Int8 "indexInt8OffAddr#" GenPrimOp
978 Addr# -> Int# -> Int#
980 primop IndexOffAddrOp_Int16 "indexInt16OffAddr#" GenPrimOp
981 Addr# -> Int# -> Int#
983 primop IndexOffAddrOp_Int32 "indexInt32OffAddr#" GenPrimOp
984 Addr# -> Int# -> INT32
986 primop IndexOffAddrOp_Int64 "indexInt64OffAddr#" GenPrimOp
987 Addr# -> Int# -> INT64
989 primop IndexOffAddrOp_Word8 "indexWord8OffAddr#" GenPrimOp
990 Addr# -> Int# -> Word#
992 primop IndexOffAddrOp_Word16 "indexWord16OffAddr#" GenPrimOp
993 Addr# -> Int# -> Word#
995 primop IndexOffAddrOp_Word32 "indexWord32OffAddr#" GenPrimOp
996 Addr# -> Int# -> WORD32
998 primop IndexOffAddrOp_Word64 "indexWord64OffAddr#" GenPrimOp
999 Addr# -> Int# -> WORD64
1001 primop ReadOffAddrOp_Char "readCharOffAddr#" GenPrimOp
1002 Addr# -> Int# -> State# s -> (# State# s, Char# #)
1003 {Reads 8-bit character; offset in bytes.}
1004 with has_side_effects = True
1006 primop ReadOffAddrOp_WideChar "readWideCharOffAddr#" GenPrimOp
1007 Addr# -> Int# -> State# s -> (# State# s, Char# #)
1008 {Reads 31-bit character; offset in 4-byte words.}
1009 with has_side_effects = True
1011 primop ReadOffAddrOp_Int "readIntOffAddr#" GenPrimOp
1012 Addr# -> Int# -> State# s -> (# State# s, Int# #)
1013 with has_side_effects = True
1015 primop ReadOffAddrOp_Word "readWordOffAddr#" GenPrimOp
1016 Addr# -> Int# -> State# s -> (# State# s, Word# #)
1017 with has_side_effects = True
1019 primop ReadOffAddrOp_Addr "readAddrOffAddr#" GenPrimOp
1020 Addr# -> Int# -> State# s -> (# State# s, Addr# #)
1021 with has_side_effects = True
1023 primop ReadOffAddrOp_Float "readFloatOffAddr#" GenPrimOp
1024 Addr# -> Int# -> State# s -> (# State# s, Float# #)
1025 with has_side_effects = True
1027 primop ReadOffAddrOp_Double "readDoubleOffAddr#" GenPrimOp
1028 Addr# -> Int# -> State# s -> (# State# s, Double# #)
1029 with has_side_effects = True
1031 primop ReadOffAddrOp_StablePtr "readStablePtrOffAddr#" GenPrimOp
1032 Addr# -> Int# -> State# s -> (# State# s, StablePtr# a #)
1033 with has_side_effects = True
1035 primop ReadOffAddrOp_Int8 "readInt8OffAddr#" GenPrimOp
1036 Addr# -> Int# -> State# s -> (# State# s, Int# #)
1037 with has_side_effects = True
1039 primop ReadOffAddrOp_Int16 "readInt16OffAddr#" GenPrimOp
1040 Addr# -> Int# -> State# s -> (# State# s, Int# #)
1041 with has_side_effects = True
1043 primop ReadOffAddrOp_Int32 "readInt32OffAddr#" GenPrimOp
1044 Addr# -> Int# -> State# s -> (# State# s, INT32 #)
1045 with has_side_effects = True
1047 primop ReadOffAddrOp_Int64 "readInt64OffAddr#" GenPrimOp
1048 Addr# -> Int# -> State# s -> (# State# s, INT64 #)
1049 with has_side_effects = True
1051 primop ReadOffAddrOp_Word8 "readWord8OffAddr#" GenPrimOp
1052 Addr# -> Int# -> State# s -> (# State# s, Word# #)
1053 with has_side_effects = True
1055 primop ReadOffAddrOp_Word16 "readWord16OffAddr#" GenPrimOp
1056 Addr# -> Int# -> State# s -> (# State# s, Word# #)
1057 with has_side_effects = True
1059 primop ReadOffAddrOp_Word32 "readWord32OffAddr#" GenPrimOp
1060 Addr# -> Int# -> State# s -> (# State# s, WORD32 #)
1061 with has_side_effects = True
1063 primop ReadOffAddrOp_Word64 "readWord64OffAddr#" GenPrimOp
1064 Addr# -> Int# -> State# s -> (# State# s, WORD64 #)
1065 with has_side_effects = True
1068 primop WriteOffAddrOp_Char "writeCharOffAddr#" GenPrimOp
1069 Addr# -> Int# -> Char# -> State# s -> State# s
1070 with has_side_effects = True
1072 primop WriteOffAddrOp_WideChar "writeWideCharOffAddr#" GenPrimOp
1073 Addr# -> Int# -> Char# -> State# s -> State# s
1074 with has_side_effects = True
1076 primop WriteOffAddrOp_Int "writeIntOffAddr#" GenPrimOp
1077 Addr# -> Int# -> Int# -> State# s -> State# s
1078 with has_side_effects = True
1080 primop WriteOffAddrOp_Word "writeWordOffAddr#" GenPrimOp
1081 Addr# -> Int# -> Word# -> State# s -> State# s
1082 with has_side_effects = True
1084 primop WriteOffAddrOp_Addr "writeAddrOffAddr#" GenPrimOp
1085 Addr# -> Int# -> Addr# -> State# s -> State# s
1086 with has_side_effects = True
1088 primop WriteOffAddrOp_Float "writeFloatOffAddr#" GenPrimOp
1089 Addr# -> Int# -> Float# -> State# s -> State# s
1090 with has_side_effects = True
1092 primop WriteOffAddrOp_Double "writeDoubleOffAddr#" GenPrimOp
1093 Addr# -> Int# -> Double# -> State# s -> State# s
1094 with has_side_effects = True
1096 primop WriteOffAddrOp_StablePtr "writeStablePtrOffAddr#" GenPrimOp
1097 Addr# -> Int# -> StablePtr# a -> State# s -> State# s
1098 with has_side_effects = True
1100 primop WriteOffAddrOp_Int8 "writeInt8OffAddr#" GenPrimOp
1101 Addr# -> Int# -> Int# -> State# s -> State# s
1102 with has_side_effects = True
1104 primop WriteOffAddrOp_Int16 "writeInt16OffAddr#" GenPrimOp
1105 Addr# -> Int# -> Int# -> State# s -> State# s
1106 with has_side_effects = True
1108 primop WriteOffAddrOp_Int32 "writeInt32OffAddr#" GenPrimOp
1109 Addr# -> Int# -> INT32 -> State# s -> State# s
1110 with has_side_effects = True
1112 primop WriteOffAddrOp_Int64 "writeInt64OffAddr#" GenPrimOp
1113 Addr# -> Int# -> INT64 -> State# s -> State# s
1114 with has_side_effects = True
1116 primop WriteOffAddrOp_Word8 "writeWord8OffAddr#" GenPrimOp
1117 Addr# -> Int# -> Word# -> State# s -> State# s
1118 with has_side_effects = True
1120 primop WriteOffAddrOp_Word16 "writeWord16OffAddr#" GenPrimOp
1121 Addr# -> Int# -> Word# -> State# s -> State# s
1122 with has_side_effects = True
1124 primop WriteOffAddrOp_Word32 "writeWord32OffAddr#" GenPrimOp
1125 Addr# -> Int# -> WORD32 -> State# s -> State# s
1126 with has_side_effects = True
1128 primop WriteOffAddrOp_Word64 "writeWord64OffAddr#" GenPrimOp
1129 Addr# -> Int# -> WORD64 -> State# s -> State# s
1130 with has_side_effects = True
1132 ------------------------------------------------------------------------
1133 section "Mutable variables"
1134 {Operations on MutVar\#s.}
1135 ------------------------------------------------------------------------
1137 primtype MutVar# s a
1138 {A {\tt MutVar\#} behaves like a single-element mutable array.}
1140 primop NewMutVarOp "newMutVar#" GenPrimOp
1141 a -> State# s -> (# State# s, MutVar# s a #)
1142 {Create {\tt MutVar\#} with specified initial value in specified state thread.}
1145 has_side_effects = True
1147 primop ReadMutVarOp "readMutVar#" GenPrimOp
1148 MutVar# s a -> State# s -> (# State# s, a #)
1149 {Read contents of {\tt MutVar\#}. Result is not yet evaluated.}
1151 has_side_effects = True
1153 primop WriteMutVarOp "writeMutVar#" GenPrimOp
1154 MutVar# s a -> a -> State# s -> State# s
1155 {Write contents of {\tt MutVar\#}.}
1157 has_side_effects = True
1159 primop SameMutVarOp "sameMutVar#" GenPrimOp
1160 MutVar# s a -> MutVar# s a -> Bool
1162 -- not really the right type, but we don't know about pairs here. The
1165 -- MutVar# s a -> (a -> (a,b)) -> State# s -> (# State# s, b #)
1167 primop AtomicModifyMutVarOp "atomicModifyMutVar#" GenPrimOp
1168 MutVar# s a -> (a -> b) -> State# s -> (# State# s, c #)
1171 has_side_effects = True
1173 primop CasMutVarOp "casMutVar#" GenPrimOp
1174 MutVar# s a -> a -> a -> State# s -> (# State# s, Int#, a #)
1177 has_side_effects = True
1179 ------------------------------------------------------------------------
1180 section "Exceptions"
1181 ------------------------------------------------------------------------
1183 primop CatchOp "catch#" GenPrimOp
1184 (State# RealWorld -> (# State# RealWorld, a #) )
1185 -> (b -> State# RealWorld -> (# State# RealWorld, a #) )
1187 -> (# State# RealWorld, a #)
1189 -- Catch is actually strict in its first argument
1190 -- but we don't want to tell the strictness
1191 -- analyser about that!
1192 -- might use caught action multiply
1194 has_side_effects = True
1196 primop RaiseOp "raise#" GenPrimOp
1199 strictness = { \ _arity -> mkStrictSig (mkTopDmdType [lazyDmd] BotRes) }
1200 -- NB: result is bottom
1203 -- raiseIO# needs to be a primop, because exceptions in the IO monad
1204 -- must be *precise* - we don't want the strictness analyser turning
1205 -- one kind of bottom into another, as it is allowed to do in pure code.
1207 -- But we *do* want to know that it returns bottom after
1208 -- being applied to two arguments
1210 primop RaiseIOOp "raiseIO#" GenPrimOp
1211 a -> State# RealWorld -> (# State# RealWorld, b #)
1213 strictness = { \ _arity -> mkStrictSig (mkTopDmdType [lazyDmd,lazyDmd] BotRes) }
1215 has_side_effects = True
1217 primop MaskAsyncExceptionsOp "maskAsyncExceptions#" GenPrimOp
1218 (State# RealWorld -> (# State# RealWorld, a #))
1219 -> (State# RealWorld -> (# State# RealWorld, a #))
1222 has_side_effects = True
1224 primop MaskUninterruptibleOp "maskUninterruptible#" GenPrimOp
1225 (State# RealWorld -> (# State# RealWorld, a #))
1226 -> (State# RealWorld -> (# State# RealWorld, a #))
1229 has_side_effects = True
1231 primop UnmaskAsyncExceptionsOp "unmaskAsyncExceptions#" GenPrimOp
1232 (State# RealWorld -> (# State# RealWorld, a #))
1233 -> (State# RealWorld -> (# State# RealWorld, a #))
1236 has_side_effects = True
1238 primop MaskStatus "getMaskingState#" GenPrimOp
1239 State# RealWorld -> (# State# RealWorld, Int# #)
1242 has_side_effects = True
1244 ------------------------------------------------------------------------
1245 section "STM-accessible Mutable Variables"
1246 ------------------------------------------------------------------------
1250 primop AtomicallyOp "atomically#" GenPrimOp
1251 (State# RealWorld -> (# State# RealWorld, a #) )
1252 -> State# RealWorld -> (# State# RealWorld, a #)
1255 has_side_effects = True
1257 primop RetryOp "retry#" GenPrimOp
1258 State# RealWorld -> (# State# RealWorld, a #)
1261 has_side_effects = True
1263 primop CatchRetryOp "catchRetry#" GenPrimOp
1264 (State# RealWorld -> (# State# RealWorld, a #) )
1265 -> (State# RealWorld -> (# State# RealWorld, a #) )
1266 -> (State# RealWorld -> (# State# RealWorld, a #) )
1269 has_side_effects = True
1271 primop CatchSTMOp "catchSTM#" GenPrimOp
1272 (State# RealWorld -> (# State# RealWorld, a #) )
1273 -> (b -> State# RealWorld -> (# State# RealWorld, a #) )
1274 -> (State# RealWorld -> (# State# RealWorld, a #) )
1277 has_side_effects = True
1279 primop Check "check#" GenPrimOp
1280 (State# RealWorld -> (# State# RealWorld, a #) )
1281 -> (State# RealWorld -> (# State# RealWorld, () #) )
1284 has_side_effects = True
1286 primop NewTVarOp "newTVar#" GenPrimOp
1288 -> State# s -> (# State# s, TVar# s a #)
1289 {Create a new {\tt TVar\#} holding a specified initial value.}
1292 has_side_effects = True
1294 primop ReadTVarOp "readTVar#" GenPrimOp
1296 -> State# s -> (# State# s, a #)
1297 {Read contents of {\tt TVar\#}. Result is not yet evaluated.}
1300 has_side_effects = True
1302 primop ReadTVarIOOp "readTVarIO#" GenPrimOp
1304 -> State# s -> (# State# s, a #)
1305 {Read contents of {\tt TVar\#} outside an STM transaction}
1308 has_side_effects = True
1310 primop WriteTVarOp "writeTVar#" GenPrimOp
1313 -> State# s -> State# s
1314 {Write contents of {\tt TVar\#}.}
1317 has_side_effects = True
1319 primop SameTVarOp "sameTVar#" GenPrimOp
1320 TVar# s a -> TVar# s a -> Bool
1323 ------------------------------------------------------------------------
1324 section "Synchronized Mutable Variables"
1325 {Operations on {\tt MVar\#}s. }
1326 ------------------------------------------------------------------------
1329 { A shared mutable variable ({\it not} the same as a {\tt MutVar\#}!).
1330 (Note: in a non-concurrent implementation, {\tt (MVar\# a)} can be
1331 represented by {\tt (MutVar\# (Maybe a))}.) }
1333 primop NewMVarOp "newMVar#" GenPrimOp
1334 State# s -> (# State# s, MVar# s a #)
1335 {Create new {\tt MVar\#}; initially empty.}
1338 has_side_effects = True
1340 primop TakeMVarOp "takeMVar#" GenPrimOp
1341 MVar# s a -> State# s -> (# State# s, a #)
1342 {If {\tt MVar\#} is empty, block until it becomes full.
1343 Then remove and return its contents, and set it empty.}
1346 has_side_effects = True
1348 primop TryTakeMVarOp "tryTakeMVar#" GenPrimOp
1349 MVar# s a -> State# s -> (# State# s, Int#, a #)
1350 {If {\tt MVar\#} is empty, immediately return with integer 0 and value undefined.
1351 Otherwise, return with integer 1 and contents of {\tt MVar\#}, and set {\tt MVar\#} empty.}
1354 has_side_effects = True
1356 primop PutMVarOp "putMVar#" GenPrimOp
1357 MVar# s a -> a -> State# s -> State# s
1358 {If {\tt MVar\#} is full, block until it becomes empty.
1359 Then store value arg as its new contents.}
1362 has_side_effects = True
1364 primop TryPutMVarOp "tryPutMVar#" GenPrimOp
1365 MVar# s a -> a -> State# s -> (# State# s, Int# #)
1366 {If {\tt MVar\#} is full, immediately return with integer 0.
1367 Otherwise, store value arg as {\tt MVar\#}'s new contents, and return with integer 1.}
1370 has_side_effects = True
1372 primop SameMVarOp "sameMVar#" GenPrimOp
1373 MVar# s a -> MVar# s a -> Bool
1375 primop IsEmptyMVarOp "isEmptyMVar#" GenPrimOp
1376 MVar# s a -> State# s -> (# State# s, Int# #)
1377 {Return 1 if {\tt MVar\#} is empty; 0 otherwise.}
1380 has_side_effects = True
1382 ------------------------------------------------------------------------
1383 section "Delay/wait operations"
1384 ------------------------------------------------------------------------
1386 primop DelayOp "delay#" GenPrimOp
1387 Int# -> State# s -> State# s
1388 {Sleep specified number of microseconds.}
1390 needs_wrapper = True
1391 has_side_effects = True
1394 primop WaitReadOp "waitRead#" GenPrimOp
1395 Int# -> State# s -> State# s
1396 {Block until input is available on specified file descriptor.}
1398 needs_wrapper = True
1399 has_side_effects = True
1402 primop WaitWriteOp "waitWrite#" GenPrimOp
1403 Int# -> State# s -> State# s
1404 {Block until output is possible on specified file descriptor.}
1406 needs_wrapper = True
1407 has_side_effects = True
1410 #ifdef mingw32_TARGET_OS
1411 primop AsyncReadOp "asyncRead#" GenPrimOp
1412 Int# -> Int# -> Int# -> Addr# -> State# RealWorld-> (# State# RealWorld, Int#, Int# #)
1413 {Asynchronously read bytes from specified file descriptor.}
1415 needs_wrapper = True
1416 has_side_effects = True
1419 primop AsyncWriteOp "asyncWrite#" GenPrimOp
1420 Int# -> Int# -> Int# -> Addr# -> State# RealWorld-> (# State# RealWorld, Int#, Int# #)
1421 {Asynchronously write bytes from specified file descriptor.}
1423 needs_wrapper = True
1424 has_side_effects = True
1427 primop AsyncDoProcOp "asyncDoProc#" GenPrimOp
1428 Addr# -> Addr# -> State# RealWorld-> (# State# RealWorld, Int#, Int# #)
1429 {Asynchronously perform procedure (first arg), passing it 2nd arg.}
1431 needs_wrapper = True
1432 has_side_effects = True
1437 ------------------------------------------------------------------------
1438 section "Concurrency primitives"
1439 ------------------------------------------------------------------------
1442 { {\tt State\#} is the primitive, unlifted type of states. It has
1443 one type parameter, thus {\tt State\# RealWorld}, or {\tt State\# s},
1444 where s is a type variable. The only purpose of the type parameter
1445 is to keep different state threads separate. It is represented by
1449 { {\tt RealWorld} is deeply magical. It is {\it primitive}, but it is not
1450 {\it unlifted} (hence {\tt ptrArg}). We never manipulate values of type
1451 {\tt RealWorld}; it's only used in the type system, to parameterise {\tt State\#}. }
1454 {(In a non-concurrent implementation, this can be a singleton
1455 type, whose (unique) value is returned by {\tt myThreadId\#}. The
1456 other operations can be omitted.)}
1458 primop ForkOp "fork#" GenPrimOp
1459 a -> State# RealWorld -> (# State# RealWorld, ThreadId# #)
1461 has_side_effects = True
1464 primop ForkOnOp "forkOn#" GenPrimOp
1465 Int# -> a -> State# RealWorld -> (# State# RealWorld, ThreadId# #)
1467 has_side_effects = True
1470 primop KillThreadOp "killThread#" GenPrimOp
1471 ThreadId# -> a -> State# RealWorld -> State# RealWorld
1473 has_side_effects = True
1476 primop YieldOp "yield#" GenPrimOp
1477 State# RealWorld -> State# RealWorld
1479 has_side_effects = True
1482 primop MyThreadIdOp "myThreadId#" GenPrimOp
1483 State# RealWorld -> (# State# RealWorld, ThreadId# #)
1486 has_side_effects = True
1488 primop LabelThreadOp "labelThread#" GenPrimOp
1489 ThreadId# -> Addr# -> State# RealWorld -> State# RealWorld
1491 has_side_effects = True
1494 primop IsCurrentThreadBoundOp "isCurrentThreadBound#" GenPrimOp
1495 State# RealWorld -> (# State# RealWorld, Int# #)
1498 has_side_effects = True
1500 primop NoDuplicateOp "noDuplicate#" GenPrimOp
1501 State# RealWorld -> State# RealWorld
1504 has_side_effects = True
1506 primop ThreadStatusOp "threadStatus#" GenPrimOp
1507 ThreadId# -> State# RealWorld -> (# State# RealWorld, Int#, Int#, Int# #)
1510 has_side_effects = True
1512 ------------------------------------------------------------------------
1513 section "Weak pointers"
1514 ------------------------------------------------------------------------
1518 -- note that tyvar "o" denotes openAlphaTyVar
1520 primop MkWeakOp "mkWeak#" GenPrimOp
1521 o -> b -> c -> State# RealWorld -> (# State# RealWorld, Weak# b #)
1523 has_side_effects = True
1526 primop MkWeakForeignEnvOp "mkWeakForeignEnv#" GenPrimOp
1527 o -> b -> Addr# -> Addr# -> Int# -> Addr# -> State# RealWorld -> (# State# RealWorld, Weak# b #)
1529 has_side_effects = True
1532 primop DeRefWeakOp "deRefWeak#" GenPrimOp
1533 Weak# a -> State# RealWorld -> (# State# RealWorld, Int#, a #)
1535 has_side_effects = True
1538 primop FinalizeWeakOp "finalizeWeak#" GenPrimOp
1539 Weak# a -> State# RealWorld -> (# State# RealWorld, Int#,
1540 (State# RealWorld -> (# State# RealWorld, () #)) #)
1542 has_side_effects = True
1545 primop TouchOp "touch#" GenPrimOp
1546 o -> State# RealWorld -> State# RealWorld
1548 has_side_effects = True
1550 ------------------------------------------------------------------------
1551 section "Stable pointers and names"
1552 ------------------------------------------------------------------------
1554 primtype StablePtr# a
1556 primtype StableName# a
1558 primop MakeStablePtrOp "makeStablePtr#" GenPrimOp
1559 a -> State# RealWorld -> (# State# RealWorld, StablePtr# a #)
1561 has_side_effects = True
1564 primop DeRefStablePtrOp "deRefStablePtr#" GenPrimOp
1565 StablePtr# a -> State# RealWorld -> (# State# RealWorld, a #)
1567 needs_wrapper = True
1568 has_side_effects = True
1571 primop EqStablePtrOp "eqStablePtr#" GenPrimOp
1572 StablePtr# a -> StablePtr# a -> Int#
1574 has_side_effects = True
1576 primop MakeStableNameOp "makeStableName#" GenPrimOp
1577 a -> State# RealWorld -> (# State# RealWorld, StableName# a #)
1579 needs_wrapper = True
1580 has_side_effects = True
1583 primop EqStableNameOp "eqStableName#" GenPrimOp
1584 StableName# a -> StableName# a -> Int#
1586 primop StableNameToIntOp "stableNameToInt#" GenPrimOp
1587 StableName# a -> Int#
1589 ------------------------------------------------------------------------
1590 section "Unsafe pointer equality"
1591 -- (#1 Bad Guy: Alistair Reid :)
1592 ------------------------------------------------------------------------
1594 primop ReallyUnsafePtrEqualityOp "reallyUnsafePtrEquality#" GenPrimOp
1597 ------------------------------------------------------------------------
1598 section "Parallelism"
1599 ------------------------------------------------------------------------
1601 primop ParOp "par#" GenPrimOp
1604 -- Note that Par is lazy to avoid that the sparked thing
1605 -- gets evaluted strictly, which it should *not* be
1606 has_side_effects = True
1608 primop GetSparkOp "getSpark#" GenPrimOp
1609 State# s -> (# State# s, Int#, a #)
1611 has_side_effects = True
1614 primop NumSparks "numSparks#" GenPrimOp
1615 State# s -> (# State# s, Int# #)
1616 { Returns the number of sparks in the local spark pool. }
1618 has_side_effects = True
1621 -- HWL: The first 4 Int# in all par... annotations denote:
1622 -- name, granularity info, size of result, degree of parallelism
1623 -- Same structure as _seq_ i.e. returns Int#
1624 -- KSW: v, the second arg in parAt# and parAtForNow#, is used only to determine
1625 -- `the processor containing the expression v'; it is not evaluated
1627 primop ParGlobalOp "parGlobal#" GenPrimOp
1628 a -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1630 has_side_effects = True
1632 primop ParLocalOp "parLocal#" GenPrimOp
1633 a -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1635 has_side_effects = True
1637 primop ParAtOp "parAt#" GenPrimOp
1638 b -> a -> Int# -> Int# -> Int# -> Int# -> c -> Int#
1640 has_side_effects = True
1642 primop ParAtAbsOp "parAtAbs#" GenPrimOp
1643 a -> Int# -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1645 has_side_effects = True
1647 primop ParAtRelOp "parAtRel#" GenPrimOp
1648 a -> Int# -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1650 has_side_effects = True
1652 primop ParAtForNowOp "parAtForNow#" GenPrimOp
1653 b -> a -> Int# -> Int# -> Int# -> Int# -> c -> Int#
1655 has_side_effects = True
1657 -- copyable# and noFollow# are yet to be implemented (for GpH)
1659 --primop CopyableOp "copyable#" GenPrimOp
1662 -- has_side_effects = True
1664 --primop NoFollowOp "noFollow#" GenPrimOp
1667 -- has_side_effects = True
1670 ------------------------------------------------------------------------
1671 section "Tag to enum stuff"
1672 {Convert back and forth between values of enumerated types
1673 and small integers.}
1674 ------------------------------------------------------------------------
1676 primop DataToTagOp "dataToTag#" GenPrimOp
1679 strictness = { \ _arity -> mkStrictSig (mkTopDmdType [seqDmd] TopRes) }
1680 -- dataToTag# must have an evaluated argument
1682 primop TagToEnumOp "tagToEnum#" GenPrimOp
1685 ------------------------------------------------------------------------
1686 section "Bytecode operations"
1687 {Support for the bytecode interpreter and linker.}
1688 ------------------------------------------------------------------------
1691 {Primitive bytecode type.}
1693 primop AddrToHValueOp "addrToHValue#" GenPrimOp
1695 {Convert an {\tt Addr\#} to a followable type.}
1697 primop MkApUpd0_Op "mkApUpd0#" GenPrimOp
1702 primop NewBCOOp "newBCO#" GenPrimOp
1703 ByteArray# -> ByteArray# -> Array# a -> Int# -> ByteArray# -> State# s -> (# State# s, BCO# #)
1705 has_side_effects = True
1708 primop UnpackClosureOp "unpackClosure#" GenPrimOp
1709 a -> (# Addr#, Array# b, ByteArray# #)
1713 primop GetApStackValOp "getApStackVal#" GenPrimOp
1714 a -> Int# -> (# Int#, b #)
1718 ------------------------------------------------------------------------
1720 {These aren't nearly as wired in as Etc...}
1721 ------------------------------------------------------------------------
1723 primop TraceCcsOp "traceCcs#" GenPrimOp
1726 has_side_effects = True
1729 ------------------------------------------------------------------------
1731 {Miscellaneous built-ins}
1732 ------------------------------------------------------------------------
1736 { Evaluates its first argument to head normal form, and then returns its second
1737 argument as the result. }
1741 { The call {\tt (inline f)} arranges that f is inlined, regardless of its size.
1742 More precisely, the call {\tt (inline f)} rewrites to the right-hand side of
1743 {\tt f}'s definition. This allows the programmer to control inlining from a
1744 particular call site rather than the definition site of the function (c.f.
1745 {\tt INLINE} pragmas in User's Guide, Section 7.10.3, "INLINE and NOINLINE
1748 This inlining occurs regardless of the argument to the call or the size of
1749 {\tt f}'s definition; it is unconditional. The main caveat is that {\tt f}'s
1750 definition must be visible to the compiler. That is, {\tt f} must be
1751 {\tt let}-bound in the current scope. If no inlining takes place, the
1752 {\tt inline} function expands to the identity function in Phase zero; so its
1753 use imposes no overhead.
1755 It is good practice to mark the function with an INLINABLE pragma at
1756 its definition, (a) so that GHC guarantees to expose its unfolding regardless
1757 of size, and (b) so that you have control over exactly what is inlined. }
1761 { The {\tt lazy} function restrains strictness analysis a little. The call
1762 {\tt (lazy e)} means the same as {\tt e}, but {\tt lazy} has a magical
1763 property so far as strictness analysis is concerned: it is lazy in its first
1764 argument, even though its semantics is strict. After strictness analysis has
1765 run, calls to {\tt lazy} are inlined to be the identity function.
1767 This behaviour is occasionally useful when controlling evaluation order.
1768 Notably, {\tt lazy} is used in the library definition of {\tt Control.Parallel.par}:
1770 {\tt par :: a -> b -> b}
1772 {\tt par x y = case (par\# x) of \_ -> lazy y}
1774 If {\tt lazy} were not lazy, {\tt par} would look strict in {\tt y} which
1775 would defeat the whole purpose of {\tt par}.
1777 Like {\tt seq}, the argument of {\tt lazy} can have an unboxed type. }
1780 { The type constructor {\tt Any} is type to which you can unsafely coerce any
1781 lifted type, and back.
1783 * It is lifted, and hence represented by a pointer
1785 * It does not claim to be a {\it data} type, and that's important for
1786 the code generator, because the code gen may {\it enter} a data value
1787 but never enters a function value.
1789 It's also used to instantiate un-constrained type variables after type
1790 checking. For example, {\tt length} has type
1792 {\tt length :: forall a. [a] -> Int}
1794 and the list datacon for the empty list has type
1796 {\tt [] :: forall a. [a]}
1798 In order to compose these two terms as {\tt length []} a type
1799 application is required, but there is no constraint on the
1800 choice. In this situation GHC uses {\tt Any}:
1802 {\tt length Any ([] Any)}
1804 Annoyingly, we sometimes need {\tt Any}s of other kinds, such as {\tt (* -> *)} etc.
1805 This is a bit like tuples. We define a couple of useful ones here,
1806 and make others up on the fly. If any of these others end up being exported
1807 into interface files, we'll get a crash; at least until we add interface-file
1808 syntax to support them. }
1810 pseudoop "unsafeCoerce#"
1812 { The function {\tt unsafeCoerce\#} allows you to side-step the typechecker entirely. That
1813 is, it allows you to coerce any type into any other type. If you use this function,
1814 you had better get it right, otherwise segmentation faults await. It is generally
1815 used when you want to write a program that you know is well-typed, but where Haskell's
1816 type system is not expressive enough to prove that it is well typed.
1818 The following uses of {\tt unsafeCoerce\#} are supposed to work (i.e. not lead to
1819 spurious compile-time or run-time crashes):
1821 * Casting any lifted type to {\tt Any}
1823 * Casting {\tt Any} back to the real type
1825 * Casting an unboxed type to another unboxed type of the same size
1826 (but not coercions between floating-point and integral types)
1828 * Casting between two types that have the same runtime representation. One case is when
1829 the two types differ only in "phantom" type parameters, for example
1830 {\tt Ptr Int} to {\tt Ptr Float}, or {\tt [Int]} to {\tt [Float]} when the list is
1831 known to be empty. Also, a {\tt newtype} of a type {\tt T} has the same representation
1832 at runtime as {\tt T}.
1834 Other uses of {\tt unsafeCoerce\#} are undefined. In particular, you should not use
1835 {\tt unsafeCoerce\#} to cast a T to an algebraic data type D, unless T is also
1836 an algebraic data type. For example, do not cast {\tt Int->Int} to {\tt Bool}, even if
1837 you later cast that {\tt Bool} back to {\tt Int->Int} before applying it. The reasons
1838 have to do with GHC's internal representation details (for the congnoscenti, data values
1839 can be entered but function closures cannot). If you want a safe type to cast things
1840 to, use {\tt Any}, which is not an algebraic data type.
1844 -- NB. It is tempting to think that casting a value to a type that it doesn't have is safe
1845 -- as long as you don't "do anything" with the value in its cast form, such as seq on it. This
1846 -- isn't the case: the compiler can insert seqs itself, and if these happen at the wrong type,
1847 -- Bad Things Might Happen. See bug #1616: in this case we cast a function of type (a,b) -> (a,b)
1848 -- to () -> () and back again. The strictness analyser saw that the function was strict, but
1849 -- the wrapper had type () -> (), and hence the wrapper de-constructed the (), the worker re-constructed
1850 -- a new (), with the result that the code ended up with "case () of (a,b) -> ...".
1852 primop TraceEventOp "traceEvent#" GenPrimOp
1853 Addr# -> State# s -> State# s
1854 { Emits an event via the RTS tracing framework. The contents
1855 of the event is the zero-terminated byte string passed as the first
1856 argument. The event will be emitted either to the .eventlog file,
1857 or to stderr, depending on the runtime RTS flags. }
1859 has_side_effects = True
1862 ------------------------------------------------------------------------
1864 ------------------------------------------------------------------------