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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.drill.exec.ops;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.ExecutorService;
import org.apache.drill.exec.work.filter.RuntimeFilterSink;
import org.apache.drill.shaded.guava.com.google.common.annotations.VisibleForTesting;
import org.apache.calcite.schema.SchemaPlus;
import org.apache.drill.common.config.DrillConfig;
import org.apache.drill.exec.compile.CodeCompiler;
import org.apache.drill.exec.exception.ClassTransformationException;
import org.apache.drill.exec.expr.ClassGenerator;
import org.apache.drill.exec.expr.CodeGenerator;
import org.apache.drill.exec.expr.fn.FunctionLookupContext;
import org.apache.drill.exec.memory.BufferAllocator;
import org.apache.drill.exec.physical.base.PhysicalOperator;
import org.apache.drill.exec.proto.ExecProtos;
import org.apache.drill.exec.server.options.OptionManager;
import org.apache.drill.exec.testing.ExecutionControls;
import io.netty.buffer.DrillBuf;
import org.apache.drill.exec.work.filter.RuntimeFilterWritable;
/**
* Provides the resources required by a non-exchange operator to execute.
*/
public interface FragmentContext extends UdfUtilities, AutoCloseable {
/**
* Returns the UDF registry.
* @return the UDF registry
*/
FunctionLookupContext getFunctionRegistry();
/**
* Returns a read-only version of the session options.
* @return the session options
*/
OptionManager getOptions();
boolean isImpersonationEnabled();
/**
* Generates code for a class given a {@link ClassGenerator},
* and returns a single instance of the generated class. (Note
* that the name is a misnomer, it would be better called
* <tt>getImplementationInstance</tt>.)
*
* @param cg the class generator
* @return an instance of the generated class
*/
<T> T getImplementationClass(final ClassGenerator<T> cg)
throws ClassTransformationException, IOException;
/**
* Generates code for a class given a {@link CodeGenerator},
* and returns a single instance of the generated class. (Note
* that the name is a misnomer, it would be better called
* <tt>getImplementationInstance</tt>.)
*
* @param cg the code generator
* @return an instance of the generated class
*/
<T> T getImplementationClass(final CodeGenerator<T> cg)
throws ClassTransformationException, IOException;
/**
* Generates code for a class given a {@link ClassGenerator}, and returns the
* specified number of instances of the generated class. (Note that the name
* is a misnomer, it would be better called
* <tt>getImplementationInstances</tt>.)
*
* @param cg the class generator
* @return list of instances of the generated class
*/
<T> List<T> getImplementationClass(final ClassGenerator<T> cg, final int instanceCount)
throws ClassTransformationException, IOException;
/**
* Generates code for a class given a {@link CodeGenerator}, and returns the
* specified number of instances of the generated class. (Note that the name
* is a misnomer, it would be better called
* <tt>getImplementationInstances</tt>.)
*
* @param cg the code generator
* @return list of instances of the generated class
*/
<T> List<T> getImplementationClass(final CodeGenerator<T> cg, final int instanceCount)
throws ClassTransformationException, IOException;
/**
* Return the set of execution controls used to inject faults into running
* code for testing.
*
* @return the execution controls
*/
ExecutionControls getExecutionControls();
/**
* Returns the Drill configuration for this run. Note that the config is
* global and immutable.
*
* @return the Drill configuration
*/
DrillConfig getConfig();
CodeCompiler getCompiler();
ExecutorService getScanDecodeExecutor();
ExecutorService getScanExecutor();
ExecutorService getExecutor();
ExecutorState getExecutorState();
BufferAllocator getNewChildAllocator(final String operatorName,
final int operatorId,
final long initialReservation,
final long maximumReservation);
ExecProtos.FragmentHandle getHandle();
BufferAllocator getAllocator();
OperatorContext newOperatorContext(PhysicalOperator popConfig);
OperatorContext newOperatorContext(PhysicalOperator popConfig, OperatorStats stats);
SchemaPlus getFullRootSchema();
String getQueryUserName();
String getFragIdString();
DrillBuf replace(DrillBuf old, int newSize);
@Override
DrillBuf getManagedBuffer();
DrillBuf getManagedBuffer(int size);
@Override
void close();
/**
* @return
*/
RuntimeFilterSink getRuntimeFilterSink();
/**
* add a RuntimeFilter when the RuntimeFilter receiver belongs to the same MinorFragment
* @param runtimeFilter
*/
public void addRuntimeFilter(RuntimeFilterWritable runtimeFilter);
interface ExecutorState {
/**
* Tells individual operations whether they should continue. In some cases, an external event (typically cancellation)
* will mean that the fragment should prematurely exit execution. Long running operations should check this every so
* often so that Drill is responsive to cancellation operations.
*
* @return False if the action should terminate immediately, true if everything is okay.
*/
boolean shouldContinue();
/**
* Inform the executor if a exception occurs and fragment should be failed.
*
* @param t
* The exception that occurred.
*/
void fail(final Throwable t);
@VisibleForTesting
@Deprecated
boolean isFailed();
@VisibleForTesting
@Deprecated
Throwable getFailureCause();
}
}
|
