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.regionserver.throttle;
019
020import java.util.concurrent.atomic.AtomicInteger;
021import org.apache.hadoop.hbase.regionserver.HStore;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * Helper methods for throttling
026 */
027@InterfaceAudience.Private
028public final class ThroughputControlUtil {
029  private ThroughputControlUtil() {
030  }
031
032  private static final AtomicInteger NAME_COUNTER = new AtomicInteger(0);
033  private static final String NAME_DELIMITER = "#";
034
035  /**
036   * Generate a name for throttling, to prevent name conflict when multiple IO operation running
037   * parallel on the same store.
038   * @param store  the Store instance on which IO operation is happening
039   * @param opName Name of the IO operation, e.g. "flush", "compaction", etc.
040   * @return The name for throttling
041   */
042  public static String getNameForThrottling(HStore store, String opName) {
043    int counter;
044    for (;;) {
045      counter = NAME_COUNTER.get();
046      int next = counter == Integer.MAX_VALUE ? 0 : counter + 1;
047      if (NAME_COUNTER.compareAndSet(counter, next)) {
048        break;
049      }
050    }
051    return store.getRegionInfo().getEncodedName() + NAME_DELIMITER
052      + store.getColumnFamilyDescriptor().getNameAsString() + NAME_DELIMITER + opName
053      + NAME_DELIMITER + counter;
054  }
055}