stm 2.4.5.0 → 2.4.5.1

raw patch · 4 files changed

+41/−26 lines, 4 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

Control/Concurrent/STM/TBQueue.hs +22/−20
Control/Concurrent/STM/TQueue.hs +3/−3
changelog.md +7/−0
stm.cabal +9/−3

Control/Concurrent/STM/TBQueue.hs view

@@ -52,14 +52,15 @@ -- -- @since 2.4 data TBQueue a-   = TBQueue _UPK_(TVar Int)  -- CR: read capacity-             _UPK_(TVar [a])  -- R:  elements waiting to be read-             _UPK_(TVar Int)  -- CW: write capacity-             _UPK_(TVar [a])  -- W:  elements written (head is most recent)+   = TBQueue _UPK_(TVar Int)  -- CR:  read capacity+             _UPK_(TVar [a])  -- R:   elements waiting to be read+             _UPK_(TVar Int)  -- CW:  write capacity+             _UPK_(TVar [a])  -- W:   elements written (head is most recent)+             _UPK_(Int)       -- CAP: initial capacity   deriving Typeable  instance Eq (TBQueue a) where-  TBQueue a _ _ _ == TBQueue b _ _ _ = a == b+  TBQueue a _ _ _ _ == TBQueue b _ _ _ _ = a == b  -- Total channel capacity remaining is CR + CW. Reads only need to -- access CR, writes usually need to access only CW but sometimes need@@ -83,7 +84,7 @@   write <- newTVar []   rsize <- newTVar 0   wsize <- newTVar size-  return (TBQueue rsize read wsize write)+  return (TBQueue rsize read wsize write size)  -- |@IO@ version of 'newTBQueue'.  This is useful for creating top-level -- 'TBQueue's using 'System.IO.Unsafe.unsafePerformIO', because using@@ -95,11 +96,11 @@   write <- newTVarIO []   rsize <- newTVarIO 0   wsize <- newTVarIO size-  return (TBQueue rsize read wsize write)+  return (TBQueue rsize read wsize write size)  -- |Write a value to a 'TBQueue'; blocks if the queue is full. writeTBQueue :: TBQueue a -> a -> STM ()-writeTBQueue (TBQueue rsize _read wsize write) a = do+writeTBQueue (TBQueue rsize _read wsize write _size) a = do   w <- readTVar wsize   if (w /= 0)      then do writeTVar wsize $! w - 1@@ -114,7 +115,7 @@  -- |Read the next value from the 'TBQueue'. readTBQueue :: TBQueue a -> STM a-readTBQueue (TBQueue rsize read _wsize write) = do+readTBQueue (TBQueue rsize read _wsize write _size) = do   xs <- readTVar read   r <- readTVar rsize   writeTVar rsize $! r + 1@@ -143,16 +144,17 @@ -- -- @since 2.4.5 flushTBQueue :: TBQueue a -> STM [a]-flushTBQueue (TBQueue rsize read wsize write) = do+flushTBQueue (TBQueue rsize read wsize write size) = do   xs <- readTVar read   ys <- readTVar write-  r <- readTVar rsize-  w <- readTVar wsize-  writeTVar read []-  writeTVar write []-  writeTVar rsize 0-  writeTVar wsize (r + w)-  return (xs ++ reverse ys)+  if null xs && null ys+    then return []+    else do+      writeTVar read []+      writeTVar write []+      writeTVar rsize 0+      writeTVar wsize size+      return (xs ++ reverse ys)  -- | Get the next value from the @TBQueue@ without removing it, -- retrying if the channel is empty.@@ -176,7 +178,7 @@ -- |Put a data item back onto a channel, where it will be the next item read. -- Blocks if the queue is full. unGetTBQueue :: TBQueue a -> a -> STM ()-unGetTBQueue (TBQueue rsize read wsize _write) a = do+unGetTBQueue (TBQueue rsize read wsize _write _size) a = do   r <- readTVar rsize   if (r > 0)      then do writeTVar rsize $! r - 1@@ -190,7 +192,7 @@  -- |Returns 'True' if the supplied 'TBQueue' is empty. isEmptyTBQueue :: TBQueue a -> STM Bool-isEmptyTBQueue (TBQueue _rsize read _wsize write) = do+isEmptyTBQueue (TBQueue _rsize read _wsize write _size) = do   xs <- readTVar read   case xs of     (_:_) -> return False@@ -203,7 +205,7 @@ -- -- @since 2.4.3 isFullTBQueue :: TBQueue a -> STM Bool-isFullTBQueue (TBQueue rsize _read wsize _write) = do+isFullTBQueue (TBQueue rsize _read wsize _write _size) = do   w <- readTVar wsize   if (w > 0)      then return False

Control/Concurrent/STM/TQueue.hs view

@@ -47,7 +47,7 @@   ) where  import GHC.Conc-+import Control.Monad (unless) import Data.Typeable (Typeable)  -- | 'TQueue' is an abstract type representing an unbounded FIFO channel.@@ -115,8 +115,8 @@ flushTQueue (TQueue read write) = do   xs <- readTVar read   ys <- readTVar write-  writeTVar read []-  writeTVar write []+  unless (null xs) $ writeTVar read []+  unless (null ys) $ writeTVar write []   return (xs ++ reverse ys)  -- | Get the next value from the @TQueue@ without removing it,

changelog.md view

@@ -1,5 +1,12 @@ # Changelog for [`stm` package](http://hackage.haskell.org/package/stm) +## 2.4.5.1 *Sep 2018*++  * Fix incorrect bookkeeping of write capacity in `flushTBQueue` (gh-9)++  * Avoid redundant `writeTVar`s in `flushTQueue` to avoid unncessarily+    invalidating other transactions (gh-6)+ ## 2.4.5.0 *Feb 2018*    * Fix space leak in `TBQueue` (gh-2, GHC#14494)

stm.cabal view

@@ -1,6 +1,8 @@+cabal-version:  >=1.10 name:           stm-version:        2.4.5.0--- don't forget to update changelog.md file!+version:        2.4.5.1+-- don't forget to update changelog.md file & source-repo tag!+ license:        BSD3 license-file:   LICENSE maintainer:     libraries@haskell.org@@ -9,7 +11,6 @@ synopsis:       Software Transactional Memory category:       Concurrency build-type:     Simple-cabal-version:  >=1.10 tested-with:    GHC==7.10.*, GHC==7.8.*, GHC==7.6.*, GHC==7.4.*, GHC==7.2.*, GHC==7.0.* description:     Software Transactional Memory, or STM, is an abstraction for@@ -27,6 +28,11 @@ source-repository head     type:     git     location: https://github.com/haskell/stm.git++source-repository this+    type:     git+    location: https://github.com/haskell/stm.git+    tag:      v2.4.5.1  library     default-language: Haskell2010