summaryrefslogtreecommitdiff
path: root/ndb/include/transporter/TransporterDefinitions.hpp
blob: a8da806855246793ecc352378756f1059769439c (plain)
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
/* Copyright (C) 2003 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; either version 2 of the License, or
   (at your option) any later version.

   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

#ifndef TransporterDefinitions_H
#define TransporterDefinitions_H

#include <ndb_global.h> 
#include <kernel_types.h> 
#include <NdbOut.hpp>

/**
 * The maximum number of transporters allowed
 * A maximum is needed to be able to allocate the array of transporters
 */
const int MAX_NTRANSPORTERS = 128;

/**
 * The sendbuffer limit after which the contents of the buffer is sent
 */
const int TCP_SEND_LIMIT = 64000;

enum SendStatus { 
  SEND_OK = 0, 
  SEND_BLOCKED = 1, 
  SEND_DISCONNECTED = 2, 
  SEND_BUFFER_FULL = 3,
  SEND_MESSAGE_TOO_BIG = 4,
  SEND_UNKNOWN_NODE = 5
};

/**
 * Protocol6 Header + 
 *  (optional signal id) + (optional checksum) + (signal data)
 */
//const Uint32 MAX_MESSAGE_SIZE = (12+4+4+(4*25));
const Uint32 MAX_MESSAGE_SIZE = (12+4+4+(4*25)+(3*4)+4*4096);

/**
 * TCP Transporter Configuration
 */
struct TCP_TransporterConfiguration {
  Uint32 port; 
  const char *remoteHostName;
  const char *localHostName;
  NodeId remoteNodeId;
  NodeId localNodeId;
  Uint32 sendBufferSize;     // Size of SendBuffer of priority B 
  Uint32 maxReceiveSize;     // Maximum no of bytes to receive
  bool checksum;
  bool signalId;
};

/**
 * SHM Transporter Configuration
 */
struct SHM_TransporterConfiguration {
  Uint32 port; 
  NodeId remoteNodeId;
  NodeId localNodeId;
  bool checksum;
  bool signalId;
  
  Uint32 shmKey;
  Uint32 shmSize;
};

/**
 * OSE Transporter Configuration
 */
struct OSE_TransporterConfiguration {
  const char *remoteHostName;
  const char *localHostName;
  NodeId remoteNodeId;
  NodeId localNodeId;
  bool checksum;
  bool signalId;
  
  Uint32 prioASignalSize;
  Uint32 prioBSignalSize;
  Uint32 receiveBufferSize; // In number of signals
};

/**
 * SCI Transporter Configuration
 */
struct SCI_TransporterConfiguration {
  const char *remoteHostName;
  const char *localHostName;
  Uint32 port; 
  Uint32 sendLimit;        // Packet size
  Uint32 bufferSize;       // Buffer size

  Uint32 nLocalAdapters;   // 1 or 2, the number of adapters on local host
  
  Uint32 remoteSciNodeId0; // SCInodeId for adapter 1
  Uint32 remoteSciNodeId1; // SCInodeId for adapter 2
  
  NodeId localNodeId;      // Local node Id
  NodeId remoteNodeId;     // Remote node Id

  bool checksum;
  bool signalId;

};

struct SignalHeader {	
  Uint32 theVerId_signalNumber;    // 4 bit ver id - 16 bit gsn
  Uint32 theReceiversBlockNumber;  // Only 16 bit blocknum  
  Uint32 theSendersBlockRef;
  Uint32 theLength;
  Uint32 theSendersSignalId;
  Uint32 theSignalId;
  Uint16 theTrace;
  Uint8  m_noOfSections;
  Uint8  m_fragmentInfo;
}; /** 7x4 = 28 Bytes */

struct LinearSectionPtr {
  Uint32 sz;
  Uint32 * p;
};

struct SegmentedSectionPtr {
  Uint32 sz;
  Uint32 i;
  struct SectionSegment * p;

  void setNull() { p = 0;}
  bool isNull() const { return p == 0;}
};

class NdbOut & operator <<(class NdbOut & out, SignalHeader & sh);

#endif // Define of TransporterDefinitions_H