001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.master.procedure;
019
020import java.io.IOException;
021import org.apache.hadoop.hbase.TableName;
022import org.apache.hadoop.hbase.client.TableDescriptor;
023import org.apache.hadoop.hbase.procedure2.ProcedureStateSerializer;
024import org.apache.yetus.audience.InterfaceAudience;
025import org.slf4j.Logger;
026import org.slf4j.LoggerFactory;
027
028import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;
029import org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos;
030import org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RefreshHFilesTableProcedureState;
031
032@InterfaceAudience.Private
033public class RefreshHFilesTableProcedure
034  extends AbstractStateMachineTableProcedure<RefreshHFilesTableProcedureState> {
035  private static final Logger LOG = LoggerFactory.getLogger(RefreshHFilesTableProcedure.class);
036
037  private TableName tableName;
038  private String namespaceName;
039
040  public RefreshHFilesTableProcedure() {
041    super();
042  }
043
044  public RefreshHFilesTableProcedure(MasterProcedureEnv env) {
045    super(env);
046  }
047
048  public RefreshHFilesTableProcedure(MasterProcedureEnv env, TableName tableName) {
049    super(env);
050    this.tableName = tableName;
051  }
052
053  public RefreshHFilesTableProcedure(MasterProcedureEnv env, String namespaceName) {
054    super(env);
055    this.namespaceName = namespaceName;
056  }
057
058  @Override
059  public TableOperationType getTableOperationType() {
060    return TableOperationType.REFRESH_HFILES;
061  }
062
063  @Override
064  protected void serializeStateData(ProcedureStateSerializer serializer) throws IOException {
065    super.serializeStateData(serializer);
066    MasterProcedureProtos.RefreshHFilesTableProcedureStateData.Builder builder =
067      MasterProcedureProtos.RefreshHFilesTableProcedureStateData.newBuilder();
068    if (tableName != null && namespaceName == null) {
069      builder.setTableName(ProtobufUtil.toProtoTableName(tableName));
070    } else if (tableName == null && namespaceName != null) {
071      builder.setNamespaceName(namespaceName);
072    }
073    serializer.serialize(builder.build());
074  }
075
076  @Override
077  protected void deserializeStateData(ProcedureStateSerializer serializer) throws IOException {
078    super.deserializeStateData(serializer);
079    MasterProcedureProtos.RefreshHFilesTableProcedureStateData data =
080      serializer.deserialize(MasterProcedureProtos.RefreshHFilesTableProcedureStateData.class);
081    if (data.hasTableName() && !data.hasNamespaceName()) {
082      this.tableName = ProtobufUtil.toTableName(data.getTableName());
083    } else if (!data.hasTableName() && data.hasNamespaceName()) {
084      this.namespaceName = data.getNamespaceName();
085    }
086  }
087
088  @Override
089  public TableName getTableName() {
090    if (tableName != null && namespaceName == null) {
091      return tableName;
092    }
093    return DUMMY_NAMESPACE_TABLE_NAME;
094  }
095
096  @Override
097  protected RefreshHFilesTableProcedureState getInitialState() {
098    return RefreshHFilesTableProcedureState.REFRESH_HFILES_PREPARE;
099  }
100
101  @Override
102  protected int getStateId(RefreshHFilesTableProcedureState state) {
103    return state.getNumber();
104  }
105
106  @Override
107  protected RefreshHFilesTableProcedureState getState(int stateId) {
108    return RefreshHFilesTableProcedureState.forNumber(stateId);
109  }
110
111  @Override
112  protected void rollbackState(MasterProcedureEnv env, RefreshHFilesTableProcedureState state)
113    throws IOException, InterruptedException {
114    // Refresh HFiles is idempotent operation hence rollback is not needed
115    LOG.trace("Rollback not implemented for RefreshHFilesTableProcedure state: {}", state);
116  }
117
118  @Override
119  protected Flow executeFromState(MasterProcedureEnv env, RefreshHFilesTableProcedureState state) {
120    LOG.info("Executing RefreshHFilesTableProcedureState state: {}", state);
121
122    try {
123      return switch (state) {
124        case REFRESH_HFILES_PREPARE -> prepare(env);
125        case REFRESH_HFILES_REFRESH_REGION -> refreshHFiles(env);
126        case REFRESH_HFILES_FINISH -> finish();
127        default -> throw new UnsupportedOperationException("Unhandled state: " + state);
128      };
129    } catch (Exception ex) {
130      LOG.error("Error in RefreshHFilesTableProcedure state {}", state, ex);
131      setFailure("RefreshHFilesTableProcedure", ex);
132      return Flow.NO_MORE_STATE;
133    }
134  }
135
136  private Flow prepare(final MasterProcedureEnv env) {
137    setNextState(RefreshHFilesTableProcedureState.REFRESH_HFILES_REFRESH_REGION);
138    return Flow.HAS_MORE_STATE;
139  }
140
141  private void refreshHFilesForTable(final MasterProcedureEnv env, TableName tableName) {
142    addChildProcedure(env.getAssignmentManager().getTableRegions(tableName, true).stream()
143      .map(RefreshHFilesRegionProcedure::new).toArray(RefreshHFilesRegionProcedure[]::new));
144  }
145
146  private Flow refreshHFiles(final MasterProcedureEnv env) throws IOException {
147    if (tableName != null && namespaceName == null) {
148      refreshHFilesForTable(env, tableName);
149    } else if (tableName == null && namespaceName != null) {
150      env.getMasterServices().listTableNamesByNamespace(namespaceName)
151        .forEach(table -> refreshHFilesForTable(env, table));
152    } else {
153      env.getMasterServices().getTableDescriptors().getAll().values().stream()
154        .map(TableDescriptor::getTableName).filter(table -> !table.isSystemTable())
155        .forEach(table -> refreshHFilesForTable(env, table));
156    }
157
158    setNextState(RefreshHFilesTableProcedureState.REFRESH_HFILES_FINISH);
159    return Flow.HAS_MORE_STATE;
160  }
161
162  private Flow finish() {
163    return Flow.NO_MORE_STATE;
164  }
165}