-- | Breakpoint related types
module GHC.Types.Breakpoint
  ( BreakpointId (..)
  , InternalBreakpointId (..)
  , toBreakpointId
  )
where

import GHC.Prelude
import GHC.Unit.Module

-- | Breakpoint identifier.
--
-- See Note [Breakpoint identifiers]
data BreakpointId = BreakpointId
  { BreakpointId -> Module
bi_tick_mod   :: !Module  -- ^ Breakpoint tick module
  , BreakpointId -> Int
bi_tick_index :: !Int     -- ^ Breakpoint tick index
  }
  deriving (BreakpointId -> BreakpointId -> Bool
(BreakpointId -> BreakpointId -> Bool)
-> (BreakpointId -> BreakpointId -> Bool) -> Eq BreakpointId
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: BreakpointId -> BreakpointId -> Bool
== :: BreakpointId -> BreakpointId -> Bool
$c/= :: BreakpointId -> BreakpointId -> Bool
/= :: BreakpointId -> BreakpointId -> Bool
Eq, Eq BreakpointId
Eq BreakpointId =>
(BreakpointId -> BreakpointId -> Ordering)
-> (BreakpointId -> BreakpointId -> Bool)
-> (BreakpointId -> BreakpointId -> Bool)
-> (BreakpointId -> BreakpointId -> Bool)
-> (BreakpointId -> BreakpointId -> Bool)
-> (BreakpointId -> BreakpointId -> BreakpointId)
-> (BreakpointId -> BreakpointId -> BreakpointId)
-> Ord BreakpointId
BreakpointId -> BreakpointId -> Bool
BreakpointId -> BreakpointId -> Ordering
BreakpointId -> BreakpointId -> BreakpointId
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: BreakpointId -> BreakpointId -> Ordering
compare :: BreakpointId -> BreakpointId -> Ordering
$c< :: BreakpointId -> BreakpointId -> Bool
< :: BreakpointId -> BreakpointId -> Bool
$c<= :: BreakpointId -> BreakpointId -> Bool
<= :: BreakpointId -> BreakpointId -> Bool
$c> :: BreakpointId -> BreakpointId -> Bool
> :: BreakpointId -> BreakpointId -> Bool
$c>= :: BreakpointId -> BreakpointId -> Bool
>= :: BreakpointId -> BreakpointId -> Bool
$cmax :: BreakpointId -> BreakpointId -> BreakpointId
max :: BreakpointId -> BreakpointId -> BreakpointId
$cmin :: BreakpointId -> BreakpointId -> BreakpointId
min :: BreakpointId -> BreakpointId -> BreakpointId
Ord)

-- | Internal breakpoint identifier
--
-- See Note [Breakpoint identifiers]
data InternalBreakpointId = InternalBreakpointId
  { InternalBreakpointId -> Module
ibi_tick_mod   :: !Module  -- ^ Breakpoint tick module
  , InternalBreakpointId -> Int
ibi_tick_index :: !Int     -- ^ Breakpoint tick index
  , InternalBreakpointId -> Module
ibi_info_mod   :: !Module  -- ^ Breakpoint info module
  , InternalBreakpointId -> Int
ibi_info_index :: !Int     -- ^ Breakpoint info index
  }
  deriving (InternalBreakpointId -> InternalBreakpointId -> Bool
(InternalBreakpointId -> InternalBreakpointId -> Bool)
-> (InternalBreakpointId -> InternalBreakpointId -> Bool)
-> Eq InternalBreakpointId
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: InternalBreakpointId -> InternalBreakpointId -> Bool
== :: InternalBreakpointId -> InternalBreakpointId -> Bool
$c/= :: InternalBreakpointId -> InternalBreakpointId -> Bool
/= :: InternalBreakpointId -> InternalBreakpointId -> Bool
Eq, Eq InternalBreakpointId
Eq InternalBreakpointId =>
(InternalBreakpointId -> InternalBreakpointId -> Ordering)
-> (InternalBreakpointId -> InternalBreakpointId -> Bool)
-> (InternalBreakpointId -> InternalBreakpointId -> Bool)
-> (InternalBreakpointId -> InternalBreakpointId -> Bool)
-> (InternalBreakpointId -> InternalBreakpointId -> Bool)
-> (InternalBreakpointId
    -> InternalBreakpointId -> InternalBreakpointId)
-> (InternalBreakpointId
    -> InternalBreakpointId -> InternalBreakpointId)
-> Ord InternalBreakpointId
InternalBreakpointId -> InternalBreakpointId -> Bool
InternalBreakpointId -> InternalBreakpointId -> Ordering
InternalBreakpointId
-> InternalBreakpointId -> InternalBreakpointId
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: InternalBreakpointId -> InternalBreakpointId -> Ordering
compare :: InternalBreakpointId -> InternalBreakpointId -> Ordering
$c< :: InternalBreakpointId -> InternalBreakpointId -> Bool
< :: InternalBreakpointId -> InternalBreakpointId -> Bool
$c<= :: InternalBreakpointId -> InternalBreakpointId -> Bool
<= :: InternalBreakpointId -> InternalBreakpointId -> Bool
$c> :: InternalBreakpointId -> InternalBreakpointId -> Bool
> :: InternalBreakpointId -> InternalBreakpointId -> Bool
$c>= :: InternalBreakpointId -> InternalBreakpointId -> Bool
>= :: InternalBreakpointId -> InternalBreakpointId -> Bool
$cmax :: InternalBreakpointId
-> InternalBreakpointId -> InternalBreakpointId
max :: InternalBreakpointId
-> InternalBreakpointId -> InternalBreakpointId
$cmin :: InternalBreakpointId
-> InternalBreakpointId -> InternalBreakpointId
min :: InternalBreakpointId
-> InternalBreakpointId -> InternalBreakpointId
Ord)

toBreakpointId :: InternalBreakpointId -> BreakpointId
toBreakpointId :: InternalBreakpointId -> BreakpointId
toBreakpointId InternalBreakpointId
ibi = BreakpointId
  { bi_tick_mod :: Module
bi_tick_mod   = InternalBreakpointId -> Module
ibi_tick_mod InternalBreakpointId
ibi
  , bi_tick_index :: Int
bi_tick_index = InternalBreakpointId -> Int
ibi_tick_index InternalBreakpointId
ibi
  }


-- Note [Breakpoint identifiers]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- Before optimization a breakpoint is identified uniquely with a tick module
-- and a tick index. See BreakpointId. A tick module contains an array, indexed
-- with the tick indexes, which indicates breakpoint status.
--
-- When we generate ByteCode, we collect information for every breakpoint at
-- their *occurrence sites* (see CgBreakInfo in GHC.ByteCode.Types) and these info
-- are stored in the ModIface of the occurrence module. Because of inlining, we
-- can't reuse the tick index to uniquely identify an occurrence; because of
-- cross-module inlining, we can't assume that the occurrence module is the same
-- as the tick module (#24712).
--
-- So every breakpoint occurrence gets assigned a module-unique *info index* and
-- we store it alongside the occurrence module (*info module*) in the
-- InternalBreakpointId datatype.