{-# LANGUAGE PatternSynonyms #-} {-| This module defines the semi-ring of multiplicities, and associated functions. Multiplicities annotate arrow types to indicate the linearity of the arrow (in the sense of linear types). Mult is a type synonym for Type, used only when its kind is Multiplicity. To simplify dealing with multiplicities, functions such as mkMultMul perform simplifications such as Many * x = Many on the fly. -} module GHC.Core.Multiplicity ( Mult , pattern OneTy , pattern ManyTy , isMultMul , mkMultAdd , mkMultMul , mkMultSup , Scaled(..) , scaledMult , scaledThing , unrestricted , linear , tymult , irrelevantMult , mkScaled , scaledSet , scaleScaled , IsSubmult(..) , submult , mapScaledType , pprArrowWithMultiplicity , MultiplicityFlag(..) ) where import GHC.Prelude import GHC.Utils.Outputable import GHC.Core.Type import GHC.Core.TyCo.Rep import GHC.Types.Var( isFUNArg ) import {-# SOURCE #-} GHC.Builtin.Types ( multMulTyCon ) import GHC.Builtin.Names (multMulTyConKey) import GHC.Types.Unique (hasKey) {- Note [Linear types] ~~~~~~~~~~~~~~~~~~~ This module is the entry point for linear types. The detailed design is in the _Linear Haskell_ article [https://arxiv.org/abs/1710.09756]. Other important resources in the linear types implementation wiki page [https://gitlab.haskell.org/ghc/ghc/wikis/linear-types/implementation], and the proposal [https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0111-linear-types.rst] which describes the concrete design at length. For the busy developer, though, here is a high-level view of linear types is the following: - Function arrows are annotated with a multiplicity (as defined by type `Mult` and its smart constructors in this module) - Multiplicities, in Haskell, are types of kind `GHC.Types.Multiplicity`. as in map :: forall (p :: Multiplicity). (a %p -> b) -> [a] %p -> [b] - The type constructor for function types (FUN) has type FUN :: forall (m :: Multiplicity) -> forall {r1) {r2}. TYPE r1 -> TYPE r2 -> Type The argument order is explained in https://gitlab.haskell.org/ghc/ghc/-/issues/20164 - (->) retains its backward compatible meaning: (->) a b = a -> b = a %'Many -> b To achieve this, `(->)` is defined as a type synonym to `FUN Many` (see below). - A ground multiplicity (that is, without a variable) can be `One` or `Many` (`Many` is generally rendered as ω in the scientific literature). Functions whose type is annotated with `One` are linear functions, functions whose type is annotated with `Many` are regular functions, often called “unrestricted” to contrast them with linear functions. - A linear function is defined as a function such that *if* its result is consumed exactly once, *then* its argument is consumed exactly once. You can think of “consuming exactly once” as evaluating a value in normal form exactly once (though not necessarily in one go). The _Linear Haskell_ article (see supra) has a more precise definition of “consuming exactly once”. - Data constructors are linear by default. See Note [Data constructors are linear by default]. - Multiplicities form a semiring. - Multiplicities can also be variables and we can universally quantify over these variables. This is referred to as “multiplicity polymorphism”. Furthermore, multiplicity can be formal semiring expressions combining variables. - Contrary to the paper, the sum of two multiplicities is always `Many`. This will have to change, however, if we want to add a multiplicity for 0. Whether we want to is still debated. - Case expressions have a multiplicity annotation too. A case expression with multiplicity `One`, consumes its scrutinee exactly once (provided the entire case expression is consumed exactly once); whereas a case expression with multiplicity `Many` can consume its scrutinee as many time as it wishes (no matter how much the case expression is consumed). For linear types in the linter see Note [Linting linearity] in GHC.Core.Lint. Note [Usages] ~~~~~~~~~~~~~ In the _Linear Haskell_ paper, you'll find typing rules such as these: Γ ⊢ f : A #π-> B Δ ⊢ u : A --------------------------- Γ + kΔ ⊢ f u : B If you read this as a type-checking algorithm going from the bottom up, this reads as: the algorithm has to find a split of some input context Ξ into an appropriate Γ and a Δ such as Ξ = Γ + kΔ, *and the multiplicities are chosen to make f and u typecheck*. This could be achieved by letting the typechecking of `f` use exactly the variable it needs, then passing the remainder, as `Delta` to the typechecking of u. But what does that mean if `x` is bound with multiplicity `p` (a variable) and `f` consumes `x` once? `Delta` would have to contain `x` with multiplicity `p-1`. It's not really clear how to make that works. In summary: bottom-up multiplicity checking forgoes addition and multiplication in favour of subtraction and division. And variables make the latter hard. The alternative is to read multiplicities from the top down: as an *output* from the typechecking algorithm, rather than an input. We call these output multiplicities Usages, to distinguish them from the multiplicities which come, as input, from the types of functions. Usages are checked for compatibility with multiplicity annotations using an ordering relation. In other words, the usage of x in the expression u is the smallest multiplicity which can be ascribed to x for u to typecheck. Usages are usually group in a UsageEnv, as defined in the UsageEnv module. So, in our function application example, the typechecking algorithm would receive usage environments f_ue from the typechecking of f, and u_ue from the typechecking of u. Then the output would be f_ue + (k * u_ue). Addition and scaling of usage environment is the pointwise extension of the semiring operations on multiplicities. Note [Zero as a usage] ~~~~~~~~~~~~~~~~~~~~~~ In the current presentation usages are not exactly multiplicities, because they can contain 0, and multiplicities can't. Why do we need a 0 usage? A function which doesn't use its argument will be required to annotate it with `Many`: \(x % Many) -> 0 However, we cannot replace absence with Many when computing usages compositionally: in (x, True) We expect x to have usage 1. But when computing the usage of x in True we would find that x is absent, hence has multiplicity Many. The final multiplicity would be One+Many = Many. Oops! Hence there is a usage Zero for absent variables. Zero is characterised by being the neutral element to usage addition. We may decide to add Zero as a multiplicity in the future. In which case, this distinction will go away. Note [Joining usages] ~~~~~~~~~~~~~~~~~~~~~ The usage of a variable is defined, in Note [Usages], as the minimum usage which can be ascribed to a variable. So what is the usage of x in case … of { p1 -> u -- usage env: u_ue ; p2 -> v } -- usage env: v_ue It must be the least upper bound, or _join_, of u_ue(x) and v_ue(x). So, contrary to a declarative presentation where the correct usage of x can be conjured out of thin air, we need to be able to compute the join of two multiplicities. Join is extended pointwise on usage environments. Note [Bottom as a usage] ~~~~~~~~~~~~~~~~~~~~~~ What is the usage of x in case … of {} Per usual linear logic, as well as the _Linear Haskell_ article, x can have every multiplicity. So we need a minimum usage _bottom_, which is also the neutral element for join. In fact, this is not such as nice solution, because it is not clear how to define sum and multiplication with bottom. We give reasonable definitions, but they are not complete (they don't respect the semiring laws, and it's possible to come up with examples of Core transformation which are not well-typed) A better solution would probably be to annotate case expressions with a usage environment, just like they are annotated with a type. Which, probably not coincidentally, is also primarily for empty cases. A side benefit of this approach is that the linter would not need to join multiplicities, anymore; hence would be closer to the presentation in the article. That's because it could use the annotation as the multiplicity for each branch. Note [Data constructors are linear by default] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All data constructors defined without -XLinearTypes, as well as data constructors defined with the Haskell 98 in all circumstances, have all their fields linear. That is, in data Maybe a = Nothing | Just a We have Just :: a %1 -> Just a Irrespective of whether -XLinearTypes is turned on or not. Furthermore, when -XLinearTypes is turned off, the declaration data Endo a where { MkIntEndo :: (Int -> Int) -> T Int } gives MkIntEndo :: (Int -> Int) %1 -> T Int With -XLinearTypes turned on, instead, this would give data EndoU a where { MkIntEndoU :: (Int -> Int) -> T Int } MkIntEndoU :: (Int -> Int) -> T Int With -XLinearTypes turned on, to get a linear field with GADT syntax we would need to write data EndoL a where { MkIntEndoL :: (Int -> Int) %1 -> T Int } The goal is to maximise reuse of types between linear code and traditional code. This is argued at length in the proposal and the article (links in Note [Linear types]). Unrestricted field don't need to be consumed for a value to be consumed exactly once. So consuming a value of type `IntEndoU a` exactly once means forcing it at least once. Why “at least once”? Because if `case u of { MkIntEndoL x -> f (MkIntEndoL x) }` is linear (provided `f` is a linear function). But we might as well have done `case u of { !z -> f z }`. So, we can observe constructors as many times as we want, and we are actually allowed to force the same thing several times because laziness means that we are really forcing the value once, and observing its constructor several times. The type checker and the linter recognise some (but not all) of these multiple forces as indeed linear. Mostly just enough to support variable patterns. In summary: - Fields of data constructors defined with Haskell 98 syntax are always linear (even if `-XLinearTypes` is off). This choice has been made to favour sharing types between linearly typed Haskell and traditional Haskell. To avoid an ecosystem split. - When `-XLinearTypes` is off, GADT-syntax declaration can only use the regular arrow `(->)`. However all the fields are linear. Note [Polymorphisation of linear fields] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The choice in Note [Data constructors are linear by default] has an impact on backwards compatibility. Consider map Just We have map :: (a -> b) -> f a -> f b Just :: a %1 -> Just a Types don't match, we should get a type error. But this is legal Haskell 98 code! Bad! Bad! Bad! It could be solved with subtyping, but subtyping doesn't combine well with polymorphism. Instead, we generalise the type of Just, when used as term: Just :: forall {p}. a %p-> Just a This is solely a concern for higher-order code like this: when called fully applied linear constructors are more general than constructors with unrestricted fields. In particular, linear constructors can always be eta-expanded to their Haskell 98 type. This is explained in the paper (but there, we had a different strategy to resolve this type mismatch in higher-order code. It turned out to be insufficient, which is explained in the wiki page as well as the proposal). We only generalise linear fields this way: fields with multiplicity Many, or other multiplicity expressions are exclusive to -XLinearTypes, hence don't have backward compatibility implications. The implementation is described in Note [Typechecking data constructors] in GHC.Tc.Gen.Head. More details in the proposal. -} {- Note [Adding new multiplicities] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To add a new multiplicity, you need to: * Add the new type with Multiplicity kind * Update cases in mkMultAdd, mkMultMul, mkMultSup, submult, tcSubMult * Check supUE function that computes sup of a multiplicity and Zero -} isMultMul :: Mult -> Maybe (Mult, Mult) isMultMul :: Mult -> Maybe (Mult, Mult) isMultMul Mult ty | Just (TyCon tc, [Mult x, Mult y]) <- HasDebugCallStack => Mult -> Maybe (TyCon, [Mult]) Mult -> Maybe (TyCon, [Mult]) splitTyConApp_maybe Mult ty , TyCon tc TyCon -> Unique -> Bool forall a. Uniquable a => a -> Unique -> Bool `hasKey` Unique multMulTyConKey = (Mult, Mult) -> Maybe (Mult, Mult) forall a. a -> Maybe a Just (Mult x, Mult y) | Bool otherwise = Maybe (Mult, Mult) forall a. Maybe a Nothing {- Note [Overapproximating multiplicities] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The functions mkMultAdd, mkMultMul, mkMultSup perform operations on multiplicities. They can return overapproximations: their result is merely guaranteed to be a submultiplicity of the actual value. They should be used only when an upper bound is acceptable. In most cases, they are used in usage environments (UsageEnv); in usage environments, replacing a usage with a larger one can only cause more programs to fail to typecheck. In future work, instead of approximating we might add type families and allow users to write types involving operations on multiplicities. In this case, we could enforce more invariants in Mult, for example, enforce that it is in the form of a sum of products, and even that the summands and factors are ordered somehow, to have more equalities. -} -- With only two multiplicities One and Many, we can always replace -- p + q by Many. See Note [Overapproximating multiplicities]. mkMultAdd :: Mult -> Mult -> Mult mkMultAdd :: Mult -> Mult -> Mult mkMultAdd Mult _ Mult _ = Mult ManyTy mkMultMul :: Mult -> Mult -> Mult mkMultMul :: Mult -> Mult -> Mult mkMultMul Mult OneTy Mult p = Mult p mkMultMul Mult p Mult OneTy = Mult p mkMultMul Mult ManyTy Mult _ = Mult ManyTy mkMultMul Mult _ Mult ManyTy = Mult ManyTy mkMultMul Mult p Mult q = TyCon -> [Mult] -> Mult mkTyConApp TyCon multMulTyCon [Mult p, Mult q] scaleScaled :: Mult -> Scaled a -> Scaled a scaleScaled :: forall a. Mult -> Scaled a -> Scaled a scaleScaled Mult m' (Scaled Mult m a t) = Mult -> a -> Scaled a forall a. Mult -> a -> Scaled a Scaled (Mult m' Mult -> Mult -> Mult `mkMultMul` Mult m) a t -- See Note [Joining usages] -- | @mkMultSup w1 w2@ returns a multiplicity such that @mkMultSup w1 -- w2 >= w1@ and @mkMultSup w1 w2 >= w2@. See Note [Overapproximating multiplicities]. mkMultSup :: Mult -> Mult -> Mult mkMultSup :: Mult -> Mult -> Mult mkMultSup = Mult -> Mult -> Mult mkMultMul -- Note: If you are changing this logic, check 'supUE' in UsageEnv as well. -- -- * Multiplicity ordering -- data IsSubmult = Submult -- Definitely a submult | Unknown -- Could be a submult, need to ask the typechecker deriving (Int -> IsSubmult -> ShowS [IsSubmult] -> ShowS IsSubmult -> String (Int -> IsSubmult -> ShowS) -> (IsSubmult -> String) -> ([IsSubmult] -> ShowS) -> Show IsSubmult forall a. (Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a $cshowsPrec :: Int -> IsSubmult -> ShowS showsPrec :: Int -> IsSubmult -> ShowS $cshow :: IsSubmult -> String show :: IsSubmult -> String $cshowList :: [IsSubmult] -> ShowS showList :: [IsSubmult] -> ShowS Show, IsSubmult -> IsSubmult -> Bool (IsSubmult -> IsSubmult -> Bool) -> (IsSubmult -> IsSubmult -> Bool) -> Eq IsSubmult forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a $c== :: IsSubmult -> IsSubmult -> Bool == :: IsSubmult -> IsSubmult -> Bool $c/= :: IsSubmult -> IsSubmult -> Bool /= :: IsSubmult -> IsSubmult -> Bool Eq) instance Outputable IsSubmult where ppr :: IsSubmult -> SDoc ppr = String -> SDoc forall doc. IsLine doc => String -> doc text (String -> SDoc) -> (IsSubmult -> String) -> IsSubmult -> SDoc forall b c a. (b -> c) -> (a -> b) -> a -> c . IsSubmult -> String forall a. Show a => a -> String show -- | @submult w1 w2@ check whether a value of multiplicity @w1@ is allowed where a -- value of multiplicity @w2@ is expected. This is a partial order. submult :: Mult -> Mult -> IsSubmult submult :: Mult -> Mult -> IsSubmult submult Mult _ Mult ManyTy = IsSubmult Submult submult Mult OneTy Mult OneTy = IsSubmult Submult -- The 1 <= p rule submult Mult OneTy Mult _ = IsSubmult Submult submult Mult _ Mult _ = IsSubmult Unknown pprArrowWithMultiplicity :: FunTyFlag -> Either Bool SDoc -> SDoc -- Pretty-print a multiplicity arrow. The multiplicity itself -- is described by the (Either Bool SDoc) -- Left False -- Many -- Left True -- One -- Right doc -- Something else -- In the Right case, the doc is in parens if not atomic pprArrowWithMultiplicity :: FunTyFlag -> Either Bool SDoc -> SDoc pprArrowWithMultiplicity FunTyFlag af Either Bool SDoc pp_mult | FunTyFlag -> Bool isFUNArg FunTyFlag af = case Either Bool SDoc pp_mult of Left Bool False -> SDoc arrow Left Bool True -> SDoc lollipop Right SDoc doc -> String -> SDoc forall doc. IsLine doc => String -> doc text String "%" SDoc -> SDoc -> SDoc forall doc. IsLine doc => doc -> doc -> doc <> SDoc doc SDoc -> SDoc -> SDoc forall doc. IsLine doc => doc -> doc -> doc <+> SDoc arrow | Bool otherwise = TyCon -> SDoc forall a. Outputable a => a -> SDoc ppr (FunTyFlag -> TyCon funTyFlagTyCon FunTyFlag af) -- | In Core, without `-dlinear-core-lint`, some function must ignore -- multiplicities. See Note [Linting linearity] in GHC.Core.Lint. data MultiplicityFlag = RespectMultiplicities | IgnoreMultiplicities