1 -----------------------------------------------------------------------
2 -- $Id: primops.txt.pp,v 1.37 2005/11/25 09:46:19 simonmar Exp $
4 -- Primitive Operations and Types
6 -----------------------------------------------------------------------
8 -- This file is processed by the utility program genprimopcode to produce
9 -- a number of include files within the compiler and optionally to produce
10 -- human-readable documentation.
12 -- It should first be preprocessed.
14 -- To add a new primop, you currently need to update the following files:
16 -- - this file (ghc/compiler/prelude/primops.txt.pp), which includes
17 -- the type of the primop, and various other properties (its
18 -- strictness attributes, whether it is defined as a macro
19 -- or as out-of-line code, etc.)
21 -- - if the primop is inline (i.e. a macro), then:
22 -- ghc/compiler/AbsCUtils.lhs (dscCOpStmt)
23 -- defines the translation of the primop into simpler
24 -- abstract C operations.
26 -- - or, for an out-of-line primop:
27 -- ghc/includes/StgMiscClosures.h (just add the declaration)
28 -- ghc/rts/PrimOps.cmm (define it here)
29 -- ghc/rts/Linker.c (declare the symbol for GHCi)
34 -- This file is divided into named sections, each containing or more
35 -- primop entries. Section headers have the format:
37 -- section "section-name" {description}
39 -- This information is used solely when producing documentation; it is
40 -- otherwise ignored. The description is optional.
42 -- The format of each primop entry is as follows:
44 -- primop internal-name "name-in-program-text" type category {description} attributes
46 -- The default attribute values which apply if you don't specify
47 -- other ones. Attribute values can be True, False, or arbitrary
48 -- text between curly brackets. This is a kludge to enable
49 -- processors of this file to easily get hold of simple info
50 -- (eg, out_of_line), whilst avoiding parsing complex expressions
51 -- needed for strictness info.
54 has_side_effects = False
59 strictness = { \ arity -> mkStrictSig (mkTopDmdType (replicate arity lazyDmd) TopRes) }
61 -- Currently, documentation is produced using latex, so contents of
62 -- description fields should be legal latex. Descriptions can contain
63 -- matched pairs of embedded curly brackets.
67 -- We need platform defines (tests for mingw32 below). However, we only
68 -- test the TARGET platform, which doesn't vary between stages, so the
69 -- stage1 platform defines are fine:
70 #include "../stage1/ghc_boot_platform.h"
72 section "The word size story."
73 {Haskell98 specifies that signed integers (type {\tt Int})
74 must contain at least 30 bits. GHC always implements {\tt
75 Int} using the primitive type {\tt Int\#}, whose size equals
76 the {\tt MachDeps.h} constant {\tt WORD\_SIZE\_IN\_BITS}.
77 This is normally set based on the {\tt config.h} parameter
78 {\tt SIZEOF\_HSWORD}, i.e., 32 bits on 32-bit machines, 64
79 bits on 64-bit machines. However, it can also be explicitly
80 set to a smaller number, e.g., 31 bits, to allow the
81 possibility of using tag bits. Currently GHC itself has only
82 32-bit and 64-bit variants, but 30 or 31-bit code can be
83 exported as an external core file for use in other back ends.
85 GHC also implements a primitive unsigned integer type {\tt
86 Word\#} which always has the same number of bits as {\tt
89 In addition, GHC supports families of explicit-sized integers
90 and words at 8, 16, 32, and 64 bits, with the usual
91 arithmetic operations, comparisons, and a range of
92 conversions. The 8-bit and 16-bit sizes are always
93 represented as {\tt Int\#} and {\tt Word\#}, and the
94 operations implemented in terms of the the primops on these
95 types, with suitable range restrictions on the results (using
96 the {\tt narrow$n$Int\#} and {\tt narrow$n$Word\#} families
97 of primops. The 32-bit sizes are represented using {\tt
98 Int\#} and {\tt Word\#} when {\tt WORD\_SIZE\_IN\_BITS}
99 $\geq$ 32; otherwise, these are represented using distinct
100 primitive types {\tt Int32\#} and {\tt Word32\#}. These (when
101 needed) have a complete set of corresponding operations;
102 however, nearly all of these are implemented as external C
103 functions rather than as primops. Exactly the same story
104 applies to the 64-bit sizes. All of these details are hidden
105 under the {\tt PrelInt} and {\tt PrelWord} modules, which use
106 {\tt \#if}-defs to invoke the appropriate types and
109 Word size also matters for the families of primops for
110 indexing/reading/writing fixed-size quantities at offsets
111 from an array base, address, or foreign pointer. Here, a
112 slightly different approach is taken. The names of these
113 primops are fixed, but their {\it types} vary according to
114 the value of {\tt WORD\_SIZE\_IN\_BITS}. For example, if word
115 size is at least 32 bits then an operator like
116 \texttt{indexInt32Array\#} has type {\tt ByteArray\# -> Int\#
117 -> Int\#}; otherwise it has type {\tt ByteArray\# -> Int\# ->
118 Int32\#}. This approach confines the necessary {\tt
119 \#if}-defs to this file; no conditional compilation is needed
120 in the files that expose these primops.
122 Finally, there are strongly deprecated primops for coercing
123 between {\tt Addr\#}, the primitive type of machine
124 addresses, and {\tt Int\#}. These are pretty bogus anyway,
125 but will work on existing 32-bit and 64-bit GHC targets; they
126 are completely bogus when tag bits are used in {\tt Int\#},
127 so are not available in this case. }
129 -- Define synonyms for indexing ops.
131 #if WORD_SIZE_IN_BITS < 32
133 #define WORD32 Word32#
139 #if WORD_SIZE_IN_BITS < 64
141 #define WORD64 Word64#
147 ------------------------------------------------------------------------
149 {Operations on 31-bit characters.}
150 ------------------------------------------------------------------------
154 primop CharGtOp "gtChar#" Compare Char# -> Char# -> Bool
155 primop CharGeOp "geChar#" Compare Char# -> Char# -> Bool
157 primop CharEqOp "eqChar#" Compare
158 Char# -> Char# -> Bool
159 with commutable = True
161 primop CharNeOp "neChar#" Compare
162 Char# -> Char# -> Bool
163 with commutable = True
165 primop CharLtOp "ltChar#" Compare Char# -> Char# -> Bool
166 primop CharLeOp "leChar#" Compare Char# -> Char# -> Bool
168 primop OrdOp "ord#" GenPrimOp Char# -> Int#
170 ------------------------------------------------------------------------
172 {Operations on native-size integers (30+ bits).}
173 ------------------------------------------------------------------------
177 primop IntAddOp "+#" Dyadic
179 with commutable = True
181 primop IntSubOp "-#" Dyadic Int# -> Int# -> Int#
184 Dyadic Int# -> Int# -> Int#
185 {Low word of signed integer multiply.}
186 with commutable = True
188 primop IntMulMayOfloOp "mulIntMayOflo#"
189 Dyadic Int# -> Int# -> Int#
190 {Return non-zero if there is any possibility that the upper word of a
191 signed integer multiply might contain useful information. Return
192 zero only if you are completely sure that no overflow can occur.
193 On a 32-bit platform, the recommmended implementation is to do a
194 32 x 32 -> 64 signed multiply, and subtract result[63:32] from
195 (result[31] >>signed 31). If this is zero, meaning that the
196 upper word is merely a sign extension of the lower one, no
199 On a 64-bit platform it is not always possible to
200 acquire the top 64 bits of the result. Therefore, a recommended
201 implementation is to take the absolute value of both operands, and
202 return 0 iff bits[63:31] of them are zero, since that means that their
203 magnitudes fit within 31 bits, so the magnitude of the product must fit
206 If in doubt, return non-zero, but do make an effort to create the
207 correct answer for small args, since otherwise the performance of
208 \texttt{(*) :: Integer -> Integer -> Integer} will be poor.
210 with commutable = True
212 primop IntQuotOp "quotInt#" Dyadic
214 {Rounds towards zero.}
217 primop IntRemOp "remInt#" Dyadic
219 {Satisfies \texttt{(quotInt\# x y) *\# y +\# (remInt\# x y) == x}.}
222 primop IntGcdOp "gcdInt#" Dyadic Int# -> Int# -> Int#
223 with out_of_line = True
225 primop IntNegOp "negateInt#" Monadic Int# -> Int#
226 primop IntAddCOp "addIntC#" GenPrimOp Int# -> Int# -> (# Int#, Int# #)
227 {Add with carry. First member of result is (wrapped) sum;
228 second member is 0 iff no overflow occured.}
229 primop IntSubCOp "subIntC#" GenPrimOp Int# -> Int# -> (# Int#, Int# #)
230 {Subtract with carry. First member of result is (wrapped) difference;
231 second member is 0 iff no overflow occured.}
233 primop IntGtOp ">#" Compare Int# -> Int# -> Bool
234 primop IntGeOp ">=#" Compare Int# -> Int# -> Bool
236 primop IntEqOp "==#" Compare
238 with commutable = True
240 primop IntNeOp "/=#" Compare
242 with commutable = True
244 primop IntLtOp "<#" Compare Int# -> Int# -> Bool
245 primop IntLeOp "<=#" Compare Int# -> Int# -> Bool
247 primop ChrOp "chr#" GenPrimOp Int# -> Char#
249 primop Int2WordOp "int2Word#" GenPrimOp Int# -> Word#
250 primop Int2FloatOp "int2Float#" GenPrimOp Int# -> Float#
251 primop Int2DoubleOp "int2Double#" GenPrimOp Int# -> Double#
253 primop Int2IntegerOp "int2Integer#"
254 GenPrimOp Int# -> (# Int#, ByteArray# #)
255 with out_of_line = True
257 primop ISllOp "uncheckedIShiftL#" GenPrimOp Int# -> Int# -> Int#
258 {Shift left. Result undefined if shift amount is not
259 in the range 0 to word size - 1 inclusive.}
260 primop ISraOp "uncheckedIShiftRA#" GenPrimOp Int# -> Int# -> Int#
261 {Shift right arithmetic. Result undefined if shift amount is not
262 in the range 0 to word size - 1 inclusive.}
263 primop ISrlOp "uncheckedIShiftRL#" GenPrimOp Int# -> Int# -> Int#
264 {Shift right logical. Result undefined if shift amount is not
265 in the range 0 to word size - 1 inclusive.}
267 ------------------------------------------------------------------------
269 {Operations on native-sized unsigned words (30+ bits).}
270 ------------------------------------------------------------------------
274 primop WordAddOp "plusWord#" Dyadic Word# -> Word# -> Word#
275 with commutable = True
277 primop WordSubOp "minusWord#" Dyadic Word# -> Word# -> Word#
279 primop WordMulOp "timesWord#" Dyadic Word# -> Word# -> Word#
280 with commutable = True
282 primop WordQuotOp "quotWord#" Dyadic Word# -> Word# -> Word#
285 primop WordRemOp "remWord#" Dyadic Word# -> Word# -> Word#
288 primop AndOp "and#" Dyadic Word# -> Word# -> Word#
289 with commutable = True
291 primop OrOp "or#" Dyadic Word# -> Word# -> Word#
292 with commutable = True
294 primop XorOp "xor#" Dyadic Word# -> Word# -> Word#
295 with commutable = True
297 primop NotOp "not#" Monadic Word# -> Word#
299 primop SllOp "uncheckedShiftL#" GenPrimOp Word# -> Int# -> Word#
300 {Shift left logical. Result undefined if shift amount is not
301 in the range 0 to word size - 1 inclusive.}
302 primop SrlOp "uncheckedShiftRL#" GenPrimOp Word# -> Int# -> Word#
303 {Shift right logical. Result undefined if shift amount is not
304 in the range 0 to word size - 1 inclusive.}
306 primop Word2IntOp "word2Int#" GenPrimOp Word# -> Int#
308 primop Word2IntegerOp "word2Integer#" GenPrimOp
309 Word# -> (# Int#, ByteArray# #)
310 with out_of_line = True
312 primop WordGtOp "gtWord#" Compare Word# -> Word# -> Bool
313 primop WordGeOp "geWord#" Compare Word# -> Word# -> Bool
314 primop WordEqOp "eqWord#" Compare Word# -> Word# -> Bool
315 primop WordNeOp "neWord#" Compare Word# -> Word# -> Bool
316 primop WordLtOp "ltWord#" Compare Word# -> Word# -> Bool
317 primop WordLeOp "leWord#" Compare Word# -> Word# -> Bool
319 ------------------------------------------------------------------------
321 {Explicit narrowing of native-sized ints or words.}
322 ------------------------------------------------------------------------
324 primop Narrow8IntOp "narrow8Int#" Monadic Int# -> Int#
325 primop Narrow16IntOp "narrow16Int#" Monadic Int# -> Int#
326 primop Narrow32IntOp "narrow32Int#" Monadic Int# -> Int#
327 primop Narrow8WordOp "narrow8Word#" Monadic Word# -> Word#
328 primop Narrow16WordOp "narrow16Word#" Monadic Word# -> Word#
329 primop Narrow32WordOp "narrow32Word#" Monadic Word# -> Word#
332 #if WORD_SIZE_IN_BITS < 32
333 ------------------------------------------------------------------------
335 {Operations on 32-bit integers ({\tt Int32\#}). This type is only used
336 if plain {\tt Int\#} has less than 32 bits. In any case, the operations
337 are not primops; they are implemented (if needed) as ccalls instead.}
338 ------------------------------------------------------------------------
342 primop Int32ToIntegerOp "int32ToInteger#" GenPrimOp
343 Int32# -> (# Int#, ByteArray# #)
344 with out_of_line = True
347 ------------------------------------------------------------------------
349 {Operations on 32-bit unsigned words. This type is only used
350 if plain {\tt Word\#} has less than 32 bits. In any case, the operations
351 are not primops; they are implemented (if needed) as ccalls instead.}
352 ------------------------------------------------------------------------
356 primop Word32ToIntegerOp "word32ToInteger#" GenPrimOp
357 Word32# -> (# Int#, ByteArray# #)
358 with out_of_line = True
364 #if WORD_SIZE_IN_BITS < 64
365 ------------------------------------------------------------------------
367 {Operations on 64-bit unsigned words. This type is only used
368 if plain {\tt Int\#} has less than 64 bits. In any case, the operations
369 are not primops; they are implemented (if needed) as ccalls instead.}
370 ------------------------------------------------------------------------
374 primop Int64ToIntegerOp "int64ToInteger#" GenPrimOp
375 Int64# -> (# Int#, ByteArray# #)
376 with out_of_line = True
378 ------------------------------------------------------------------------
380 {Operations on 64-bit unsigned words. This type is only used
381 if plain {\tt Word\#} has less than 64 bits. In any case, the operations
382 are not primops; they are implemented (if needed) as ccalls instead.}
383 ------------------------------------------------------------------------
387 primop Word64ToIntegerOp "word64ToInteger#" GenPrimOp
388 Word64# -> (# Int#, ByteArray# #)
389 with out_of_line = True
393 ------------------------------------------------------------------------
395 {Operations on arbitrary-precision integers. These operations are
396 implemented via the GMP package. An integer is represented as a pair
397 consisting of an {\tt Int\#} representing the number of 'limbs' in use and
398 the sign, and a {\tt ByteArray\#} containing the 'limbs' themselves. Such pairs
399 are returned as unboxed pairs, but must be passed as separate
402 For .NET these operations are implemented by foreign imports, so the
403 primops are omitted.}
404 ------------------------------------------------------------------------
408 primop IntegerAddOp "plusInteger#" GenPrimOp
409 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
410 with commutable = True
413 primop IntegerSubOp "minusInteger#" GenPrimOp
414 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
415 with out_of_line = True
417 primop IntegerMulOp "timesInteger#" GenPrimOp
418 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
419 with commutable = True
422 primop IntegerGcdOp "gcdInteger#" GenPrimOp
423 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
424 {Greatest common divisor.}
425 with commutable = True
428 primop IntegerIntGcdOp "gcdIntegerInt#" GenPrimOp
429 Int# -> ByteArray# -> Int# -> Int#
430 {Greatest common divisor, where second argument is an ordinary {\tt Int\#}.}
431 with out_of_line = True
433 primop IntegerDivExactOp "divExactInteger#" GenPrimOp
434 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
435 {Divisor is guaranteed to be a factor of dividend.}
436 with out_of_line = True
438 primop IntegerQuotOp "quotInteger#" GenPrimOp
439 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
440 {Rounds towards zero.}
441 with out_of_line = True
443 primop IntegerRemOp "remInteger#" GenPrimOp
444 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
445 {Satisfies \texttt{plusInteger\# (timesInteger\# (quotInteger\# x y) y) (remInteger\# x y) == x}.}
446 with out_of_line = True
448 primop IntegerCmpOp "cmpInteger#" GenPrimOp
449 Int# -> ByteArray# -> Int# -> ByteArray# -> Int#
450 {Returns -1,0,1 according as first argument is less than, equal to, or greater than second argument.}
451 with needs_wrapper = True
454 primop IntegerCmpIntOp "cmpIntegerInt#" GenPrimOp
455 Int# -> ByteArray# -> Int# -> Int#
456 {Returns -1,0,1 according as first argument is less than, equal to, or greater than second argument, which
457 is an ordinary Int\#.}
458 with needs_wrapper = True
461 primop IntegerQuotRemOp "quotRemInteger#" GenPrimOp
462 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray#, Int#, ByteArray# #)
463 {Compute quot and rem simulaneously.}
467 primop IntegerDivModOp "divModInteger#" GenPrimOp
468 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray#, Int#, ByteArray# #)
469 {Compute div and mod simultaneously, where div rounds towards negative infinity
470 and\texttt{(q,r) = divModInteger\#(x,y)} implies \texttt{plusInteger\# (timesInteger\# q y) r = x}.}
474 primop Integer2IntOp "integer2Int#" GenPrimOp
475 Int# -> ByteArray# -> Int#
476 with needs_wrapper = True
479 primop Integer2WordOp "integer2Word#" GenPrimOp
480 Int# -> ByteArray# -> Word#
481 with needs_wrapper = True
484 #if WORD_SIZE_IN_BITS < 32
485 primop IntegerToInt32Op "integerToInt32#" GenPrimOp
486 Int# -> ByteArray# -> Int32#
488 primop IntegerToWord32Op "integerToWord32#" GenPrimOp
489 Int# -> ByteArray# -> Word32#
492 primop IntegerAndOp "andInteger#" GenPrimOp
493 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
494 with out_of_line = True
496 primop IntegerOrOp "orInteger#" GenPrimOp
497 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
498 with out_of_line = True
500 primop IntegerXorOp "xorInteger#" GenPrimOp
501 Int# -> ByteArray# -> Int# -> ByteArray# -> (# Int#, ByteArray# #)
502 with out_of_line = True
504 primop IntegerComplementOp "complementInteger#" GenPrimOp
505 Int# -> ByteArray# -> (# Int#, ByteArray# #)
506 with out_of_line = True
508 #endif /* ndef ILX */
510 ------------------------------------------------------------------------
512 {Operations on double-precision (64 bit) floating-point numbers.}
513 ------------------------------------------------------------------------
517 primop DoubleGtOp ">##" Compare Double# -> Double# -> Bool
518 primop DoubleGeOp ">=##" Compare Double# -> Double# -> Bool
520 primop DoubleEqOp "==##" Compare
521 Double# -> Double# -> Bool
522 with commutable = True
524 primop DoubleNeOp "/=##" Compare
525 Double# -> Double# -> Bool
526 with commutable = True
528 primop DoubleLtOp "<##" Compare Double# -> Double# -> Bool
529 primop DoubleLeOp "<=##" Compare Double# -> Double# -> Bool
531 primop DoubleAddOp "+##" Dyadic
532 Double# -> Double# -> Double#
533 with commutable = True
535 primop DoubleSubOp "-##" Dyadic Double# -> Double# -> Double#
537 primop DoubleMulOp "*##" Dyadic
538 Double# -> Double# -> Double#
539 with commutable = True
541 primop DoubleDivOp "/##" Dyadic
542 Double# -> Double# -> Double#
545 primop DoubleNegOp "negateDouble#" Monadic Double# -> Double#
547 primop Double2IntOp "double2Int#" GenPrimOp Double# -> Int#
548 {Truncates a {\tt Double#} value to the nearest {\tt Int#}.
549 Results are undefined if the truncation if truncation yields
550 a value outside the range of {\tt Int#}.}
552 primop Double2FloatOp "double2Float#" GenPrimOp Double# -> Float#
554 primop DoubleExpOp "expDouble#" Monadic
556 with needs_wrapper = True
558 primop DoubleLogOp "logDouble#" Monadic
564 primop DoubleSqrtOp "sqrtDouble#" Monadic
566 with needs_wrapper = True
568 primop DoubleSinOp "sinDouble#" Monadic
570 with needs_wrapper = True
572 primop DoubleCosOp "cosDouble#" Monadic
574 with needs_wrapper = True
576 primop DoubleTanOp "tanDouble#" Monadic
578 with needs_wrapper = True
580 primop DoubleAsinOp "asinDouble#" Monadic
586 primop DoubleAcosOp "acosDouble#" Monadic
592 primop DoubleAtanOp "atanDouble#" Monadic
597 primop DoubleSinhOp "sinhDouble#" Monadic
599 with needs_wrapper = True
601 primop DoubleCoshOp "coshDouble#" Monadic
603 with needs_wrapper = True
605 primop DoubleTanhOp "tanhDouble#" Monadic
607 with needs_wrapper = True
609 primop DoublePowerOp "**##" Dyadic
610 Double# -> Double# -> Double#
612 with needs_wrapper = True
614 primop DoubleDecodeOp "decodeDouble#" GenPrimOp
615 Double# -> (# Int#, Int#, ByteArray# #)
616 {Convert to arbitrary-precision integer.
617 First {\tt Int\#} in result is the exponent; second {\tt Int\#} and {\tt ByteArray\#}
618 represent an {\tt Integer\#} holding the mantissa.}
619 with out_of_line = True
621 primop DoubleDecode_2IntOp "decodeDouble_2Int#" GenPrimOp
622 Double# -> (# Int#, Word#, Word#, Int# #)
623 {Convert to arbitrary-precision integer.
624 First component of the result is -1 or 1, indicating the sign of the
625 mantissa. The next two are the high and low 32 bits of the mantissa
626 respectively, and the last is the exponent.}
627 with out_of_line = True
629 ------------------------------------------------------------------------
631 {Operations on single-precision (32-bit) floating-point numbers.}
632 ------------------------------------------------------------------------
636 primop FloatGtOp "gtFloat#" Compare Float# -> Float# -> Bool
637 primop FloatGeOp "geFloat#" Compare Float# -> Float# -> Bool
639 primop FloatEqOp "eqFloat#" Compare
640 Float# -> Float# -> Bool
641 with commutable = True
643 primop FloatNeOp "neFloat#" Compare
644 Float# -> Float# -> Bool
645 with commutable = True
647 primop FloatLtOp "ltFloat#" Compare Float# -> Float# -> Bool
648 primop FloatLeOp "leFloat#" Compare Float# -> Float# -> Bool
650 primop FloatAddOp "plusFloat#" Dyadic
651 Float# -> Float# -> Float#
652 with commutable = True
654 primop FloatSubOp "minusFloat#" Dyadic Float# -> Float# -> Float#
656 primop FloatMulOp "timesFloat#" Dyadic
657 Float# -> Float# -> Float#
658 with commutable = True
660 primop FloatDivOp "divideFloat#" Dyadic
661 Float# -> Float# -> Float#
664 primop FloatNegOp "negateFloat#" Monadic Float# -> Float#
666 primop Float2IntOp "float2Int#" GenPrimOp Float# -> Int#
667 {Truncates a {\tt Float#} value to the nearest {\tt Int#}.
668 Results are undefined if the truncation if truncation yields
669 a value outside the range of {\tt Int#}.}
671 primop FloatExpOp "expFloat#" Monadic
673 with needs_wrapper = True
675 primop FloatLogOp "logFloat#" Monadic
677 with needs_wrapper = True
680 primop FloatSqrtOp "sqrtFloat#" Monadic
682 with needs_wrapper = True
684 primop FloatSinOp "sinFloat#" Monadic
686 with needs_wrapper = True
688 primop FloatCosOp "cosFloat#" Monadic
690 with needs_wrapper = True
692 primop FloatTanOp "tanFloat#" Monadic
694 with needs_wrapper = True
696 primop FloatAsinOp "asinFloat#" Monadic
698 with needs_wrapper = True
701 primop FloatAcosOp "acosFloat#" Monadic
703 with needs_wrapper = True
706 primop FloatAtanOp "atanFloat#" Monadic
708 with needs_wrapper = True
710 primop FloatSinhOp "sinhFloat#" Monadic
712 with needs_wrapper = True
714 primop FloatCoshOp "coshFloat#" Monadic
716 with needs_wrapper = True
718 primop FloatTanhOp "tanhFloat#" Monadic
720 with needs_wrapper = True
722 primop FloatPowerOp "powerFloat#" Dyadic
723 Float# -> Float# -> Float#
724 with needs_wrapper = True
726 primop Float2DoubleOp "float2Double#" GenPrimOp Float# -> Double#
728 primop FloatDecodeOp "decodeFloat#" GenPrimOp
729 Float# -> (# Int#, Int#, ByteArray# #)
730 {Convert to arbitrary-precision integer.
731 First {\tt Int\#} in result is the exponent; second {\tt Int\#} and {\tt ByteArray\#}
732 represent an {\tt Integer\#} holding the mantissa.}
733 with out_of_line = True
735 primop FloatDecode_IntOp "decodeFloat_Int#" GenPrimOp
736 Float# -> (# Int#, Int# #)
737 {Convert to arbitrary-precision integer.
738 First {\tt Int\#} in result is the mantissa; second is the exponent.}
739 with out_of_line = True
741 ------------------------------------------------------------------------
743 {Operations on {\tt Array\#}.}
744 ------------------------------------------------------------------------
748 primtype MutableArray# s a
750 primop NewArrayOp "newArray#" GenPrimOp
751 Int# -> a -> State# s -> (# State# s, MutableArray# s a #)
752 {Create a new mutable array of specified size (in bytes),
753 in the specified state thread,
754 with each element containing the specified initial value.}
758 primop SameMutableArrayOp "sameMutableArray#" GenPrimOp
759 MutableArray# s a -> MutableArray# s a -> Bool
761 primop ReadArrayOp "readArray#" GenPrimOp
762 MutableArray# s a -> Int# -> State# s -> (# State# s, a #)
763 {Read from specified index of mutable array. Result is not yet evaluated.}
765 primop WriteArrayOp "writeArray#" GenPrimOp
766 MutableArray# s a -> Int# -> a -> State# s -> State# s
767 {Write to specified index of mutable array.}
769 has_side_effects = True
771 primop IndexArrayOp "indexArray#" GenPrimOp
772 Array# a -> Int# -> (# a #)
773 {Read from specified index of immutable array. Result is packaged into
774 an unboxed singleton; the result itself is not yet evaluated.}
776 primop UnsafeFreezeArrayOp "unsafeFreezeArray#" GenPrimOp
777 MutableArray# s a -> State# s -> (# State# s, Array# a #)
778 {Make a mutable array immutable, without copying.}
780 has_side_effects = True
782 primop UnsafeThawArrayOp "unsafeThawArray#" GenPrimOp
783 Array# a -> State# s -> (# State# s, MutableArray# s a #)
784 {Make an immutable array mutable, without copying.}
788 ------------------------------------------------------------------------
789 section "Byte Arrays"
790 {Operations on {\tt ByteArray\#}. A {\tt ByteArray\#} is a just a region of
791 raw memory in the garbage-collected heap, which is not scanned
792 for pointers. It carries its own size (in bytes). There are
793 three sets of operations for accessing byte array contents:
794 index for reading from immutable byte arrays, and read/write
795 for mutable byte arrays. Each set contains operations for
796 a range of useful primitive data types. Each operation takes
797 an offset measured in terms of the size fo the primitive type
798 being read or written.}
800 ------------------------------------------------------------------------
804 primtype MutableByteArray# s
806 primop NewByteArrayOp_Char "newByteArray#" GenPrimOp
807 Int# -> State# s -> (# State# s, MutableByteArray# s #)
808 {Create a new mutable byte array of specified size (in bytes), in
809 the specified state thread.}
810 with out_of_line = True
812 primop NewPinnedByteArrayOp_Char "newPinnedByteArray#" GenPrimOp
813 Int# -> State# s -> (# State# s, MutableByteArray# s #)
814 {Create a mutable byte array that the GC guarantees not to move.}
815 with out_of_line = True
817 primop ByteArrayContents_Char "byteArrayContents#" GenPrimOp
819 {Intended for use with pinned arrays; otherwise very unsafe!}
821 primop SameMutableByteArrayOp "sameMutableByteArray#" GenPrimOp
822 MutableByteArray# s -> MutableByteArray# s -> Bool
824 primop UnsafeFreezeByteArrayOp "unsafeFreezeByteArray#" GenPrimOp
825 MutableByteArray# s -> State# s -> (# State# s, ByteArray# #)
826 {Make a mutable byte array immutable, without copying.}
828 has_side_effects = True
830 primop SizeofByteArrayOp "sizeofByteArray#" GenPrimOp
833 primop SizeofMutableByteArrayOp "sizeofMutableByteArray#" GenPrimOp
834 MutableByteArray# s -> Int#
837 primop IndexByteArrayOp_Char "indexCharArray#" GenPrimOp
838 ByteArray# -> Int# -> Char#
839 {Read 8-bit character; offset in bytes.}
841 primop IndexByteArrayOp_WideChar "indexWideCharArray#" GenPrimOp
842 ByteArray# -> Int# -> Char#
843 {Read 31-bit character; offset in 4-byte words.}
845 primop IndexByteArrayOp_Int "indexIntArray#" GenPrimOp
846 ByteArray# -> Int# -> Int#
848 primop IndexByteArrayOp_Word "indexWordArray#" GenPrimOp
849 ByteArray# -> Int# -> Word#
851 primop IndexByteArrayOp_Addr "indexAddrArray#" GenPrimOp
852 ByteArray# -> Int# -> Addr#
854 primop IndexByteArrayOp_Float "indexFloatArray#" GenPrimOp
855 ByteArray# -> Int# -> Float#
857 primop IndexByteArrayOp_Double "indexDoubleArray#" GenPrimOp
858 ByteArray# -> Int# -> Double#
860 primop IndexByteArrayOp_StablePtr "indexStablePtrArray#" GenPrimOp
861 ByteArray# -> Int# -> StablePtr# a
863 primop IndexByteArrayOp_Int8 "indexInt8Array#" GenPrimOp
864 ByteArray# -> Int# -> Int#
866 primop IndexByteArrayOp_Int16 "indexInt16Array#" GenPrimOp
867 ByteArray# -> Int# -> Int#
869 primop IndexByteArrayOp_Int32 "indexInt32Array#" GenPrimOp
870 ByteArray# -> Int# -> INT32
872 primop IndexByteArrayOp_Int64 "indexInt64Array#" GenPrimOp
873 ByteArray# -> Int# -> INT64
875 primop IndexByteArrayOp_Word8 "indexWord8Array#" GenPrimOp
876 ByteArray# -> Int# -> Word#
878 primop IndexByteArrayOp_Word16 "indexWord16Array#" GenPrimOp
879 ByteArray# -> Int# -> Word#
881 primop IndexByteArrayOp_Word32 "indexWord32Array#" GenPrimOp
882 ByteArray# -> Int# -> WORD32
884 primop IndexByteArrayOp_Word64 "indexWord64Array#" GenPrimOp
885 ByteArray# -> Int# -> WORD64
887 primop ReadByteArrayOp_Char "readCharArray#" GenPrimOp
888 MutableByteArray# s -> Int# -> State# s -> (# State# s, Char# #)
889 {Read 8-bit character; offset in bytes.}
891 primop ReadByteArrayOp_WideChar "readWideCharArray#" GenPrimOp
892 MutableByteArray# s -> Int# -> State# s -> (# State# s, Char# #)
893 {Read 31-bit character; offset in 4-byte words.}
895 primop ReadByteArrayOp_Int "readIntArray#" GenPrimOp
896 MutableByteArray# s -> Int# -> State# s -> (# State# s, Int# #)
898 primop ReadByteArrayOp_Word "readWordArray#" GenPrimOp
899 MutableByteArray# s -> Int# -> State# s -> (# State# s, Word# #)
901 primop ReadByteArrayOp_Addr "readAddrArray#" GenPrimOp
902 MutableByteArray# s -> Int# -> State# s -> (# State# s, Addr# #)
904 primop ReadByteArrayOp_Float "readFloatArray#" GenPrimOp
905 MutableByteArray# s -> Int# -> State# s -> (# State# s, Float# #)
907 primop ReadByteArrayOp_Double "readDoubleArray#" GenPrimOp
908 MutableByteArray# s -> Int# -> State# s -> (# State# s, Double# #)
910 primop ReadByteArrayOp_StablePtr "readStablePtrArray#" GenPrimOp
911 MutableByteArray# s -> Int# -> State# s -> (# State# s, StablePtr# a #)
913 primop ReadByteArrayOp_Int8 "readInt8Array#" GenPrimOp
914 MutableByteArray# s -> Int# -> State# s -> (# State# s, Int# #)
916 primop ReadByteArrayOp_Int16 "readInt16Array#" GenPrimOp
917 MutableByteArray# s -> Int# -> State# s -> (# State# s, Int# #)
919 primop ReadByteArrayOp_Int32 "readInt32Array#" GenPrimOp
920 MutableByteArray# s -> Int# -> State# s -> (# State# s, INT32 #)
922 primop ReadByteArrayOp_Int64 "readInt64Array#" GenPrimOp
923 MutableByteArray# s -> Int# -> State# s -> (# State# s, INT64 #)
925 primop ReadByteArrayOp_Word8 "readWord8Array#" GenPrimOp
926 MutableByteArray# s -> Int# -> State# s -> (# State# s, Word# #)
928 primop ReadByteArrayOp_Word16 "readWord16Array#" GenPrimOp
929 MutableByteArray# s -> Int# -> State# s -> (# State# s, Word# #)
931 primop ReadByteArrayOp_Word32 "readWord32Array#" GenPrimOp
932 MutableByteArray# s -> Int# -> State# s -> (# State# s, WORD32 #)
934 primop ReadByteArrayOp_Word64 "readWord64Array#" GenPrimOp
935 MutableByteArray# s -> Int# -> State# s -> (# State# s, WORD64 #)
937 primop WriteByteArrayOp_Char "writeCharArray#" GenPrimOp
938 MutableByteArray# s -> Int# -> Char# -> State# s -> State# s
939 {Write 8-bit character; offset in bytes.}
940 with has_side_effects = True
942 primop WriteByteArrayOp_WideChar "writeWideCharArray#" GenPrimOp
943 MutableByteArray# s -> Int# -> Char# -> State# s -> State# s
944 {Write 31-bit character; offset in 4-byte words.}
945 with has_side_effects = True
947 primop WriteByteArrayOp_Int "writeIntArray#" GenPrimOp
948 MutableByteArray# s -> Int# -> Int# -> State# s -> State# s
949 with has_side_effects = True
951 primop WriteByteArrayOp_Word "writeWordArray#" GenPrimOp
952 MutableByteArray# s -> Int# -> Word# -> State# s -> State# s
953 with has_side_effects = True
955 primop WriteByteArrayOp_Addr "writeAddrArray#" GenPrimOp
956 MutableByteArray# s -> Int# -> Addr# -> State# s -> State# s
957 with has_side_effects = True
959 primop WriteByteArrayOp_Float "writeFloatArray#" GenPrimOp
960 MutableByteArray# s -> Int# -> Float# -> State# s -> State# s
961 with has_side_effects = True
963 primop WriteByteArrayOp_Double "writeDoubleArray#" GenPrimOp
964 MutableByteArray# s -> Int# -> Double# -> State# s -> State# s
965 with has_side_effects = True
967 primop WriteByteArrayOp_StablePtr "writeStablePtrArray#" GenPrimOp
968 MutableByteArray# s -> Int# -> StablePtr# a -> State# s -> State# s
969 with has_side_effects = True
971 primop WriteByteArrayOp_Int8 "writeInt8Array#" GenPrimOp
972 MutableByteArray# s -> Int# -> Int# -> State# s -> State# s
973 with has_side_effects = True
975 primop WriteByteArrayOp_Int16 "writeInt16Array#" GenPrimOp
976 MutableByteArray# s -> Int# -> Int# -> State# s -> State# s
977 with has_side_effects = True
979 primop WriteByteArrayOp_Int32 "writeInt32Array#" GenPrimOp
980 MutableByteArray# s -> Int# -> INT32 -> State# s -> State# s
981 with has_side_effects = True
983 primop WriteByteArrayOp_Int64 "writeInt64Array#" GenPrimOp
984 MutableByteArray# s -> Int# -> INT64 -> State# s -> State# s
985 with has_side_effects = True
987 primop WriteByteArrayOp_Word8 "writeWord8Array#" GenPrimOp
988 MutableByteArray# s -> Int# -> Word# -> State# s -> State# s
989 with has_side_effects = True
991 primop WriteByteArrayOp_Word16 "writeWord16Array#" GenPrimOp
992 MutableByteArray# s -> Int# -> Word# -> State# s -> State# s
993 with has_side_effects = True
995 primop WriteByteArrayOp_Word32 "writeWord32Array#" GenPrimOp
996 MutableByteArray# s -> Int# -> WORD32 -> State# s -> State# s
997 with has_side_effects = True
999 primop WriteByteArrayOp_Word64 "writeWord64Array#" GenPrimOp
1000 MutableByteArray# s -> Int# -> WORD64 -> State# s -> State# s
1001 with has_side_effects = True
1003 ------------------------------------------------------------------------
1005 ------------------------------------------------------------------------
1008 { An arbitrary machine address assumed to point outside
1009 the garbage-collected heap. }
1011 pseudoop "nullAddr#" Addr#
1012 { The null address. }
1014 primop AddrAddOp "plusAddr#" GenPrimOp Addr# -> Int# -> Addr#
1015 primop AddrSubOp "minusAddr#" GenPrimOp Addr# -> Addr# -> Int#
1016 {Result is meaningless if two {\tt Addr\#}s are so far apart that their
1017 difference doesn't fit in an {\tt Int\#}.}
1018 primop AddrRemOp "remAddr#" GenPrimOp Addr# -> Int# -> Int#
1019 {Return the remainder when the {\tt Addr\#} arg, treated like an {\tt Int\#},
1020 is divided by the {\tt Int\#} arg.}
1021 #if (WORD_SIZE_IN_BITS == 32 || WORD_SIZE_IN_BITS == 64)
1022 primop Addr2IntOp "addr2Int#" GenPrimOp Addr# -> Int#
1023 {Coerce directly from address to int. Strongly deprecated.}
1024 primop Int2AddrOp "int2Addr#" GenPrimOp Int# -> Addr#
1025 {Coerce directly from int to address. Strongly deprecated.}
1028 primop AddrGtOp "gtAddr#" Compare Addr# -> Addr# -> Bool
1029 primop AddrGeOp "geAddr#" Compare Addr# -> Addr# -> Bool
1030 primop AddrEqOp "eqAddr#" Compare Addr# -> Addr# -> Bool
1031 primop AddrNeOp "neAddr#" Compare Addr# -> Addr# -> Bool
1032 primop AddrLtOp "ltAddr#" Compare Addr# -> Addr# -> Bool
1033 primop AddrLeOp "leAddr#" Compare Addr# -> Addr# -> Bool
1035 primop IndexOffAddrOp_Char "indexCharOffAddr#" GenPrimOp
1036 Addr# -> Int# -> Char#
1037 {Reads 8-bit character; offset in bytes.}
1039 primop IndexOffAddrOp_WideChar "indexWideCharOffAddr#" GenPrimOp
1040 Addr# -> Int# -> Char#
1041 {Reads 31-bit character; offset in 4-byte words.}
1043 primop IndexOffAddrOp_Int "indexIntOffAddr#" GenPrimOp
1044 Addr# -> Int# -> Int#
1046 primop IndexOffAddrOp_Word "indexWordOffAddr#" GenPrimOp
1047 Addr# -> Int# -> Word#
1049 primop IndexOffAddrOp_Addr "indexAddrOffAddr#" GenPrimOp
1050 Addr# -> Int# -> Addr#
1052 primop IndexOffAddrOp_Float "indexFloatOffAddr#" GenPrimOp
1053 Addr# -> Int# -> Float#
1055 primop IndexOffAddrOp_Double "indexDoubleOffAddr#" GenPrimOp
1056 Addr# -> Int# -> Double#
1058 primop IndexOffAddrOp_StablePtr "indexStablePtrOffAddr#" GenPrimOp
1059 Addr# -> Int# -> StablePtr# a
1061 primop IndexOffAddrOp_Int8 "indexInt8OffAddr#" GenPrimOp
1062 Addr# -> Int# -> Int#
1064 primop IndexOffAddrOp_Int16 "indexInt16OffAddr#" GenPrimOp
1065 Addr# -> Int# -> Int#
1067 primop IndexOffAddrOp_Int32 "indexInt32OffAddr#" GenPrimOp
1068 Addr# -> Int# -> INT32
1070 primop IndexOffAddrOp_Int64 "indexInt64OffAddr#" GenPrimOp
1071 Addr# -> Int# -> INT64
1073 primop IndexOffAddrOp_Word8 "indexWord8OffAddr#" GenPrimOp
1074 Addr# -> Int# -> Word#
1076 primop IndexOffAddrOp_Word16 "indexWord16OffAddr#" GenPrimOp
1077 Addr# -> Int# -> Word#
1079 primop IndexOffAddrOp_Word32 "indexWord32OffAddr#" GenPrimOp
1080 Addr# -> Int# -> WORD32
1082 primop IndexOffAddrOp_Word64 "indexWord64OffAddr#" GenPrimOp
1083 Addr# -> Int# -> WORD64
1085 primop ReadOffAddrOp_Char "readCharOffAddr#" GenPrimOp
1086 Addr# -> Int# -> State# s -> (# State# s, Char# #)
1087 {Reads 8-bit character; offset in bytes.}
1089 primop ReadOffAddrOp_WideChar "readWideCharOffAddr#" GenPrimOp
1090 Addr# -> Int# -> State# s -> (# State# s, Char# #)
1091 {Reads 31-bit character; offset in 4-byte words.}
1093 primop ReadOffAddrOp_Int "readIntOffAddr#" GenPrimOp
1094 Addr# -> Int# -> State# s -> (# State# s, Int# #)
1096 primop ReadOffAddrOp_Word "readWordOffAddr#" GenPrimOp
1097 Addr# -> Int# -> State# s -> (# State# s, Word# #)
1099 primop ReadOffAddrOp_Addr "readAddrOffAddr#" GenPrimOp
1100 Addr# -> Int# -> State# s -> (# State# s, Addr# #)
1102 primop ReadOffAddrOp_Float "readFloatOffAddr#" GenPrimOp
1103 Addr# -> Int# -> State# s -> (# State# s, Float# #)
1105 primop ReadOffAddrOp_Double "readDoubleOffAddr#" GenPrimOp
1106 Addr# -> Int# -> State# s -> (# State# s, Double# #)
1108 primop ReadOffAddrOp_StablePtr "readStablePtrOffAddr#" GenPrimOp
1109 Addr# -> Int# -> State# s -> (# State# s, StablePtr# a #)
1111 primop ReadOffAddrOp_Int8 "readInt8OffAddr#" GenPrimOp
1112 Addr# -> Int# -> State# s -> (# State# s, Int# #)
1114 primop ReadOffAddrOp_Int16 "readInt16OffAddr#" GenPrimOp
1115 Addr# -> Int# -> State# s -> (# State# s, Int# #)
1117 primop ReadOffAddrOp_Int32 "readInt32OffAddr#" GenPrimOp
1118 Addr# -> Int# -> State# s -> (# State# s, INT32 #)
1120 primop ReadOffAddrOp_Int64 "readInt64OffAddr#" GenPrimOp
1121 Addr# -> Int# -> State# s -> (# State# s, INT64 #)
1123 primop ReadOffAddrOp_Word8 "readWord8OffAddr#" GenPrimOp
1124 Addr# -> Int# -> State# s -> (# State# s, Word# #)
1126 primop ReadOffAddrOp_Word16 "readWord16OffAddr#" GenPrimOp
1127 Addr# -> Int# -> State# s -> (# State# s, Word# #)
1129 primop ReadOffAddrOp_Word32 "readWord32OffAddr#" GenPrimOp
1130 Addr# -> Int# -> State# s -> (# State# s, WORD32 #)
1132 primop ReadOffAddrOp_Word64 "readWord64OffAddr#" GenPrimOp
1133 Addr# -> Int# -> State# s -> (# State# s, WORD64 #)
1136 primop WriteOffAddrOp_Char "writeCharOffAddr#" GenPrimOp
1137 Addr# -> Int# -> Char# -> State# s -> State# s
1138 with has_side_effects = True
1140 primop WriteOffAddrOp_WideChar "writeWideCharOffAddr#" GenPrimOp
1141 Addr# -> Int# -> Char# -> State# s -> State# s
1142 with has_side_effects = True
1144 primop WriteOffAddrOp_Int "writeIntOffAddr#" GenPrimOp
1145 Addr# -> Int# -> Int# -> State# s -> State# s
1146 with has_side_effects = True
1148 primop WriteOffAddrOp_Word "writeWordOffAddr#" GenPrimOp
1149 Addr# -> Int# -> Word# -> State# s -> State# s
1150 with has_side_effects = True
1152 primop WriteOffAddrOp_Addr "writeAddrOffAddr#" GenPrimOp
1153 Addr# -> Int# -> Addr# -> State# s -> State# s
1154 with has_side_effects = True
1156 primop WriteOffAddrOp_Float "writeFloatOffAddr#" GenPrimOp
1157 Addr# -> Int# -> Float# -> State# s -> State# s
1158 with has_side_effects = True
1160 primop WriteOffAddrOp_Double "writeDoubleOffAddr#" GenPrimOp
1161 Addr# -> Int# -> Double# -> State# s -> State# s
1162 with has_side_effects = True
1164 primop WriteOffAddrOp_StablePtr "writeStablePtrOffAddr#" GenPrimOp
1165 Addr# -> Int# -> StablePtr# a -> State# s -> State# s
1166 with has_side_effects = True
1168 primop WriteOffAddrOp_Int8 "writeInt8OffAddr#" GenPrimOp
1169 Addr# -> Int# -> Int# -> State# s -> State# s
1170 with has_side_effects = True
1172 primop WriteOffAddrOp_Int16 "writeInt16OffAddr#" GenPrimOp
1173 Addr# -> Int# -> Int# -> State# s -> State# s
1174 with has_side_effects = True
1176 primop WriteOffAddrOp_Int32 "writeInt32OffAddr#" GenPrimOp
1177 Addr# -> Int# -> INT32 -> State# s -> State# s
1178 with has_side_effects = True
1180 primop WriteOffAddrOp_Int64 "writeInt64OffAddr#" GenPrimOp
1181 Addr# -> Int# -> INT64 -> State# s -> State# s
1182 with has_side_effects = True
1184 primop WriteOffAddrOp_Word8 "writeWord8OffAddr#" GenPrimOp
1185 Addr# -> Int# -> Word# -> State# s -> State# s
1186 with has_side_effects = True
1188 primop WriteOffAddrOp_Word16 "writeWord16OffAddr#" GenPrimOp
1189 Addr# -> Int# -> Word# -> State# s -> State# s
1190 with has_side_effects = True
1192 primop WriteOffAddrOp_Word32 "writeWord32OffAddr#" GenPrimOp
1193 Addr# -> Int# -> WORD32 -> State# s -> State# s
1194 with has_side_effects = True
1196 primop WriteOffAddrOp_Word64 "writeWord64OffAddr#" GenPrimOp
1197 Addr# -> Int# -> WORD64 -> State# s -> State# s
1198 with has_side_effects = True
1200 ------------------------------------------------------------------------
1201 section "Mutable variables"
1202 {Operations on MutVar\#s.}
1203 ------------------------------------------------------------------------
1205 primtype MutVar# s a
1206 {A {\tt MutVar\#} behaves like a single-element mutable array.}
1208 primop NewMutVarOp "newMutVar#" GenPrimOp
1209 a -> State# s -> (# State# s, MutVar# s a #)
1210 {Create {\tt MutVar\#} with specified initial value in specified state thread.}
1214 primop ReadMutVarOp "readMutVar#" GenPrimOp
1215 MutVar# s a -> State# s -> (# State# s, a #)
1216 {Read contents of {\tt MutVar\#}. Result is not yet evaluated.}
1218 primop WriteMutVarOp "writeMutVar#" GenPrimOp
1219 MutVar# s a -> a -> State# s -> State# s
1220 {Write contents of {\tt MutVar\#}.}
1222 has_side_effects = True
1224 primop SameMutVarOp "sameMutVar#" GenPrimOp
1225 MutVar# s a -> MutVar# s a -> Bool
1227 -- not really the right type, but we don't know about pairs here. The
1230 -- MutVar# s a -> (a -> (a,b)) -> State# s -> (# State# s, b #)
1232 primop AtomicModifyMutVarOp "atomicModifyMutVar#" GenPrimOp
1233 MutVar# s a -> (a -> b) -> State# s -> (# State# s, c #)
1235 has_side_effects = True
1238 ------------------------------------------------------------------------
1239 section "Exceptions"
1240 ------------------------------------------------------------------------
1242 primop CatchOp "catch#" GenPrimOp
1243 (State# RealWorld -> (# State# RealWorld, a #) )
1244 -> (b -> State# RealWorld -> (# State# RealWorld, a #) )
1246 -> (# State# RealWorld, a #)
1248 -- Catch is actually strict in its first argument
1249 -- but we don't want to tell the strictness
1250 -- analyser about that!
1251 -- might use caught action multiply
1254 primop RaiseOp "raise#" GenPrimOp
1257 strictness = { \ _arity -> mkStrictSig (mkTopDmdType [lazyDmd] BotRes) }
1258 -- NB: result is bottom
1261 -- raiseIO# needs to be a primop, because exceptions in the IO monad
1262 -- must be *precise* - we don't want the strictness analyser turning
1263 -- one kind of bottom into another, as it is allowed to do in pure code.
1265 primop RaiseIOOp "raiseIO#" GenPrimOp
1266 a -> State# RealWorld -> (# State# RealWorld, b #)
1270 primop BlockAsyncExceptionsOp "blockAsyncExceptions#" GenPrimOp
1271 (State# RealWorld -> (# State# RealWorld, a #))
1272 -> (State# RealWorld -> (# State# RealWorld, a #))
1276 primop UnblockAsyncExceptionsOp "unblockAsyncExceptions#" GenPrimOp
1277 (State# RealWorld -> (# State# RealWorld, a #))
1278 -> (State# RealWorld -> (# State# RealWorld, a #))
1282 primop AsyncExceptionsBlockedOp "asyncExceptionsBlocked#" GenPrimOp
1283 State# RealWorld -> (# State# RealWorld, Int# #)
1287 ------------------------------------------------------------------------
1288 section "STM-accessible Mutable Variables"
1289 ------------------------------------------------------------------------
1293 primop AtomicallyOp "atomically#" GenPrimOp
1294 (State# RealWorld -> (# State# RealWorld, a #) )
1295 -> State# RealWorld -> (# State# RealWorld, a #)
1298 has_side_effects = True
1300 primop RetryOp "retry#" GenPrimOp
1301 State# RealWorld -> (# State# RealWorld, a #)
1304 has_side_effects = True
1306 primop CatchRetryOp "catchRetry#" GenPrimOp
1307 (State# RealWorld -> (# State# RealWorld, a #) )
1308 -> (State# RealWorld -> (# State# RealWorld, a #) )
1309 -> (State# RealWorld -> (# State# RealWorld, a #) )
1312 has_side_effects = True
1314 primop CatchSTMOp "catchSTM#" GenPrimOp
1315 (State# RealWorld -> (# State# RealWorld, a #) )
1316 -> (b -> State# RealWorld -> (# State# RealWorld, a #) )
1317 -> (State# RealWorld -> (# State# RealWorld, a #) )
1320 has_side_effects = True
1322 primop Check "check#" GenPrimOp
1323 (State# RealWorld -> (# State# RealWorld, a #) )
1324 -> (State# RealWorld -> (# State# RealWorld, () #) )
1327 has_side_effects = True
1329 primop NewTVarOp "newTVar#" GenPrimOp
1331 -> State# s -> (# State# s, TVar# s a #)
1332 {Create a new {\tt TVar\#} holding a specified initial value.}
1336 primop ReadTVarOp "readTVar#" GenPrimOp
1338 -> State# s -> (# State# s, a #)
1339 {Read contents of {\tt TVar\#}. Result is not yet evaluated.}
1343 primop ReadTVarIOOp "readTVarIO#" GenPrimOp
1345 -> State# s -> (# State# s, a #)
1346 {Read contents of {\tt TVar\#} outside an STM transaction}
1350 primop WriteTVarOp "writeTVar#" GenPrimOp
1353 -> State# s -> State# s
1354 {Write contents of {\tt TVar\#}.}
1357 has_side_effects = True
1359 primop SameTVarOp "sameTVar#" GenPrimOp
1360 TVar# s a -> TVar# s a -> Bool
1363 ------------------------------------------------------------------------
1364 section "Synchronized Mutable Variables"
1365 {Operations on {\tt MVar\#}s. }
1366 ------------------------------------------------------------------------
1369 { A shared mutable variable ({\it not} the same as a {\tt MutVar\#}!).
1370 (Note: in a non-concurrent implementation, {\tt (MVar\# a)} can be
1371 represented by {\tt (MutVar\# (Maybe a))}.) }
1373 primop NewMVarOp "newMVar#" GenPrimOp
1374 State# s -> (# State# s, MVar# s a #)
1375 {Create new {\tt MVar\#}; initially empty.}
1379 primop TakeMVarOp "takeMVar#" GenPrimOp
1380 MVar# s a -> State# s -> (# State# s, a #)
1381 {If {\tt MVar\#} is empty, block until it becomes full.
1382 Then remove and return its contents, and set it empty.}
1384 has_side_effects = True
1387 primop TryTakeMVarOp "tryTakeMVar#" GenPrimOp
1388 MVar# s a -> State# s -> (# State# s, Int#, a #)
1389 {If {\tt MVar\#} is empty, immediately return with integer 0 and value undefined.
1390 Otherwise, return with integer 1 and contents of {\tt MVar\#}, and set {\tt MVar\#} empty.}
1392 has_side_effects = True
1395 primop PutMVarOp "putMVar#" GenPrimOp
1396 MVar# s a -> a -> State# s -> State# s
1397 {If {\tt MVar\#} is full, block until it becomes empty.
1398 Then store value arg as its new contents.}
1400 has_side_effects = True
1403 primop TryPutMVarOp "tryPutMVar#" GenPrimOp
1404 MVar# s a -> a -> State# s -> (# State# s, Int# #)
1405 {If {\tt MVar\#} is full, immediately return with integer 0.
1406 Otherwise, store value arg as {\tt MVar\#}'s new contents, and return with integer 1.}
1408 has_side_effects = True
1411 primop SameMVarOp "sameMVar#" GenPrimOp
1412 MVar# s a -> MVar# s a -> Bool
1414 primop IsEmptyMVarOp "isEmptyMVar#" GenPrimOp
1415 MVar# s a -> State# s -> (# State# s, Int# #)
1416 {Return 1 if {\tt MVar\#} is empty; 0 otherwise.}
1420 ------------------------------------------------------------------------
1421 section "Delay/wait operations"
1422 ------------------------------------------------------------------------
1424 primop DelayOp "delay#" GenPrimOp
1425 Int# -> State# s -> State# s
1426 {Sleep specified number of microseconds.}
1428 needs_wrapper = True
1429 has_side_effects = True
1432 primop WaitReadOp "waitRead#" GenPrimOp
1433 Int# -> State# s -> State# s
1434 {Block until input is available on specified file descriptor.}
1436 needs_wrapper = True
1437 has_side_effects = True
1440 primop WaitWriteOp "waitWrite#" GenPrimOp
1441 Int# -> State# s -> State# s
1442 {Block until output is possible on specified file descriptor.}
1444 needs_wrapper = True
1445 has_side_effects = True
1448 #ifdef mingw32_TARGET_OS
1449 primop AsyncReadOp "asyncRead#" GenPrimOp
1450 Int# -> Int# -> Int# -> Addr# -> State# RealWorld-> (# State# RealWorld, Int#, Int# #)
1451 {Asynchronously read bytes from specified file descriptor.}
1453 needs_wrapper = True
1454 has_side_effects = True
1457 primop AsyncWriteOp "asyncWrite#" GenPrimOp
1458 Int# -> Int# -> Int# -> Addr# -> State# RealWorld-> (# State# RealWorld, Int#, Int# #)
1459 {Asynchronously write bytes from specified file descriptor.}
1461 needs_wrapper = True
1462 has_side_effects = True
1465 primop AsyncDoProcOp "asyncDoProc#" GenPrimOp
1466 Addr# -> Addr# -> State# RealWorld-> (# State# RealWorld, Int#, Int# #)
1467 {Asynchronously perform procedure (first arg), passing it 2nd arg.}
1469 needs_wrapper = True
1470 has_side_effects = True
1475 ------------------------------------------------------------------------
1476 section "Concurrency primitives"
1477 ------------------------------------------------------------------------
1480 { {\tt State\#} is the primitive, unlifted type of states. It has
1481 one type parameter, thus {\tt State\# RealWorld}, or {\tt State\# s},
1482 where s is a type variable. The only purpose of the type parameter
1483 is to keep different state threads separate. It is represented by
1487 { {\tt RealWorld} is deeply magical. It is {\it primitive}, but it is not
1488 {\it unlifted} (hence {\tt ptrArg}). We never manipulate values of type
1489 {\tt RealWorld}; it's only used in the type system, to parameterise {\tt State\#}. }
1492 {(In a non-concurrent implementation, this can be a singleton
1493 type, whose (unique) value is returned by {\tt myThreadId\#}. The
1494 other operations can be omitted.)}
1496 primop ForkOp "fork#" GenPrimOp
1497 a -> State# RealWorld -> (# State# RealWorld, ThreadId# #)
1499 has_side_effects = True
1502 primop ForkOnOp "forkOn#" GenPrimOp
1503 Int# -> a -> State# RealWorld -> (# State# RealWorld, ThreadId# #)
1505 has_side_effects = True
1508 primop KillThreadOp "killThread#" GenPrimOp
1509 ThreadId# -> a -> State# RealWorld -> State# RealWorld
1511 has_side_effects = True
1514 primop YieldOp "yield#" GenPrimOp
1515 State# RealWorld -> State# RealWorld
1517 has_side_effects = True
1520 primop MyThreadIdOp "myThreadId#" GenPrimOp
1521 State# RealWorld -> (# State# RealWorld, ThreadId# #)
1525 primop LabelThreadOp "labelThread#" GenPrimOp
1526 ThreadId# -> Addr# -> State# RealWorld -> State# RealWorld
1528 has_side_effects = True
1531 primop IsCurrentThreadBoundOp "isCurrentThreadBound#" GenPrimOp
1532 State# RealWorld -> (# State# RealWorld, Int# #)
1536 primop NoDuplicateOp "noDuplicate#" GenPrimOp
1537 State# RealWorld -> State# RealWorld
1541 primop ThreadStatusOp "threadStatus#" GenPrimOp
1542 ThreadId# -> State# RealWorld -> (# State# RealWorld, Int# #)
1546 ------------------------------------------------------------------------
1547 section "Weak pointers"
1548 ------------------------------------------------------------------------
1552 -- note that tyvar "o" denotes openAlphaTyVar
1554 primop MkWeakOp "mkWeak#" GenPrimOp
1555 o -> b -> c -> State# RealWorld -> (# State# RealWorld, Weak# b #)
1557 has_side_effects = True
1560 primop MkWeakForeignEnvOp "mkWeakForeignEnv#" GenPrimOp
1561 o -> b -> Addr# -> Addr# -> Int# -> Addr# -> State# RealWorld -> (# State# RealWorld, Weak# b #)
1563 has_side_effects = True
1566 primop DeRefWeakOp "deRefWeak#" GenPrimOp
1567 Weak# a -> State# RealWorld -> (# State# RealWorld, Int#, a #)
1569 has_side_effects = True
1572 primop FinalizeWeakOp "finalizeWeak#" GenPrimOp
1573 Weak# a -> State# RealWorld -> (# State# RealWorld, Int#,
1574 (State# RealWorld -> (# State# RealWorld, () #)) #)
1576 has_side_effects = True
1579 primop TouchOp "touch#" GenPrimOp
1580 o -> State# RealWorld -> State# RealWorld
1582 has_side_effects = True
1584 ------------------------------------------------------------------------
1585 section "Stable pointers and names"
1586 ------------------------------------------------------------------------
1588 primtype StablePtr# a
1590 primtype StableName# a
1592 primop MakeStablePtrOp "makeStablePtr#" GenPrimOp
1593 a -> State# RealWorld -> (# State# RealWorld, StablePtr# a #)
1595 has_side_effects = True
1598 primop DeRefStablePtrOp "deRefStablePtr#" GenPrimOp
1599 StablePtr# a -> State# RealWorld -> (# State# RealWorld, a #)
1601 needs_wrapper = True
1602 has_side_effects = True
1605 primop EqStablePtrOp "eqStablePtr#" GenPrimOp
1606 StablePtr# a -> StablePtr# a -> Int#
1608 has_side_effects = True
1610 primop MakeStableNameOp "makeStableName#" GenPrimOp
1611 a -> State# RealWorld -> (# State# RealWorld, StableName# a #)
1613 needs_wrapper = True
1614 has_side_effects = True
1617 primop EqStableNameOp "eqStableName#" GenPrimOp
1618 StableName# a -> StableName# a -> Int#
1620 primop StableNameToIntOp "stableNameToInt#" GenPrimOp
1621 StableName# a -> Int#
1623 ------------------------------------------------------------------------
1624 section "Unsafe pointer equality"
1625 -- (#1 Bad Guy: Alistair Reid :)
1626 ------------------------------------------------------------------------
1628 primop ReallyUnsafePtrEqualityOp "reallyUnsafePtrEquality#" GenPrimOp
1631 ------------------------------------------------------------------------
1632 section "Parallelism"
1633 ------------------------------------------------------------------------
1635 primop ParOp "par#" GenPrimOp
1638 -- Note that Par is lazy to avoid that the sparked thing
1639 -- gets evaluted strictly, which it should *not* be
1640 has_side_effects = True
1642 primop GetSparkOp "getSpark#" GenPrimOp
1643 State# s -> (# State# s, Int#, a #)
1645 has_side_effects = True
1648 -- HWL: The first 4 Int# in all par... annotations denote:
1649 -- name, granularity info, size of result, degree of parallelism
1650 -- Same structure as _seq_ i.e. returns Int#
1651 -- KSW: v, the second arg in parAt# and parAtForNow#, is used only to determine
1652 -- `the processor containing the expression v'; it is not evaluated
1654 primop ParGlobalOp "parGlobal#" GenPrimOp
1655 a -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1657 has_side_effects = True
1659 primop ParLocalOp "parLocal#" GenPrimOp
1660 a -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1662 has_side_effects = True
1664 primop ParAtOp "parAt#" GenPrimOp
1665 b -> a -> Int# -> Int# -> Int# -> Int# -> c -> Int#
1667 has_side_effects = True
1669 primop ParAtAbsOp "parAtAbs#" GenPrimOp
1670 a -> Int# -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1672 has_side_effects = True
1674 primop ParAtRelOp "parAtRel#" GenPrimOp
1675 a -> Int# -> Int# -> Int# -> Int# -> Int# -> b -> Int#
1677 has_side_effects = True
1679 primop ParAtForNowOp "parAtForNow#" GenPrimOp
1680 b -> a -> Int# -> Int# -> Int# -> Int# -> c -> Int#
1682 has_side_effects = True
1684 -- copyable# and noFollow# are yet to be implemented (for GpH)
1686 --primop CopyableOp "copyable#" GenPrimOp
1689 -- has_side_effects = True
1691 --primop NoFollowOp "noFollow#" GenPrimOp
1694 -- has_side_effects = True
1697 ------------------------------------------------------------------------
1698 section "Tag to enum stuff"
1699 {Convert back and forth between values of enumerated types
1700 and small integers.}
1701 ------------------------------------------------------------------------
1703 primop DataToTagOp "dataToTag#" GenPrimOp
1706 strictness = { \ _arity -> mkStrictSig (mkTopDmdType [seqDmd] TopRes) }
1707 -- dataToTag# must have an evaluated argument
1709 primop TagToEnumOp "tagToEnum#" GenPrimOp
1712 ------------------------------------------------------------------------
1713 section "Bytecode operations"
1714 {Support for the bytecode interpreter and linker.}
1715 ------------------------------------------------------------------------
1718 {Primitive bytecode type.}
1720 primop AddrToHValueOp "addrToHValue#" GenPrimOp
1722 {Convert an {\tt Addr\#} to a followable type.}
1724 primop MkApUpd0_Op "mkApUpd0#" GenPrimOp
1729 primop NewBCOOp "newBCO#" GenPrimOp
1730 ByteArray# -> ByteArray# -> Array# a -> Int# -> ByteArray# -> State# s -> (# State# s, BCO# #)
1732 has_side_effects = True
1735 primop UnpackClosureOp "unpackClosure#" GenPrimOp
1736 a -> (# Addr#, Array# b, ByteArray# #)
1740 primop GetApStackValOp "getApStackVal#" GenPrimOp
1741 a -> Int# -> (# Int#, b #)
1745 ------------------------------------------------------------------------
1747 {Miscellaneous built-ins}
1748 ------------------------------------------------------------------------
1752 { Evaluates its first argument to head normal form, and then returns its second
1753 argument as the result. }
1757 { The call {\tt (inline f)} arranges that f is inlined, regardless of its size.
1758 More precisely, the call {\tt (inline f)} rewrites to the right-hand side of
1759 {\tt f}'s definition. This allows the programmer to control inlining from a
1760 particular call site rather than the definition site of the function (c.f.
1761 {\tt INLINE} pragmas in User's Guide, Section 7.10.3, "INLINE and NOINLINE
1764 This inlining occurs regardless of the argument to the call or the size of
1765 {\tt f}'s definition; it is unconditional. The main caveat is that {\tt f}'s
1766 definition must be visible to the compiler. That is, {\tt f} must be
1767 {\tt let}-bound in the current scope. If no inlining takes place, the
1768 {\tt inline} function expands to the identity function in Phase zero; so its
1769 use imposes no overhead.
1771 If the function is defined in another module, GHC only exposes its inlining
1772 in the interface file if the function is sufficiently small that it might be
1773 inlined by the automatic mechanism. There is currently no way to tell GHC to
1774 expose arbitrarily-large functions in the interface file. (This shortcoming
1775 is something that could be fixed, with some kind of pragma.) }
1779 { The {\tt lazy} function restrains strictness analysis a little. The call
1780 {\tt (lazy e)} means the same as {\tt e}, but {\tt lazy} has a magical
1781 property so far as strictness analysis is concerned: it is lazy in its first
1782 argument, even though its semantics is strict. After strictness analysis has
1783 run, calls to {\tt lazy} are inlined to be the identity function.
1785 This behaviour is occasionally useful when controlling evaluation order.
1786 Notably, {\tt lazy} is used in the library definition of {\tt Control.Parallel.par}:
1788 {\tt par :: a -> b -> b}
1790 {\tt par x y = case (par\# x) of \_ -> lazy y}
1792 If {\tt lazy} were not lazy, {\tt par} would look strict in {\tt y} which
1793 would defeat the whole purpose of {\tt par}.
1795 Like {\tt seq}, the argument of {\tt lazy} can have an unboxed type. }
1798 { The type constructor {\tt Any} is type to which you can unsafely coerce any
1799 lifted type, and back.
1801 * It is lifted, and hence represented by a pointer
1803 * It does not claim to be a {\it data} type, and that's important for
1804 the code generator, because the code gen may {\it enter} a data value
1805 but never enters a function value.
1807 It's also used to instantiate un-constrained type variables after type
1808 checking. For example
1812 Annoyingly, we sometimes need {\tt Any}s of other kinds, such as {\tt (* -> *)} etc.
1813 This is a bit like tuples. We define a couple of useful ones here,
1814 and make others up on the fly. If any of these others end up being exported
1815 into interface files, we'll get a crash; at least until we add interface-file
1816 syntax to support them. }
1818 pseudoop "unsafeCoerce#"
1820 { The function {\tt unsafeCoerce\#} allows you to side-step the typechecker entirely. That
1821 is, it allows you to coerce any type into any other type. If you use this function,
1822 you had better get it right, otherwise segmentation faults await. It is generally
1823 used when you want to write a program that you know is well-typed, but where Haskell's
1824 type system is not expressive enough to prove that it is well typed.
1826 The following uses of {\tt unsafeCoerce\#} are supposed to work (i.e. not lead to
1827 spurious compile-time or run-time crashes):
1829 * Casting any lifted type to {\tt Any}
1831 * Casting {\tt Any} back to the real type
1833 * Casting an unboxed type to another unboxed type of the same size
1834 (but not coercions between floating-point and integral types)
1836 * Casting between two types that have the same runtime representation. One case is when
1837 the two types differ only in "phantom" type parameters, for example
1838 {\tt Ptr Int} to {\tt Ptr Float}, or {\tt [Int]} to {\tt [Float]} when the list is
1839 known to be empty. Also, a {\tt newtype} of a type {\tt T} has the same representation
1840 at runtime as {\tt T}.
1842 Other uses of {\tt unsafeCoerce\#} are undefined. In particular, you should not use
1843 {\tt unsafeCoerce\#} to cast a T to an algebraic data type D, unless T is also
1844 an algebraic data type. For example, do not cast {\tt Int->Int} to {\tt Bool}, even if
1845 you later cast that {\tt Bool} back to {\tt Int->Int} before applying it. The reasons
1846 have to do with GHC's internal representation details (for the congnoscenti, data values
1847 can be entered but function closures cannot). If you want a safe type to cast things
1848 to, use {\tt Any}, which is not an algebraic data type.
1852 -- NB. It is tempting to think that casting a value to a type that it doesn't have is safe
1853 -- as long as you don't "do anything" with the value in its cast form, such as seq on it. This
1854 -- isn't the case: the compiler can insert seqs itself, and if these happen at the wrong type,
1855 -- Bad Things Might Happen. See bug #1616: in this case we cast a function of type (a,b) -> (a,b)
1856 -- to () -> () and back again. The strictness analyser saw that the function was strict, but
1857 -- the wrapper had type () -> (), and hence the wrapper de-constructed the (), the worker re-constructed
1858 -- a new (), with the result that the code ended up with "case () of (a,b) -> ...".
1860 ------------------------------------------------------------------------
1862 ------------------------------------------------------------------------