aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/actions/ActionInputMap.java
blob: f8fec0d7c0a87721be7c8e101eda3eebd0768eb6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
// Copyright 2018 The Bazel Authors. All rights reserved.
//
// Licensed 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 com.google.devtools.build.lib.actions;

import com.google.common.base.Preconditions;
import java.util.Arrays;
import javax.annotation.Nullable;

/**
 * Helper for {@link MetadataProvider} implementations.
 *
 * <p>Allows {@link FileArtifactValue} lookups by exec path or {@link ActionInput}. <i>Also</i>
 * allows {@link ActionInput} to be looked up by exec path.
 *
 * <p>This class is thread-compatible.
 */
public final class ActionInputMap implements MetadataProvider {
  /**
   * {@link ActionInput} keys stored in even indices
   *
   * <p>{@link FileArtifactValue} values stored in odd indices
   */
  private Object[] data;

  /** Number of contained elements. */
  private int size;

  /** Length of data = 2^(numBits+1) */
  private int numBits;

  /** Mask to use to perform the modulo operation since the table size is a power of 2. */
  private int mask;

  public ActionInputMap(int sizeHint) {
    this.numBits = 1;
    while ((1 << numBits) <= sizeHint) {
      ++numBits;
    }
    this.mask = (1 << numBits) - 1;
    this.data = new Object[1 << (numBits + 1)];
    this.size = 0;
  }

  @Nullable
  @Override
  public FileArtifactValue getMetadata(ActionInput input) {
    return getMetadata(input.getExecPathString());
  }

  @Nullable
  public FileArtifactValue getMetadata(String execPathString) {
    int hashCode = execPathString.hashCode();
    int probe = getProbe(hashCode);
    ActionInput nextKey;
    while ((nextKey = (ActionInput) data[probe]) != null) {
      if (hashCode == nextKey.getExecPathString().hashCode()
          && nextKey.getExecPathString().equals(execPathString)) {
        return (FileArtifactValue) data[probe + 1];
      }
      probe = incProbe(probe);
    }
    return null;
  }

  @Nullable
  @Override
  public ActionInput getInput(String execPathString) {
    int hashCode = execPathString.hashCode();
    int probe = getProbe(hashCode);
    ActionInput nextKey;
    while ((nextKey = (ActionInput) data[probe]) != null) {
      if (hashCode == nextKey.getExecPathString().hashCode()
          && nextKey.getExecPathString().equals(execPathString)) {
        return nextKey;
      }
      probe = incProbe(probe);
    }
    return null;
  }

  /** Count of contained entries. */
  public int size() {
    return size;
  }

  /** @return true if an entry was added, false if the map already contains {@code input} */
  public boolean put(ActionInput input, FileArtifactValue metadata) {
    Preconditions.checkNotNull(input);
    if (size * 4 >= data.length) {
      resize();
    }
    return putImpl(input, metadata);
  }

  public void clear() {
    Arrays.fill(data, null);
    size = 0;
  }

  private void resize() {
    Object[] oldData = data;
    data = new Object[data.length * 2];
    ++numBits;
    mask = (1 << numBits) - 1;
    for (int i = 0; i < oldData.length; i += 2) {
      ActionInput key = (ActionInput) oldData[i];
      if (key == null) {
        continue;
      }
      int hashCode = key.getExecPathString().hashCode();
      int probe = getProbe(hashCode);
      while (true) {
        // Only checks for empty slots because all map keys are known to be unique.
        if (data[probe] == null) {
          data[probe] = key;
          data[probe + 1] = oldData[i + 1];
          break;
        }
        probe = incProbe(probe);
      }
    }
  }

  /**
   * Unlike the public version, this doesn't resize.
   *
   * <p>REQUIRES: there are free positions in {@link data}.
   */
  private boolean putImpl(ActionInput key, FileArtifactValue value) {
    int hashCode = key.getExecPathString().hashCode();
    int probe = getProbe(hashCode);
    while (true) {
      ActionInput next = (ActionInput) data[probe];
      if (next == null) {
        data[probe] = key;
        data[probe + 1] = value;
        ++size;
        return true;
      }
      if (hashCode == next.getExecPathString().hashCode()
          && next.getExecPathString().equals(key.getExecPathString())) {
        return false; // already present
      }
      probe = incProbe(probe);
    }
  }

  private int getProbe(int hashCode) {
    return (hashCode & mask) << 1;
  }

  private int incProbe(int probe) {
    probe += 2;
    if (probe >= data.length) {
      probe -= data.length;
    }
    return probe;
  }
}