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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.schema.processing;
import com.yahoo.config.application.api.DeployLogger;
import com.yahoo.schema.RankProfileRegistry;
import com.yahoo.schema.Schema;
import com.yahoo.schema.derived.SummaryClass;
import com.yahoo.schema.document.ImmutableSDField;
import com.yahoo.vespa.documentmodel.DocumentSummary;
import com.yahoo.vespa.documentmodel.SummaryField;
import com.yahoo.vespa.documentmodel.SummaryTransform;
import com.yahoo.vespa.model.container.search.QueryProfiles;
import java.util.LinkedHashSet;
import java.util.Optional;
import java.util.Set;
import java.util.logging.Level;
import static com.yahoo.schema.document.ComplexAttributeFieldUtils.isComplexFieldWithOnlyStructFieldAttributes;
/**
* Emits a warning for summaries which accesses disk.
*
* @author bratseth
*/
public class SummaryDiskAccessValidator extends Processor {
public SummaryDiskAccessValidator(Schema schema,
DeployLogger deployLogger,
RankProfileRegistry rankProfileRegistry,
QueryProfiles queryProfiles) {
super(schema, deployLogger, rankProfileRegistry, queryProfiles);
}
@Override
public void process(boolean validate, boolean documentsOnly) {
if ( ! validate) return;
if (documentsOnly) return;
for (DocumentSummary summary : schema.getSummaries().values()) {
for (SummaryField summaryField : summary.getSummaryFields().values()) {
Set<String> implicitDiskFields = new LinkedHashSet<>();
for (SummaryField.Source source : summaryField.getSources()) {
ImmutableSDField field = schema.getField(source.getName());
if (field == null)
field = findFieldProducingSummaryField(source.getName(), schema).orElse(null);
if (field == null && ! source.getName().equals(SummaryClass.DOCUMENT_ID_FIELD))
throw new IllegalArgumentException(summaryField + " in " + summary + " references " +
source + ", but this field does not exist");
if ( ! isInMemory(field, summaryField) && ! summary.isFromDisk())
implicitDiskFields.add(summaryField.getName());
}
if ( ! implicitDiskFields.isEmpty())
deployLogger.logApplicationPackage(Level.WARNING, "In " + schema + ", " + summary +
": Fields " + implicitDiskFields + " references " +
"non-attribute fields: Using this " +
"summary will cause disk accesses. " +
"Set 'from-disk' on this summary class to silence this warning.");
}
}
}
private boolean isInMemory(ImmutableSDField field, SummaryField summaryField) {
if (field == null) return false; // For DOCUMENT_ID_FIELD, which may be implicit, but is then not in memory
if (isComplexFieldWithOnlyStructFieldAttributes(field) &&
(summaryField.getTransform() == SummaryTransform.ATTRIBUTECOMBINER ||
summaryField.getTransform() == SummaryTransform.MATCHED_ATTRIBUTE_ELEMENTS_FILTER)) {
return true;
}
return field.doesAttributing();
}
private Optional<ImmutableSDField> findFieldProducingSummaryField(String name, Schema schema) {
return schema.allFields().filter(field -> field.getSummaryFields().get(name) != null).findAny();
}
}
|
