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
|
// Copyright 2014 Google Inc. 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.Splitter;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.common.options.Converter;
import com.google.devtools.common.options.OptionsParsingException;
import java.util.Iterator;
import java.util.NoSuchElementException;
/**
* Instances of this class represent an estimate of the resource consumption
* for a particular Action, or the total available resources. We plan to
* use this to do smarter scheduling of actions, for example making sure
* that we don't schedule jobs concurrently if they would use so much
* memory as to cause the machine to thrash.
*/
@Immutable
public class ResourceSet {
/** For actions that consume negligible resources. */
public static final ResourceSet ZERO = new ResourceSet(0.0, 0.0, 0.0, 0);
/** The amount of real memory (resident set size). */
private final double memoryMb;
/** The number of CPUs, or fractions thereof. */
private final double cpuUsage;
/** The number of local tests. */
private final int localTestCount;
/**
* Relative amount of used I/O resources (with 1.0 being total available amount on an "average"
* workstation.
*/
private final double ioUsage;
private ResourceSet(double memoryMb, double cpuUsage, double ioUsage, int localTestCount) {
this.memoryMb = memoryMb;
this.cpuUsage = cpuUsage;
this.ioUsage = ioUsage;
this.localTestCount = localTestCount;
}
/**
* Returns a new ResourceSet with the provided values for memoryMb, cpuUsage, and ioUsage, and
* with 0.0 for localTestCount. Use this method in action resource definitions when they aren't
* local tests.
*/
public static ResourceSet createWithRamCpuIo(double memoryMb, double cpuUsage, double ioUsage) {
return new ResourceSet(memoryMb, cpuUsage, ioUsage, 0);
}
/**
* Returns a new ResourceSet with the provided value for localTestCount, and 0.0 for memoryMb,
* cpuUsage, and ioUsage. Use this method in action resource definitions when they are local tests
* that acquire no local resources.
*/
public static ResourceSet createWithLocalTestCount(int localTestCount) {
return new ResourceSet(0.0, 0.0, 0.0, localTestCount);
}
/**
* Returns a new ResourceSet with the provided values for memoryMb, cpuUsage, ioUsage, and
* localTestCount. Most action resource definitions should use
* {@link #createWithRamCpuIo(double, double, double)} or {@link #createWithLocalTestCount(int)}.
* Use this method primarily when constructing ResourceSets that represent available resources.
*/
public static ResourceSet create(double memoryMb, double cpuUsage, double ioUsage,
int localTestCount) {
return new ResourceSet(memoryMb, cpuUsage, ioUsage, localTestCount);
}
/** Returns the amount of real memory (resident set size) used in MB. */
public double getMemoryMb() {
return memoryMb;
}
/**
* Returns the number of CPUs (or fractions thereof) used.
* For a CPU-bound single-threaded process, this will be 1.0.
* For a single-threaded process which spends part of its
* time waiting for I/O, this will be somewhere between 0.0 and 1.0.
* For a multi-threaded or multi-process application,
* this may be more than 1.0.
*/
public double getCpuUsage() {
return cpuUsage;
}
/**
* Returns the amount of I/O used.
* Full amount of available I/O resources on the "average" workstation is
* considered to be 1.0.
*/
public double getIoUsage() {
return ioUsage;
}
/** Returns the local test count used. */
public int getLocalTestCount() {
return localTestCount;
}
@Override
public String toString() {
return "Resources: \n"
+ "Memory: " + memoryMb + "M\n"
+ "CPU: " + cpuUsage + "\n"
+ "I/O: " + ioUsage + "\n"
+ "Local tests: " + localTestCount + "\n";
}
public static class ResourceSetConverter implements Converter<ResourceSet> {
private static final Splitter SPLITTER = Splitter.on(',');
@Override
public ResourceSet convert(String input) throws OptionsParsingException {
Iterator<String> values = SPLITTER.split(input).iterator();
try {
double memoryMb = Double.parseDouble(values.next());
double cpuUsage = Double.parseDouble(values.next());
double ioUsage = Double.parseDouble(values.next());
if (values.hasNext()) {
throw new OptionsParsingException("Expected exactly 3 comma-separated float values");
}
if (memoryMb <= 0.0 || cpuUsage <= 0.0 || ioUsage <= 0.0) {
throw new OptionsParsingException("All resource values must be positive");
}
return create(memoryMb, cpuUsage, ioUsage, Integer.MAX_VALUE);
} catch (NumberFormatException | NoSuchElementException nfe) {
throw new OptionsParsingException("Expected exactly 3 comma-separated float values", nfe);
}
}
@Override
public String getTypeDescription() {
return "comma-separated available amount of RAM (in MB), CPU (in cores) and "
+ "available I/O (1.0 being average workstation)";
}
}
}
|
