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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
|
/* Copyright (c) 2003-2006 MySQL AB
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */
#ifndef TC_KEY_REQ_H
#define TC_KEY_REQ_H
#include "SignalData.hpp"
/**
* @class TcKeyReq
* @brief Contains KeyInfo and AttrInfo and is commonly followed by more signals
*
* - SENDER: API, NDBCNTR
* - RECEIVER: TC
*/
class TcKeyReq {
/**
* Receiver(s)
*/
friend class Dbtc; // Receiver
/**
* Sender(s)
*/
friend class Ndbcntr;
friend class NdbOperation;
friend class NdbIndexOperation;
friend class NdbScanOperation;
friend class NdbBlob;
friend class DbUtil;
/**
* For printing
*/
friend bool printTCKEYREQ(FILE *, const Uint32 *, Uint32, Uint16);
friend bool printTCINDXREQ(FILE *, const Uint32 *, Uint32, Uint16);
public:
/**
* Length of signal
*/
STATIC_CONST( StaticLength = 8 );
STATIC_CONST( SignalLength = 25 );
STATIC_CONST( MaxKeyInfo = 8 );
STATIC_CONST( MaxAttrInfo = 5 );
STATIC_CONST( MaxTotalAttrInfo = 0xFFFF );
private:
enum AbortOption {
CommitIfFailFree = 0, AbortOnError = 0,
CommitAsMuchAsPossible = 2, IgnoreError = 2
};
typedef AbortOption CommitType;
/**
* DATA VARIABLES
*/
// ----------------------------------------------------------------------
// Unconditional part = must be present in signal. First 8 words
// ----------------------------------------------------------------------
Uint32 apiConnectPtr; // DATA 0
union {
Uint32 senderData;
UintR apiOperationPtr; // DATA 1
};
/**
* ATTRIBUTE INFO (attrinfo) LENGTH
* This is the total length of all attribute info that is sent from
* the application as part of this operation.
* It includes all attribute info sent in possible attrinfo
* signals as well as the attribute info sent in TCKEYREQ.
*/
UintR attrLen; // DATA 2 (also stores API Version)
UintR tableId; // DATA 3
UintR requestInfo; // DATA 4 Various transaction flags
UintR tableSchemaVersion; // DATA 5
UintR transId1; // DATA 6
UintR transId2; // DATA 7
// ----------------------------------------------------------------------
// Conditional part = can be present in signal.
// These four words will be sent only if their indicator is set.
// ----------------------------------------------------------------------
UintR scanInfo; // DATA 8 Various flags for scans
UintR distrGroupHashValue; // DATA 9
UintR distributionKeySize; // DATA 10
UintR storedProcId; // DATA 11
// ----------------------------------------------------------------------
// Variable sized KEY and ATTRINFO part.
// These will be placed to pack the signal in an appropriate manner.
// ----------------------------------------------------------------------
UintR keyInfo[MaxKeyInfo]; // DATA 12 - 19
UintR attrInfo[MaxAttrInfo]; // DATA 20 - 24
/**
* Get:ers for attrLen
*/
static Uint16 getAPIVersion(const UintR & attrLen);
static Uint16 getAttrinfoLen(const UintR & attrLen);
static void setAPIVersion(UintR & attrLen, Uint16 apiVersion);
static void setAttrinfoLen(UintR & attrLen, Uint16 aiLen);
/**
* Get:ers for requestInfo
*/
static Uint8 getCommitFlag(const UintR & requestInfo);
static Uint8 getAbortOption(const UintR & requestInfo);
static Uint8 getStartFlag(const UintR & requestInfo);
static Uint8 getSimpleFlag(const UintR & requestInfo);
static Uint8 getDirtyFlag(const UintR & requestInfo);
static Uint8 getInterpretedFlag(const UintR & requestInfo);
static Uint8 getDistributionKeyFlag(const UintR & requestInfo);
static Uint8 getScanIndFlag(const UintR & requestInfo);
static Uint8 getOperationType(const UintR & requestInfo);
static Uint8 getExecuteFlag(const UintR & requestInfo);
static Uint16 getKeyLength(const UintR & requestInfo);
static Uint8 getAIInTcKeyReq(const UintR & requestInfo);
static Uint8 getExecutingTrigger(const UintR & requestInfo);
static UintR getNoDiskFlag(const UintR & requestInfo);
/**
* Get:ers for scanInfo
*/
static Uint8 getTakeOverScanFlag(const UintR & scanInfo);
static Uint16 getTakeOverScanFragment(const UintR & scanInfo);
static Uint32 getTakeOverScanInfo(const UintR & scanInfo);
/**
* Set:ers for requestInfo
*/
static void clearRequestInfo(UintR & requestInfo);
static void setAbortOption(UintR & requestInfo, Uint32 type);
static void setCommitFlag(UintR & requestInfo, Uint32 flag);
static void setStartFlag(UintR & requestInfo, Uint32 flag);
static void setSimpleFlag(UintR & requestInfo, Uint32 flag);
static void setDirtyFlag(UintR & requestInfo, Uint32 flag);
static void setInterpretedFlag(UintR & requestInfo, Uint32 flag);
static void setDistributionKeyFlag(UintR & requestInfo, Uint32 flag);
static void setScanIndFlag(UintR & requestInfo, Uint32 flag);
static void setExecuteFlag(UintR & requestInfo, Uint32 flag);
static void setOperationType(UintR & requestInfo, Uint32 type);
static void setKeyLength(UintR & requestInfo, Uint32 len);
static void setAIInTcKeyReq(UintR & requestInfo, Uint32 len);
static void setExecutingTrigger(UintR & requestInfo, Uint32 flag);
static void setNoDiskFlag(UintR & requestInfo, UintR val);
/**
* Set:ers for scanInfo
*/
static void setTakeOverScanFlag(UintR & scanInfo, Uint8 flag);
static void setTakeOverScanFragment(UintR & scanInfo, Uint16 fragment);
static void setTakeOverScanInfo(UintR & scanInfo, Uint32 aScanInfo);
};
/**
* Request Info
*
a = Attr Info in TCKEYREQ - 3 Bits -> Max 7 (Bit 16-18)
b = Distribution Key Ind - 1 Bit 2
c = Commit Indicator - 1 Bit 4
d = Dirty Indicator - 1 Bit 0
e = Scan Indicator - 1 Bit 14
f = Execute fired trigger - 1 Bit 19
i = Interpreted Indicator - 1 Bit 15
k = Key length - 12 Bits -> Max 4095 (Bit 20 - 31)
o = Operation Type - 3 Bits -> Max 7 (Bit 5-7)
l = Execute - 1 Bit 10
p = Simple Indicator - 1 Bit 8
s = Start Indicator - 1 Bit 11
y = Commit Type - 2 Bit 12-13
n = No disk flag - 1 Bit 1
1111111111222222222233
01234567890123456789012345678901
dnb cooop lsyyeiaaafkkkkkkkkkkkk
*/
#define TCKEY_NODISK_SHIFT (1)
#define COMMIT_SHIFT (4)
#define START_SHIFT (11)
#define SIMPLE_SHIFT (8)
#define DIRTY_SHIFT (0)
#define EXECUTE_SHIFT (10)
#define INTERPRETED_SHIFT (15)
#define DISTR_KEY_SHIFT (2)
#define SCAN_SHIFT (14)
#define OPERATION_SHIFT (5)
#define OPERATION_MASK (7)
#define AINFO_SHIFT (16)
#define AINFO_MASK (7)
#define KEY_LEN_SHIFT (20)
#define KEY_LEN_MASK (4095)
#define COMMIT_TYPE_SHIFT (12)
#define COMMIT_TYPE_MASK (3)
#define EXECUTING_TRIGGER_SHIFT (19)
/**
* Scan Info
*
t = Scan take over indicator - 1 Bit
n = Take over node - 12 Bits -> max 65535
p = Scan Info - 18 Bits -> max 4095
1111111111222222222233
01234567890123456789012345678901
tpppppppppppppppppp nnnnnnnnnnnn
*/
#define TAKE_OVER_SHIFT (0)
#define TAKE_OVER_FRAG_SHIFT (20)
#define TAKE_OVER_FRAG_MASK (4095)
#define SCAN_INFO_SHIFT (1)
#define SCAN_INFO_MASK (262143)
/**
* Attr Len
*
n = Attrinfo length(words) - 16 Bits -> max 65535
a = API version no - 16 Bits -> max 65535
1111111111222222222233
01234567890123456789012345678901
aaaaaaaaaaaaaaaannnnnnnnnnnnnnnn
*/
#define API_VER_NO_SHIFT (16)
#define API_VER_NO_MASK (65535)
#define ATTRLEN_SHIFT (0)
#define ATTRLEN_MASK (65535)
inline
Uint8
TcKeyReq::getCommitFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> COMMIT_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getAbortOption(const UintR & requestInfo){
return (Uint8)((requestInfo >> COMMIT_TYPE_SHIFT) & COMMIT_TYPE_MASK);
}
inline
Uint8
TcKeyReq::getStartFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> START_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getSimpleFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> SIMPLE_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getExecuteFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> EXECUTE_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getDirtyFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> DIRTY_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getInterpretedFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> INTERPRETED_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getDistributionKeyFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> DISTR_KEY_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getScanIndFlag(const UintR & requestInfo){
return (Uint8)((requestInfo >> SCAN_SHIFT) & 1);
}
inline
Uint8
TcKeyReq::getOperationType(const UintR & requestInfo){
return (Uint8)((requestInfo >> OPERATION_SHIFT) & OPERATION_MASK);
}
inline
Uint16
TcKeyReq::getKeyLength(const UintR & requestInfo){
return (Uint16)((requestInfo >> KEY_LEN_SHIFT) & KEY_LEN_MASK);
}
inline
Uint8
TcKeyReq::getAIInTcKeyReq(const UintR & requestInfo){
return (Uint8)((requestInfo >> AINFO_SHIFT) & AINFO_MASK);
}
inline
Uint8
TcKeyReq::getExecutingTrigger(const UintR & requestInfo){
return (Uint8)((requestInfo >> EXECUTING_TRIGGER_SHIFT) & 1);
}
inline
void
TcKeyReq::clearRequestInfo(UintR & requestInfo){
requestInfo = 0;
}
inline
void
TcKeyReq::setAbortOption(UintR & requestInfo, Uint32 type){
ASSERT_MAX(type, COMMIT_TYPE_MASK, "TcKeyReq::setAbortOption");
requestInfo &= ~(COMMIT_TYPE_MASK << COMMIT_TYPE_SHIFT);
requestInfo |= (type << COMMIT_TYPE_SHIFT);
}
inline
void
TcKeyReq::setCommitFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setCommitFlag");
requestInfo &= ~(1 << COMMIT_SHIFT);
requestInfo |= (flag << COMMIT_SHIFT);
}
inline
void
TcKeyReq::setStartFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setStartFlag");
requestInfo &= ~(1 << START_SHIFT);
requestInfo |= (flag << START_SHIFT);
}
inline
void
TcKeyReq::setSimpleFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setSimpleFlag");
requestInfo &= ~(1 << SIMPLE_SHIFT);
requestInfo |= (flag << SIMPLE_SHIFT);
}
inline
void
TcKeyReq::setDirtyFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setDirstFlag");
requestInfo &= ~(1 << DIRTY_SHIFT);
requestInfo |= (flag << DIRTY_SHIFT);
}
inline
void
TcKeyReq::setExecuteFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setExecuteFlag");
requestInfo &= ~(1 << EXECUTE_SHIFT);
requestInfo |= (flag << EXECUTE_SHIFT);
}
inline
void
TcKeyReq::setInterpretedFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setInterpretedFlag");
requestInfo &= ~(1 << INTERPRETED_SHIFT);
requestInfo |= (flag << INTERPRETED_SHIFT);
}
inline
void
TcKeyReq::setDistributionKeyFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setDistributionKeyFlag");
requestInfo &= ~(1 << DISTR_KEY_SHIFT);
requestInfo |= (flag << DISTR_KEY_SHIFT);
}
inline
void
TcKeyReq::setScanIndFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setScanIndFlag");
requestInfo &= ~(1 << SCAN_SHIFT);
requestInfo |= (flag << SCAN_SHIFT);
}
inline
void
TcKeyReq::setOperationType(UintR & requestInfo, Uint32 type){
ASSERT_MAX(type, OPERATION_MASK, "TcKeyReq::setOperationType");
requestInfo &= ~(OPERATION_MASK << OPERATION_SHIFT);
requestInfo |= (type << OPERATION_SHIFT);
}
inline
void
TcKeyReq::setKeyLength(UintR & requestInfo, Uint32 len){
ASSERT_MAX(len, KEY_LEN_MASK, "TcKeyReq::setKeyLength");
requestInfo &= ~(KEY_LEN_MASK << KEY_LEN_SHIFT);
requestInfo |= (len << KEY_LEN_SHIFT);
}
inline
void
TcKeyReq::setAIInTcKeyReq(UintR & requestInfo, Uint32 len){
ASSERT_MAX(len, AINFO_MASK, "TcKeyReq::setAIInTcKeyReq");
requestInfo &= ~(AINFO_MASK << AINFO_SHIFT);
requestInfo |= (len << AINFO_SHIFT);
}
inline
void
TcKeyReq::setExecutingTrigger(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setExecutingTrigger");
requestInfo &= ~(1 << EXECUTING_TRIGGER_SHIFT);
requestInfo |= (flag << EXECUTING_TRIGGER_SHIFT);
}
inline
Uint8
TcKeyReq::getTakeOverScanFlag(const UintR & scanInfo){
return (Uint8)((scanInfo >> TAKE_OVER_SHIFT) & 1);
}
inline
Uint16
TcKeyReq::getTakeOverScanFragment(const UintR & scanInfo){
return (Uint16)((scanInfo >> TAKE_OVER_FRAG_SHIFT) & TAKE_OVER_FRAG_MASK);
}
inline
Uint32
TcKeyReq::getTakeOverScanInfo(const UintR & scanInfo){
return (Uint32)((scanInfo >> SCAN_INFO_SHIFT) & SCAN_INFO_MASK);
}
inline
void
TcKeyReq::setTakeOverScanFlag(UintR & scanInfo, Uint8 flag){
ASSERT_BOOL(flag, "TcKeyReq::setTakeOverScanFlag");
scanInfo |= (flag << TAKE_OVER_SHIFT);
}
inline
void
TcKeyReq::setTakeOverScanFragment(UintR & scanInfo, Uint16 node){
// ASSERT_MAX(node, TAKE_OVER_NODE_MASK, "TcKeyReq::setTakeOverScanNode");
scanInfo |= (node << TAKE_OVER_FRAG_SHIFT);
}
inline
void
TcKeyReq::setTakeOverScanInfo(UintR & scanInfo, Uint32 aScanInfo){
// ASSERT_MAX(aScanInfo, SCAN_INFO_MASK, "TcKeyReq::setTakeOverScanInfo");
scanInfo |= (aScanInfo << SCAN_INFO_SHIFT);
}
inline
Uint16
TcKeyReq::getAPIVersion(const UintR & anAttrLen){
return (Uint16)((anAttrLen >> API_VER_NO_SHIFT) & API_VER_NO_MASK);
}
inline
void
TcKeyReq::setAPIVersion(UintR & anAttrLen, Uint16 apiVersion){
// ASSERT_MAX(apiVersion, API_VER_NO_MASK, "TcKeyReq::setAPIVersion");
anAttrLen |= (apiVersion << API_VER_NO_SHIFT);
}
inline
Uint16
TcKeyReq::getAttrinfoLen(const UintR & anAttrLen){
return (Uint16)((anAttrLen) & ATTRLEN_MASK);
}
inline
void
TcKeyReq::setAttrinfoLen(UintR & anAttrLen, Uint16 aiLen){
// ASSERT_MAX(aiLen, ATTRLEN_MASK, "TcKeyReq::setAttrinfoLen");
anAttrLen |= aiLen;
}
inline
UintR
TcKeyReq::getNoDiskFlag(const UintR & requestInfo){
return (requestInfo >> TCKEY_NODISK_SHIFT) & 1;
}
inline
void
TcKeyReq::setNoDiskFlag(UintR & requestInfo, Uint32 flag){
ASSERT_BOOL(flag, "TcKeyReq::setNoDiskFlag");
requestInfo &= ~(1 << TCKEY_NODISK_SHIFT);
requestInfo |= (flag << TCKEY_NODISK_SHIFT);
}
#endif
|