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

MySQL数据库

开发平台:

Visual C++

  1. /************************************************************************
  2. SQL data field and tuple
  3. (c) 1994-1996 Innobase Oy
  4. Created 5/30/1994 Heikki Tuuri
  5. *************************************************************************/
  6. #ifndef data0data_h
  7. #define data0data_h
  8. #include "univ.i"
  9. #include "data0types.h"
  10. #include "data0type.h"
  11. #include "mem0mem.h"
  12. #include "dict0types.h"
  13. typedef struct big_rec_struct big_rec_t;
  14. /* Some non-inlined functions used in the MySQL interface: */
  15. void 
  16. dfield_set_data_noninline(
  17. dfield_t*  field, /* in: field */
  18. void* data, /* in: data */
  19. ulint len); /* in: length or UNIV_SQL_NULL */
  20. void* 
  21. dfield_get_data_noninline(
  22. dfield_t* field); /* in: field */
  23. ulint
  24. dfield_get_len_noninline(
  25. dfield_t* field); /* in: field */
  26. ulint 
  27. dtuple_get_n_fields_noninline(
  28. dtuple_t*  tuple); /* in: tuple */
  29. dfield_t* 
  30. dtuple_get_nth_field_noninline(
  31. dtuple_t*  tuple, /* in: tuple */
  32. ulint n); /* in: index of field */
  33. /*************************************************************************
  34. Gets pointer to the type struct of SQL data field. */
  35. UNIV_INLINE
  36. dtype_t*
  37. dfield_get_type(
  38. /*============*/
  39. /* out: pointer to the type struct */
  40. dfield_t* field); /* in: SQL data field */
  41. /*************************************************************************
  42. Sets the type struct of SQL data field. */
  43. UNIV_INLINE
  44. void
  45. dfield_set_type(
  46. /*============*/
  47. dfield_t* field, /* in: SQL data field */
  48. dtype_t* type); /* in: pointer to data type struct */
  49. /*************************************************************************
  50. Gets pointer to the data in a field. */
  51. UNIV_INLINE
  52. void* 
  53. dfield_get_data(
  54. /*============*/
  55. /* out: pointer to data */
  56. dfield_t* field); /* in: field */
  57. /*************************************************************************
  58. Gets length of field data. */
  59. UNIV_INLINE
  60. ulint
  61. dfield_get_len(
  62. /*===========*/
  63. /* out: length of data; UNIV_SQL_NULL if 
  64. SQL null data */
  65. dfield_t* field); /* in: field */
  66. /*************************************************************************
  67. Sets length in a field. */
  68. UNIV_INLINE
  69. void 
  70. dfield_set_len(
  71. /*===========*/
  72. dfield_t*  field, /* in: field */
  73. ulint len); /* in: length or UNIV_SQL_NULL */
  74. /*************************************************************************
  75. Sets pointer to the data and length in a field. */
  76. UNIV_INLINE
  77. void 
  78. dfield_set_data(
  79. /*============*/
  80. dfield_t*  field, /* in: field */
  81. const void* data, /* in: data */
  82. ulint len); /* in: length or UNIV_SQL_NULL */
  83. /**************************************************************************
  84. Writes an SQL null field full of zeros. */
  85. UNIV_INLINE
  86. void
  87. data_write_sql_null(
  88. /*================*/
  89. byte* data, /* in: pointer to a buffer of size len */
  90. ulint len); /* in: SQL null size in bytes */
  91. /*************************************************************************
  92. Copies the data and len fields. */
  93. UNIV_INLINE
  94. void 
  95. dfield_copy_data(
  96. /*=============*/
  97. dfield_t*  field1, /* in: field to copy to */
  98. dfield_t* field2);/* in: field to copy from */
  99. /*************************************************************************
  100. Copies a data field to another. */
  101. UNIV_INLINE
  102. void
  103. dfield_copy(
  104. /*========*/
  105. dfield_t* field1, /* in: field to copy to */
  106. dfield_t* field2);/* in: field to copy from */
  107. /*************************************************************************
  108. Tests if data length and content is equal for two dfields. */
  109. UNIV_INLINE
  110. ibool
  111. dfield_datas_are_binary_equal(
  112. /*==========================*/
  113. /* out: TRUE if equal */
  114. dfield_t* field1, /* in: field */
  115. dfield_t* field2);/* in: field */
  116. /*************************************************************************
  117. Tests if dfield data length and content is equal to the given. */
  118. ibool
  119. dfield_data_is_binary_equal(
  120. /*========================*/
  121. /* out: TRUE if equal */
  122. dfield_t* field, /* in: field */
  123. ulint len, /* in: data length or UNIV_SQL_NULL */
  124. byte* data); /* in: data */
  125. /*************************************************************************
  126. Gets number of fields in a data tuple. */
  127. UNIV_INLINE
  128. ulint 
  129. dtuple_get_n_fields(
  130. /*================*/
  131. /* out: number of fields */
  132. dtuple_t*  tuple); /* in: tuple */
  133. /*************************************************************************
  134. Gets nth field of a tuple. */
  135. UNIV_INLINE
  136. dfield_t* 
  137. dtuple_get_nth_field(
  138. /*=================*/
  139. /* out: nth field */
  140. dtuple_t*  tuple, /* in: tuple */
  141. ulint n); /* in: index of field */
  142. /*************************************************************************
  143. Gets info bits in a data tuple. */
  144. UNIV_INLINE
  145. ulint
  146. dtuple_get_info_bits(
  147. /*=================*/
  148. /* out: info bits */
  149. dtuple_t*  tuple); /* in: tuple */
  150. /*************************************************************************
  151. Sets info bits in a data tuple. */
  152. UNIV_INLINE
  153. void
  154. dtuple_set_info_bits(
  155. /*=================*/
  156. dtuple_t*  tuple, /* in: tuple */
  157. ulint info_bits); /* in: info bits */
  158. /*************************************************************************
  159. Gets number of fields used in record comparisons. */
  160. UNIV_INLINE
  161. ulint
  162. dtuple_get_n_fields_cmp(
  163. /*====================*/
  164. /* out: number of fields used in comparisons
  165. in rem0cmp.* */
  166. dtuple_t* tuple); /* in: tuple */
  167. /*************************************************************************
  168. Gets number of fields used in record comparisons. */
  169. UNIV_INLINE
  170. void
  171. dtuple_set_n_fields_cmp(
  172. /*====================*/
  173. dtuple_t* tuple, /* in: tuple */
  174. ulint n_fields_cmp); /* in: number of fields used in
  175. comparisons in rem0cmp.* */
  176. /**************************************************************
  177. Creates a data tuple to a memory heap. The default value for number
  178. of fields used in record comparisons for this tuple is n_fields. */
  179. UNIV_INLINE
  180. dtuple_t*
  181. dtuple_create(
  182. /*==========*/
  183.     /* out, own: created tuple */
  184. mem_heap_t* heap, /* in: memory heap where the tuple
  185. is created */
  186. ulint n_fields); /* in: number of fields */
  187. /*************************************************************************
  188. Creates a dtuple for use in MySQL. */
  189. dtuple_t*
  190. dtuple_create_for_mysql(
  191. /*====================*/
  192. /* out, own created dtuple */
  193. void** heap,    /* out: created memory heap */
  194. ulint n_fields); /* in: number of fields */
  195. /*************************************************************************
  196. Frees a dtuple used in MySQL. */
  197. void
  198. dtuple_free_for_mysql(
  199. /*==================*/
  200. void* heap);
  201. /*************************************************************************
  202. Sets number of fields used in a tuple. Normally this is set in
  203. dtuple_create, but if you want later to set it smaller, you can use this. */ 
  204. void
  205. dtuple_set_n_fields(
  206. /*================*/
  207. dtuple_t* tuple, /* in: tuple */
  208. ulint n_fields); /* in: number of fields */
  209. /**************************************************************
  210. The following function returns the sum of data lengths of a tuple. The space
  211. occupied by the field structs or the tuple struct is not counted. */
  212. UNIV_INLINE
  213. ulint
  214. dtuple_get_data_size(
  215. /*=================*/
  216. /* out: sum of data lens */
  217. dtuple_t* tuple); /* in: typed data tuple */
  218. /****************************************************************
  219. Returns TRUE if lengths of two dtuples are equal and respective data fields
  220. in them are equal when compared with collation in char fields (not as binary
  221. strings). */
  222. ibool
  223. dtuple_datas_are_ordering_equal(
  224. /*============================*/
  225. /* out: TRUE if length and fieds are equal
  226. when compared with cmp_data_data:
  227. NOTE: in character type fields some letters
  228. are identified with others! (collation) */
  229. dtuple_t* tuple1, /* in: tuple 1 */
  230. dtuple_t* tuple2);/* in: tuple 2 */
  231. /****************************************************************
  232. Folds a prefix given as the number of fields of a tuple. */
  233. UNIV_INLINE
  234. ulint
  235. dtuple_fold(
  236. /*========*/
  237. /* out: the folded value */
  238. dtuple_t* tuple, /* in: the tuple */
  239. ulint n_fields,/* in: number of complete fields to fold */
  240. ulint n_bytes,/* in: number of bytes to fold in an
  241. incomplete last field */
  242. dulint tree_id);/* in: index tree id */
  243. /***********************************************************************
  244. Sets types of fields binary in a tuple. */
  245. UNIV_INLINE
  246. void
  247. dtuple_set_types_binary(
  248. /*====================*/
  249. dtuple_t* tuple, /* in: data tuple */
  250. ulint n); /* in: number of fields to set */
  251. /**************************************************************************
  252. Checks if a dtuple contains an SQL null value. */
  253. UNIV_INLINE
  254. ibool
  255. dtuple_contains_null(
  256. /*=================*/
  257. /* out: TRUE if some field is SQL null */
  258. dtuple_t* tuple); /* in: dtuple */
  259. /**************************************************************
  260. Checks that a data field is typed. Asserts an error if not. */
  261. ibool
  262. dfield_check_typed(
  263. /*===============*/
  264. /* out: TRUE if ok */
  265. dfield_t* field); /* in: data field */
  266. /**************************************************************
  267. Checks that a data tuple is typed. Asserts an error if not. */
  268. ibool
  269. dtuple_check_typed(
  270. /*===============*/
  271. /* out: TRUE if ok */
  272. dtuple_t* tuple); /* in: tuple */
  273. /**************************************************************
  274. Checks that a data tuple is typed. */
  275. ibool
  276. dtuple_check_typed_no_assert(
  277. /*=========================*/
  278. /* out: TRUE if ok */
  279. dtuple_t* tuple); /* in: tuple */
  280. #ifdef UNIV_DEBUG
  281. /**************************************************************
  282. Validates the consistency of a tuple which must be complete, i.e,
  283. all fields must have been set. */
  284. ibool
  285. dtuple_validate(
  286. /*============*/
  287. /* out: TRUE if ok */
  288. dtuple_t* tuple); /* in: tuple */
  289. #endif /* UNIV_DEBUG */
  290. /*****************************************************************
  291. Pretty prints a dfield value according to its data type. */
  292. void
  293. dfield_print(
  294. /*=========*/
  295. dfield_t* dfield);/* in: dfield */
  296. /*****************************************************************
  297. Pretty prints a dfield value according to its data type. Also the hex string
  298. is printed if a string contains non-printable characters. */ 
  299. void
  300. dfield_print_also_hex(
  301. /*==================*/
  302. dfield_t* dfield);  /* in: dfield */
  303. /**************************************************************
  304. The following function prints the contents of a tuple. */
  305. void
  306. dtuple_print(
  307. /*=========*/
  308. FILE* f, /* in: output stream */
  309. dtuple_t* tuple); /* in: tuple */
  310. /******************************************************************
  311. Moves parts of long fields in entry to the big record vector so that
  312. the size of tuple drops below the maximum record size allowed in the
  313. database. Moves data only from those fields which are not necessary
  314. to determine uniquely the insertion place of the tuple in the index. */
  315. big_rec_t*
  316. dtuple_convert_big_rec(
  317. /*===================*/
  318. /* out, own: created big record vector,
  319. NULL if we are not able to shorten
  320. the entry enough, i.e., if there are
  321. too many short fields in entry */
  322. dict_index_t* index, /* in: index */
  323. dtuple_t* entry, /* in: index entry */
  324. ulint* ext_vec,/* in: array of externally stored fields,
  325. or NULL: if a field already is externally
  326. stored, then we cannot move it to the vector
  327. this function returns */
  328. ulint n_ext_vec);/* in: number of elements is ext_vec */
  329. /******************************************************************
  330. Puts back to entry the data stored in vector. Note that to ensure the
  331. fields in entry can accommodate the data, vector must have been created
  332. from entry with dtuple_convert_big_rec. */
  333. void
  334. dtuple_convert_back_big_rec(
  335. /*========================*/
  336. dict_index_t* index, /* in: index */
  337. dtuple_t* entry, /* in: entry whose data was put to vector */
  338. big_rec_t* vector);/* in, own: big rec vector; it is
  339. freed in this function */
  340. /******************************************************************
  341. Frees the memory in a big rec vector. */
  342. void
  343. dtuple_big_rec_free(
  344. /*================*/
  345. big_rec_t* vector); /* in, own: big rec vector; it is
  346. freed in this function */
  347. /*######################################################################*/
  348. /* Structure for an SQL data field */
  349. struct dfield_struct{
  350. void* data; /* pointer to data */
  351. ulint len; /* data length; UNIV_SQL_NULL if SQL null; */
  352. dtype_t type; /* type of data */
  353. };
  354. struct dtuple_struct {
  355. ulint info_bits; /* info bits of an index record:
  356. the default is 0; this field is used
  357. if an index record is built from
  358. a data tuple */
  359. ulint n_fields; /* number of fields in dtuple */
  360. ulint n_fields_cmp; /* number of fields which should
  361. be used in comparison services
  362. of rem0cmp.*; the index search
  363. is performed by comparing only these
  364. fields, others are ignored; the
  365. default value in dtuple creation is
  366. the same value as n_fields */
  367. dfield_t* fields; /* fields */
  368. UT_LIST_NODE_T(dtuple_t) tuple_list;
  369. /* data tuples can be linked into a
  370. list using this field */
  371. ulint magic_n;
  372. };
  373. #define DATA_TUPLE_MAGIC_N 65478679
  374. /* A slot for a field in a big rec vector */
  375. typedef struct big_rec_field_struct  big_rec_field_t;
  376. struct big_rec_field_struct {
  377. ulint field_no; /* field number in record */
  378. ulint len; /* stored data len */
  379. byte* data; /* stored data */
  380. };
  381. /* Storage format for overflow data in a big record, that is, a record
  382. which needs external storage of data fields */
  383. struct big_rec_struct {
  384. mem_heap_t* heap; /* memory heap from which allocated */
  385. ulint n_fields; /* number of stored fields */
  386. big_rec_field_t* fields; /* stored fields */
  387. };
  388. #ifndef UNIV_NONINL
  389. #include "data0data.ic"
  390. #endif
  391. #endif