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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.fs4;
import com.yahoo.compress.IntegerCompressor;
import com.yahoo.io.GrowableByteBuffer;
import com.yahoo.prelude.query.Item;
import com.yahoo.search.Query;
import com.yahoo.search.dispatch.Dispatcher;
import com.yahoo.search.grouping.vespa.GroupingExecutor;
import com.yahoo.search.query.Ranking;
import com.yahoo.searchlib.aggregation.Grouping;
import com.yahoo.text.Utf8String;
import com.yahoo.vespa.objects.BufferSerializer;
import java.nio.ByteBuffer;
import java.util.List;
/**
* An "extended query" packet. This is the query packets used today,
* they allow more flexible sets of parameters to be shipped with queries.
* This packet can be encoded only.
*
* @author bratseth
* @author Bjørn Borud
*/
public class QueryPacket extends Packet {
private final String serverId;
private final Query query;
private QueryPacketData queryPacketData;
private QueryPacket(String serverId, Query query) {
this.serverId = serverId;
this.query = query;
}
/** Returns the query from which this packet is populated */
public Query getQuery() {
return query;
}
/**
* Creates and returns a query packet
*
* @param query the query to convert to a packet
*/
public static QueryPacket create(String serverId, Query query) {
return new QueryPacket(serverId, query);
}
/** Returns the first offset requested */
public int getOffset() {
return query.getOffset();
}
/**
* Returns the <i>last</i> offset requested (inclusively), that is
* getOffset() + getHits()
*/
public int getLastOffset() {
return getOffset() + getHits();
}
/** Returns the number of hits requested */
public int getHits() {
return query.getHits();
}
public void encodeBody(ByteBuffer buffer) {
queryPacketData = new QueryPacketData();
boolean sendSessionKey = query.getGroupingSessionCache() || query.getRanking().getQueryCache();
int featureFlag = getFeatureInt(sendSessionKey);
buffer.putInt(featureFlag);
IntegerCompressor.putCompressedPositiveNumber(getOffset(), buffer);
IntegerCompressor.putCompressedPositiveNumber(getHits(), buffer);
buffer.putInt(Math.max(1, (int)query.getTimeLeft())); // Safety to avoid sending down 0 or negative number
buffer.putInt(getFlagInt());
int startOfFieldToSave = buffer.position();
Item.putString(query.getRanking().getProfile(), buffer);
queryPacketData.setRankProfile(buffer, startOfFieldToSave);
if ( (featureFlag & QF_PROPERTIES) != 0) {
startOfFieldToSave = buffer.position();
query.encodeAsProperties(buffer, true);
queryPacketData.setPropertyMaps(buffer, startOfFieldToSave);
}
// Language not needed when sending query stacks
if ((featureFlag & QF_SORTSPEC) != 0) {
int sortSpecLengthPosition=buffer.position();
buffer.putInt(0);
int sortSpecLength = query.getRanking().getSorting().encode(buffer);
buffer.putInt(sortSpecLengthPosition, sortSpecLength);
}
if ( (featureFlag & QF_GROUPSPEC) != 0) {
List<Grouping> groupingList = GroupingExecutor.getGroupingList(query);
BufferSerializer gbuf = new BufferSerializer(new GrowableByteBuffer());
gbuf.putInt(null, groupingList.size());
for (Grouping g: groupingList){
g.serialize(gbuf);
}
gbuf.getBuf().flip();
byte[] blob = new byte [gbuf.getBuf().limit()];
gbuf.getBuf().get(blob);
buffer.putInt(blob.length);
buffer.put(blob);
}
if (sendSessionKey) {
Utf8String key = query.getSessionId(serverId).asUtf8String();
buffer.putInt(key.getByteLength());
buffer.put(key.getBytes());
}
if ((featureFlag & QF_LOCATION) != 0) {
startOfFieldToSave = buffer.position();
int locationLengthPosition=buffer.position();
buffer.putInt(0);
int locationLength= query.getRanking().getLocation().encode(buffer);
buffer.putInt(locationLengthPosition, locationLength);
queryPacketData.setLocation(buffer, startOfFieldToSave);
}
startOfFieldToSave = buffer.position();
int stackItemPosition=buffer.position();
buffer.putInt(0); // Number of stack items written below
int stackLengthPosition = buffer.position();
buffer.putInt(0);
int stackPosition = buffer.position();
int stackItemCount=query.encode(buffer);
int stackLength = buffer.position() - stackPosition;
buffer.putInt(stackItemPosition,stackItemCount);
buffer.putInt(stackLengthPosition, stackLength);
queryPacketData.setQueryStack(buffer, startOfFieldToSave);
}
/**
* feature bits, taken from searchlib/common/transport.h
*/
private static final int QF_PARSEDQUERY = 0x00000002;
private static final int QF_RANKP = 0x00000004;
private static final int QF_SORTSPEC = 0x00000080;
private static final int QF_LOCATION = 0x00000800;
private static final int QF_PROPERTIES = 0x00100000;
private static final int QF_GROUPSPEC = 0x00400000;
private static final int QF_SESSIONID = 0x00800000;
private int getFeatureInt(boolean sendSessionId) {
int features = QF_PARSEDQUERY | QF_RANKP; // this bitmask means "parsed query" in query packet.
// And rank properties. Both are always present
features |= (query.getRanking().getSorting() != null) ? QF_SORTSPEC : 0;
features |= (query.getRanking().getLocation() != null) ? QF_LOCATION : 0;
features |= (query.hasEncodableProperties()) ? QF_PROPERTIES : 0;
features |= GroupingExecutor.hasGroupingList(query) ? QF_GROUPSPEC : 0;
features |= (sendSessionId) ? QF_SESSIONID : 0;
return features;
}
/**
* query flag bits, taken from searchlib/common/transport.h
*/
private static final int QFLAG_EXTENDED_COVERAGE = 0x00000001;
private static final int QFLAG_COVERAGE_NODES = 0x00000002;
private static final int QFLAG_ESTIMATE = 0x00000080;
private static final int QFLAG_DROP_SORTDATA = 0x00004000;
private static final int QFLAG_NO_RESULTCACHE = 0x00010000;
private static final int QFLAG_DUMP_FEATURES = 0x00040000;
private int getFlagInt() {
int flags = getQueryFlags(query);
queryPacketData.setQueryFlags(flags);
flags |= query.properties().getBoolean(Dispatcher.dispatchInternal, false) ? 0 : QFLAG_DROP_SORTDATA;
return flags;
}
public int getCode() {
return 218;
}
public String toString() {
return "Query x packet [query: " + query + "]";
}
static int getQueryFlags(Query query) {
int flags = QFLAG_EXTENDED_COVERAGE | QFLAG_COVERAGE_NODES;
flags |= query.properties().getBoolean(com.yahoo.search.query.Model.ESTIMATE) ? QFLAG_ESTIMATE : 0;
flags |= query.getNoCache() ? QFLAG_NO_RESULTCACHE : 0;
flags |= query.properties().getBoolean(Ranking.RANKFEATURES, false) ? QFLAG_DUMP_FEATURES : 0;
return flags;
}
/**
* Fetch a binary wrapper containing data from encoding process for use in
* creating a summary request.
*
* @return wrapper object suitable for creating a summary fetch packet
* @throws IllegalStateException if no wrapper has been generated
*/
public QueryPacketData getQueryPacketData() {
if (queryPacketData == null)
throw new IllegalStateException("Trying to fetch a hit tag without having encoded the packet first.");
return queryPacketData;
}
}
|
