DECIMAL 數據處理原理淺析

• 2022 年 8 月 23 日
• 筆記
• GreatSQL

註：本文分析內容基於 MySQL 8.0 版本

文章開始前先複習一下官方文檔關於 DECIMAL 類型的一些介紹：

The declaration syntax for a DECIMAL column is DECIMAL(M,D). The ranges of values for the arguments are as follows:

M is the maximum number of digits (the precision). It has a range of 1 to 65.

D is the number of digits to the right of the decimal point (the scale). It has a range of 0 to 30 and must be no larger than M.

If D is omitted, the default is 0. If M is omitted, the default is 10.

The maximum value of 65 for M means that calculations on DECIMAL values are accurate up to 65 digits. This limit of 65 digits of precision also applies to exact-value numeric literals, so the maximum range of such literals differs from before. (There is also a limit on how long the text of DECIMAL literals can be; see Section 12.25.3, 「Expression Handling」.)

以上材料提到的最大精度和小數位是本文分析關注的重點：

1. 最大精度是 65 位
2. 小數位最多 30 位

接下來將先分析 MySQL 服務輸入處理 DECIMAL 類型的常數。

現在，先拋出幾個問題：

1. MySQL 中當使用 SELECT 查詢常數時，例如：SELECT 123456789.123; 是如何處理的？
2. MySQL 中查詢一下兩條語句分別返回結果是多少？為什麼？

   SELECT 111111111111111111111111111111111111111111111111111111111111111111111111111111111;
   SELECT 1111111111111111111111111111111111111111111111111111111111111111111111111111111111;
   

MySQL 如何解析常數

來看第1個問題，MySQL 的詞法分析在處理 SELECT 查詢常數的語句時，會根據數字串的長度選擇合適的類型來存儲數值，決策邏輯程式碼位於 int_token(const char *str, uint length)@sql_lex.cc，具體的程式碼片段如下：

static inline uint int_token(const char *str, uint length) {
  ...
  if (neg) {
      cmp = signed_long_str + 1;
      smaller = NUM;      // If <= signed_long_str
      bigger = LONG_NUM;  // If >= signed_long_str
    } else if (length < signed_longlong_len)
      return LONG_NUM;
    else if (length > signed_longlong_len)
      return DECIMAL_NUM;
    else {
      cmp = signed_longlong_str + 1;
      smaller = LONG_NUM;  // If <= signed_longlong_str
      bigger = DECIMAL_NUM;
    }
  } else {
    if (length == long_len) {
      cmp = long_str;
      smaller = NUM;
      bigger = LONG_NUM;
    } else if (length < longlong_len)
      return LONG_NUM;
    else if (length > longlong_len) {
      if (length > unsigned_longlong_len) return DECIMAL_NUM;
      cmp = unsigned_longlong_str;
      smaller = ULONGLONG_NUM;
      bigger = DECIMAL_NUM;
    } else {
      cmp = longlong_str;
      smaller = LONG_NUM;
      bigger = ULONGLONG_NUM;
    }
  }
  while (*cmp && *cmp++ == *str++)
    ;
  return ((uchar)str[-1] <= (uchar)cmp[-1]) ? smaller : bigger;
}

上面程式碼中，long_len 值為 10，longlong_len 值為 19，unsigned_longlong_len值為20。

neg表示是否是負數，直接看正數的處理分支，負數同理：

• 當輸入的數值串長度等於 10 時 MySQL 可能使用 LONG_NUM 或 LONG_NUM 表示
• 當輸入的數值串長度小於 19 時 MySQL 使用 LONG_NUM 表示
• 當輸入的數值串長度等於 20 時 MySQL 可能使用 LONG_NUM 或 DECIMAL_NUM 表示
• 當輸入的數值串長度大於 20 時 MySQL 使用 DECIMAL_NUM 表示
• 其他長度時，MySQL 可能使用 LONG_NUM或ULONGLONG_NUM 表示

對於可能有兩種表示方式的數據，MySQL 是通過將數字串與 cmp 指向的數值字元串進行比較，如果小於等於 cmp 表示的數值則使用 smaller 表示，否則使用 bigger 表示。cmp 指向的數值字元串定義在 sql_lex.cc 文件中，具體如下：

static const char *long_str = "2147483647";
static const uint long_len = 10;
static const char *signed_long_str = "-2147483648";
static const char *longlong_str = "9223372036854775807";
static const uint longlong_len = 19;
static const char *signed_longlong_str = "-9223372036854775808";
static const uint signed_longlong_len = 19;
static const char *unsigned_longlong_str = "18446744073709551615";
static const uint unsigned_longlong_len = 20;

因此，這裡我們可以得出結論：MySQL 中當使用 SELECT 查詢常數時，根據數值串的長度和數值大小來決定使用什麼類型來接收常數。當數值串長度大於 20，或數值串長度等於 20 且數值小於-9223372036854775808或大於18446744073709551615時，MySQL 服務選擇使用 DECIMAL 類型來接收處理常數。

這裡，再拋出一個問題：
3. 上面分析提到的 DECIMAL 是否與官方文檔中提到的 DECIMAL 類型或者換一種方式說：是否與建表語句 CREATE TABLE t(d DECIMAL(65, 30)); 中欄位 d 的 DECIMAL(65, 30)類型(可以不考慮精度和小數位)相同？

MySQL 解析 DECIMAL 常數時怎麼處理溢出

分析第2個問題，先看一下語句的執行結果：

root@mysqldb 14:09:  [(none)]> SELECT 111111111111111111111111111111111111111111111111111111111111111111111111111111111;
+-----------------------------------------------------------------------------------+
| 111111111111111111111111111111111111111111111111111111111111111111111111111111111 |
+-----------------------------------------------------------------------------------+
| 111111111111111111111111111111111111111111111111111111111111111111111111111111111 |
+-----------------------------------------------------------------------------------+
1 row in set (2.28 sec)

root@mysqldb 14:09:  [(none)]> SELECT 1111111111111111111111111111111111111111111111111111111111111111111111111111111111;
+------------------------------------------------------------------------------------+
| 1111111111111111111111111111111111111111111111111111111111111111111111111111111111 |
+------------------------------------------------------------------------------------+
|                  99999999999999999999999999999999999999999999999999999999999999999 |
+------------------------------------------------------------------------------------+
1 row in set, 1 warning (2.01 sec)

接著上面的思路往下看常數的語法解析：

NUM_literal:
          int64_literal
        | DECIMAL_NUM
          {
            $$= NEW_PTN Item_decimal(@$, $1.str, $1.length, YYCSCL);
          }
        | FLOAT_NUM
          {
            $$= NEW_PTN Item_float(@$, $1.str, $1.length);
          }
        ;

語法解析器在獲取到 toekn = DECIMAL_NUM 後，會創建一個 Item_decimal 對象來存儲輸入的數值。

在分析程式碼之前先來看幾個常數定義：

/** maximum length of buffer in our big digits (uint32). */
static constexpr int DECIMAL_BUFF_LENGTH{9};

/** the number of digits that my_decimal can possibly contain */
static constexpr int DECIMAL_MAX_POSSIBLE_PRECISION{DECIMAL_BUFF_LENGTH * 9};

/**
  maximum guaranteed precision of number in decimal digits (number of our
  digits * number of decimal digits in one our big digit - number of decimal
  digits in one our big digit decreased by 1 (because we always put decimal
  point on the border of our big digits))
*/
static constexpr int DECIMAL_MAX_PRECISION{DECIMAL_MAX_POSSIBLE_PRECISION -
                                           8 * 2};

static constexpr int DECIMAL_MAX_SCALE{30};

• DECIMAL_BUFF_LENGTH：表示整個 DECIMAL 類型數據的緩衝區大小
• DECIMAL_MAX_POSSIBLE_PRECISION：每個緩衝區單元可以存儲 9 位數字，所以最大可以處理的精度這裡為 81
• DECIMAL_MAX_PRECISION：用來限制官方文檔介紹中 decimal(M,D) 中的 M 的最大值，亦或是當超大常數溢出後返回的整數部分最大長度
• DECIMAL_MAX_SCALE：用來限制官方文檔介紹中 decimal(M,D) 中的 D 的最大值

Item_decimal::Item_decimal(const POS &pos, const char *str_arg, uint length,
                           const CHARSET_INFO *charset)
    : super(pos) {
  str2my_decimal(E_DEC_FATAL_ERROR, str_arg, length, charset, &decimal_value);
  item_name.set(str_arg);
  set_data_type(MYSQL_TYPE_NEWDECIMAL);
  decimals = (uint8)decimal_value.frac;
  fixed = true;
  max_length = my_decimal_precision_to_length_no_truncation(
      decimal_value.intg + decimals, decimals, unsigned_flag);
}

在Item_decimal構造函數中調用str2my_decimal函數對輸入數值進行處理，將其轉換為my_decimal類型的數據。

int str2my_decimal(uint mask, const char *from, size_t length,
                   const CHARSET_INFO *charset, my_decimal *decimal_value) {
  const char *end, *from_end;
  int err;
  char buff[STRING_BUFFER_USUAL_SIZE];
  String tmp(buff, sizeof(buff), &my_charset_bin);
  if (charset->mbminlen > 1) {
    uint dummy_errors;
    tmp.copy(from, length, charset, &my_charset_latin1, &dummy_errors);
    from = tmp.ptr();
    length = tmp.length();
    charset = &my_charset_bin;
  }
  from_end = end = from + length;
  err = string2decimal(from, (decimal_t *)decimal_value, &end);
  if (end != from_end && !err) {
    /* Give warning if there is something other than end space */
    for (; end < from_end; end++) {
      if (!my_isspace(&my_charset_latin1, *end)) {
        err = E_DEC_TRUNCATED;
        break;
      }
  }
  check_result_and_overflow(mask, err, decimal_value);
  return err;
}

str2my_decimal 函數先將數值字元串轉為合適的字符集後，調用 string2decimal 函數將數值字元串轉為 decimal_t 類型的數據。my_decimal 類型和 decimal_t 類型的關係如下：

@startuml

class decimal_t 
{
  + int intg, frac, len;
  + bool sign;
  + decimal_digit_t *buf;
}

class my_decimal
{
  - decimal_digit_t buffer[DECIMAL_BUFF_LENGTH];
}

decimal_t <|-- my_decimal
@enduml

• decimal_digit_t 是 int32_t 的別名
• intg 表示整數部分的字元個數
• frac 表示小數部分的字元個數
• sign 表示是否負數
• buf 指向 buffer
• buffer 是數據存放數組，數組長度為9，也就意味著一個 decimal 最多可以存放 9 個 int32_t 大小的數據，但由於設計限制每個數組元素限制存儲 9 個字元，因此 buffer 最多可以存儲81個字元

由於 buffer 長度的限制，在 string2decimal 函數解析時會有溢出的可能，因此，解析後還需要調用check_result_and_overflow函數處理溢出的情況。

string2decimal 的程式碼實現：

int string2decimal(const char *from, decimal_t *to, const char **end) {
  const char *s = from, *s1, *endp, *end_of_string = *end;
  int i, intg, frac, error, intg1, frac1;
  dec1 x, *buf;
  sanity(to);

  error = E_DEC_BAD_NUM; /* In case of bad number */
  while (s < end_of_string && my_isspace(&my_charset_latin1, *s)) s++;
  if (s == end_of_string) goto fatal_error;

  if ((to->sign = (*s == '-')))
    s++;
  else if (*s == '+')
    s++;

  s1 = s;
  while (s < end_of_string && my_isdigit(&my_charset_latin1, *s)) s++;
  intg = (int)(s - s1);
  if (s < end_of_string && *s == '.') {
    endp = s + 1;
    while (endp < end_of_string && my_isdigit(&my_charset_latin1, *endp))
      endp++;
    frac = (int)(endp - s - 1);
  } else {
    frac = 0;
    endp = s;
  }

  *end = endp;

  if (frac + intg == 0) goto fatal_error;

  error = 0;

  intg1 = ROUND_UP(intg);
  frac1 = ROUND_UP(frac);
  FIX_INTG_FRAC_ERROR(to->len, intg1, frac1, error);
  if (unlikely(error)) {
    frac = frac1 * DIG_PER_DEC1;
    if (error == E_DEC_OVERFLOW) intg = intg1 * DIG_PER_DEC1;
  }

  /* Error is guranteed to be set here */
  to->intg = intg;
  to->frac = frac;

  buf = to->buf + intg1;
  s1 = s;

  for (x = 0, i = 0; intg; intg--) {
    x += (*--s - '0') * powers10[i];

    if (unlikely(++i == DIG_PER_DEC1)) {
      *--buf = x;
      x = 0;
      i = 0;
    }
  }
  if (i) *--buf = x;

  buf = to->buf + intg1;
  for (x = 0, i = 0; frac; frac--) {
    x = (*++s1 - '0') + x * 10;

    if (unlikely(++i == DIG_PER_DEC1)) {
      *buf++ = x;
      x = 0;
      i = 0;
    }
  }
  if (i) *buf = x * powers10[DIG_PER_DEC1 - i];

  /* Handle exponent */
  if (endp + 1 < end_of_string && (*endp == 'e' || *endp == 'E')) {
    int str_error;
    longlong exponent = my_strtoll10(endp + 1, &end_of_string, &str_error);

    if (end_of_string != endp + 1) /* If at least one digit */
    {
      *end = end_of_string;
      if (str_error > 0) {
        error = E_DEC_BAD_NUM;
        goto fatal_error;
      }
      if (exponent > INT_MAX / 2 || (str_error == 0 && exponent < 0)) {
        error = E_DEC_OVERFLOW;
        goto fatal_error;
      }
      if (exponent < INT_MIN / 2 && error != E_DEC_OVERFLOW) {
        error = E_DEC_TRUNCATED;
        goto fatal_error;
      }
      if (error != E_DEC_OVERFLOW) error = decimal_shift(to, (int)exponent);
    }
  }
  /* Avoid returning negative zero, cfr. decimal_cmp() */
  if (to->sign && decimal_is_zero(to)) to->sign = false;
  return error;

fatal_error:
  decimal_make_zero(to);
  return error;
}

解析過程大致如下：

1. 分別計算整數部分和小數部分各有多少個字元
2. 分別計算整數部分和小數部分各需要多少個 buffer 元素來存儲
   1. 如果整數部分需要的 buffer 元素個數超過 9，則表示溢出
   2. 如果整數部分和小數部分需要的 buffer 元素個數超過 9，則表示需要將小數部分進行截斷
      由於先解析整數部分，再解析小數部分，因此，如果整數部分如果完全佔用所有 buffer 元素，此時，小數部分會被截斷。
3. 將整數部分和小數部分按每 9 個字元轉為一個整數記錄到 buffer 的元素中（buffer中的模型示例如下）

例如常數：111111111222222222333333333.444444444

intg = 27, frac = 9, len = 9, sign = false
byte         0            1           2           3          4         5         6         6         7         8
buffer: | 111111111 | 222222222 | 333333333 | 444444444 | UNKNOWN | UNKNOWN | UNKNOWN | UNKNOWN | UNKNOWN | UNKNOWN |
        低地址  -----------------------------------------------------------------------------------------------> 高地址

check_result_and_overflow 程式碼實現:

void max_decimal(int precision, int frac, decimal_t *to) {
  int intpart;
  dec1 *buf = to->buf;
  assert(precision && precision >= frac);

  to->sign = false;
  // 發生溢出時將 buffer 中的數據更新為 9 99 999 ...
  if ((intpart = to->intg = (precision - frac))) {
    int firstdigits = intpart % DIG_PER_DEC1;
    if (firstdigits) *buf++ = powers10[firstdigits] - 1; /* get 9 99 999 ... */
    for (intpart /= DIG_PER_DEC1; intpart; intpart--) *buf++ = DIG_MAX;
  }

  if ((to->frac = frac)) {
    int lastdigits = frac % DIG_PER_DEC1;
    for (frac /= DIG_PER_DEC1; frac; frac--) *buf++ = DIG_MAX;
    if (lastdigits) *buf = frac_max[lastdigits - 1];
  }
}

inline void max_my_decimal(my_decimal *to, int precision, int frac) {
  assert((precision <= DECIMAL_MAX_PRECISION) && (frac <= DECIMAL_MAX_SCALE));
  max_decimal(precision, frac, to);
}

inline void max_internal_decimal(my_decimal *to) {
  max_my_decimal(to, DECIMAL_MAX_PRECISION, 0);
}

inline int check_result_and_overflow(uint mask, int result, my_decimal *val) {
  // 檢查前面的處理是否發生溢出
  if (val->check_result(mask, result) & E_DEC_OVERFLOW) {
    bool sign = val->sign();
    val->sanity_check();
    max_internal_decimal(val);
    val->sign(sign);
  }
  /*
    Avoid returning negative zero, cfr. decimal_cmp()
    For result == E_DEC_DIV_ZERO *val has not been assigned.
  */
  if (result != E_DEC_DIV_ZERO && val->sign() && decimal_is_zero(val))
    val->sign(false);
  return result;
}

如果 check_result_and_overflow 調用之前的處理髮生了溢出行為，則意味著 decimal 不能存儲完整的數據，MySQL 決定這種情況下僅返回decimal 默認的最大精度數值，由上面的程式碼片段可以看出最大精度數值是 65 個 9。

超大常量數據生成的 DECIMAL 數據與 DECIMAL 欄位類型的區別

通過上面對超大常量數據生成的 DECIMAL 數據處理的分析，可以得出問題3的答案：兩者不同，區別如下：

1. DECIMAL 欄位類型有顯式的精度和小數位的限制，也就是 DECIMAL 欄位插入數據時能插入的正數部分的長度為 M-D，而超大常量數據生成的 DECIMAL 數據則會隱含的優先處理考慮整數部分，整數部分處理完才繼續處理小數部分，如果緩衝區不夠則將小數位截斷，如果緩衝區不夠整數部分存放則轉為 65 個 9。
2. 在 MySQL 的服務源碼中 DECIMAL 欄位類型使用 Field_new_decimal 類型接收處理，而超大常量數據生成的 DECIMAL 數據由 Item_decimal 類型接收處理。

Enjoy GreatSQL 😃

文章推薦：

有趣的SQL DIGEST

ulimits不生效導致資料庫啟動失敗和相關設置說明
MGR及GreatSQL資源匯總

GreatSQL MGR FAQ

在Linux下源碼編譯安裝GreatSQL/MySQL

關於 GreatSQL

GreatSQL是由萬里資料庫維護的MySQL分支，專註於提升MGR可靠性及性能，支援InnoDB並行查詢特性，是適用於金融級應用的MySQL分支版本。

Gitee:
//gitee.com/GreatSQL/GreatSQL

GitHub:
//github.com/GreatSQL/GreatSQL

Bilibili：
//space.bilibili.com/1363850082/favlist

技術交流群：

微信：掃碼添加GreatSQL社區助手微信好友，發送驗證資訊加群。