data0type.ic 10.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/******************************************************
Data types

(c) 1996 Innobase Oy

Created 1/16/1996 Heikki Tuuri
*******************************************************/

#include "mach0data.h"

11
/**********************************************************************
12
Get the variable length bounds of the given character set.
13 14 15 16

NOTE: the prototype of this function is copied from ha_innodb.cc! If you change
this function, you MUST change also the prototype here! */
extern
17
void
18 19
innobase_get_cset_width(
/*====================*/
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
	ulint	cset,		/* in: MySQL charset-collation code */
	ulint*	mbminlen,	/* out: minimum length of a char (in bytes) */
	ulint*	mbmaxlen);	/* out: maximum length of a char (in bytes) */

/*************************************************************************
Gets the MySQL charset-collation code for MySQL string types. */
UNIV_INLINE
ulint
dtype_get_charset_coll(
/*===================*/
	ulint	prtype)	/* in: precise data type */
{
	return((prtype >> 16) & 0xFFUL);
}

/*************************************************************************
Sets the mbminlen and mbmaxlen members of a data type structure. */
UNIV_INLINE
void
dtype_set_mblen(
/*============*/
	dtype_t*	type)	/* in/out: type struct */
{
	ut_ad(type);
	if (dtype_is_string_type(type->mtype)) {
45
		innobase_get_cset_width(dtype_get_charset_coll(type->prtype),
46 47 48 49 50 51
				&type->mbminlen, &type->mbmaxlen);
		ut_ad(type->mbminlen <= type->mbmaxlen);
	} else {
		type->mbminlen = type->mbmaxlen = 0;
	}
}
52

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
/*************************************************************************
Sets a data type structure. */
UNIV_INLINE
void
dtype_set(
/*======*/
	dtype_t*	type,	/* in: type struct to init */
	ulint		mtype,	/* in: main data type */
	ulint		prtype,	/* in: precise type */
	ulint		len,	/* in: length of type */
	ulint		prec)	/* in: precision of type */
{
	ut_ad(type);
	ut_ad(mtype <= DATA_MTYPE_MAX);
	
	type->mtype = mtype;
	type->prtype = prtype;
	type->len = len;
	type->prec = prec;

73
	dtype_set_mblen(type);
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
	ut_ad(dtype_validate(type));
}

/*************************************************************************
Copies a data type structure. */
UNIV_INLINE
void
dtype_copy(
/*=======*/
	dtype_t*	type1,	/* in: type struct to copy to */
	dtype_t*	type2)	/* in: type struct to copy from */
{
	*type1 = *type2;

	ut_ad(dtype_validate(type1));
}

/*************************************************************************
Gets the SQL main data type. */
UNIV_INLINE
ulint
dtype_get_mtype(
/*============*/
	dtype_t*	type)
{
	ut_ad(type);

	return(type->mtype);
}

/*************************************************************************
Gets the precise data type. */
UNIV_INLINE
ulint
dtype_get_prtype(
/*=============*/
	dtype_t*	type)
{
	ut_ad(type);

	return(type->prtype);
}

/*************************************************************************
Gets the type length. */
UNIV_INLINE
ulint
dtype_get_len(
/*==========*/
	dtype_t*	type)
{
	ut_ad(type);

	return(type->len);
}

/*************************************************************************
Gets the type precision. */
UNIV_INLINE
ulint
dtype_get_prec(
/*===========*/
	dtype_t*	type)
{
	ut_ad(type);

	return(type->prec);
}

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
/*************************************************************************
Gets the minimum length of a character, in bytes. */
UNIV_INLINE
ulint
dtype_get_mbminlen(
/*===============*/
				/* out: minimum length of a char, in bytes,
				or 0 if this is not a character type */
	const dtype_t*	type)	/* in: type */
{
	ut_ad(type);
	return(type->mbminlen);
}
/*************************************************************************
Gets the maximum length of a character, in bytes. */
UNIV_INLINE
ulint
dtype_get_mbmaxlen(
/*===============*/
				/* out: maximum length of a char, in bytes,
				or 0 if this is not a character type */
	const dtype_t*	type)	/* in: type */
{
	ut_ad(type);
	return(type->mbmaxlen);
}

170 171 172 173 174 175 176 177 178 179
/*************************************************************************
Gets the padding character code for the type. */
UNIV_INLINE
ulint
dtype_get_pad_char(
/*===============*/
				/* out: padding character code, or
				ULINT_UNDEFINED if no padding specified */
	dtype_t*	type)	/* in: type */
{
180 181 182
	if (type->mtype == DATA_CHAR
	    || type->mtype == DATA_VARCHAR
	    || type->mtype == DATA_BINARY
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
183 184 185
	    || type->mtype == DATA_FIXBINARY
	    || type->mtype == DATA_MYSQL
	    || type->mtype == DATA_VARMYSQL) {
186 187 188

		/* Space is the padding character for all char and binary
	        strings */
189 190 191 192 193 194 195 196 197 198

		return((ulint)' ');
	}

	/* No padding specified */

	return(ULINT_UNDEFINED);
}

/**************************************************************************
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
199
Stores for a type the information which determines its alphabetical ordering
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
200 201
and the storage size of an SQL NULL value. This is the >= 4.1.x storage
format. */
202 203
UNIV_INLINE
void
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
204 205 206 207
dtype_new_store_for_order_and_null_size(
/*====================================*/
	byte*		buf,	/* in: buffer for
				DATA_NEW_ORDER_NULL_TYPE_BUF_SIZE
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
208
				bytes where we store the info */
209 210
	dtype_t*	type)	/* in: type struct */
{
marko@hundin.mysql.fi's avatar
marko@hundin.mysql.fi committed
211 212 213 214
#if 6 != DATA_NEW_ORDER_NULL_TYPE_BUF_SIZE
#error "6 != DATA_NEW_ORDER_NULL_TYPE_BUF_SIZE"
#endif

heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
215
	buf[0] = (byte)(type->mtype & 0xFFUL);
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
216 217 218 219 220

	if (type->prtype & DATA_BINARY_TYPE) {
		buf[0] = buf[0] | 128;
	}

221 222 223 224
	/* In versions < 4.1.2 we had: 	if (type->prtype & DATA_NONLATIN1) {
						buf[0] = buf[0] | 64;
					}
	*/
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
225

heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
226 227 228
	buf[1] = (byte)(type->prtype & 0xFFUL);

	mach_write_to_2(buf + 2, type->len & 0xFFFFUL);
229

marko@hundin.mysql.fi's avatar
marko@hundin.mysql.fi committed
230
	ut_ad(dtype_get_charset_coll(type->prtype) < 256);
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
231 232
	mach_write_to_2(buf + 4, dtype_get_charset_coll(type->prtype));

marko@hundin.mysql.fi's avatar
marko@hundin.mysql.fi committed
233 234 235
	if (type->prtype & DATA_NOT_NULL) {
		buf[4] |= 128;
	}
236 237 238
}

/**************************************************************************
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
239
Reads to a type the stored information which determines its alphabetical
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
240 241
ordering and the storage size of an SQL NULL value. This is the < 4.1.x
storage format. */
242 243 244 245 246
UNIV_INLINE
void
dtype_read_for_order_and_null_size(
/*===============================*/
	dtype_t*	type,	/* in: type struct */
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
247
	byte*		buf)	/* in: buffer for stored type order info */
248 249 250
{
	ut_ad(4 == DATA_ORDER_NULL_TYPE_BUF_SIZE);
	
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
251
	type->mtype = buf[0] & 63;
252 253
	type->prtype = buf[1];

heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
254 255 256 257
	if (buf[0] & 128) {
	        type->prtype = type->prtype | DATA_BINARY_TYPE;
	}

258
	type->len = mach_read_from_2(buf + 2);
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
259 260 261
		
	type->prtype = dtype_form_prtype(type->prtype,
					data_mysql_default_charset_coll);
262
	dtype_set_mblen(type);
263 264
}	

heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
265 266
/**************************************************************************
Reads to a type the stored information which determines its alphabetical
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
267 268
ordering and the storage size of an SQL NULL value. This is the >= 4.1.x
storage format. */
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
269 270 271 272 273 274 275
UNIV_INLINE
void
dtype_new_read_for_order_and_null_size(
/*===================================*/
	dtype_t*	type,	/* in: type struct */
	byte*		buf)	/* in: buffer for stored type order info */
{
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
276 277
	ulint	charset_coll;

marko@hundin.mysql.fi's avatar
marko@hundin.mysql.fi committed
278 279 280
#if 6 != DATA_NEW_ORDER_NULL_TYPE_BUF_SIZE
#error "6 != DATA_NEW_ORDER_NULL_TYPE_BUF_SIZE"
#endif
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
281 282 283 284 285
	
	type->mtype = buf[0] & 63;
	type->prtype = buf[1];

	if (buf[0] & 128) {
marko@hundin.mysql.fi's avatar
marko@hundin.mysql.fi committed
286 287 288 289 290
		type->prtype |= DATA_BINARY_TYPE;
	}

	if (buf[4] & 128) {
		type->prtype |= DATA_NOT_NULL;
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
291 292 293 294
	}

	type->len = mach_read_from_2(buf + 2);

heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
295 296
	mach_read_from_2(buf + 4);

marko@hundin.mysql.fi's avatar
marko@hundin.mysql.fi committed
297
	charset_coll = mach_read_from_2(buf + 4) & 0x7fff;
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

	if (dtype_is_string_type(type->mtype)) {
		ut_a(charset_coll < 256);

		if (charset_coll == 0) {
			/* This insert buffer record was inserted with MySQL
			version < 4.1.2, and the charset-collation code was not
			explicitly stored to dtype->prtype at that time. It
			must be the default charset-collation of this MySQL
			installation. */

			charset_coll = data_mysql_default_charset_coll;
		}
		
		type->prtype = dtype_form_prtype(type->prtype, charset_coll);
	}						
314
	dtype_set_mblen(type);
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
315
}
heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
316

317 318 319 320 321 322 323 324 325
/***************************************************************************
Returns the size of a fixed size data type, 0 if not a fixed size type. */
UNIV_INLINE
ulint
dtype_get_fixed_size(
/*=================*/
				/* out: fixed size, or 0 */
	dtype_t*	type)	/* in: type */
{
326
#ifndef UNIV_HOTBACKUP
327 328 329 330 331
	ulint	mtype;

	mtype = dtype_get_mtype(type);

	switch (mtype) {
marko@hundin.mysql.fi's avatar
marko@hundin.mysql.fi committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	case DATA_SYS:
#ifdef UNIV_DEBUG
			switch (type->prtype & DATA_MYSQL_TYPE_MASK) {
			default:
				ut_ad(0);
				return(0);
			case DATA_ROW_ID:
				ut_ad(type->len == DATA_ROW_ID_LEN);
				break;
			case DATA_TRX_ID:
				ut_ad(type->len == DATA_TRX_ID_LEN);
				break;
			case DATA_ROLL_PTR:
				ut_ad(type->len == DATA_ROLL_PTR_LEN);
				break;
			case DATA_MIX_ID:
				ut_ad(type->len == DATA_MIX_ID_LEN);
				break;
			}
#endif /* UNIV_DEBUG */
352 353 354 355 356 357
	case DATA_CHAR:
	case DATA_FIXBINARY:
	case DATA_INT:
	case DATA_FLOAT:
	case DATA_DOUBLE:
	case DATA_MYSQL:
358
			if (type->prtype & DATA_BINARY_TYPE) {
359
				return(dtype_get_len(type));
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
			} else {
				/* We play it safe here and ask MySQL for
				mbminlen and mbmaxlen.  Although
				type->mbminlen and type->mbmaxlen are
				initialized if and only if type->prtype
				is (in one of the 3 functions in this file),
				it could be that none of these functions
				has been called. */

				ulint	mbminlen, mbmaxlen;

				innobase_get_cset_width(
					dtype_get_charset_coll(type->prtype),
					&mbminlen, &mbmaxlen);

				if (type->mbminlen != mbminlen
					|| type->mbmaxlen != mbmaxlen) {

					ut_print_timestamp(stderr);
					fprintf(stderr, "  InnoDB: "
						"mbminlen=%lu, "
						"mbmaxlen=%lu, "
						"type->mbminlen=%lu, "
						"type->mbmaxlen=%lu\n",
						(ulong) mbminlen,
						(ulong) mbmaxlen,
						(ulong) type->mbminlen,
						(ulong) type->mbmaxlen);
				}
				if (mbminlen == mbmaxlen) {
					return(dtype_get_len(type));
				}
392 393
			}
			/* fall through for variable-length charsets */
394 395 396 397 398 399
	case DATA_VARCHAR:
	case DATA_BINARY:
	case DATA_DECIMAL:
	case DATA_VARMYSQL:
	case DATA_BLOB:
			return(0); 
400
	default:	ut_error;
401 402 403
	}

	return(0);
404 405 406 407 408 409
#else /* UNIV_HOTBACKUP */
	/* This function depends on MySQL code that is not included in
	InnoDB Hot Backup builds.  Besides, this function should never
	be called in InnoDB Hot Backup. */
	ut_error;
#endif /* UNIV_HOTBACKUP */
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
}

/***************************************************************************
Returns a stored SQL NULL size for a type. For fixed length types it is
the fixed length of the type, otherwise 0. */
UNIV_INLINE
ulint
dtype_get_sql_null_size(
/*====================*/
				/* out: SQL null storage size */
	dtype_t*	type)	/* in: type */
{
	return(dtype_get_fixed_size(type));
}

/***************************************************************************
Returns TRUE if a type is of a fixed size. */
UNIV_INLINE
ibool
dtype_is_fixed_size(
/*================*/
				/* out: TRUE if fixed size */
	dtype_t*	type)	/* in: type */
{
	ulint	size;

	size = dtype_get_fixed_size(type);

	if (size) {
		return(TRUE);
	}

	return(FALSE);
}