szetszwo commented on code in PR #11097: URL: https://github.com/apache/ozone/pull/11097#discussion_r3887131514
########## hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/export/ContainerExportManager.java: ########## @@ -0,0 +1,261 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.hadoop.hdds.scm.container.export; + +import java.io.IOException; +import java.io.OutputStream; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.BooleanSupplier; +import org.apache.hadoop.hdds.conf.OzoneConfiguration; +import org.apache.hadoop.hdds.protocol.proto.HddsProtos.LifeCycleState; +import org.apache.hadoop.hdds.scm.container.ContainerHealthState; +import org.apache.hadoop.hdds.scm.container.ContainerID; +import org.apache.hadoop.hdds.scm.container.ContainerManager; +import org.apache.ratis.util.Preconditions; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Manages asynchronous container ID export jobs on the SCM leader. + * + * <p>Health filters read {@link org.apache.hadoop.hdds.scm.container.ContainerInfo#getHealthState()} + * as last written by Replication Manager; they are not recomputed during export and may be stale + * if RM has not yet evaluated a container. + * + * <p>Job status is kept in memory only. On SCM restart or leader failover, in-flight jobs are lost + * and the operator must re-submit on the new leader. {@link ExportFileManager} owns on-disk layout, + * locking, part files, and completed archives; this class tracks {@link ExportJob} state and + * schedules work. + */ +public class ContainerExportManager { + + private static final Logger LOG = LoggerFactory.getLogger(ContainerExportManager.class); + + private static final int DEFAULT_BATCH_SIZE = 100_000; + private static final int DEFAULT_PART_SIZE = 500_000; + private static final long SHUTDOWN_TIMEOUT_MS = 5_000; + + private final Map<ExportJob.Id, ExportJob> jobMap = new ConcurrentHashMap<>(); + private final AtomicReference<ExportJob> runningJob = new AtomicReference<>(); + private final ExecutorService workerPool; + private final ContainerManager containerManager; + private final ExportFileManager fileManager; + private final BooleanSupplier isLeaderReady; + private final int partSize; + private final int batchSize; + + public ContainerExportManager(String scmId, ContainerManager containerManager, BooleanSupplier isLeaderReady, + OzoneConfiguration conf) { + this(scmId, containerManager, isLeaderReady, + ExportFileManager.resolveExportDirectory(conf), DEFAULT_PART_SIZE, DEFAULT_BATCH_SIZE); + } + + ContainerExportManager(String scmId, ContainerManager containerManager, BooleanSupplier isLeaderReady, + String exportDirectory, int partSize, int batchSize) { + this.containerManager = Objects.requireNonNull(containerManager, "containerManager == null"); + this.isLeaderReady = Objects.requireNonNull(isLeaderReady, "isLeaderReady == null"); + this.fileManager = new ExportFileManager(exportDirectory); + this.partSize = partSize; + this.batchSize = batchSize; + this.workerPool = newWorkerPool(scmId); + } + + private static ExecutorService newWorkerPool(String scmId) { + return Executors.newSingleThreadExecutor(r -> { + Thread t = new Thread(r, scmId + "-ContainerExportWorker"); + t.setDaemon(true); + return t; + }); + } + + /** + * Initializes the export directory. Must be called once before submitting jobs. + */ + public void start() throws IOException { + fileManager.start(); + LOG.info("ContainerExportManager started (dir={}, partSize={}, batchSize={})", + fileManager.getExportDirectory(), partSize, batchSize); + } + + /** + * Submit a container ID export job on the SCM leader. + * + * @return the submitted job, or {@code null} if not leader or another export is already running + */ + public ExportJob submitJob(ContainerID start, LifeCycleState lifeCycleState, ContainerHealthState healthState) { + if (!isLeaderReady.getAsBoolean()) { + return null; + } + + final ExportScope scope = ExportScope.of(lifeCycleState, healthState); + final ExportJob job = new ExportJob(scope, start, batchSize, partSize); + if (!runningJob.compareAndSet(null, job)) { + return null; + } + + jobMap.put(job.getId(), job); + workerPool.submit(() -> executeExport(job)); + LOG.info("Submitted container ID export job {} (scope={}, start={}, batchSize={}, partSize={})", + job, scope, start, batchSize, partSize); + return job; + } + + public ExportJob.Status getExportStatus(ExportJob.Id jobId) { + ExportJob job = jobMap.get(jobId); + return job != null ? job.getStatus() : null; + } + + public void shutdown() { + LOG.info("Shutting down ContainerExportManager"); + workerPool.shutdownNow(); + try { + if (!workerPool.awaitTermination(SHUTDOWN_TIMEOUT_MS, TimeUnit.MILLISECONDS)) { + LOG.warn("Timed out waiting for export worker shutdown"); + } + } catch (InterruptedException e) { + LOG.warn("Interrupted waiting for export worker shutdown"); + Thread.currentThread().interrupt(); + } + try { + fileManager.unlock(); + } catch (IOException e) { + LOG.warn("Failed to unlock container export directory", e); + } + } + + private void executeExport(ExportJob job) { + try { + fileManager.createJobDirectory(job.getId()); + + final Long idsWritten = writeContainerIDs(job); + if (idsWritten == null) { + fileManager.cleanupFailedJob(job); + job.getFuture().completeExceptionally(new InterruptedException("Export cancelled")); + LOG.info("Export {} was cancelled", job); + } else { + job.getFuture().complete(idsWritten); + if (idsWritten > 0) { + fileManager.writeArchive(job); + LOG.info("{} completed: {} ids, archive={}", job, idsWritten, job.getFileName()); + } else { + LOG.info("{} completed with {} matching containers", job, idsWritten); + } + } + + fileManager.deleteJobDirectory(job.getId()); + } catch (Exception e) { + fileManager.cleanupFailedJob(job); + job.getFuture().completeExceptionally(e); + LOG.error("Export {} failed", job, e); + } finally { + final boolean cleared = runningJob.compareAndSet(job, null); + Preconditions.assertTrue(cleared); + } + } + + private Long writeContainerIDs(ExportJob job) throws IOException { + // Pre-allocated buffer: ~12 chars per ID (up to 20 digits + newline) per batch. + final byte[] buffer = new byte[job.getBatchSize() * 12]; + final WriteState state = new WriteState(); + + try { + for (ContainerID cursor = job.getStartContainerId(); cursor != null;) { + if (Thread.interrupted()) { + return null; + } + if (!isLeaderReady.getAsBoolean()) { + throw new IOException("SCM lost leadership during " + job); + } + + final List<ContainerID> batch = containerManager.getContainerIDs( + cursor, job.getBatchSize(), job.getLifeCycleState(), job.getHealthState()); + if (batch.isEmpty()) { + cursor = null; + } else { + writeBatch(job, state, batch, buffer); + cursor = ContainerID.valueOf(batch.get(batch.size() - 1).getProtobuf().getId() + 1); + } + } + state.out = closeOutputStream(state.out); + } finally { + closeOutputStream(state.out); + state.out = null; + } + return state.idsWritten; + } + + private void writeBatch(ExportJob job, WriteState state, List<ContainerID> batch, byte[] buffer) + throws IOException { + int offset = 0; + for (ContainerID containerId : batch) { + if (state.idsInCurrentPart == 0) { + state.out = closeOutputStream(state.out); + state.out = fileManager.newPartOutputStream(job.getId(), job.partFileName(state.partNumber)); + job.writeMetadataHeader(state.out, state.partNumber, containerId); + LOG.info("{} created part{}", job, state.partNumber); + } + + final byte[] idBytes = (containerId.getProtobuf().getId() + "\n").getBytes(StandardCharsets.UTF_8); + if (offset + idBytes.length > buffer.length) { + state.out.write(buffer, 0, offset); + offset = 0; + } + System.arraycopy(idBytes, 0, buffer, offset, idBytes.length); + offset += idBytes.length; + state.idsWritten++; + state.idsInCurrentPart++; + + if (state.idsInCurrentPart >= job.getPartSize()) { + if (offset > 0) { + state.out.write(buffer, 0, offset); + offset = 0; + } + state.out = closeOutputStream(state.out); + state.idsInCurrentPart = 0; + state.partNumber++; + } + } + + if (offset > 0) { + state.out.write(buffer, 0, offset); + } + } + + private static final class WriteState { + private int partNumber = 1; + private long idsInCurrentPart = 0; + private long idsWritten = 0; + private OutputStream out = null; + } + + private static OutputStream closeOutputStream(OutputStream out) throws IOException { + if (out != null) { + out.flush(); + out.close(); + } + return null; + } Review Comment: Use try-with-resource. This kind of methods is error-prone; see <img width="639" height="596" alt="Image" src="https://github.com/user-attachments/assets/1bb214ad-f0e2-420f-b578-f352b4e4d65b"; /> ########## hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/export/ContainerExportManager.java: ########## @@ -0,0 +1,261 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.hadoop.hdds.scm.container.export; + +import java.io.IOException; +import java.io.OutputStream; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.BooleanSupplier; +import org.apache.hadoop.hdds.conf.OzoneConfiguration; +import org.apache.hadoop.hdds.protocol.proto.HddsProtos.LifeCycleState; +import org.apache.hadoop.hdds.scm.container.ContainerHealthState; +import org.apache.hadoop.hdds.scm.container.ContainerID; +import org.apache.hadoop.hdds.scm.container.ContainerManager; +import org.apache.ratis.util.Preconditions; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Manages asynchronous container ID export jobs on the SCM leader. + * + * <p>Health filters read {@link org.apache.hadoop.hdds.scm.container.ContainerInfo#getHealthState()} + * as last written by Replication Manager; they are not recomputed during export and may be stale + * if RM has not yet evaluated a container. + * + * <p>Job status is kept in memory only. On SCM restart or leader failover, in-flight jobs are lost + * and the operator must re-submit on the new leader. {@link ExportFileManager} owns on-disk layout, + * locking, part files, and completed archives; this class tracks {@link ExportJob} state and + * schedules work. + */ +public class ContainerExportManager { + + private static final Logger LOG = LoggerFactory.getLogger(ContainerExportManager.class); + + private static final int DEFAULT_BATCH_SIZE = 100_000; + private static final int DEFAULT_PART_SIZE = 500_000; + private static final long SHUTDOWN_TIMEOUT_MS = 5_000; + + private final Map<ExportJob.Id, ExportJob> jobMap = new ConcurrentHashMap<>(); + private final AtomicReference<ExportJob> runningJob = new AtomicReference<>(); + private final ExecutorService workerPool; + private final ContainerManager containerManager; + private final ExportFileManager fileManager; + private final BooleanSupplier isLeaderReady; + private final int partSize; + private final int batchSize; + + public ContainerExportManager(String scmId, ContainerManager containerManager, BooleanSupplier isLeaderReady, + OzoneConfiguration conf) { + this(scmId, containerManager, isLeaderReady, + ExportFileManager.resolveExportDirectory(conf), DEFAULT_PART_SIZE, DEFAULT_BATCH_SIZE); + } + + ContainerExportManager(String scmId, ContainerManager containerManager, BooleanSupplier isLeaderReady, + String exportDirectory, int partSize, int batchSize) { + this.containerManager = Objects.requireNonNull(containerManager, "containerManager == null"); + this.isLeaderReady = Objects.requireNonNull(isLeaderReady, "isLeaderReady == null"); + this.fileManager = new ExportFileManager(exportDirectory); + this.partSize = partSize; + this.batchSize = batchSize; + this.workerPool = newWorkerPool(scmId); + } + + private static ExecutorService newWorkerPool(String scmId) { + return Executors.newSingleThreadExecutor(r -> { + Thread t = new Thread(r, scmId + "-ContainerExportWorker"); + t.setDaemon(true); + return t; + }); + } + + /** + * Initializes the export directory. Must be called once before submitting jobs. + */ + public void start() throws IOException { + fileManager.start(); + LOG.info("ContainerExportManager started (dir={}, partSize={}, batchSize={})", + fileManager.getExportDirectory(), partSize, batchSize); + } + + /** + * Submit a container ID export job on the SCM leader. + * + * @return the submitted job, or {@code null} if not leader or another export is already running + */ + public ExportJob submitJob(ContainerID start, LifeCycleState lifeCycleState, ContainerHealthState healthState) { + if (!isLeaderReady.getAsBoolean()) { + return null; + } + + final ExportScope scope = ExportScope.of(lifeCycleState, healthState); + final ExportJob job = new ExportJob(scope, start, batchSize, partSize); + if (!runningJob.compareAndSet(null, job)) { + return null; + } + + jobMap.put(job.getId(), job); + workerPool.submit(() -> executeExport(job)); + LOG.info("Submitted container ID export job {} (scope={}, start={}, batchSize={}, partSize={})", + job, scope, start, batchSize, partSize); + return job; + } + + public ExportJob.Status getExportStatus(ExportJob.Id jobId) { + ExportJob job = jobMap.get(jobId); + return job != null ? job.getStatus() : null; + } + + public void shutdown() { + LOG.info("Shutting down ContainerExportManager"); + workerPool.shutdownNow(); + try { + if (!workerPool.awaitTermination(SHUTDOWN_TIMEOUT_MS, TimeUnit.MILLISECONDS)) { + LOG.warn("Timed out waiting for export worker shutdown"); + } + } catch (InterruptedException e) { + LOG.warn("Interrupted waiting for export worker shutdown"); + Thread.currentThread().interrupt(); + } + try { + fileManager.unlock(); + } catch (IOException e) { + LOG.warn("Failed to unlock container export directory", e); + } + } + + private void executeExport(ExportJob job) { + try { + fileManager.createJobDirectory(job.getId()); + + final Long idsWritten = writeContainerIDs(job); + if (idsWritten == null) { + fileManager.cleanupFailedJob(job); + job.getFuture().completeExceptionally(new InterruptedException("Export cancelled")); + LOG.info("Export {} was cancelled", job); + } else { + job.getFuture().complete(idsWritten); + if (idsWritten > 0) { + fileManager.writeArchive(job); + LOG.info("{} completed: {} ids, archive={}", job, idsWritten, job.getFileName()); + } else { + LOG.info("{} completed with {} matching containers", job, idsWritten); + } + } + + fileManager.deleteJobDirectory(job.getId()); + } catch (Exception e) { + fileManager.cleanupFailedJob(job); + job.getFuture().completeExceptionally(e); + LOG.error("Export {} failed", job, e); + } finally { + final boolean cleared = runningJob.compareAndSet(job, null); + Preconditions.assertTrue(cleared); + } + } + + private Long writeContainerIDs(ExportJob job) throws IOException { + // Pre-allocated buffer: ~12 chars per ID (up to 20 digits + newline) per batch. + final byte[] buffer = new byte[job.getBatchSize() * 12]; + final WriteState state = new WriteState(); + + try { + for (ContainerID cursor = job.getStartContainerId(); cursor != null;) { + if (Thread.interrupted()) { + return null; + } + if (!isLeaderReady.getAsBoolean()) { + throw new IOException("SCM lost leadership during " + job); + } + + final List<ContainerID> batch = containerManager.getContainerIDs( + cursor, job.getBatchSize(), job.getLifeCycleState(), job.getHealthState()); + if (batch.isEmpty()) { + cursor = null; + } else { + writeBatch(job, state, batch, buffer); + cursor = ContainerID.valueOf(batch.get(batch.size() - 1).getProtobuf().getId() + 1); + } + } + state.out = closeOutputStream(state.out); + } finally { + closeOutputStream(state.out); + state.out = null; + } + return state.idsWritten; + } + + private void writeBatch(ExportJob job, WriteState state, List<ContainerID> batch, byte[] buffer) + throws IOException { + int offset = 0; + for (ContainerID containerId : batch) { + if (state.idsInCurrentPart == 0) { + state.out = closeOutputStream(state.out); + state.out = fileManager.newPartOutputStream(job.getId(), job.partFileName(state.partNumber)); + job.writeMetadataHeader(state.out, state.partNumber, containerId); + LOG.info("{} created part{}", job, state.partNumber); + } + + final byte[] idBytes = (containerId.getProtobuf().getId() + "\n").getBytes(StandardCharsets.UTF_8); + if (offset + idBytes.length > buffer.length) { + state.out.write(buffer, 0, offset); + offset = 0; + } + System.arraycopy(idBytes, 0, buffer, offset, idBytes.length); + offset += idBytes.length; + state.idsWritten++; + state.idsInCurrentPart++; + + if (state.idsInCurrentPart >= job.getPartSize()) { + if (offset > 0) { + state.out.write(buffer, 0, offset); + offset = 0; + } + state.out = closeOutputStream(state.out); + state.idsInCurrentPart = 0; + state.partNumber++; + } + } + + if (offset > 0) { + state.out.write(buffer, 0, offset); + } + } + + private static final class WriteState { + private int partNumber = 1; + private long idsInCurrentPart = 0; + private long idsWritten = 0; + private OutputStream out = null; + } Review Comment: Although it is tolerable, it is generally considered a bad practice and a design anti-pattern for class with mutable fields but no methods. Since Ozone is a public project with many contributors, let's avoid it. <img width="626" height="805" alt="Image" src="https://github.com/user-attachments/assets/a792521e-fbd1-4d7f-9947-abcdf310b040"; /> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
