tdataformat.h 9.5 KB
Newer Older
H
more  
hzcheng 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
 *
 * This program is free software: you can use, redistribute, and/or modify
 * it under the terms of the GNU Affero General Public License, version 3
 * or later ("AGPL"), as published by the Free Software Foundation.
 *
 * 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.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
H
hzcheng 已提交
15
#ifndef _TD_DATA_FORMAT_H_
H
more  
Hongze Cheng 已提交
16 17 18
#define _TD_DATA_FORMAT_H_

#include <stdint.h>
H
hzcheng 已提交
19
#include <stdlib.h>
H
hzcheng 已提交
20
#include <string.h>
H
more  
Hongze Cheng 已提交
21

H
hzcheng 已提交
22
#include "taosdef.h"
H
TD-166  
hzcheng 已提交
23
#include "tutil.h"
H
hzcheng 已提交
24

H
more  
hzcheng 已提交
25 26 27
#ifdef __cplusplus
extern "C" {
#endif
H
hzcheng 已提交
28

29 30
#define STR_TO_VARSTR(x, str) do {VarDataLenT __len = strlen(str); \
  *(VarDataLenT*)(x) = __len; \
31
  strncpy(varDataVal(x), (str), __len);} while(0);
32 33

#define STR_WITH_MAXSIZE_TO_VARSTR(x, str, _maxs) do {\
34 35
  char* _e = stpncpy(varDataVal(x), (str), (_maxs));\
  varDataSetLen(x, (_e - (x) - VARSTR_HEADER_SIZE));\
36 37 38 39
} while(0)

#define STR_WITH_SIZE_TO_VARSTR(x, str, _size) do {\
  *(VarDataLenT*)(x) = (_size); \
40
  strncpy(varDataVal(x), (str), (_size));\
H
hjxilinx 已提交
41 42
} while(0);

H
hzcheng 已提交
43 44 45 46 47
// ----------------- TSDB COLUMN DEFINITION
typedef struct {
  int8_t  type;    // Column type
  int16_t colId;   // column ID
  int32_t bytes;   // column bytes
H
TD-166  
hzcheng 已提交
48
  int32_t offset;  // point offset in SDataRow after the header part
H
hzcheng 已提交
49 50 51 52 53 54 55 56 57 58 59 60 61 62
} STColumn;

#define colType(col) ((col)->type)
#define colColId(col) ((col)->colId)
#define colBytes(col) ((col)->bytes)
#define colOffset(col) ((col)->offset)

#define colSetType(col, t) (colType(col) = (t))
#define colSetColId(col, id) (colColId(col) = (id))
#define colSetBytes(col, b) (colBytes(col) = (b))
#define colSetOffset(col, o) (colOffset(col) = (o))

// ----------------- TSDB SCHEMA DEFINITION
typedef struct {
H
TD-166  
hzcheng 已提交
63
  int      totalCols;  // Total columns allocated
H
hzcheng 已提交
64
  int      numOfCols;  // Number of columns appended
H
TD-166  
hzcheng 已提交
65 66
  int      tlen;       // maximum length of a SDataRow without the header part
  int      flen;       // First part length in a SDataRow after the header part
H
hzcheng 已提交
67 68 69 70
  STColumn columns[];
} STSchema;

#define schemaNCols(s) ((s)->numOfCols)
H
TD-166  
hzcheng 已提交
71 72 73
#define schemaTotalCols(s) ((s)->totalCols)
#define schemaTLen(s) ((s)->tlen)
#define schemaFLen(s) ((s)->flen)
H
hzcheng 已提交
74 75 76
#define schemaColAt(s, i) ((s)->columns + i)

STSchema *tdNewSchema(int32_t nCols);
H
TD-166  
hzcheng 已提交
77 78
#define   tdFreeSchema(s) tfree((s))
int       tdSchemaAddCol(STSchema *pSchema, int8_t type, int16_t colId, int32_t bytes);
H
hzcheng 已提交
79
STSchema *tdDupSchema(STSchema *pSchema);
H
TD-27  
hzcheng 已提交
80 81 82
int       tdGetSchemaEncodeSize(STSchema *pSchema);
void *    tdEncodeSchema(void *dst, STSchema *pSchema);
STSchema *tdDecodeSchema(void **psrc);
H
hzcheng 已提交
83

H
more  
Hongze Cheng 已提交
84 85
// ----------------- Data row structure

H
hzcheng 已提交
86
/* A data row, the format is like below:
H
TD-166  
hzcheng 已提交
87 88 89 90 91 92 93
 * |<------------------------------------- len ---------------------------------->|
 * |<--Head ->|<---------   flen -------------->|                                 |
 * +----------+---------------------------------+---------------------------------+
 * | int32_t  |                                 |                                 |
 * +----------+---------------------------------+---------------------------------+
 * |   len    |           First part            |             Second part         |
 * +----------+---------------------------------+---------------------------------+
H
more  
Hongze Cheng 已提交
94
 */
H
hzcheng 已提交
95 96
typedef void *SDataRow;

H
TD-166  
hzcheng 已提交
97
#define TD_DATA_ROW_HEAD_SIZE sizeof(int32_t)
H
hzcheng 已提交
98

H
hzcheng 已提交
99
#define dataRowLen(r) (*(int32_t *)(r))
H
hzcheng 已提交
100
#define dataRowTuple(r) POINTER_SHIFT(r, TD_DATA_ROW_HEAD_SIZE)
H
TD-34  
hzcheng 已提交
101
#define dataRowKey(r) (*(TSKEY *)(dataRowTuple(r)))
H
hzcheng 已提交
102
#define dataRowSetLen(r, l) (dataRowLen(r) = (l))
H
hzcheng 已提交
103
#define dataRowCpy(dst, r) memcpy((dst), (r), dataRowLen(r))
H
TD-166  
hzcheng 已提交
104
#define dataRowMaxBytesFromSchema(s) (schemaTLen(s) + TD_DATA_ROW_HEAD_SIZE)
H
hzcheng 已提交
105

H
hzcheng 已提交
106
SDataRow tdNewDataRowFromSchema(STSchema *pSchema);
H
hzcheng 已提交
107
void     tdFreeDataRow(SDataRow row);
H
TD-166  
hzcheng 已提交
108
void     tdInitDataRow(SDataRow row, STSchema *pSchema);
H
TD-166  
hzcheng 已提交
109
int      tdAppendColVal(SDataRow row, void *value, int8_t type, int32_t bytes, int32_t offset);
H
hzcheng 已提交
110
SDataRow tdDataRowDup(SDataRow row);
H
more  
Hongze Cheng 已提交
111

H
TD-166  
hzcheng 已提交
112
// NOTE: offset here including the header size
H
TD-166  
hzcheng 已提交
113 114 115 116
static FORCE_INLINE void *tdGetRowDataOfCol(SDataRow row, int8_t type, int32_t offset) {
  switch (type) {
    case TSDB_DATA_TYPE_BINARY:
    case TSDB_DATA_TYPE_NCHAR:
H
hzcheng 已提交
117
      return POINTER_SHIFT(row, *(VarDataOffsetT *)POINTER_SHIFT(row, offset));
H
TD-166  
hzcheng 已提交
118
    default:
H
hzcheng 已提交
119
      return POINTER_SHIFT(row, offset);
H
TD-166  
hzcheng 已提交
120 121 122
  }
}

H
TD-34  
hzcheng 已提交
123 124
// ----------------- Data column structure
typedef struct SDataCol {
H
TD-166  
hzcheng 已提交
125 126 127
  int8_t          type;       // column type
  int16_t         colId;      // column ID
  int             bytes;      // column data bytes defined
H
TD-166  
hzcheng 已提交
128
  int             offset;     // data offset in a SDataRow (including the header size)
H
TD-166  
hzcheng 已提交
129 130 131 132
  int             spaceSize;  // Total space size for this column
  int             len;        // column data length
  VarDataOffsetT *dataOff;    // For binary and nchar data, the offset in the data column
  void *          pData;      // Actual data pointer
H
TD-34  
hzcheng 已提交
133 134
} SDataCol;

H
TD-166  
hzcheng 已提交
135 136 137
static FORCE_INLINE void dataColReset(SDataCol *pDataCol) { pDataCol->len = 0; }

void dataColInit(SDataCol *pDataCol, STColumn *pCol, void **pBuf, int maxPoints);
H
TD-166  
hzcheng 已提交
138
void dataColAppendVal(SDataCol *pCol, void *value, int numOfPoints, int maxPoints);
H
TD-166  
hzcheng 已提交
139 140 141
void dataColPopPoints(SDataCol *pCol, int pointsToPop, int numOfPoints);
void dataColSetOffset(SDataCol *pCol, int nEle);

H
TD-166  
hzcheng 已提交
142 143
bool isNEleNull(SDataCol *pCol, int nEle);
void dataColSetNEleNull(SDataCol *pCol, int nEle, int maxPoints);
H
TD-166  
hzcheng 已提交
144 145 146

// Get the data pointer from a column-wised data
static FORCE_INLINE void *tdGetColDataOfRow(SDataCol *pCol, int row) {
H
TD-166  
hzcheng 已提交
147 148 149
  switch (pCol->type) {
    case TSDB_DATA_TYPE_BINARY:
    case TSDB_DATA_TYPE_NCHAR:
H
hzcheng 已提交
150
      return POINTER_SHIFT(pCol->pData, pCol->dataOff[row]);
H
TD-166  
hzcheng 已提交
151 152 153
      break;

    default:
H
hzcheng 已提交
154
      return POINTER_SHIFT(pCol->pData, TYPE_BYTES[pCol->type] * row);
H
TD-166  
hzcheng 已提交
155
      break;
H
TD-166  
hzcheng 已提交
156 157 158
  }
}

H
TD-166  
hzcheng 已提交
159
static FORCE_INLINE int32_t dataColGetNEleLen(SDataCol *pDataCol, int rows) {
H
TD-166  
hzcheng 已提交
160 161
  ASSERT(rows > 0);

H
TD-166  
hzcheng 已提交
162 163 164
  switch (pDataCol->type) {
    case TSDB_DATA_TYPE_BINARY:
    case TSDB_DATA_TYPE_NCHAR:
H
TD-166  
hzcheng 已提交
165
      return pDataCol->dataOff[rows - 1] + varDataTLen(tdGetColDataOfRow(pDataCol, rows - 1));
H
TD-166  
hzcheng 已提交
166 167
      break;
    default:
H
TD-166  
hzcheng 已提交
168
      return TYPE_BYTES[pDataCol->type] * rows;
H
TD-166  
hzcheng 已提交
169 170 171 172
  }
}


H
TD-34  
hzcheng 已提交
173
typedef struct {
H
TD-34  
hzcheng 已提交
174 175 176
  int      maxRowSize;
  int      maxCols;    // max number of columns
  int      maxPoints;  // max number of points
H
TD-166  
hzcheng 已提交
177
  int      bufSize;
H
TD-166  
hzcheng 已提交
178

H
TD-34  
hzcheng 已提交
179
  int      numOfPoints;
H
TD-34  
hzcheng 已提交
180
  int      numOfCols;  // Total number of cols
H
TD-34  
hzcheng 已提交
181
  int      sversion;   // TODO: set sversion
H
TD-34  
hzcheng 已提交
182 183 184 185
  void *   buf;
  SDataCol cols[];
} SDataCols;

H
TD-34  
hzcheng 已提交
186
#define keyCol(pCols) (&((pCols)->cols[0]))  // Key column
H
TD-166  
hzcheng 已提交
187
#define dataColsKeyAt(pCols, idx) ((TSKEY *)(keyCol(pCols)->pData))[(idx)]
H
TD-34  
hzcheng 已提交
188
#define dataColsKeyFirst(pCols) dataColsKeyAt(pCols, 0)
H
hzcheng 已提交
189
#define dataColsKeyLast(pCols) ((pCols->numOfPoints == 0) ? 0 : dataColsKeyAt(pCols, (pCols)->numOfPoints - 1))
H
TD-34  
hzcheng 已提交
190

H
TD-166  
hzcheng 已提交
191
SDataCols *tdNewDataCols(int maxRowSize, int maxCols, int maxRows);
H
TD-34  
hzcheng 已提交
192
void       tdResetDataCols(SDataCols *pCols);
H
TD-34  
hzcheng 已提交
193
void       tdInitDataCols(SDataCols *pCols, STSchema *pSchema);
H
TD-100  
hzcheng 已提交
194
SDataCols *tdDupDataCols(SDataCols *pCols, bool keepData);
H
TD-34  
hzcheng 已提交
195
void       tdFreeDataCols(SDataCols *pCols);
H
TD-34  
hzcheng 已提交
196
void       tdAppendDataRowToDataCol(SDataRow row, SDataCols *pCols);
H
hjxilinx 已提交
197
void       tdPopDataColsPoints(SDataCols *pCols, int pointsToPop); //!!!!
H
hzcheng 已提交
198
int        tdMergeDataCols(SDataCols *target, SDataCols *src, int rowsToMerge);
H
TD-100  
hzcheng 已提交
199
void       tdMergeTwoDataCols(SDataCols *target, SDataCols *src1, int *iter1, SDataCols *src2, int *iter2, int tRows);
H
more  
Hongze Cheng 已提交
200

T
Tao Liu 已提交
201 202 203 204 205 206 207 208 209 210

// ----------------- Tag row structure

/* A tag row, the format is like below:
+----------+-------------------------------------------------------------+---------------------------------+
|  int16   | int16  | int64   | int16  | int64   | ...| int16  | int64   |              char               |
+----------+-------------------------------------------------------------+---------------------------------+
|  ncols   | colId1 | offset1 | colId2 | offset2 | ...| colIdN | offsetN |              values             |
+----------+-------------------------------------------------------------+---------------------------------+
 */
T
Tao Liu 已提交
211

T
Tao Liu 已提交
212 213 214 215 216 217 218 219 220 221 222 223

#define TD_TAG_ROW_HEAD_SIZE sizeof(int16_t)

#define tagRowNum(r) (*(int16_t *)(r))
#define tagRowArray(r) POINTER_SHIFT(r, TD_TAG_ROW_HEAD_SIZE)
//#define dataRowKey(r) (*(TSKEY *)(dataRowTuple(r)))
//#define dataRowSetLen(r, l) (dataRowLen(r) = (l))
//#define dataRowCpy(dst, r) memcpy((dst), (r), dataRowLen(r))
//#define dataRowMaxBytesFromSchema(s) (schemaTLen(s) + TD_DATA_ROW_HEAD_SIZE)

typedef struct {
  int16_t colId;   // column ID
T
Tao Liu 已提交
224 225 226
  int8_t colType;
  int8_t colLen;  // if col type is binary/Nchar, this is the length of binary/Nchar
  int16_t offset;  //to store value for numeric col or offset for binary/Nchar
T
Tao Liu 已提交
227 228 229
} STagCol;

typedef struct {
T
Tao Liu 已提交
230
  int32_t    len;  
T
Tao Liu 已提交
231
  void *     pData;  // Space to store the tag value   
T
Tao Liu 已提交
232 233
  int16_t    ncols;  // Total columns allocated
  STagCol    tagCols[];
T
Tao Liu 已提交
234 235
} STagRow;

T
Tao Liu 已提交
236 237 238 239 240 241 242 243

#define tagColSize(r) (sizeof(STagCol) + r.colLen)

int tdInsertTagCol(SDataRow row, void *value, int16_t len, int8_t type, int16_t colId);  //insert tag value and update all the information
int tdDeleteTagCol(SDataRow row, int16_t colId);  // delete tag value and update all the information
int tdQuerTagByID(SDataRow row, int16_t colId, void *value);   //if find tag, return value length, else return -1;
int tdAppendTagColVal(SDataRow row, void *value, int8_t type, int32_t bytes);  

T
Tao Liu 已提交
244
SDataRow tdNewTagRowFromSchema(STSchema *pSchema);
T
Tao Liu 已提交
245
STSchema *tdGetSchemaFromData(SDataRow *row);
T
Tao Liu 已提交
246

H
more  
hzcheng 已提交
247 248 249 250
#ifdef __cplusplus
}
#endif

H
hzcheng 已提交
251
#endif  // _TD_DATA_FORMAT_H_