From 2c21457be3d20b67d420d335d31d4e6109763009 Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Fri, 2 Sep 2022 08:02:54 +0200 Subject: [PATCH 1/4] Added LICENSE and NOTICE files --- LICENSE | 176 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ NOTICE | 14 +++++ 2 files changed, 190 insertions(+) create mode 100644 LICENSE create mode 100644 NOTICE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..d9a10c0d --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/NOTICE b/NOTICE new file mode 100644 index 00000000..f3a42c2d --- /dev/null +++ b/NOTICE @@ -0,0 +1,14 @@ +Copyright 2022 Input Output (Hong Kong) Ltd. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + From 7dd2073e170f8d656e6706ca6fa9823d32312817 Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Fri, 2 Sep 2022 08:21:56 +0200 Subject: [PATCH 2/4] Added CONTRIBUTING.md document --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..2ca49ac2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to io-sim + +We designed `io-classes` to be as close as possible to what `base` package +provides. Almost all `IO` instances instantiate with api provided by one of +the core packages, see +[example](https://github.com/input-output-hk/io-sim/blob/main/io-classes/src/Control/Monad/Class/MonadSTM.hs?plain=1#L410-L446). +Please keep this in mind when adding new functionality. + +## Style Guide + +Please follow the [style guide][style-guide]. + +## Pull Request + +Ideally the series of commits you want to include should be written with the +reviewer in mind. This will make it easier for the maintainers to review your +changes. Each commit should heave a clear explanation what it changes and most +importantly why the changes are necessary. We prefer if commits are small and +just introduce a single change. For example if you are adding a new typeclass +in `io-classes` and you want `io-sim` and `io-sim-por` to support it, we'd +expect at least three commits: first which introduces the new type class, and +separate commits which add implement it for `IOSim` and `IOSimPOR`, since both +are using the same free monad, just interpret it differently, it's ok to first +implement it for `IOSim` and leave placeholders in the `IOSimPOR` interpreter. + +If you are adding a new functionality to `MonadSTM`, don't forget to support it +in `strict-stm` package. + +Please also include your changes in `CHANGELOG.md` file. + + +[style-guide]: https://github.com/input-output-hk/ouroboros-network/blob/master/docs/StyleGuide.md + From 4f6c205834c51ca155e8defbd38c675d93b99154 Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Fri, 2 Sep 2022 08:40:53 +0200 Subject: [PATCH 3/4] Early support for GHC 9.4.2 We still need: * cborg * serialise which support 9.4.2. Both are addressed in https://github.com/well-typed/cborg/pull/298 --- cabal.project | 2 +- io-classes/io-classes.cabal | 6 +++--- io-classes/src/Control/Monad/Class/MonadMVar.hs | 1 + io-classes/src/Control/Monad/Class/MonadSTM.hs | 2 ++ io-sim/io-sim.cabal | 6 +++--- io-sim/src/Control/Monad/IOSim/Internal.hs | 10 +++++----- io-sim/src/Control/Monad/IOSimPOR/Internal.hs | 10 +++++----- strict-stm/src/Control/Monad/Class/MonadSTM/Strict.hs | 1 + strict-stm/strict-stm.cabal | 3 ++- 9 files changed, 23 insertions(+), 18 deletions(-) diff --git a/cabal.project b/cabal.project index 7dc8de1f..147827dd 100644 --- a/cabal.project +++ b/cabal.project @@ -1,4 +1,4 @@ -index-state: 2022-02-18T00:00:00Z +index-state: 2022-09-01T00:00:00Z packages: ./io-sim ./io-classes diff --git a/io-classes/io-classes.cabal b/io-classes/io-classes.cabal index d8ea8eb6..fd93f9f1 100644 --- a/io-classes/io-classes.cabal +++ b/io-classes/io-classes.cabal @@ -51,13 +51,13 @@ library FlexibleContexts ScopedTypeVariables RankNTypes - build-depends: base >=4.9 && <4.17, + build-depends: base >=4.9 && <4.18, async >=2.1, bytestring, deque, - mtl >=2.2 && <2.3, + mtl >=2.2 && <2.4, stm >=2.5 && <2.6, - time >=1.9.1 && <1.11 + time >=1.9.1 && <1.13 ghc-options: -Wall -Wno-unticked-promoted-constructors -Wcompat diff --git a/io-classes/src/Control/Monad/Class/MonadMVar.hs b/io-classes/src/Control/Monad/Class/MonadMVar.hs index a9cbec46..339d4095 100644 --- a/io-classes/src/Control/Monad/Class/MonadMVar.hs +++ b/io-classes/src/Control/Monad/Class/MonadMVar.hs @@ -1,6 +1,7 @@ {-# LANGUAGE DefaultSignatures #-} {-# LANGUAGE QuantifiedConstraints #-} {-# LANGUAGE TypeFamilyDependencies #-} +{-# LANGUAGE TypeOperators #-} module Control.Monad.Class.MonadMVar ( MonadMVar (..) diff --git a/io-classes/src/Control/Monad/Class/MonadSTM.hs b/io-classes/src/Control/Monad/Class/MonadSTM.hs index 8a043295..73650d2d 100644 --- a/io-classes/src/Control/Monad/Class/MonadSTM.hs +++ b/io-classes/src/Control/Monad/Class/MonadSTM.hs @@ -12,9 +12,11 @@ {-# LANGUAGE StandaloneDeriving #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeFamilyDependencies #-} +{-# LANGUAGE TypeOperators #-} -- undecidable instances needed for 'WrappedSTM' instances of 'MonadThrow' and -- 'MonadCatch' type classes. {-# LANGUAGE UndecidableInstances #-} + module Control.Monad.Class.MonadSTM ( MonadSTM (..) , MonadLabelledSTM (..) diff --git a/io-sim/io-sim.cabal b/io-sim/io-sim.cabal index 255e4503..eea762bc 100644 --- a/io-sim/io-sim.cabal +++ b/io-sim/io-sim.cabal @@ -49,7 +49,7 @@ library RankNTypes, ScopedTypeVariables, TypeFamilies - build-depends: base >=4.9 && <4.17, + build-depends: base >=4.9 && <4.18, io-classes >=0.2 && <0.3, exceptions >=0.10, containers, @@ -58,7 +58,7 @@ library pretty-simple, psqueues >=0.2 && <0.3, text, - time >=1.9.1 && <1.11, + time >=1.9.1 && <1.13, quiet, QuickCheck, syb @@ -94,7 +94,7 @@ test-suite test tasty, tasty-quickcheck, tasty-hunit, - time >= 1.9.1 + time ghc-options: -Wall -fno-ignore-asserts diff --git a/io-sim/src/Control/Monad/IOSim/Internal.hs b/io-sim/src/Control/Monad/IOSim/Internal.hs index f5c684be..1cd80178 100644 --- a/io-sim/src/Control/Monad/IOSim/Internal.hs +++ b/io-sim/src/Control/Monad/IOSim/Internal.hs @@ -1046,17 +1046,17 @@ saveTVar TVar{tvarCurrent, tvarUndo} = do revertTVar :: TVar s a -> ST s () revertTVar TVar{tvarCurrent, tvarUndo} = do -- pop the undo stack, and revert the current value - (v:vs) <- readSTRef tvarUndo - !_ <- writeSTRef tvarCurrent v - !_ <- writeSTRef tvarUndo vs + vs <- readSTRef tvarUndo + !_ <- writeSTRef tvarCurrent (head vs) + !_ <- writeSTRef tvarUndo (tail vs) return () {-# INLINE revertTVar #-} commitTVar :: TVar s a -> ST s () commitTVar TVar{tvarUndo} = do + vs <- readSTRef tvarUndo -- pop the undo stack, leaving the current value unchanged - (_:vs) <- readSTRef tvarUndo - !_ <- writeSTRef tvarUndo vs + !_ <- writeSTRef tvarUndo (tail vs) return () {-# INLINE commitTVar #-} diff --git a/io-sim/src/Control/Monad/IOSimPOR/Internal.hs b/io-sim/src/Control/Monad/IOSimPOR/Internal.hs index 18894af2..df8dd3ac 100644 --- a/io-sim/src/Control/Monad/IOSimPOR/Internal.hs +++ b/io-sim/src/Control/Monad/IOSimPOR/Internal.hs @@ -1264,16 +1264,16 @@ saveTVar TVar{tvarCurrent, tvarUndo} = do revertTVar :: TVar s a -> ST s () revertTVar TVar{tvarCurrent, tvarUndo} = do -- pop the undo stack, and revert the current value - (v:vs) <- readSTRef tvarUndo - writeSTRef tvarCurrent v - writeSTRef tvarUndo vs + vs <- readSTRef tvarUndo + writeSTRef tvarCurrent (head vs) + writeSTRef tvarUndo (tail vs) {-# INLINE revertTVar #-} commitTVar :: TVar s a -> ST s () commitTVar TVar{tvarUndo} = do + vs <- readSTRef tvarUndo -- pop the undo stack, leaving the current value unchanged - (_:vs) <- readSTRef tvarUndo - writeSTRef tvarUndo vs + writeSTRef tvarUndo (tail vs) {-# INLINE commitTVar #-} readTVarUndos :: TVar s a -> ST s [a] diff --git a/strict-stm/src/Control/Monad/Class/MonadSTM/Strict.hs b/strict-stm/src/Control/Monad/Class/MonadSTM/Strict.hs index 1ca8c07e..022c60e5 100644 --- a/strict-stm/src/Control/Monad/Class/MonadSTM/Strict.hs +++ b/strict-stm/src/Control/Monad/Class/MonadSTM/Strict.hs @@ -4,6 +4,7 @@ {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} -- to preserve 'HasCallstack' constraint on 'checkInvariant' {-# OPTIONS_GHC -Wno-redundant-constraints #-} diff --git a/strict-stm/strict-stm.cabal b/strict-stm/strict-stm.cabal index 3790726a..04285bdf 100644 --- a/strict-stm/strict-stm.cabal +++ b/strict-stm/strict-stm.cabal @@ -14,6 +14,7 @@ maintainer: category: Control build-type: Simple cabal-version: >=1.10 +tested-with: GHC == 8.10.7, GHC == 9.2.2 source-repository head type: git @@ -35,7 +36,7 @@ library exposed-modules: Control.Monad.Class.MonadSTM.Strict default-language: Haskell2010 - build-depends: base >=4.9 && <4.17, + build-depends: base >=4.9 && <4.18, stm >=2.5 && <2.6, io-classes ghc-options: -Wall From 203d6847d8b85d78a6478cb90b099fdf64144d6d Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Fri, 2 Sep 2022 10:02:31 +0200 Subject: [PATCH 4/4] Use GHC 9.2.4 in CI --- .github/workflows/haskell.yml | 2 +- io-classes/io-classes.cabal | 2 +- io-sim/bench/Main.hs | 2 +- io-sim/io-sim.cabal | 2 +- strict-stm/strict-stm.cabal | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml index 16d0ed9d..0f80b133 100644 --- a/.github/workflows/haskell.yml +++ b/.github/workflows/haskell.yml @@ -9,7 +9,7 @@ jobs: strategy: fail-fast: false matrix: - ghc: ["8.10.7", "9.2.2"] + ghc: ["8.10.7", "9.2.4"] os: [ubuntu-latest, macos-latest, windows-latest] defaults: diff --git a/io-classes/io-classes.cabal b/io-classes/io-classes.cabal index fd93f9f1..d528d672 100644 --- a/io-classes/io-classes.cabal +++ b/io-classes/io-classes.cabal @@ -12,7 +12,7 @@ maintainer: category: Control build-type: Simple cabal-version: >=1.10 -tested-with: GHC == 8.10.7, GHC == 9.2.2 +tested-with: GHC == 8.10.7, GHC == 9.2.4 source-repository head type: git diff --git a/io-sim/bench/Main.hs b/io-sim/bench/Main.hs index ee0bc9f5..729b2332 100644 --- a/io-sim/bench/Main.hs +++ b/io-sim/bench/Main.hs @@ -30,7 +30,7 @@ import Network.TypedProtocol.PingPong.Server import Network.TypedProtocol.PingPong.Type -prop_channel :: forall m. (MonadSTM m, MonadAsync m, MonadCatch m, MonadTimer m) +prop_channel :: forall m. (MonadAsync m, MonadCatch m, MonadTimer m) => Maybe (DiffTime, DiffTime) -> Int -> Tracer m (Role, TraceSendRecv PingPong) diff --git a/io-sim/io-sim.cabal b/io-sim/io-sim.cabal index eea762bc..96ee8707 100644 --- a/io-sim/io-sim.cabal +++ b/io-sim/io-sim.cabal @@ -12,7 +12,7 @@ author: Duncan Coutts, Marcin Szamotulski, Alexander Vieth maintainer: category: Testing build-type: Simple -tested-with: GHC == 8.10.7, GHC == 9.2.2 +tested-with: GHC == 8.10.7, GHC == 9.2.4 flag asserts description: Enable assertions diff --git a/strict-stm/strict-stm.cabal b/strict-stm/strict-stm.cabal index 04285bdf..653aeb9b 100644 --- a/strict-stm/strict-stm.cabal +++ b/strict-stm/strict-stm.cabal @@ -14,7 +14,7 @@ maintainer: category: Control build-type: Simple cabal-version: >=1.10 -tested-with: GHC == 8.10.7, GHC == 9.2.2 +tested-with: GHC == 8.10.7, GHC == 9.2.4 source-repository head type: git