Hoogle Search

Within LTS Haskell 24.67 (ghc-9.10.3)

Note that Stackage only displays results for the latest LTS and Nightly snapshot. Learn more.

  1. disableAllocationLimit :: IO ()

    base GHC.Conc.Sync

    Disable allocation limit processing for the current thread.

  2. enableAllocationLimit :: IO ()

    base GHC.Conc.Sync

    Enables the allocation counter to be treated as a limit for the current thread. When the allocation limit is enabled, if the allocation counter counts down below zero, the thread will be sent the AllocationLimitExceeded asynchronous exception. When this happens, the counter is reinitialised (by default to 100K, but tunable with the +RTS -xq option) so that it can handle the exception and perform any necessary clean up. If it exhausts this additional allowance, another AllocationLimitExceeded exception is sent, and so forth. Like other asynchronous exceptions, the AllocationLimitExceeded exception is deferred while the thread is inside mask or an exception handler in catch. Note that memory allocation is unrelated to live memory, also known as heap residency. A thread can allocate a large amount of memory and retain anything between none and all of it. It is better to think of the allocation limit as a limit on CPU time, rather than a limit on memory. Compared to using timeouts, allocation limits don't count time spent blocked or in foreign calls.

  3. getAllocationCounter :: IO Int64

    base GHC.Conc.Sync

    Return the current value of the allocation counter for the current thread.

  4. setAllocationCounter :: Int64 -> IO ()

    base GHC.Conc.Sync

    Every thread has an allocation counter that tracks how much memory has been allocated by the thread. The counter is initialized to zero, and setAllocationCounter sets the current value. The allocation counter counts *down*, so in the absence of a call to setAllocationCounter its value is the negation of the number of bytes of memory allocated by the thread. There are two things that you can do with this counter:

    Allocation accounting is accurate only to about 4Kbytes.

  5. type IOCallback = FdKey -> Event -> IO ()

    base GHC.Event

    Callback invoked on I/O events.

  6. type TimeoutCallback = IO ()

    base GHC.Event

    Warning: since the TimeoutCallback is called from the I/O manager, it must not throw an exception or block for a long period of time. In particular, be wary of throwTo and killThread: if the target thread is making a foreign call, these functions will block until the call completes.

  7. type TimeoutCallback = IO ()

    base GHC.Event.TimeOut

    Warning: since the TimeoutCallback is called from the I/O manager, it must not throw an exception or block for a long period of time. In particular, be wary of throwTo and killThread: if the target thread is making a foreign call, these functions will block until the call completes.

  8. data CallStack

    base GHC.Exception

    CallStacks are a lightweight method of obtaining a partial call-stack at any point in the program. A function can request its call-site with the HasCallStack constraint. For example, we can define

    putStrLnWithCallStack :: HasCallStack => String -> IO ()
    
    as a variant of putStrLn that will get its call-site and print it, along with the string given as argument. We can access the call-stack inside putStrLnWithCallStack with callStack.
    >>> :{
    putStrLnWithCallStack :: HasCallStack => String -> IO ()
    putStrLnWithCallStack msg = do
    putStrLn msg
    putStrLn (prettyCallStack callStack)
    :}
    
    Thus, if we call putStrLnWithCallStack we will get a formatted call-stack alongside our string.
    >>> putStrLnWithCallStack "hello"
    hello
    CallStack (from HasCallStack):
    putStrLnWithCallStack, called at <interactive>:... in interactive:Ghci...
    
    GHC solves HasCallStack constraints in three steps:
    1. If there is a CallStack in scope -- i.e. the enclosing function has a HasCallStack constraint -- GHC will append the new call-site to the existing CallStack.
    2. If there is no CallStack in scope -- e.g. in the GHCi session above -- and the enclosing definition does not have an explicit type signature, GHC will infer a HasCallStack constraint for the enclosing definition (subject to the monomorphism restriction).
    3. If there is no CallStack in scope and the enclosing definition has an explicit type signature, GHC will solve the HasCallStack constraint for the singleton CallStack containing just the current call-site.
    CallStacks do not interact with the RTS and do not require compilation with -prof. On the other hand, as they are built up explicitly via the HasCallStack constraints, they will generally not contain as much information as the simulated call-stacks maintained by the RTS. A CallStack is a [(String, SrcLoc)]. The String is the name of function that was called, the SrcLoc is the call-site. The list is ordered with the most recently called function at the head. NOTE: The intrepid user may notice that HasCallStack is just an alias for an implicit parameter ?callStack :: CallStack. This is an implementation detail and should not be considered part of the CallStack API, we may decide to change the implementation in the future.

  9. data ErrorCall

    base GHC.Exception

    This is thrown when the user calls error. The first String is the argument given to error, second String is the location.

  10. pattern ErrorCall :: String -> ErrorCall

    base GHC.Exception

    No documentation available.

Page 185 of many | Previous | Next