Skip to content

Commit dcc02f3

Browse files
oleg-cherednikoleg-cherednik
committed
#20 Extract entries async
1 parent 41d6959 commit dcc02f3

File tree

14 files changed

+278
-117
lines changed

14 files changed

+278
-117
lines changed

‎src/main/java/ru/olegcherednik/zip4jvm/decompose/LocalFileHeaderDecompose.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -128,26 +128,27 @@ private void copyPayload(Path dir, ZipEntry zipEntry, ZipEntryBlock.LocalFileHea
128128

129129
Block content = diagLocalFileHeader.getContent();
130130
long size = zipEntry.getCompressedSize();
131-
long offs = content.getDiskOffs() + content.getSize();
131+
// TODO here we should use SrcZip methods
132+
long absOffs = content.getDiskOffs() + content.getSize();
132133

133134
EncryptionMethod encryptionMethod = zipEntry.getEncryptionMethod();
134135

135136
if (encryptionMethod.isAes()) {
136137
AesEncryptionHeaderBlock block = (AesEncryptionHeaderBlock) encryptionHeaderBlock;
137138

138-
offs += block.getSalt().getSize();
139-
offs += block.getPasswordChecksum().getSize();
139+
absOffs += block.getSalt().getSize();
140+
absOffs += block.getPasswordChecksum().getSize();
140141

141142
size -= block.getSalt().getSize();
142143
size -= block.getPasswordChecksum().getSize();
143144
size -= block.getMac().getSize();
144145
} else if (encryptionMethod == EncryptionMethod.PKWARE) {
145146
PkwareEncryptionHeaderBlock block = (PkwareEncryptionHeaderBlock) encryptionHeaderBlock;
146-
offs += block.getSize();
147+
absOffs += block.getSize();
147148
size -= block.getSize();
148149
}
149150

150-
Utils.copyLarge(blockModel.getZipModel(), dir.resolve("payload" + EXT_DATA), offs, size);
151+
Utils.copyLarge(blockModel.getZipModel(), dir.resolve("payload" + EXT_DATA), absOffs, absOffs, size);
151152
}
152153

153154
private EncryptionHeaderDecompose encryptionHeader(EncryptionMethod encryptionMethod,

‎src/main/java/ru/olegcherednik/zip4jvm/decompose/Utils.java

+6-14
Original file line numberDiff line numberDiff line change
@@ -50,30 +50,22 @@ public static void print(Path file, Consumer<PrintStream> consumer) throws FileN
5050
}
5151

5252
public static void copyLarge(ZipModel zipModel, Path out, Block block) throws IOException {
53-
copyLarge(zipModel, out, block.getDiskOffs(), block.getSize());
53+
copyLarge(zipModel, out, block.getDiskOffs(), block.getAbsOffs(), block.getSize());
5454
}
5555

56-
public static void copyLarge(ZipModel zipModel, Path out, long offs, long size) throws IOException {
57-
Path file = zipModel.getSrcZip().getDiskByAbsOffs(offs).getPath();
56+
public static void copyLarge(ZipModel zipModel, Path out, long diskOffs, long absOffs, long size)
57+
throws IOException {
58+
Path file = zipModel.getSrcZip().getDiskByAbsOffs(absOffs).getPath();
5859

5960
try (InputStream fis = Files.newInputStream(file);
6061
OutputStream fos = Files.newOutputStream(out)) {
61-
long skipBytes = fis.skip(offs);
62-
assert skipBytes == offs;
62+
long skipBytes = fis.skip(diskOffs);
63+
assert skipBytes == diskOffs;
6364

6465
IOUtils.copyLarge(fis, fos, 0, size);
6566
}
6667
}
6768

68-
public static void copyByteArray(Path out, byte[] buf, Block block) throws IOException {
69-
ValidationUtils.requireLessOrEqual(block.getAbsOffs(), Integer.MAX_VALUE, "block.absoluteOffs");
70-
ValidationUtils.requireLessOrEqual(block.getSize(), Integer.MAX_VALUE, "block.size");
71-
72-
try (OutputStream fos = Files.newOutputStream(out)) {
73-
fos.write(buf, (int) block.getAbsOffs(), (int) block.getSize());
74-
}
75-
}
76-
7769
public static void copyByteArray(Path out, byte[] buf) throws IOException {
7870
Files.write(out, buf);
7971
}

‎src/main/java/ru/olegcherednik/zip4jvm/engine/unzip/DataInputThreadLocal.java

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package ru.olegcherednik.zip4jvm.engine.unzip;
20+
21+
import ru.olegcherednik.zip4jvm.io.in.DataInput;
22+
23+
import lombok.RequiredArgsConstructor;
24+
import org.apache.commons.io.IOUtils;
25+
26+
import java.util.List;
27+
import java.util.concurrent.CopyOnWriteArrayList;
28+
import java.util.function.Supplier;
29+
30+
/**
31+
* @param <T> {@link DataInput} definition
32+
* @author Oleg Cherednik
33+
* @since 28.12.2024
34+
*/
35+
@RequiredArgsConstructor
36+
public class DataInputThreadLocal<T extends DataInput> extends ThreadLocal<T> {
37+
38+
private final Supplier<T> dataInputSup;
39+
private final List<T> dataInputs = new CopyOnWriteArrayList<>();
40+
41+
public void release() {
42+
dataInputs.forEach(IOUtils::closeQuietly);
43+
dataInputs.clear();
44+
}
45+
46+
// ---------- ThreadLocal ----------
47+
48+
@Override
49+
public T get() {
50+
T in = super.get();
51+
52+
if (in == null) {
53+
in = dataInputSup.get();
54+
set(in);
55+
dataInputs.add(in);
56+
}
57+
58+
return in;
59+
}
60+
61+
}

‎src/main/java/ru/olegcherednik/zip4jvm/engine/unzip/UnzipEngine.java

+15-5
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
import ru.olegcherednik.zip4jvm.model.password.PasswordProvider;
2929
import ru.olegcherednik.zip4jvm.model.settings.UnzipSettings;
3030
import ru.olegcherednik.zip4jvm.model.src.SrcZip;
31+
import ru.olegcherednik.zip4jvm.utils.quitely.Quietly;
3132

32-
import java.io.IOException;
3333
import java.nio.file.Path;
3434
import java.util.Collection;
3535
import java.util.Collections;
@@ -47,7 +47,17 @@ public final class UnzipEngine implements ZipFile.Reader {
4747
public UnzipEngine(SrcZip srcZip, UnzipSettings settings) {
4848
PasswordProvider passwordProvider = settings.getPasswordProvider();
4949
zipModel = ZipModelBuilder.read(srcZip, settings.getCharsetCustomizer(), passwordProvider);
50-
unzipExtractEngine = new UnzipExtractEngine(passwordProvider, zipModel);
50+
unzipExtractEngine = createUnzipExtractEngine(settings, zipModel);
51+
}
52+
53+
private static UnzipExtractEngine createUnzipExtractEngine(UnzipSettings settings, ZipModel zipModel) {
54+
PasswordProvider passwordProvider = settings.getPasswordProvider();
55+
56+
if (settings.getAsyncThreads() == UnzipSettings.ASYNC_THREADS_OFF)
57+
return new UnzipExtractEngine(passwordProvider, zipModel);
58+
59+
int totalThreads = settings.getAsyncThreads();
60+
return new UnzipExtractAsyncEngine(passwordProvider, zipModel, totalThreads);
5161
}
5262

5363
// ---------- ZipFile.Reader ----------
@@ -105,9 +115,9 @@ public ZipFile.Entry next() {
105115
};
106116
}
107117

108-
public static RandomAccessDataInput createRandomAccessDataInput(SrcZip srcZip) throws IOException {
109-
return srcZip.isSolid() ? new SolidRandomAccessDataInput(srcZip)
110-
: new SplitRandomAccessDataInput(srcZip);
118+
public static RandomAccessDataInput createRandomAccessDataInput(SrcZip srcZip) {
119+
return Quietly.doRuntime(() -> srcZip.isSolid() ? new SolidRandomAccessDataInput(srcZip)
120+
: new SplitRandomAccessDataInput(srcZip));
111121
}
112122

113123
}

‎src/main/java/ru/olegcherednik/zip4jvm/engine/unzip/UnzipExtractAsyncEngine.java

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package ru.olegcherednik.zip4jvm.engine.unzip;
20+
21+
import ru.olegcherednik.zip4jvm.io.in.file.consecutive.ConsecutiveAccessDataInput;
22+
import ru.olegcherednik.zip4jvm.model.ZipModel;
23+
import ru.olegcherednik.zip4jvm.model.entry.ZipEntry;
24+
import ru.olegcherednik.zip4jvm.model.password.PasswordProvider;
25+
import ru.olegcherednik.zip4jvm.utils.quitely.Quietly;
26+
import ru.olegcherednik.zip4jvm.utils.quitely.functions.RunnableWithException;
27+
28+
import java.nio.file.Path;
29+
import java.util.Iterator;
30+
import java.util.LinkedList;
31+
import java.util.List;
32+
import java.util.Map;
33+
import java.util.Optional;
34+
import java.util.concurrent.CompletableFuture;
35+
import java.util.concurrent.Executor;
36+
import java.util.concurrent.ExecutorService;
37+
import java.util.concurrent.ForkJoinPool;
38+
import java.util.concurrent.ForkJoinWorkerThread;
39+
import java.util.concurrent.atomic.AtomicInteger;
40+
41+
/**
42+
* @author Oleg Cherednik
43+
* @since 28.12.2024
44+
*/
45+
public class UnzipExtractAsyncEngine extends UnzipExtractEngine {
46+
47+
protected final int totalThreads;
48+
49+
public UnzipExtractAsyncEngine(PasswordProvider passwordProvider, ZipModel zipModel, int totalThreads) {
50+
super(passwordProvider, zipModel);
51+
this.totalThreads = totalThreads <= 0 ? Runtime.getRuntime().availableProcessors() : totalThreads;
52+
}
53+
54+
// ---------- UnzipExtractEngine ----------
55+
56+
@Override
57+
protected void extractEntry(Path dstDir, Map<String, String> map) {
58+
List<CompletableFuture<Void>> tasks = new LinkedList<>();
59+
Iterator<ZipEntry> it = zipModel.absOffsAscIterator();
60+
61+
DataInputThreadLocal<ConsecutiveAccessDataInput> threadLocalDataInput =
62+
new DataInputThreadLocal<>(this::createConsecutiveDataInput);
63+
ExecutorService executor = createExecutor();
64+
65+
try {
66+
while (it.hasNext()) {
67+
ZipEntry zipEntry = it.next();
68+
69+
if (map != null && !map.containsKey(zipEntry.getFileName()))
70+
continue;
71+
72+
String fileName = Optional.ofNullable(map)
73+
.map(m -> m.get(zipEntry.getFileName()))
74+
.orElse(zipEntry.getFileName());
75+
Path file = dstDir.resolve(fileName);
76+
77+
CompletableFuture<Void> task = createCompletableFuture(
78+
() -> extractEntry(file, zipEntry, threadLocalDataInput.get()), executor);
79+
80+
tasks.add(task);
81+
}
82+
83+
tasks.forEach(CompletableFuture::join);
84+
} finally {
85+
threadLocalDataInput.release();
86+
executor.shutdown();
87+
}
88+
}
89+
90+
protected ExecutorService createExecutor() {
91+
AtomicInteger counter = new AtomicInteger();
92+
String format = String.format("zip4jvm-extract-%%0%dd", String.valueOf(totalThreads).length());
93+
94+
ForkJoinPool.ForkJoinWorkerThreadFactory factory = pool -> {
95+
ForkJoinWorkerThread thread = ForkJoinPool.defaultForkJoinWorkerThreadFactory.newThread(pool);
96+
thread.setName(String.format(format, counter.incrementAndGet()));
97+
return thread;
98+
};
99+
100+
return new ForkJoinPool(totalThreads, factory, null, false);
101+
}
102+
103+
protected CompletableFuture<Void> createCompletableFuture(RunnableWithException task, Executor executor) {
104+
return CompletableFuture.runAsync(() -> Quietly.doRuntime(task), executor);
105+
}
106+
107+
}

‎src/main/java/ru/olegcherednik/zip4jvm/engine/unzip/UnzipExtractEngine.java

+25-25
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import ru.olegcherednik.zip4jvm.model.password.PasswordProvider;
3232
import ru.olegcherednik.zip4jvm.model.src.SrcZip;
3333
import ru.olegcherednik.zip4jvm.utils.ZipUtils;
34+
import ru.olegcherednik.zip4jvm.utils.quitely.Quietly;
3435
import ru.olegcherednik.zip4jvm.utils.time.DosTimestampConverterUtils;
3536

3637
import lombok.RequiredArgsConstructor;
@@ -105,31 +106,31 @@ protected List<ZipEntry> getEntriesByPrefix(String prefix) {
105106
.collect(Collectors.toList());
106107
}
107108

108-
// ----------
109-
110109
protected void extractEntry(Path dstDir, Map<String, String> map) {
111-
try (ConsecutiveAccessDataInput in = createConsecutiveDataInput(zipModel.getSrcZip())) {
110+
try (ConsecutiveAccessDataInput in = createConsecutiveDataInput()) {
112111
Iterator<ZipEntry> it = zipModel.absOffsAscIterator();
113112

114113
while (it.hasNext()) {
115114
ZipEntry zipEntry = it.next();
116115

117-
if (map == null || map.containsKey(zipEntry.getFileName())) {
118-
in.seekForward(zipEntry.getLocalFileHeaderAbsOffs());
116+
if (map != null && !map.containsKey(zipEntry.getFileName()))
117+
continue;
118+
119+
String fileName = Optional.ofNullable(map)
120+
.map(m -> m.get(zipEntry.getFileName()))
121+
.orElse(zipEntry.getFileName());
122+
Path file = dstDir.resolve(fileName);
119123

120-
String fileName = Optional.ofNullable(map)
121-
.map(m -> m.get(zipEntry.getFileName()))
122-
.orElse(zipEntry.getFileName());
123-
Path file = dstDir.resolve(fileName);
124-
extractEntry(file, zipEntry, in);
125-
}
124+
extractEntry(file, zipEntry, in);
126125
}
127126
} catch (IOException e) {
128127
throw new Zip4jvmException(e);
129128
}
130129
}
131130

132-
protected void extractEntry(Path file, ZipEntry zipEntry, DataInput in) throws IOException {
131+
protected void extractEntry(Path file, ZipEntry zipEntry, ConsecutiveAccessDataInput in) throws IOException {
132+
in.seekForward(zipEntry.getLocalFileHeaderAbsOffs());
133+
133134
if (zipEntry.isSymlink())
134135
extractSymlink(file, zipEntry, in);
135136
else if (zipEntry.isDirectory())
@@ -142,7 +143,7 @@ else if (zipEntry.isDirectory())
142143
setFileLastModifiedTime(file, zipEntry);
143144
}
144145

145-
protected static void extractSymlink(Path symlink, ZipEntry zipEntry, DataInput in) throws IOException {
146+
protected void extractSymlink(Path symlink, ZipEntry zipEntry, DataInput in) throws IOException {
146147
String target = IOUtils.toString(zipEntry.createInputStream(in), Charsets.UTF_8);
147148

148149
if (target.startsWith("/"))
@@ -154,7 +155,7 @@ else if (target.contains(":"))
154155
ZipSymlinkEngine.createRelativeSymlink(symlink, symlink.getParent().resolve(target));
155156
}
156157

157-
protected static void extractEmptyDirectory(Path dir) throws IOException {
158+
protected void extractEmptyDirectory(Path dir) throws IOException {
158159
Files.createDirectories(dir);
159160
}
160161

@@ -164,17 +165,24 @@ protected void extractRegularFile(Path file, ZipEntry zipEntry, DataInput in) th
164165
ZipUtils.copyLarge(zipEntry.createInputStream(in), getOutputStream(file));
165166
}
166167

167-
protected static void setFileAttributes(Path path, ZipEntry zipEntry) throws IOException {
168+
public ConsecutiveAccessDataInput createConsecutiveDataInput() {
169+
SrcZip srcZip = zipModel.getSrcZip();
170+
171+
return Quietly.doRuntime(() -> srcZip.isSolid() ? new SolidConsecutiveAccessDataInput(srcZip)
172+
: new SplitConsecutiveAccessDataInput(srcZip));
173+
}
174+
175+
protected void setFileAttributes(Path path, ZipEntry zipEntry) throws IOException {
168176
if (zipEntry.getExternalFileAttributes() != null)
169177
zipEntry.getExternalFileAttributes().apply(path);
170178
}
171179

172-
private static void setFileLastModifiedTime(Path path, ZipEntry zipEntry) throws IOException {
180+
protected void setFileLastModifiedTime(Path path, ZipEntry zipEntry) throws IOException {
173181
long lastModifiedTime = DosTimestampConverterUtils.dosToJavaTime(zipEntry.getLastModifiedTime());
174182
Files.setLastModifiedTime(path, FileTime.fromMillis(lastModifiedTime));
175183
}
176184

177-
protected static OutputStream getOutputStream(Path file) throws IOException {
185+
protected OutputStream getOutputStream(Path file) throws IOException {
178186
Path parent = file.getParent();
179187

180188
if (!Files.exists(parent))
@@ -184,12 +192,4 @@ protected static OutputStream getOutputStream(Path file) throws IOException {
184192
return Files.newOutputStream(file);
185193
}
186194

187-
// ---------- static ----------
188-
189-
public static ConsecutiveAccessDataInput createConsecutiveDataInput(SrcZip srcZip) throws IOException {
190-
return srcZip.isSolid() ? new SolidConsecutiveAccessDataInput(srcZip)
191-
: new SplitConsecutiveAccessDataInput(srcZip);
192-
193-
}
194-
195195
}

0 commit comments

Comments
 (0)