| /** |
| * |
| * 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.hbase.coordination; |
| |
| import java.io.IOException; |
| import java.io.InterruptedIOException; |
| import java.util.Set; |
| import java.util.concurrent.ConcurrentMap; |
| |
| import org.apache.hadoop.hbase.classification.InterfaceAudience; |
| import org.apache.hadoop.hbase.HRegionInfo; |
| import org.apache.hadoop.hbase.ServerName; |
| import org.apache.hadoop.hbase.master.MasterServices; |
| import org.apache.hadoop.hbase.master.SplitLogManager.ResubmitDirective; |
| import org.apache.hadoop.hbase.master.SplitLogManager.Task; |
| import org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.SplitLogTask.RecoveryMode; |
| |
| import com.google.common.annotations.VisibleForTesting; |
| |
| /** |
| * Coordination for SplitLogManager. It creates and works with tasks for split log operations<BR> |
| * Manager prepares task by calling {@link #prepareTask} and submit it by |
| * {@link #submitTask(String)}. After that it periodically check the number of remaining tasks by |
| * {@link #remainingTasksInCoordination()} and waits until it become zero. |
| * <P> |
| * Methods required for task life circle: <BR> |
| * {@link #markRegionsRecovering(ServerName, Set)} mark regions for log replaying. Used by |
| * {@link org.apache.hadoop.hbase.master.MasterFileSystem} <BR> |
| * {@link #removeRecoveringRegions(Set, Boolean)} make regions cleanup that previous were marked as |
| * recovering. Called after all tasks processed <BR> |
| * {@link #removeStaleRecoveringRegions(Set)} remove stale recovering. called by |
| * {@link org.apache.hadoop.hbase.master.MasterFileSystem} after Active Master is initialized <BR> |
| * {@link #getLastRecoveryTime()} required for garbage collector and should indicate when the last |
| * recovery has been made<BR> |
| * {@link #checkTaskStillAvailable(String)} Check that task is still there <BR> |
| * {@link #checkTasks()} check for unassigned tasks and resubmit them |
| */ |
| @InterfaceAudience.Private |
| public interface SplitLogManagerCoordination { |
| |
| /** |
| * Detail class that shares data between coordination and split log manager |
| */ |
| public static class SplitLogManagerDetails { |
| final private ConcurrentMap<String, Task> tasks; |
| final private MasterServices master; |
| final private Set<String> failedDeletions; |
| final private ServerName serverName; |
| |
| public SplitLogManagerDetails(ConcurrentMap<String, Task> tasks, MasterServices master, |
| Set<String> failedDeletions, ServerName serverName) { |
| this.tasks = tasks; |
| this.master = master; |
| this.failedDeletions = failedDeletions; |
| this.serverName = serverName; |
| } |
| |
| /** |
| * @return the master value |
| */ |
| public MasterServices getMaster() { |
| return master; |
| } |
| |
| /** |
| * @return map of tasks |
| */ |
| public ConcurrentMap<String, Task> getTasks() { |
| return tasks; |
| } |
| |
| /** |
| * @return a set of failed deletions |
| */ |
| public Set<String> getFailedDeletions() { |
| return failedDeletions; |
| } |
| |
| /** |
| * @return server name |
| */ |
| public ServerName getServerName() { |
| return serverName; |
| } |
| } |
| |
| /** |
| * Provide the configuration from the SplitLogManager |
| */ |
| void setDetails(SplitLogManagerDetails details); |
| |
| /** |
| * Returns the configuration that was provided previously |
| */ |
| SplitLogManagerDetails getDetails(); |
| |
| /** |
| * Prepare the new task |
| * @param taskName name of the task |
| * @return the task id |
| */ |
| String prepareTask(String taskName); |
| |
| /** |
| * Mark regions in recovering state for distributed log replay |
| * @param serverName server name |
| * @param userRegions set of regions to be marked |
| * @throws IOException in case of failure |
| * @throws InterruptedIOException |
| */ |
| void markRegionsRecovering(final ServerName serverName, Set<HRegionInfo> userRegions) |
| throws IOException, InterruptedIOException; |
| |
| /** |
| * tells Coordination that it should check for new tasks |
| */ |
| void checkTasks(); |
| |
| /** |
| * It removes recovering regions from Coordination |
| * @param serverNames servers which are just recovered |
| * @param isMetaRecovery whether current recovery is for the meta region on |
| * <code>serverNames</code> |
| */ |
| void removeRecoveringRegions(Set<String> serverNames, Boolean isMetaRecovery) throws IOException; |
| |
| /** |
| * Return the number of remaining tasks |
| */ |
| int remainingTasksInCoordination(); |
| |
| /** |
| * Check that the task is still there |
| * @param task node to check |
| */ |
| void checkTaskStillAvailable(String task); |
| |
| /** |
| * Change the recovery mode. |
| * @param b the recovery mode state |
| * @throws InterruptedIOException |
| * @throws IOException in case of failure |
| */ |
| void setRecoveryMode(boolean b) throws InterruptedIOException, IOException; |
| |
| /** |
| * Removes known stale servers |
| * @param knownServers set of previously failed servers |
| * @throws IOException in case of failure |
| * @throws InterruptedIOException |
| */ |
| void removeStaleRecoveringRegions(Set<String> knownServers) throws IOException, |
| InterruptedIOException; |
| |
| /** |
| * Resubmit the task in case if found unassigned or failed |
| * @param taskName path related to task |
| * @param task to resubmit |
| * @param force whether it should be forced |
| * @return whether it was successful |
| */ |
| |
| boolean resubmitTask(String taskName, Task task, ResubmitDirective force); |
| |
| /** |
| * @param taskName to be submitted |
| */ |
| void submitTask(String taskName); |
| |
| /** |
| * @param taskName to be removed |
| */ |
| void deleteTask(String taskName); |
| |
| /** |
| * @return shows whether the log recovery mode is in replaying state |
| */ |
| boolean isReplaying(); |
| |
| /** |
| * @return shows whether the log recovery mode is in splitting state |
| */ |
| boolean isSplitting(); |
| |
| /** |
| * @return the time of last attempt to recover |
| */ |
| long getLastRecoveryTime(); |
| |
| /** |
| * Temporary function, mostly for UTs. In the regular code isReplaying or isSplitting should be |
| * used. |
| * @return the current log recovery mode. |
| */ |
| RecoveryMode getRecoveryMode(); |
| |
| /** |
| * Support method to init constants such as timeout. Mostly required for UTs. |
| * @throws IOException |
| */ |
| @VisibleForTesting |
| void init() throws IOException; |
| } |