File: innodb_utility.h

package info (click to toggle)
mysql-8.0 8.0.43-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,273,924 kB
  • sloc: cpp: 4,684,605; ansic: 412,450; pascal: 108,398; java: 83,641; perl: 30,221; cs: 27,067; sql: 26,594; sh: 24,181; python: 21,816; yacc: 17,169; php: 11,522; xml: 7,388; javascript: 7,076; makefile: 2,194; lex: 1,075; awk: 670; asm: 520; objc: 183; ruby: 97; lisp: 86
file content (231 lines) | stat: -rw-r--r-- 10,403 bytes parent folder | download
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/***********************************************************************

Copyright (c) 2012, 2025, Oracle and/or its affiliates.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.

This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation.  The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.

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, version 2.0, 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA

***********************************************************************/
/**************************************************/ /**
 @file innodb_utility.h

 Created 03/15/2011      Jimmy Yang (most macros and defines are adopted
                         from utility files in the InnoDB. Namely
                         ut/ut0lst.h, ut0rnd.h and hash0hash.h etc.)
 *******************************************************/

#ifndef INNODB_UTILITY_H
#define INNODB_UTILITY_H

#include "api0api.h"
#include "config.h"

#define UT_LIST_NODE_T(TYPE)                                      \
  struct {                                                        \
    TYPE *prev; /*!< pointer to the previous node,                \
                NULL if start of list */                          \
    TYPE *next; /*!< pointer to next node, NULL if end of list */ \
  }

#define UT_LIST_BASE_NODE_T(TYPE)                             \
  struct {                                                    \
    int count;   /*!< count of nodes in list */               \
    TYPE *start; /*!< pointer to list start, NULL if empty */ \
    TYPE *end;   /*!< pointer to list end, NULL if empty */   \
  }

/** Some Macros to manipulate the list, extracted from "ut0lst.h" */
#define UT_LIST_INIT(BASE) \
  {                        \
    (BASE).count = 0;      \
    (BASE).start = NULL;   \
    (BASE).end = NULL;     \
  }

#define UT_LIST_ADD_LAST(NAME, BASE, N) \
  {                                     \
    ((BASE).count)++;                   \
    ((N)->NAME).prev = (BASE).end;      \
    ((N)->NAME).next = NULL;            \
    if ((BASE).end != NULL) {           \
      (((BASE).end)->NAME).next = (N);  \
    }                                   \
    (BASE).end = (N);                   \
    if ((BASE).start == NULL) {         \
      (BASE).start = (N);               \
    }                                   \
  }

#define UT_LIST_ADD_FIRST(NAME, BASE, N)     \
  {                                          \
    ((BASE).count)++;                        \
    ((N)->NAME).next = (BASE).start;         \
    ((N)->NAME).prev = NULL;                 \
    if (UNIV_LIKELY((BASE).start != NULL)) { \
      (((BASE).start)->NAME).prev = (N);     \
    }                                        \
    (BASE).start = (N);                      \
    if (UNIV_UNLIKELY((BASE).end == NULL)) { \
      (BASE).end = (N);                      \
    }                                        \
  }

#define UT_LIST_REMOVE_CLEAR(NAME, N) \
  ((N)->NAME.prev = (N)->NAME.next =  \
       reinterpret_cast<decltype((N)->NAME.next)>(-1))

/** Removes a node from a linked list. */
#define UT_LIST_REMOVE(NAME, BASE, N)                     \
  do {                                                    \
    ((BASE).count)--;                                     \
    if (((N)->NAME).next != NULL) {                       \
      ((((N)->NAME).next)->NAME).prev = ((N)->NAME).prev; \
    } else {                                              \
      (BASE).end = ((N)->NAME).prev;                      \
    }                                                     \
    if (((N)->NAME).prev != NULL) {                       \
      ((((N)->NAME).prev)->NAME).next = ((N)->NAME).next; \
    } else {                                              \
      (BASE).start = ((N)->NAME).next;                    \
    }                                                     \
    UT_LIST_REMOVE_CLEAR(NAME, N);                        \
  } while (0)

#define UT_LIST_GET_NEXT(NAME, N) (((N)->NAME).next)

#define UT_LIST_GET_LEN(BASE) (BASE).count

#define UT_LIST_GET_FIRST(BASE) (BASE).start

/*************************************************************/ /**
 Folds a character string ending in the null character.
 Extracted from ut0rnd.h and ut0rnd.ic.
 @return folded value */

uint64_t ut_fold_string(
    /*===========*/
    const char *str); /*!< in: null-terminated string */

typedef struct hash_cell_struct {
  void *node; /*!< hash chain node, NULL if none */
} hash_cell_t;

typedef struct hash_table_struct {
  uint64_t n_cells;   /* number of cells in the hash table */
  hash_cell_t *array; /*!< pointer to cell array */
} hash_table_t;

#define HASH_INSERT(TYPE, NAME, TABLE, FOLD, DATA)                    \
  do {                                                                \
    hash_cell_t *cell3333;                                            \
    TYPE *struct3333;                                                 \
                                                                      \
    (DATA)->NAME = NULL;                                              \
                                                                      \
    cell3333 = hash_get_nth_cell(TABLE, hash_calc_hash(FOLD, TABLE)); \
                                                                      \
    if (cell3333->node == NULL) {                                     \
      cell3333->node = DATA;                                          \
    } else {                                                          \
      struct3333 = (TYPE *)cell3333->node;                            \
                                                                      \
      while (struct3333->NAME != NULL) {                              \
        struct3333 = (TYPE *)struct3333->NAME;                        \
      }                                                               \
                                                                      \
      struct3333->NAME = DATA;                                        \
    }                                                                 \
  } while (0)

/*******************************************************************/ /**
 Gets the first struct in a hash chain, NULL if none. */

#define HASH_GET_FIRST(TABLE, HASH_VAL) \
  (hash_get_nth_cell(TABLE, HASH_VAL)->node)

/*******************************************************************/ /**
 Gets the next struct in a hash chain, NULL if none. */

#define HASH_GET_NEXT(NAME, DATA) ((DATA)->NAME)

/********************************************************************/ /**
 Looks for a struct in a hash table. */
#define HASH_SEARCH(NAME, TABLE, FOLD, TYPE, DATA, TEST)               \
  {                                                                    \
    (DATA) = (TYPE)HASH_GET_FIRST(TABLE, hash_calc_hash(FOLD, TABLE)); \
                                                                       \
    while ((DATA) != NULL) {                                           \
      if (TEST) {                                                      \
        break;                                                         \
      } else {                                                         \
        (DATA) = (TYPE)HASH_GET_NEXT(NAME, DATA);                      \
      }                                                                \
    }                                                                  \
  }

/********************************************************************/ /**
 Cleanup items in a hash table */
#define HASH_CLEANUP(TABLE, TYPE)                         \
  do {                                                    \
    uint64_t i;                                           \
    TYPE data;                                            \
                                                          \
    for (i = 0; i < TABLE->n_cells; i++) {                \
      data = (TYPE)HASH_GET_FIRST(TABLE, i);              \
                                                          \
      while (data) {                                      \
        TYPE next_data;                                   \
        next_data = (TYPE)HASH_GET_NEXT(name_hash, data); \
        innodb_config_free(data);                         \
        free(data);                                       \
        data = next_data;                                 \
      }                                                   \
    }                                                     \
                                                          \
    free(TABLE->array);                                   \
    free(TABLE);                                          \
  } while (0)

/************************************************************/ /**
 Gets the nth cell in a hash table.
 @return pointer to cell */
hash_cell_t *hash_get_nth_cell(
    /*==============*/
    hash_table_t *table, /*!< in: hash table */
    uint64_t n);         /*!< in: cell index */

/*************************************************************/ /**
 Creates a hash table with >= n array cells. The actual number
 of cells is chosen to be a prime number slightly bigger than n.
 @return own: created table */
hash_table_t *hash_create(
    /*========*/
    uint64_t n); /*!< in: number of array cells */

/**************************************************************/ /**
 Calculates the hash value from a folded value.
 @return hashed value */
uint64_t hash_calc_hash(
    /*===========*/
    uint64_t fold,        /*!< in: folded value */
    hash_table_t *table); /*!< in: hash table */

#endif /* INNODB_UTILITY_H */