You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/09/06 15:55:01 UTC

[jira] [Commented] (FLINK-7068) change BlobService sub-classes for permanent and transient BLOBs

    [ https://issues.apache.org/jira/browse/FLINK-7068?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16155570#comment-16155570 ] 

ASF GitHub Bot commented on FLINK-7068:
---------------------------------------

Github user tillrohrmann commented on a diff in the pull request:

    https://github.com/apache/flink/pull/4358#discussion_r137289123
  
    --- Diff: flink-runtime/src/main/java/org/apache/flink/runtime/blob/PermanentBlobCache.java ---
    @@ -0,0 +1,429 @@
    +/*
    + * 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.flink.runtime.blob;
    +
    +import org.apache.flink.annotation.VisibleForTesting;
    +import org.apache.flink.api.common.JobID;
    +import org.apache.flink.configuration.BlobServerOptions;
    +import org.apache.flink.configuration.Configuration;
    +import org.apache.flink.util.FileUtils;
    +import org.slf4j.Logger;
    +import org.slf4j.LoggerFactory;
    +
    +import javax.annotation.Nullable;
    +import java.io.File;
    +import java.io.IOException;
    +import java.net.InetSocketAddress;
    +import java.util.HashMap;
    +import java.util.Iterator;
    +import java.util.Map;
    +import java.util.Timer;
    +import java.util.TimerTask;
    +import java.util.concurrent.atomic.AtomicBoolean;
    +import java.util.concurrent.atomic.AtomicLong;
    +import java.util.concurrent.locks.ReadWriteLock;
    +import java.util.concurrent.locks.ReentrantReadWriteLock;
    +
    +import static org.apache.flink.util.Preconditions.checkArgument;
    +import static org.apache.flink.util.Preconditions.checkNotNull;
    +
    +/**
    + * Provides a cache for permanent BLOB files including a per-job ref-counting and a staged cleanup.
    + * <p>
    + * When requesting BLOBs via {@link #getHAFile(JobID, BlobKey)}, the cache will first attempt to
    + * serve the file from its local cache. Only if the local cache does not contain the desired BLOB,
    + * it will try to download it from a distributed HA file system (if available) or the BLOB server.
    + * <p>
    + * If files for a job are not needed any more, they will enter a staged, i.e. deferred, cleanup.
    + * Files may thus still be be accessible upon recovery and do not need to be re-downloaded.
    + */
    +public class PermanentBlobCache extends TimerTask implements PermanentBlobService {
    +
    +	/** The log object used for debugging. */
    +	private static final Logger LOG = LoggerFactory.getLogger(PermanentBlobCache.class);
    +
    +	/** Counter to generate unique names for temporary files. */
    +	private final AtomicLong tempFileCounter = new AtomicLong(0);
    +
    +	private final InetSocketAddress serverAddress;
    +
    +	/** Root directory for local file storage */
    +	private final File storageDir;
    +
    +	/** Blob store for distributed file storage, e.g. in HA */
    +	private final BlobView blobView;
    +
    +	private final AtomicBoolean shutdownRequested = new AtomicBoolean();
    +
    +	/** Shutdown hook thread to ensure deletion of the storage directory. */
    +	private final Thread shutdownHook;
    +
    +	/** The number of retries when the transfer fails */
    +	private final int numFetchRetries;
    +
    +	/** Configuration for the blob client like ssl parameters required to connect to the blob server */
    +	private final Configuration blobClientConfig;
    +
    +	/** Lock guarding concurrent file accesses */
    +	private final ReadWriteLock readWriteLock;
    +
    +	// --------------------------------------------------------------------------------------------
    +
    +	/**
    +	 * Job reference counters with a time-to-live (TTL).
    +	 */
    +	@VisibleForTesting
    +	static class RefCount {
    +		/**
    +		 * Number of references to a job.
    +		 */
    +		public int references = 0;
    +
    +		/**
    +		 * Timestamp in milliseconds when any job data should be cleaned up (no cleanup for
    +		 * non-positive values).
    +		 */
    +		public long keepUntil = -1;
    +	}
    +
    +	/** Map to store the number of references to a specific job */
    +	private final Map<JobID, RefCount> jobRefCounters = new HashMap<>();
    +
    +	/** Time interval (ms) to run the cleanup task; also used as the default TTL. */
    +	private final long cleanupInterval;
    +
    +	private final Timer cleanupTimer;
    +
    +	/**
    +	 * Instantiates a new cache for permanent BLOBs which are also available in an HA store.
    +	 *
    +	 * @param serverAddress
    +	 * 		address of the {@link BlobServer} to use for fetching files from
    +	 * @param blobClientConfig
    +	 * 		global configuration
    +	 * @param blobView
    +	 * 		(distributed) HA blob store file system to retrieve files from first
    +	 *
    +	 * @throws IOException
    +	 * 		thrown if the (local or distributed) file storage cannot be created or is not usable
    +	 */
    +	public PermanentBlobCache(
    +		final InetSocketAddress serverAddress,
    +		final Configuration blobClientConfig,
    +		final BlobView blobView) throws IOException {
    +
    +		this.serverAddress = checkNotNull(serverAddress);
    +		this.blobClientConfig = checkNotNull(blobClientConfig);
    +		this.blobView = checkNotNull(blobView, "blobStore");
    +		this.readWriteLock = new ReentrantReadWriteLock();
    +
    +		// configure and create the storage directory
    +		String storageDirectory = blobClientConfig.getString(BlobServerOptions.STORAGE_DIRECTORY);
    +		this.storageDir = BlobUtils.initLocalStorageDirectory(storageDirectory);
    +		LOG.info("Created permanent BLOB cache storage directory " + storageDir);
    +
    +		// configure the number of fetch retries
    +		final int fetchRetries = blobClientConfig.getInteger(BlobServerOptions.FETCH_RETRIES);
    +		if (fetchRetries >= 0) {
    +			this.numFetchRetries = fetchRetries;
    +		} else {
    +			LOG.warn("Invalid value for {}. System will attempt no retries on failed fetch operations of BLOBs.",
    +				BlobServerOptions.FETCH_RETRIES.key());
    +			this.numFetchRetries = 0;
    +		}
    +
    +		// Initializing the clean up task
    +		this.cleanupTimer = new Timer(true);
    +
    +		this.cleanupInterval = blobClientConfig.getLong(BlobServerOptions.CLEANUP_INTERVAL) * 1000;
    +		this.cleanupTimer.schedule(this, cleanupInterval, cleanupInterval);
    +
    +		// Add shutdown hook to delete storage directory
    +		shutdownHook = BlobUtils.addShutdownHook(this, LOG);
    +	}
    +
    +	/**
    +	 * Registers use of job-related BLOBs.
    +	 * <p>
    +	 * Using any other method to access BLOBs, e.g. {@link #getHAFile}, is only valid within calls
    +	 * to <tt>registerJob(JobID)</tt> and {@link #releaseJob(JobID)}.
    +	 *
    +	 * @param jobId
    +	 * 		ID of the job this blob belongs to
    +	 *
    +	 * @see #releaseJob(JobID)
    +	 */
    +	public void registerJob(JobID jobId) {
    +		synchronized (jobRefCounters) {
    +			RefCount ref = jobRefCounters.get(jobId);
    +			if (ref == null) {
    +				ref = new RefCount();
    +				jobRefCounters.put(jobId, ref);
    +			} else {
    +				// reset cleanup timeout
    +				ref.keepUntil = -1;
    +			}
    +			++ref.references;
    +		}
    +	}
    +
    +	/**
    +	 * Unregisters use of job-related BLOBs and allow them to be released.
    +	 *
    +	 * @param jobId
    +	 * 		ID of the job this blob belongs to
    +	 *
    +	 * @see #registerJob(JobID)
    +	 */
    +	public void releaseJob(JobID jobId) {
    --- End diff --
    
    What happens if I call `releaseJob` multiple times for the same `jobId`? Couldn't it happen that the reference counter becomes negative?


> change BlobService sub-classes for permanent and transient BLOBs
> ----------------------------------------------------------------
>
>                 Key: FLINK-7068
>                 URL: https://issues.apache.org/jira/browse/FLINK-7068
>             Project: Flink
>          Issue Type: Sub-task
>          Components: Distributed Coordination, Network
>    Affects Versions: 1.4.0
>            Reporter: Nico Kruber
>            Assignee: Nico Kruber
>
> A {{PermanentBlobStore}} should resemble use cases for BLOBs that are permanently stored for a job's life time (HA and non-HA).
> A {{TransientBlobStore}} should reflect BLOB offloading for logs, RPC, etc. which even does not have to be reflected by files.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)