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
|
/*
* 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.physical.base;
import java.util.List;
import org.apache.drill.exec.physical.PhysicalOperatorSetupException;
import org.apache.drill.exec.planner.fragment.ParallelizationInfo;
import org.apache.drill.exec.proto.CoordinationProtos.DrillbitEndpoint;
import com.fasterxml.jackson.annotation.JsonIgnore;
public interface Exchange extends PhysicalOperator {
/**
* Exchanges are fragment boundaries in physical operator tree. It is divided into two parts. First part is Sender
* which becomes part of the sending fragment. Second part is Receiver which becomes part of the fragment that
* receives the data.
*
* Assignment dependency describes whether sender fragments depend on receiver fragment's endpoint assignment for
* determining its parallelization and endpoint assignment and vice versa.
*/
enum ParallelizationDependency {
SENDER_DEPENDS_ON_RECEIVER, // Sending fragment depends on receiving fragment for parallelization
RECEIVER_DEPENDS_ON_SENDER, // Receiving fragment depends on sending fragment for parallelization (default value).
}
/**
* Inform this Exchange node about its sender locations. This list should be index-ordered the same as the expected
* minorFragmentIds for each sender.
*
* @param senderLocations
*/
void setupSenders(int majorFragmentId, List<DrillbitEndpoint> senderLocations) throws PhysicalOperatorSetupException;
/**
* Inform this Exchange node about its receiver locations. This list should be index-ordered the same as the expected
* minorFragmentIds for each receiver.
*
* @param receiverLocations
*/
void setupReceivers(int majorFragmentId, List<DrillbitEndpoint> receiverLocations) throws PhysicalOperatorSetupException;
/**
* Get the Sender associated with the given minorFragmentId. Cannot be called until after setupSenders() and
* setupReceivers() have been called.
*
* @param minorFragmentId
* The minor fragment id, must be in the range [0, fragment.width).
* @param child
* The feeding node for the requested sender.
* @return The materialized sender for the given arguments.
*/
Sender getSender(int minorFragmentId, PhysicalOperator child) throws PhysicalOperatorSetupException;
/**
* Get the Receiver associated with the given minorFragmentId. Cannot be called until after setupSenders() and
* setupReceivers() have been called.
*
* @param minorFragmentId
* The minor fragment id, must be in the range [0, fragment.width).
* @return The materialized recevier for the given arguments.
*/
Receiver getReceiver(int minorFragmentId);
/**
* Returns the memory requirement for the sender side of the exchange operator.
* @param receiverCount number of receivers at the receiving end of this exchange operator.
* @param senderCount number of senders sending the rows for this exchange operator.
* @return Total memory required by this operator.
*/
long getSenderMemory(int receiverCount, int senderCount);
/**
* Returns the memory requirement for the receiver side of the exchange operator.
* @param receiverCount number of receivers receiving the rows sent by the sender side of this
* exchange operator.
* @param senderCount number of senders sending the rows.
* @return Total memory required by this operator.
*/
long getReceiverMemory(int receiverCount, int senderCount);
/**
* Provide parallelization parameters for sender side of the exchange. Output includes min width,
* max width and affinity to Drillbits.
*
* @param receiverFragmentEndpoints Endpoints assigned to receiver fragment if available, otherwise an empty list.
* @return Sender {@link org.apache.drill.exec.planner.fragment.ParallelizationInfo}.
*/
@JsonIgnore
ParallelizationInfo getSenderParallelizationInfo(List<DrillbitEndpoint> receiverFragmentEndpoints);
/**
* Provide parallelization parameters for receiver side of the exchange. Output includes min width,
* max width and affinity to Drillbits.
*
* @param senderFragmentEndpoints Endpoints assigned to receiver fragment if available, otherwise an empty list
* @return Receiver {@link org.apache.drill.exec.planner.fragment.ParallelizationInfo}.
*/
@JsonIgnore
ParallelizationInfo getReceiverParallelizationInfo(List<DrillbitEndpoint> senderFragmentEndpoints);
/**
* Return the feeding child of this operator node.
*
* @return The feeding child of this operator node.
*/
PhysicalOperator getChild();
/**
* Get the parallelization dependency of the Exchange.
*/
@JsonIgnore
ParallelizationDependency getParallelizationDependency();
}
|
