Skip to content

Commit f69ff16

Browse files
jorisdraljorisdral
committed
Extract a blockio package from lsm-tree 
1 parent 5622d5d commit f69ff16

File tree

23 files changed

+424
-132
lines changed

23 files changed

+424
-132
lines changed

‎blockio/CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Revision history for blockio
2+
3+
## 0.1.0.0 -- YYYY-mm-dd
4+
5+
* First version. Released on an unsuspecting world.

‎blockio/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎blockio/NOTICE

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright 2023 Input Output Global Inc (IOG), INTERSECT 2023-2024.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

‎blockio/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# blockio
2+
3+
TODO

‎blockio/blockio.cabal

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
cabal-version: 3.4
2+
name: blockio
3+
version: 0.1.0.0
4+
synopsis: Abstract interface for batched, asynchronous I/O
5+
description: Abstract interface for batched, asynchronous I/O.
6+
license: Apache-2.0
7+
license-files:
8+
LICENSE
9+
NOTICE
10+
11+
author: Duncan Coutts, Joris Dral, Matthias Heinzel
12+
maintainer: Duncan Coutts, Joris Dral, Matthias Heinzel
13+
copyright: 2023 Input Output Global Inc (IOG), INTERSECT 2023-2024
14+
category: System
15+
build-type: Simple
16+
extra-doc-files: CHANGELOG.md
17+
extra-source-files: README.md
18+
tested-with:
19+
GHC ==8.10 || ==9.2 || ==9.4 || ==9.6 || ==9.8 || ==9.10 || ==9.12
20+
21+
source-repository head
22+
type: git
23+
location: https://github.com/IntersectMBO/lsm-tree
24+
subdir: blockio
25+
26+
-- TODO: this tag obviously does not exist yet because the package has not
27+
-- been published
28+
source-repository this
29+
type: git
30+
location: https://github.com/IntersectMBO/lsm-tree
31+
tag: blockio-0.1.0.0
32+
subdir: blockio
33+
34+
common warnings
35+
ghc-options:
36+
-Wall -Wcompat -Wincomplete-uni-patterns
37+
-Wincomplete-record-updates -Wpartial-fields -Widentities
38+
-Wredundant-constraints -Wmissing-export-lists
39+
-Wno-unticked-promoted-constructors -Wunused-packages
40+
41+
ghc-options: -Werror=missing-deriving-strategies
42+
43+
common language
44+
default-language: Haskell2010
45+
46+
flag serialblockio
47+
description: Use serial HasBlockIO regardless of the operating system
48+
default: False
49+
manual: True
50+
51+
library
52+
import: language, warnings
53+
hs-source-dirs: src
54+
exposed-modules:
55+
System.FS.BlockIO.API
56+
System.FS.BlockIO.IO
57+
System.FS.BlockIO.Serial
58+
59+
build-depends:
60+
, base >=4.14 && <4.22
61+
, deepseq ^>=1.4 || ^>=1.5
62+
, fs-api ^>=0.3
63+
, io-classes ^>=1.6 || ^>=1.7
64+
, primitive ^>=0.9
65+
, vector ^>=0.13
66+
67+
if os(linux)
68+
hs-source-dirs: src-linux
69+
other-modules: System.FS.BlockIO.Internal
70+
build-depends:
71+
, blockio:fcntl-nocache
72+
, unix ^>=2.8
73+
74+
if !flag(serialblockio)
75+
other-modules: System.FS.BlockIO.Async
76+
build-depends: blockio-uring ^>=0.1
77+
78+
elif os(osx)
79+
hs-source-dirs: src-macos
80+
build-depends:
81+
, blockio:fcntl-nocache
82+
, unix ^>=2.8
83+
84+
other-modules: System.FS.BlockIO.Internal
85+
86+
elif os(windows)
87+
hs-source-dirs: src-windows
88+
build-depends: Win32 ^>=2.14
89+
other-modules: System.FS.BlockIO.Internal
90+
91+
if flag(serialblockio)
92+
cpp-options: -DSERIALBLOCKIO
93+
94+
library fcntl-nocache
95+
import: language, warnings
96+
visibility: private
97+
hs-source-dirs: src-fcntl-nocache
98+
99+
if !os(windows)
100+
exposed-modules: System.Posix.Fcntl.NoCache
101+
build-depends: base <5
102+
build-tool-depends: hsc2hs:hsc2hs
103+
104+
test-suite test
105+
import: language, warnings
106+
type: exitcode-stdio-1.0
107+
hs-source-dirs: test
108+
main-is: Main.hs
109+
other-modules: Test.System.Posix.Fcntl.NoCache
110+
build-depends:
111+
, async
112+
, base >=4.14 && <4.22
113+
, blockio
114+
, bytestring
115+
, fs-api
116+
, primitive
117+
, QuickCheck ^>=2.15.0.1
118+
, tasty
119+
, tasty-hunit
120+
, tasty-quickcheck
121+
, temporary
122+
, vector
123+
124+
if !os(windows)
125+
build-depends: blockio:fcntl-nocache
126+
127+
ghc-options: -threaded
128+
129+
library sim
130+
import: language, warnings
131+
visibility: public
132+
hs-source-dirs: src-sim
133+
exposed-modules: System.FS.BlockIO.Sim
134+
build-depends:
135+
, base >=4.14 && <4.22
136+
, blockio
137+
, bytestring ^>=0.11.4.0 || ^>=0.12.1.0
138+
, fs-api ^>=0.3
139+
, fs-sim ^>=0.3
140+
, io-classes ^>=1.6 || ^>=1.7
141+
, io-classes:strict-stm
142+
, primitive ^>=0.9
143+
144+
test-suite test-sim
145+
import: language, warnings
146+
type: exitcode-stdio-1.0
147+
hs-source-dirs: test-sim
148+
main-is: Main.hs
149+
build-depends:
150+
, base >=4.14 && <4.22
151+
, blockio
152+
, blockio:sim
153+
, fs-api
154+
, fs-sim
155+
, io-classes:strict-stm
156+
, QuickCheck
157+
, tasty
158+
, tasty-quickcheck

‎src-fcntl-nocache/System/Posix/Fcntl/NoCache.hsc renamed to ‎blockio/src-fcntl-nocache/System/Posix/Fcntl/NoCache.hsc

File renamed without changes.

‎blockio-api/src-linux/System/FS/BlockIO/Async.hs renamed to ‎blockio/src-linux/System/FS/BlockIO/Async.hs

File renamed without changes.

‎blockio-api/src-linux/System/FS/BlockIO/Internal.hs renamed to ‎blockio/src-linux/System/FS/BlockIO/Internal.hs

File renamed without changes.

‎blockio-api/src-macos/System/FS/BlockIO/Internal.hs renamed to ‎blockio/src-macos/System/FS/BlockIO/Internal.hs

File renamed without changes.

‎blockio-sim/src/System/FS/BlockIO/Sim.hs renamed to ‎blockio/src-sim/System/FS/BlockIO/Sim.hs

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
{-# LANGUAGE NamedFieldPuns #-}
2+
{-# LANGUAGE RankNTypes #-}
3+
{-# LANGUAGE ScopedTypeVariables #-}
4+
15
module System.FS.BlockIO.Sim (
26
fromHasFS
37
-- * Initialisation helpers

‎blockio-api/src-windows/System/FS/BlockIO/Internal.hs renamed to ‎blockio/src-windows/System/FS/BlockIO/Internal.hs

File renamed without changes.

0 commit comments

Comments
 (0)