TcIndx.hpp
上传用户:romrleung
上传日期:2022-05-23
资源大小:18897k
文件大小:13k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. /* Copyright (C) 2003 MySQL AB
  2.    This program is free software; you can redistribute it and/or modify
  3.    it under the terms of the GNU General Public License as published by
  4.    the Free Software Foundation; either version 2 of the License, or
  5.    (at your option) any later version.
  6.    This program is distributed in the hope that it will be useful,
  7.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  8.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  9.    GNU General Public License for more details.
  10.    You should have received a copy of the GNU General Public License
  11.    along with this program; if not, write to the Free Software
  12.    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
  13. #ifndef TC_INDX_H
  14. #define TC_INDX_H
  15. #include "SignalData.hpp"
  16. class TcIndxReq {
  17.   /**
  18.    * Reciver(s)
  19.    */
  20.   friend class Dbtc;         // Reciver
  21.   /**
  22.    * Sender(s)
  23.    */
  24.   friend class NdbIndexOperation; 
  25.   /**
  26.    * For printing
  27.    */
  28.   friend bool printTCINDXREQ(FILE *, const Uint32 *, Uint32, Uint16);
  29. public:
  30.   /**
  31.    * Length of signal
  32.    */
  33.   STATIC_CONST( StaticLength = 8 );
  34.   STATIC_CONST( SignalLength = 25 );
  35.   STATIC_CONST( MaxKeyInfo = 8 );
  36.   STATIC_CONST( MaxAttrInfo = 5 );
  37. private:
  38.   enum CommitType {
  39.     CommitIfFailFree = 0,
  40.     TryCommit = 1,
  41.     CommitAsMuchAsPossible = 2
  42.   };
  43.   /**
  44.    * DATA VARIABLES
  45.    */
  46. //-------------------------------------------------------------
  47. // Unconditional part. First 8 words
  48. //-------------------------------------------------------------
  49.   UintR apiConnectPtr;        // DATA 0
  50.   UintR senderData;           // DATA 1
  51.   UintR attrLen;              // DATA 2 (including API Version)
  52.   UintR indexId;              // DATA 3
  53.   UintR requestInfo;          // DATA 4
  54.   UintR indexSchemaVersion;   // DATA 5
  55.   UintR transId1;             // DATA 6
  56.   UintR transId2;             // DATA 7
  57. //-------------------------------------------------------------
  58. // Conditional part. Those four words will be sent only if their
  59. // indicator is set.
  60. //-------------------------------------------------------------
  61.   UintR scanInfo;             // DATA 8
  62.   UintR distrGroupHashValue;  // DATA 9
  63.   UintR distributionKeySize;  // DATA 10
  64.   UintR storedProcId;         // DATA 11
  65. //-------------------------------------------------------------
  66. // Variable sized key and attrinfo part. Those will be placed to
  67. // pack the signal in an appropriate manner.
  68. //-------------------------------------------------------------
  69.   UintR keyInfo[MaxKeyInfo];           // DATA 12 - 19
  70.   UintR attrInfo[MaxAttrInfo];         // DATA 20 - 24
  71.   static Uint8  getAPIVersion(const UintR & attrLen);
  72.   /**
  73.    * Get:ers for requestInfo
  74.    */
  75.   static Uint8 getCommitFlag(const UintR & requestInfo);
  76.   static Uint8 getCommitType(const UintR & requestInfo);
  77.   static Uint8 getStartFlag(const UintR & requestInfo);
  78.   static Uint8 getSimpleFlag(const UintR & requestInfo);
  79.   static Uint8 getDirtyFlag(const UintR & requestInfo);
  80.   static Uint8 getInterpretedFlag(const UintR & requestInfo);
  81.   static Uint8 getDistributionGroupFlag(const UintR & requestInfo);
  82.   static Uint8 getDistributionGroupTypeFlag(const UintR & requestInfo);
  83.   static Uint8 getDistributionKeyFlag(const UintR & requestInfo);
  84.   static Uint8 getScanIndFlag(const UintR & requestInfo);
  85.   
  86.   static Uint8 getOperationType(const UintR & requestInfo);
  87.   static Uint16 getIndexLength(const UintR & requestInfo);
  88.   static Uint8  getAIInTcIndxReq(const UintR & requestInfo);
  89.   /**
  90.    * Get:ers for scanInfo
  91.    */
  92.   static void setAPIVersion(UintR & attrLen, Uint16 apiVersion);
  93.   /**
  94.    * Set:ers for requestInfo
  95.    */
  96.   static void clearRequestInfo(UintR & requestInfo);
  97.   static void setCommitType(UintR & requestInfo, Uint32 type);
  98.   static void setCommitFlag(UintR & requestInfo, Uint32 flag);
  99.   static void setStartFlag(UintR & requestInfo, Uint32 flag);
  100.   static void setSimpleFlag(UintR & requestInfo, Uint32 flag);
  101.   static void setDirtyFlag(UintR & requestInfo, Uint32 flag);
  102.   static void setInterpretedFlag(UintR & requestInfo, Uint32 flag);
  103.   static void setDistributionGroupFlag(UintR & requestInfo, Uint32 flag);
  104.   static void setDistributionGroupTypeFlag(UintR & requestInfo, Uint32 flag);
  105.   static void setDistributionKeyFlag(UintR & requestInfo, Uint32 flag);
  106.   static void setScanIndFlag(UintR & requestInfo, Uint32 flag);
  107.   
  108.   static void setOperationType(UintR & requestInfo, Uint32 type);
  109.   
  110.   static void setIndexLength(UintR & requestInfo, Uint32 len);
  111.   static void setAIInTcIndxReq(UintR & requestInfo, Uint32 len);
  112.   /**
  113.    * Set:ers for scanInfo
  114.    */
  115. };
  116. #define API_VER_NO_SHIFT     (16)
  117. #define API_VER_NO_MASK      (65535)
  118. /**
  119.  * Request Info
  120.  *
  121.  a = Attr Info in TCINDXREQ - 3  Bits -> Max 7 (Bit 16-18)
  122.  b = Distribution Key Ind   - 1  Bit 2
  123.  c = Commit Indicator       - 1  Bit 4
  124.  d = Dirty Indicator        - 1  Bit 0
  125.  e = Scan Indicator         - 1  Bit 14
  126.  g = Distribution Group Ind - 1  Bit 1
  127.  i = Interpreted Indicator  - 1  Bit 15
  128.  k = Index lengt            - 12 Bits -> Max 4095 (Bit 20 - 31)
  129.  o = Operation Type         - 3  Bits -> Max 7 (Bit 5-7)
  130.  p = Simple Indicator       - 1  Bit 8
  131.  s = Start Indicator        - 1  Bit 11
  132.  t = Distribution GroupType - 1  Bit 3
  133.  y = Commit Type            - 2  Bit 12-13
  134.  x = Last Op in execute     - 1  Bit 19
  135.            1111111111222222222233
  136.  01234567890123456789012345678901
  137.  dgbtcooop  syyeiaaa-kkkkkkkkkkkk
  138. */
  139. #define COMMIT_SHIFT       (4)
  140. #define START_SHIFT        (11)
  141. #define SIMPLE_SHIFT       (8)
  142. #define DIRTY_SHIFT        (0)
  143. #define INTERPRETED_SHIFT  (15)
  144. #define DISTR_GROUP_SHIFT  (1)
  145. #define DISTR_GROUP_TYPE_SHIFT  (3)
  146. #define DISTR_KEY_SHIFT    (2)
  147. #define SCAN_SHIFT         (14)
  148. #define OPERATION_SHIFT   (5)
  149. #define OPERATION_MASK    (7)
  150. #define AINFO_SHIFT       (16)
  151. #define AINFO_MASK        (7)
  152. #define INDEX_LEN_SHIFT     (20)
  153. #define INDEX_LEN_MASK      (4095)
  154. #define COMMIT_TYPE_SHIFT  (12)
  155. #define COMMIT_TYPE_MASK   (3)
  156. #define LAST_OP_IN_EXEC_SHIFT (19)
  157. /**
  158.  * Scan Info
  159.  *
  160.  
  161.            1111111111222222222233
  162.  01234567890123456789012345678901
  163.  
  164. */
  165. inline
  166. Uint8
  167. TcIndxReq::getCommitFlag(const UintR & requestInfo){
  168.   return (Uint8)((requestInfo >> COMMIT_SHIFT) & 1);
  169. }
  170. inline
  171. Uint8
  172. TcIndxReq::getCommitType(const UintR & requestInfo){
  173.   return (Uint8)((requestInfo >> COMMIT_TYPE_SHIFT) & COMMIT_TYPE_MASK);
  174. }
  175. inline
  176. Uint8
  177. TcIndxReq::getStartFlag(const UintR & requestInfo){
  178.   return (Uint8)((requestInfo >> START_SHIFT) & 1);
  179. }
  180. inline
  181. Uint8
  182. TcIndxReq::getSimpleFlag(const UintR & requestInfo){
  183.   return (Uint8)((requestInfo >> SIMPLE_SHIFT) & 1);
  184. }
  185. inline
  186. Uint8
  187. TcIndxReq::getDirtyFlag(const UintR & requestInfo){
  188.   return (Uint8)((requestInfo >> DIRTY_SHIFT) & 1);
  189. }
  190. inline
  191. Uint8
  192. TcIndxReq::getInterpretedFlag(const UintR & requestInfo){
  193.   return (Uint8)((requestInfo >> INTERPRETED_SHIFT) & 1);
  194. }
  195. inline
  196. Uint8
  197. TcIndxReq::getDistributionGroupFlag(const UintR & requestInfo){
  198.   return (Uint8)((requestInfo >> DISTR_GROUP_SHIFT) & 1);
  199. }
  200. inline
  201. Uint8
  202. TcIndxReq::getDistributionGroupTypeFlag(const UintR & requestInfo){
  203.   return (Uint8)((requestInfo >> DISTR_GROUP_TYPE_SHIFT) & 1);
  204. }
  205. inline
  206. Uint8
  207. TcIndxReq::getDistributionKeyFlag(const UintR & requestInfo){
  208.   return (Uint8)((requestInfo >> DISTR_KEY_SHIFT) & 1);
  209. }
  210. inline
  211. Uint8
  212. TcIndxReq::getScanIndFlag(const UintR & requestInfo){
  213.   return (Uint8)((requestInfo >> SCAN_SHIFT) & 1);
  214. }
  215. inline
  216. Uint8
  217. TcIndxReq::getOperationType(const UintR & requestInfo){
  218.   return (Uint8)((requestInfo >> OPERATION_SHIFT) & OPERATION_MASK);
  219. }
  220. inline
  221. Uint16 
  222. TcIndxReq::getIndexLength(const UintR & requestInfo){
  223.   return (Uint16)((requestInfo >> INDEX_LEN_SHIFT) & INDEX_LEN_MASK);
  224. }
  225. inline
  226. Uint8
  227. TcIndxReq::getAIInTcIndxReq(const UintR & requestInfo){
  228.   return (Uint8)((requestInfo >> AINFO_SHIFT) & AINFO_MASK);
  229. }
  230. inline
  231. void 
  232. TcIndxReq::clearRequestInfo(UintR & requestInfo){
  233.   requestInfo = 0;
  234. }
  235. inline
  236. void 
  237. TcIndxReq::setCommitType(UintR & requestInfo, Uint32 type){
  238.   ASSERT_MAX(type, COMMIT_TYPE_MASK, "TcIndxReq::setCommitType");
  239.   requestInfo |= (type << COMMIT_TYPE_SHIFT);
  240. }
  241. inline
  242. void 
  243. TcIndxReq::setCommitFlag(UintR & requestInfo, Uint32 flag){
  244.   ASSERT_BOOL(flag, "TcIndxReq::setCommitFlag");
  245.   requestInfo &= ~(1 << COMMIT_SHIFT);
  246.   requestInfo |= (flag << COMMIT_SHIFT);
  247. }
  248. inline
  249. void 
  250. TcIndxReq::setStartFlag(UintR & requestInfo, Uint32 flag){
  251.   ASSERT_BOOL(flag, "TcIndxReq::setStartFlag");
  252.   requestInfo &= ~(1 << START_SHIFT);
  253.   requestInfo |= (flag << START_SHIFT);
  254. }
  255. inline
  256. void 
  257. TcIndxReq::setSimpleFlag(UintR & requestInfo, Uint32 flag){
  258.   ASSERT_BOOL(flag, "TcIndxReq::setSimpleFlag");
  259.   requestInfo &= ~(1 << SIMPLE_SHIFT);
  260.   requestInfo |= (flag << SIMPLE_SHIFT);
  261. }
  262. inline
  263. void 
  264. TcIndxReq::setDirtyFlag(UintR & requestInfo, Uint32 flag){
  265.   ASSERT_BOOL(flag, "TcIndxReq::setDirtyFlag");
  266.   requestInfo &= ~(1 << DIRTY_SHIFT);
  267.   requestInfo |= (flag << DIRTY_SHIFT);
  268. }
  269. inline
  270. void 
  271. TcIndxReq::setInterpretedFlag(UintR & requestInfo, Uint32 flag){
  272.   ASSERT_BOOL(flag, "TcIndxReq::setInterpretedFlag");
  273.   requestInfo &= ~(1 << INTERPRETED_SHIFT);
  274.   requestInfo |= (flag << INTERPRETED_SHIFT);
  275. }
  276. inline
  277. void 
  278. TcIndxReq::setDistributionGroupTypeFlag(UintR & requestInfo, Uint32 flag){
  279.   ASSERT_BOOL(flag, "TcIndxReq::setDistributionGroupTypeFlag");
  280.   requestInfo &= ~(1 << DISTR_GROUP_TYPE_SHIFT);
  281.   requestInfo |= (flag << DISTR_GROUP_TYPE_SHIFT);
  282. }
  283. inline
  284. void 
  285. TcIndxReq::setDistributionGroupFlag(UintR & requestInfo, Uint32 flag){
  286.   ASSERT_BOOL(flag, "TcIndxReq::setDistributionGroupFlag");
  287.   requestInfo &= ~(1 << DISTR_GROUP_SHIFT);
  288.   requestInfo |= (flag << DISTR_GROUP_SHIFT);
  289. }
  290. inline
  291. void 
  292. TcIndxReq::setDistributionKeyFlag(UintR & requestInfo, Uint32 flag){
  293.   ASSERT_BOOL(flag, "TcIndxReq::setDistributionKeyFlag");
  294.   requestInfo &= ~(1 << DISTR_KEY_SHIFT);
  295.   requestInfo |= (flag << DISTR_KEY_SHIFT);
  296. }
  297. inline
  298. void 
  299. TcIndxReq::setScanIndFlag(UintR & requestInfo, Uint32 flag){
  300.   ASSERT_BOOL(flag, "TcIndxReq::setScanIndFlag");
  301.   requestInfo &= ~(1 << SCAN_SHIFT);
  302.   requestInfo |= (flag << SCAN_SHIFT);
  303. }
  304. inline
  305. void 
  306. TcIndxReq::setOperationType(UintR & requestInfo, Uint32 type){
  307.   ASSERT_MAX(type, OPERATION_MASK, "TcIndxReq::setOperationType");
  308.   requestInfo |= (type << OPERATION_SHIFT);
  309. }
  310. inline
  311. void 
  312. TcIndxReq::setIndexLength(UintR & requestInfo, Uint32 len){
  313.   ASSERT_MAX(len, INDEX_LEN_MASK, "TcIndxReq::setKeyLength");
  314.   requestInfo |= (len << INDEX_LEN_SHIFT);
  315. }
  316. inline
  317. void 
  318. TcIndxReq::setAIInTcIndxReq(UintR & requestInfo, Uint32 len){
  319.   ASSERT_MAX(len, AINFO_MASK, "TcIndxReq::setAIInTcIndxReq");
  320.   requestInfo |= (len << AINFO_SHIFT);
  321. }
  322. inline
  323. Uint8 
  324. TcIndxReq::getAPIVersion(const UintR & anAttrLen){
  325.   return (Uint16)((anAttrLen >> API_VER_NO_SHIFT) & API_VER_NO_MASK);
  326. }
  327. inline
  328. void
  329. TcIndxReq::setAPIVersion(UintR & anAttrLen, Uint16 apiVersion){
  330. //  ASSERT_MAX(apiVersion, API_VER_NO_MASK, "TcIndxReq::setAPIVersion");
  331.   anAttrLen |= (apiVersion << API_VER_NO_SHIFT);
  332. }
  333. class TcIndxConf {
  334.   /**
  335.    * Reciver(s)
  336.    */
  337.   friend class Ndb;
  338.   friend class NdbConnection;
  339.   /**
  340.    * Sender(s)
  341.    */
  342.   friend class Dbtc; 
  343.   /**
  344.    * For printing
  345.    */
  346.   friend bool printTCINDXCONF(FILE *, const Uint32 *, Uint32, Uint16);
  347. public:
  348.   /**
  349.    * Length of signal
  350.    */
  351.   STATIC_CONST( SignalLength = 5 );
  352. private:
  353.   /**
  354.    * DATA VARIABLES
  355.    */
  356.   //-------------------------------------------------------------
  357.   // Unconditional part. First 5 words
  358.   //-------------------------------------------------------------
  359.   Uint32 apiConnectPtr;
  360.   Uint32 gci;
  361.   Uint32 confInfo;
  362.   Uint32 transId1;
  363.   Uint32 transId2;
  364.   struct OperationConf {
  365.     Uint32 apiOperationPtr;
  366.     Uint32 attrInfoLen;
  367.   };
  368.   //-------------------------------------------------------------
  369.   // Operations confirmations,
  370.   // No of actually sent = getNoOfOperations(confInfo)
  371.   //-------------------------------------------------------------
  372.   OperationConf operations[10];
  373.   
  374.   /**
  375.    * Get:ers for confInfo
  376.    */
  377.   static Uint32 getNoOfOperations(const Uint32 & confInfo);
  378.   static Uint32 getCommitFlag(const Uint32 & confInfo);
  379.   static bool getMarkerFlag(const Uint32 & confInfo);
  380.   
  381.   /**
  382.    * Set:ers for confInfo
  383.    */
  384.   static void setCommitFlag(Uint32 & confInfo, Uint8 flag);
  385.   static void setNoOfOperations(Uint32 & confInfo, Uint32 noOfOps);
  386.   static void setMarkerFlag(Uint32 & confInfo, Uint32 flag);
  387. };
  388. inline
  389. Uint32
  390. TcIndxConf::getNoOfOperations(const Uint32 & confInfo){
  391.   return confInfo & 65535;
  392. }
  393. inline
  394. Uint32
  395. TcIndxConf::getCommitFlag(const Uint32 & confInfo){
  396.   return ((confInfo >> 16) & 1);
  397. }
  398. inline
  399. bool
  400. TcIndxConf::getMarkerFlag(const Uint32 & confInfo){
  401.   const Uint32 bits = 3 << 16; // Marker only valid when doing commit
  402.   return (confInfo & bits) == bits;
  403. }
  404. inline
  405. void 
  406. TcIndxConf::setNoOfOperations(Uint32 & confInfo, Uint32 noOfOps){
  407.   ASSERT_MAX(noOfOps, 65535, "TcIndxConf::setNoOfOperations");
  408.   confInfo |= noOfOps;
  409. }
  410. inline
  411. void 
  412. TcIndxConf::setCommitFlag(Uint32 & confInfo, Uint8 flag){
  413.   ASSERT_BOOL(flag, "TcIndxConf::setCommitFlag");
  414.   confInfo |= (flag << 16);
  415. }
  416. inline
  417. void
  418. TcIndxConf::setMarkerFlag(Uint32 & confInfo, Uint32 flag){
  419.   ASSERT_BOOL(flag, "TcIndxConf::setMarkerFlag");
  420.   confInfo |= (flag << 17);
  421. }
  422. class TcIndxRef {
  423.   /**
  424.    * Reciver(s)
  425.    */
  426.   friend class NdbIndexOperation;
  427.   /**
  428.    * Sender(s)
  429.    */
  430.   friend class Dbtc; 
  431.   /**
  432.    * For printing
  433.    */
  434.   friend bool printTCINDXREF(FILE *, const Uint32 *, Uint32, Uint16);
  435. public:
  436.   /**
  437.    * Length of signal
  438.    */
  439. public:
  440.   STATIC_CONST( SignalLength = 4 );
  441. private:
  442.   Uint32 connectPtr;
  443.   Uint32 transId[2];
  444.   Uint32 errorCode;
  445. };
  446. #endif