Line data Source code
1 : /* FreeTDS - Library of routines accessing Sybase and Microsoft databases
2 : * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Brian Bruns
3 : * Copyright (C) 2010, 2011 Frediano Ziglio
4 : *
5 : * This library is free software; you can redistribute it and/or
6 : * modify it under the terms of the GNU Library General Public
7 : * License as published by the Free Software Foundation; either
8 : * version 2 of the License, or (at your option) any later version.
9 : *
10 : * This library is distributed in the hope that it will be useful,
11 : * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 : * Library General Public License for more details.
14 : *
15 : * You should have received a copy of the GNU Library General Public
16 : * License along with this library; if not, write to the
17 : * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 : * Boston, MA 02111-1307, USA.
19 : */
20 :
21 : #ifndef _tdsguard_hfOrWb5znoUCWdBPoNQvqN_
22 : #define _tdsguard_hfOrWb5znoUCWdBPoNQvqN_
23 :
24 : #ifndef _freetds_config_h_
25 : #error should include config.h before
26 : #endif
27 :
28 : #include <stdarg.h>
29 : #include <stdio.h>
30 : #include <time.h>
31 :
32 : #ifdef HAVE_STDDEF_H
33 : #include <stddef.h>
34 : #endif
35 :
36 : #if HAVE_NETDB_H
37 : #include <netdb.h>
38 : #endif /* HAVE_NETDB_H */
39 :
40 : #if HAVE_NETINET_IN_H
41 : #include <netinet/in.h>
42 : #endif /* HAVE_NET_INET_IN_H */
43 : #if HAVE_ARPA_INET_H
44 : #include <arpa/inet.h>
45 : #endif /* HAVE_ARPA_INET_H */
46 :
47 : #if HAVE_SYS_SOCKET_H
48 : #include <sys/socket.h>
49 : #endif /* HAVE_SYS_SOCKET_H */
50 :
51 : /* forward declaration */
52 : typedef struct tdsiconvinfo TDSICONV;
53 : typedef struct tds_connection TDSCONNECTION;
54 : typedef struct tds_socket TDSSOCKET;
55 : typedef struct tds_column TDSCOLUMN;
56 : typedef struct tds_bcpinfo TDSBCPINFO;
57 : typedef struct tds_result_info TDSRESULTINFO;
58 :
59 : #include <freetds/version.h>
60 : #include <freetds/sysdep_private.h>
61 : #include <freetds/thread.h>
62 : #include <freetds/bool.h>
63 : #include <freetds/macros.h>
64 : #include <freetds/utils/string.h>
65 : #include <freetds/utils/path.h>
66 : #include <freetds/replacements.h>
67 :
68 : #include <freetds/pushvis.h>
69 :
70 : #ifdef __cplusplus
71 : extern "C"
72 : {
73 : #if 0
74 : }
75 : #endif
76 : #endif
77 :
78 : /**
79 : * A structure to hold all the compile-time settings.
80 : * This structure is returned by tds_get_compiletime_settings
81 : */
82 :
83 : typedef struct tds_compiletime_settings
84 : {
85 : const char *freetds_version; /* release version of FreeTDS */
86 : const tds_dir_char *sysconfdir; /* location of freetds.conf */
87 : const char *last_update; /* latest software_version date among the modules */
88 : const char *tdsver; /* TDS protocol version (4.2/4.6/5.0/7.0/7.1/8.0) 5.0 */
89 : bool msdblib; /* for MS style dblib */
90 : bool sybase_compat; /* enable increased Open Client binary compatibility */
91 : bool threadsafe; /* compile for thread safety default=no */
92 : bool libiconv; /* search for libiconv in DIR/include and DIR/lib */
93 : bool iodbc; /* build odbc driver against iODBC in DIR */
94 : bool unixodbc; /* build odbc driver against unixODBC in DIR */
95 : bool openssl; /* build against OpenSSL */
96 : bool gnutls; /* build against GnuTLS */
97 : bool mars; /* MARS enabled */
98 : bool sspi; /* SSPI enabled */
99 : bool kerberos; /* Kerberos enabled */
100 : } TDS_COMPILETIME_SETTINGS;
101 :
102 : /**
103 : * @file tds.h
104 : * Main include file for libtds
105 : */
106 :
107 : /**
108 : * \defgroup libtds LibTDS API
109 : * Callable functions in \c libtds.
110 : *
111 : * The \c libtds library is for use internal to \em FreeTDS. It is not
112 : * intended for use by applications. Although any use is \em permitted, you're
113 : * encouraged to use one of the established public APIs instead, because their
114 : * interfaces are stable and documented by the vendors.
115 : */
116 :
117 : /*
118 : * All references to data that touch the wire should use the following typedefs.
119 : *
120 : * If you have problems on 64-bit machines and the code is
121 : * using a native datatype, please change it to use
122 : * these. (In the TDS layer only, the API layers have their
123 : * own typedefs which equate to these).
124 : */
125 : typedef char TDS_CHAR; /* 8-bit char */
126 : typedef uint8_t TDS_UCHAR; /* 8-bit uchar */
127 : typedef uint8_t TDS_TINYINT; /* 8-bit unsigned */
128 : typedef int16_t TDS_SMALLINT; /* 16-bit int */
129 : typedef uint16_t TDS_USMALLINT; /* 16-bit unsigned */
130 : typedef int32_t TDS_INT; /* 32-bit int */
131 : typedef uint32_t TDS_UINT; /* 32-bit unsigned */
132 : typedef int64_t TDS_INT8; /* 64-bit integer */
133 : typedef uint64_t TDS_UINT8; /* 64-bit unsigned */
134 : typedef tds_sysdep_real32_type TDS_REAL; /* 32-bit real */
135 : typedef tds_sysdep_real64_type TDS_FLOAT; /* 64-bit real */
136 :
137 : #include <freetds/proto.h>
138 :
139 : #define TDS_INVALID_TYPE ((TDS_SERVER_TYPE) 0)
140 :
141 : /**
142 : * This structure is not directly connected to TDS protocol but
143 : * keeps any DATE/TIME information.
144 : */
145 : typedef struct
146 : {
147 : TDS_UINT8 time; /**< time, 7 digit precision */
148 : TDS_INT date; /**< date, 0 = 1900-01-01 */
149 : TDS_SMALLINT offset; /**< time offset */
150 : TDS_USMALLINT time_prec:3;
151 : TDS_USMALLINT _tds_reserved:10;
152 : TDS_USMALLINT has_time:1;
153 : TDS_USMALLINT has_date:1;
154 : TDS_USMALLINT has_offset:1;
155 : } TDS_DATETIMEALL;
156 :
157 : /** Used by tds_datecrack */
158 : typedef struct tdsdaterec
159 : {
160 : TDS_INT year; /**< year */
161 : TDS_INT quarter; /**< quarter (0-3) */
162 : TDS_INT month; /**< month number (0-11) */
163 : TDS_INT day; /**< day of month (1-31) */
164 : TDS_INT dayofyear; /**< day of year (1-366) */
165 : TDS_INT weekday; /**< day of week (0-6, 0 = sunday) */
166 : TDS_INT hour; /**< 0-23 */
167 : TDS_INT minute; /**< 0-59 */
168 : TDS_INT second; /**< 0-59 */
169 : TDS_INT decimicrosecond; /**< 0-9999999 */
170 : TDS_INT timezone; /**< -840 - 840 minutes from UTC */
171 : } TDSDATEREC;
172 :
173 : /**
174 : * The following little table is indexed by precision and will
175 : * tell us the number of bytes required to store the specified
176 : * precision.
177 : */
178 : extern const uint8_t tds_numeric_bytes_per_prec[];
179 :
180 : typedef int TDSRET;
181 : #define TDS_NO_MORE_RESULTS ((TDSRET)1)
182 : #define TDS_SUCCESS ((TDSRET)0)
183 : #define TDS_FAIL ((TDSRET)-1)
184 : #define TDS_CANCELLED ((TDSRET)-2)
185 : #define TDS_FAILED(rc) ((rc)<0)
186 : #define TDS_SUCCEED(rc) ((rc)>=0)
187 : #define TDS_PROPAGATE(rc) \
188 : do { TDSRET _tds_ret = (rc); if (TDS_FAILED(_tds_ret)) return _tds_ret; } while(0)
189 :
190 : #define TDS_INT_CONTINUE 1
191 : #define TDS_INT_CANCEL 2
192 : #define TDS_INT_TIMEOUT 3
193 :
194 :
195 : #define TDS_NO_COUNT -1
196 :
197 : #define TDS_ROW_RESULT 4040
198 : #define TDS_PARAM_RESULT 4042
199 : #define TDS_STATUS_RESULT 4043
200 : #define TDS_MSG_RESULT 4044
201 : #define TDS_COMPUTE_RESULT 4045
202 : #define TDS_CMD_DONE 4046
203 : #define TDS_CMD_SUCCEED 4047
204 : #define TDS_CMD_FAIL 4048
205 : #define TDS_ROWFMT_RESULT 4049
206 : #define TDS_COMPUTEFMT_RESULT 4050
207 : #define TDS_DESCRIBE_RESULT 4051
208 : #define TDS_DONE_RESULT 4052
209 : #define TDS_DONEPROC_RESULT 4053
210 : #define TDS_DONEINPROC_RESULT 4054
211 : #define TDS_OTHERS_RESULT 4055
212 :
213 : enum tds_token_results
214 : {
215 : TDS_TOKEN_RES_OTHERS,
216 : TDS_TOKEN_RES_ROWFMT,
217 : TDS_TOKEN_RES_COMPUTEFMT,
218 : TDS_TOKEN_RES_PARAMFMT,
219 : TDS_TOKEN_RES_DONE,
220 : TDS_TOKEN_RES_ROW,
221 : TDS_TOKEN_RES_COMPUTE,
222 : TDS_TOKEN_RES_PROC,
223 : TDS_TOKEN_RES_MSG,
224 : TDS_TOKEN_RES_ENV,
225 : };
226 :
227 : #define TDS_TOKEN_FLAG(flag) TDS_RETURN_##flag = (1 << (TDS_TOKEN_RES_##flag*2)), TDS_STOPAT_##flag = (2 << (TDS_TOKEN_RES_##flag*2))
228 :
229 : enum tds_token_flags
230 : {
231 : TDS_HANDLE_ALL = 0,
232 : TDS_TOKEN_FLAG(OTHERS),
233 : TDS_TOKEN_FLAG(ROWFMT),
234 : TDS_TOKEN_FLAG(COMPUTEFMT),
235 : TDS_TOKEN_FLAG(PARAMFMT),
236 : TDS_TOKEN_FLAG(DONE),
237 : TDS_TOKEN_FLAG(ROW),
238 : TDS_TOKEN_FLAG(COMPUTE),
239 : TDS_TOKEN_FLAG(PROC),
240 : TDS_TOKEN_FLAG(MSG),
241 : TDS_TOKEN_FLAG(ENV),
242 : TDS_TOKEN_RESULTS = TDS_RETURN_ROWFMT|TDS_RETURN_COMPUTEFMT|TDS_RETURN_DONE|TDS_STOPAT_ROW|TDS_STOPAT_COMPUTE|TDS_RETURN_PROC,
243 : TDS_TOKEN_TRAILING = TDS_STOPAT_ROWFMT|TDS_STOPAT_COMPUTEFMT|TDS_STOPAT_ROW|TDS_STOPAT_COMPUTE|TDS_STOPAT_MSG|TDS_STOPAT_OTHERS
244 : };
245 :
246 : /*
247 : * TDSERRNO is emitted by libtds to the client library's error handler
248 : * (which may in turn call the client's error handler).
249 : * These match the db-lib msgno, because the same values have the same meaning
250 : * in db-lib and ODBC. ct-lib maps them to ct-lib numbers (todo).
251 : */
252 : typedef enum { TDSEOK = TDS_SUCCESS,
253 : TDSEVERDOWN = 100,
254 : TDSEINPROGRESS,
255 : TDSEICONVIU = 2400,
256 : TDSEICONVAVAIL = 2401,
257 : TDSEICONVO = 2402,
258 : TDSEICONVI = 2403,
259 : TDSEICONV2BIG = 2404,
260 : TDSEPORTINSTANCE = 2500,
261 : TDSESYNC = 20001,
262 : TDSEFCON = 20002,
263 : TDSETIME = 20003,
264 : TDSEREAD = 20004,
265 : TDSEWRIT = 20006,
266 : TDSESOCK = 20008,
267 : TDSECONN = 20009,
268 : TDSEMEM = 20010,
269 : TDSEINTF = 20012, /* Server name not found in interface file */
270 : TDSEUHST = 20013, /* Unknown host machine name. */
271 : TDSEPWD = 20014,
272 : TDSESEOF = 20017,
273 : TDSERPND = 20019,
274 : TDSEBTOK = 20020,
275 : TDSEOOB = 20022,
276 : TDSECLOS = 20056,
277 : TDSEUSCT = 20058,
278 : TDSEUTDS = 20146,
279 : TDSEEUNR = 20185,
280 : TDSECAP = 20203,
281 : TDSENEG = 20210,
282 : TDSEUMSG = 20212,
283 : TDSECAPTYP = 20213,
284 : TDSECONF = 20214,
285 : TDSEBPROBADTYP = 20250,
286 : TDSECLOSEIN = 20292
287 : } TDSERRNO;
288 :
289 :
290 : enum {
291 : TDS_CUR_ISTAT_UNUSED = 0x00,
292 : TDS_CUR_ISTAT_DECLARED = 0x01,
293 : TDS_CUR_ISTAT_OPEN = 0x02,
294 : TDS_CUR_ISTAT_CLOSED = 0x04,
295 : TDS_CUR_ISTAT_RDONLY = 0x08,
296 : TDS_CUR_ISTAT_UPDATABLE = 0x10,
297 : TDS_CUR_ISTAT_ROWCNT = 0x20,
298 : TDS_CUR_ISTAT_DEALLOC = 0x40
299 : };
300 :
301 : /* string types */
302 : #define TDS_NULLTERM -9
303 :
304 :
305 : typedef union tds_option_arg
306 : {
307 : TDS_TINYINT ti;
308 : TDS_INT i;
309 : TDS_CHAR *c;
310 : } TDS_OPTION_ARG;
311 :
312 :
313 : typedef enum tds_encryption_level {
314 : TDS_ENCRYPTION_DEFAULT,
315 : TDS_ENCRYPTION_OFF,
316 : TDS_ENCRYPTION_REQUEST,
317 : TDS_ENCRYPTION_REQUIRE,
318 : TDS_ENCRYPTION_STRICT
319 : } TDS_ENCRYPTION_LEVEL;
320 :
321 : /*
322 : * TODO use system macros for optimization
323 : * See mcrypt for reference and linux kernel source for optimization
324 : * check if unaligned access and use fast write/read when implemented
325 : */
326 : #define TDS_BYTE_SWAP16(value) \
327 : (((((uint16_t)value)<<8) & 0xFF00u) | \
328 : ((((uint16_t)value)>>8) & 0x00FFu))
329 :
330 : #define TDS_BYTE_SWAP32(value) \
331 : (((((uint32_t)value)<<24) & 0xFF000000u)| \
332 : ((((uint32_t)value)<< 8) & 0x00FF0000u)| \
333 : ((((uint32_t)value)>> 8) & 0x0000FF00u)| \
334 : ((((uint32_t)value)>>24) & 0x000000FFu))
335 :
336 : #define is_end_token(x) ((x) >= TDS_DONE_TOKEN && (x) <= TDS_DONEINPROC_TOKEN)
337 :
338 : enum {
339 : TDS_TYPEFLAG_INVALID = 0,
340 : TDS_TYPEFLAG_NULLABLE = 1,
341 : TDS_TYPEFLAG_FIXED = 2,
342 : TDS_TYPEFLAG_VARIABLE = 4,
343 : TDS_TYPEFLAG_COLLATE = 8,
344 : TDS_TYPEFLAG_ASCII = 16,
345 : TDS_TYPEFLAG_UNICODE = 32,
346 : TDS_TYPEFLAG_BINARY = 64,
347 : TDS_TYPEFLAG_DATETIME = 128,
348 : TDS_TYPEFLAG_NUMERIC = 256,
349 : TDS_TYPEFLAG_VARIANT = 512,
350 : TDS_TYPEFLAG_TEXTPTR = 1024,
351 : };
352 :
353 : extern const uint16_t tds_type_flags_ms[256];
354 : #if 0
355 : extern const uint16_t tds_type_flags_syb[256];
356 : extern const char *const tds_type_names[256];
357 : #endif
358 :
359 : #define is_fixed_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_FIXED) != 0)
360 : #define is_nullable_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_NULLABLE) != 0)
361 : #define is_variable_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_VARIABLE) != 0)
362 : #define is_variant_inner_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_VARIANT) != 0)
363 :
364 :
365 : #define type_has_textptr(x) ((tds_type_flags_ms[(x)&255] & TDS_TYPEFLAG_TEXTPTR) != 0)
366 : #define is_blob_col(x) ((x)->column_varint_size > 2)
367 : /* large type means it has a two byte size field */
368 : /* define is_large_type(x) (x>128) */
369 : #define is_numeric_type(x) ((x)==SYBNUMERIC || (x)==SYBDECIMAL)
370 : /** return true if type is a datetime (but not date or time) */
371 : #define is_datetime_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_DATETIME) != 0)
372 : #define is_unicode_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_UNICODE) != 0)
373 : #define is_collate_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_COLLATE) != 0)
374 : #define is_ascii_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_ASCII) != 0)
375 : #define is_binary_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_BINARY) != 0)
376 : #define is_char_type(x) ((tds_type_flags_ms[x] & (TDS_TYPEFLAG_ASCII|TDS_TYPEFLAG_UNICODE)) != 0)
377 : #define is_similar_type(x, y) (is_char_type(x) && is_char_type(y))
378 : inline static bool
379 : is_tds_type_valid(int type)
380 : {
381 88639 : return (unsigned) type < 256u && tds_type_flags_ms[type] != 0;
382 : }
383 :
384 :
385 : #define TDS_MAX_CAPABILITY 32
386 : #define MAXPRECISION 77
387 : #define TDS_MAX_CONN 4096
388 : #define TDS_MAX_DYNID_LEN 30
389 :
390 : /* defaults to use if no others are found */
391 : #define TDS_DEF_SERVER "SYBASE"
392 : #define TDS_DEF_BLKSZ 512
393 : #define TDS_DEF_CHARSET "iso_1"
394 : #define TDS_DEF_LANG "us_english"
395 : #if TDS50
396 : #define TDS_DEFAULT_VERSION 0x500
397 : #define TDS_DEF_PORT 4000
398 : #elif TDS71
399 : #define TDS_DEFAULT_VERSION 0x701
400 : #define TDS_DEF_PORT 1433
401 : #elif TDS72
402 : #define TDS_DEFAULT_VERSION 0x702
403 : #define TDS_DEF_PORT 1433
404 : #elif TDS73
405 : #define TDS_DEFAULT_VERSION 0x703
406 : #define TDS_DEF_PORT 1433
407 : #elif TDS74
408 : #define TDS_DEFAULT_VERSION 0x704
409 : #define TDS_DEF_PORT 1433
410 : #else
411 : #define TDS_DEFAULT_VERSION 0x000
412 : #define TDS_DEF_PORT 1433
413 : #endif
414 :
415 : /* normalized strings from freetds.conf file */
416 : #define TDS_STR_VERSION "tds version"
417 : #define TDS_STR_BLKSZ "initial block size"
418 : #define TDS_STR_SWAPDT "swap broken dates"
419 : #define TDS_STR_DUMPFILE "dump file"
420 : #define TDS_STR_DEBUGLVL "debug level"
421 : #define TDS_STR_DEBUGFLAGS "debug flags"
422 : #define TDS_STR_TIMEOUT "timeout"
423 : #define TDS_STR_QUERY_TIMEOUT "query timeout"
424 : #define TDS_STR_CONNTIMEOUT "connect timeout"
425 : #define TDS_STR_HOSTNAME "hostname"
426 : #define TDS_STR_HOST "host"
427 : #define TDS_STR_PORT "port"
428 : #define TDS_STR_TEXTSZ "text size"
429 : /* for big endian hosts, obsolete, ignored */
430 : #define TDS_STR_EMUL_LE "emulate little endian"
431 : #define TDS_STR_CHARSET "charset"
432 : #define TDS_STR_CLCHARSET "client charset"
433 : #define TDS_STR_USE_UTF_16 "use utf-16"
434 : #define TDS_STR_LANGUAGE "language"
435 : #define TDS_STR_APPENDMODE "dump file append"
436 : #define TDS_STR_DATETIMEFMT "date format"
437 : #define TDS_STR_DATEFMT "date-only format"
438 : #define TDS_STR_TIMEFMT "time-only format"
439 : #define TDS_STR_INSTANCE "instance"
440 : #define TDS_STR_ASA_DATABASE "asa database"
441 : #define TDS_STR_DATABASE "database"
442 : #define TDS_STR_ENCRYPTION "encryption"
443 : #define TDS_STR_USENTLMV2 "use ntlmv2"
444 : #define TDS_STR_USELANMAN "use lanman"
445 : /* conf values */
446 : #define TDS_STR_ENCRYPTION_OFF "off"
447 : #define TDS_STR_ENCRYPTION_REQUEST "request"
448 : #define TDS_STR_ENCRYPTION_REQUIRE "require"
449 : #define TDS_STR_ENCRYPTION_STRICT "strict"
450 : /* Defines to enable optional GSSAPI delegation */
451 : #define TDS_GSSAPI_DELEGATION "enable gssapi delegation"
452 : /* Mutual authentication */
453 : #define TDS_STR_MUTUAL_AUTHENTICATION "mutual authentication"
454 : /* Kerberos realm name */
455 : #define TDS_STR_REALM "realm"
456 : /* Kerberos SPN */
457 : #define TDS_STR_SPN "spn"
458 : /* CA file */
459 : #define TDS_STR_CAFILE "ca file"
460 : /* CRL file */
461 : #define TDS_STR_CRLFILE "crl file"
462 : /* check SSL hostname */
463 : #define TDS_STR_CHECKSSLHOSTNAME "check certificate hostname"
464 : /* SSL hostname to check certificate */
465 : #define TDS_STR_SSLHOSTNAME "certificate hostname"
466 : /* database filename to attach on login (MSSQL) */
467 : #define TDS_STR_DBFILENAME "database filename"
468 : /* Application Intent MSSQL 2012 support */
469 : #define TDS_STR_READONLY_INTENT "read-only intent"
470 : /* configurable cipher suite to send to openssl's SSL_set_cipher_list() function */
471 : #define TLS_STR_OPENSSL_CIPHERS "openssl ciphers"
472 : /* configurable cipher suite to send to gnutls's gnutls_priority_set_direct() function */
473 : #define TLS_STR_GNUTLS_CIPHERS "gnutls ciphers"
474 : /* enable old TLS v1, required for instance if you are using a really old Windows XP */
475 : #define TDS_STR_ENABLE_TLS_V1 "enable tls v1"
476 : /* enable old TLS v1.1 */
477 : #define TDS_STR_ENABLE_TLS_V1_1 "enable tls v1.1"
478 :
479 :
480 : /* TODO do a better check for alignment than this */
481 : typedef union
482 : {
483 : void *p;
484 : int i;
485 : int64_t ui;
486 : } tds_align_struct;
487 :
488 : #define TDS_ALIGN_SIZE sizeof(tds_align_struct)
489 :
490 : typedef struct tds_capability_type
491 : {
492 : unsigned char type;
493 : unsigned char len; /* always sizeof(values) */
494 : unsigned char values[TDS_MAX_CAPABILITY/2-2];
495 : } TDS_CAPABILITY_TYPE;
496 :
497 : typedef struct tds_capabilities
498 : {
499 : TDS_CAPABILITY_TYPE types[2];
500 : } TDS_CAPABILITIES;
501 :
502 : #define TDS_MAX_LOGIN_STR_SZ 128
503 : typedef struct tds_login
504 : {
505 : DSTR server_name; /**< server name (in freetds.conf) */
506 : int port; /**< port of database service */
507 : TDS_USMALLINT tds_version; /**< TDS version */
508 : int block_size;
509 : DSTR language; /* e.g. us-english */
510 : DSTR server_charset; /**< charset of server e.g. iso_1 */
511 : TDS_INT connect_timeout;
512 : DSTR client_host_name;
513 : DSTR server_host_name;
514 : DSTR server_realm_name; /**< server realm name (in freetds.conf) */
515 : DSTR server_spn; /**< server SPN (in freetds.conf) */
516 : DSTR db_filename; /**< database filename to attach (MSSQL) */
517 : DSTR cafile; /**< certificate authorities file */
518 : DSTR crlfile; /**< certificate revocation file */
519 : DSTR certificate_host_name; /**< certificate hostname to check, if empty use server_host_name */
520 : DSTR openssl_ciphers;
521 : DSTR gnutls_ciphers; /**< gnutls ciphers to use */
522 : DSTR app_name;
523 : DSTR user_name; /**< account for login */
524 : DSTR password; /**< password of account login */
525 : DSTR new_password; /**< new password to set (TDS 7.2+) */
526 :
527 : DSTR library; /* Ct-Library, DB-Library, TDS-Library or ODBC */
528 : TDS_TINYINT encryption_level;
529 :
530 : TDS_INT query_timeout;
531 : TDS_CAPABILITIES capabilities;
532 : DSTR client_charset;
533 : DSTR database;
534 :
535 : struct addrinfo *ip_addrs; /**< ip(s) of server */
536 : DSTR instance_name;
537 : tds_dir_char *dump_file;
538 : int debug_flags;
539 : int text_size;
540 : DSTR routing_address;
541 : uint16_t routing_port;
542 :
543 : unsigned char option_flag2;
544 :
545 : uint8_t bulk_copy:1; /**< if bulk copy should be enabled */
546 : uint8_t suppress_language:1;
547 : uint8_t gssapi_use_delegation:1;
548 : uint8_t mutual_authentication:1;
549 : uint8_t use_ntlmv2:1;
550 : uint8_t use_ntlmv2_specified:1;
551 : uint8_t use_lanman:1;
552 : uint8_t mars:1;
553 : uint8_t use_utf16:1;
554 : uint8_t use_new_password:1;
555 : uint8_t valid_configuration:1;
556 : uint8_t check_ssl_hostname:1;
557 : uint8_t readonly_intent:1;
558 : uint8_t enable_tls_v1:1;
559 : uint8_t enable_tls_v1_specified:1;
560 : uint8_t enable_tls_v1_1:1;
561 : uint8_t enable_tls_v1_1_specified:1;
562 : uint8_t server_is_valid:1;
563 : } TDSLOGIN;
564 :
565 : typedef struct tds_headers
566 : {
567 : const char *qn_options;
568 : const char *qn_msgtext;
569 : TDS_INT qn_timeout;
570 : /* TDS 7.4+: trace activity ID char[20] */
571 : } TDSHEADERS;
572 :
573 : typedef struct tds_locale
574 : {
575 : char *language;
576 : char *server_charset;
577 : char *datetime_fmt;
578 : char *date_fmt;
579 : char *time_fmt;
580 : } TDSLOCALE;
581 :
582 : /**
583 : * Information about blobs (e.g. text or image).
584 : * current_row contains this structure.
585 : */
586 : typedef struct tds_blob
587 : {
588 : TDS_CHAR *textvalue;
589 : TDS_CHAR textptr[16];
590 : TDS_CHAR timestamp[8];
591 : bool valid_ptr;
592 : } TDSBLOB;
593 :
594 : /**
595 : * Store variant information
596 : */
597 : typedef struct tds_variant
598 : {
599 : /* this MUST have same position and place of textvalue in tds_blob */
600 : TDS_CHAR *data;
601 : TDS_INT size;
602 : TDS_INT data_len;
603 : TDS_SERVER_TYPE type;
604 : TDS_UCHAR collation[5];
605 : } TDSVARIANT;
606 :
607 : /**
608 : * Information relevant to libiconv. The name is an iconv name, not
609 : * the same as found in master..syslanguages.
610 : */
611 : typedef struct tds_encoding
612 : {
613 : /** name of the encoding (ie UTF-8) */
614 : const char *name;
615 : unsigned char min_bytes_per_char;
616 : unsigned char max_bytes_per_char;
617 : /** internal numeric index into array of all encodings */
618 : unsigned char canonic;
619 : } TDS_ENCODING;
620 :
621 : typedef struct tds_bcpcoldata
622 : {
623 : TDS_UCHAR *data;
624 : TDS_INT datalen;
625 : bool is_null;
626 : } BCPCOLDATA;
627 :
628 :
629 : typedef TDSRET tds_func_get_info(TDSSOCKET *tds, TDSCOLUMN *col);
630 : typedef TDSRET tds_func_get_data(TDSSOCKET *tds, TDSCOLUMN *col);
631 : typedef TDS_INT tds_func_row_len(TDSCOLUMN *col);
632 : typedef TDSRET tds_func_put_info(TDSSOCKET *tds, TDSCOLUMN *col);
633 : typedef TDSRET tds_func_put_data(TDSSOCKET *tds, TDSCOLUMN *col, bool bcp7);
634 : typedef int tds_func_check(const TDSCOLUMN *col);
635 :
636 : typedef struct tds_column_funcs
637 : {
638 : tds_func_get_info *get_info;
639 : tds_func_get_data *get_data;
640 : tds_func_row_len *row_len;
641 : /**
642 : * Send metadata column information to server.
643 : * \tds
644 : * \param col column to send
645 : */
646 : tds_func_put_info *put_info;
647 : /**
648 : * Send column data to server.
649 : * Usually send parameters unless bcp7 is specified, in
650 : * this case send BCP for TDS7+ (Sybase use a completely
651 : * different format for BCP)
652 : * \tds
653 : * \param col column to send
654 : * \param bcp7 1 to send BCP column on TDS7+
655 : */
656 : tds_func_put_data *put_data;
657 : #if ENABLE_EXTRA_CHECKS
658 : /**
659 : * Check column is valid.
660 : * Some things should be checked:
661 : * - column_type and on_server.column_type;
662 : * - column_size and on_server.column_size;
663 : * - column_cur_size;
664 : * - column_prec and column_scale;
665 : * - is_XXXX_type macros/functions (nullable/fixed/blob/variable);
666 : * - tds_get_size_by_type;
667 : * - tds_get_conversion_type.
668 : *
669 : * \tds
670 : * \param col column to check
671 : */
672 : tds_func_check *check;
673 : #endif
674 : #if 0
675 : TDSRET (*convert)(TDSSOCKET *tds, TDSCOLUMN *col);
676 : #endif
677 : } TDSCOLUMNFUNCS;
678 :
679 : /**
680 : * Metadata about columns in regular and compute rows
681 : */
682 : struct tds_column
683 : {
684 : const TDSCOLUMNFUNCS *funcs;
685 : TDS_INT column_usertype;
686 : TDS_INT column_flags;
687 :
688 : /**
689 : * Maximun size of data. For fixed types is the size.
690 : */
691 : TDS_INT column_size;
692 :
693 : /**
694 : * This type can be different from wire type because
695 : * conversion (e.g. UCS-2->Ascii) can be applied.
696 : * I'm beginning to wonder about the wisdom of this, however.
697 : * April 2003 jkl
698 : */
699 : TDS_SERVER_TYPE column_type;
700 :
701 : /**
702 : * Size of length when reading from wire (0, 1, 2, 4, 5 or 8).
703 : * 0 means fixed type.
704 : * 1, 2 and 4 means the data stream contains a length exactly these bytes.
705 : * 5 means old BLOB types having TEXTPTR on them. 5 as they contain 2 lengths,
706 : * one 4 bytes for data length and another 1 byte for TEXTPTR length.
707 : * 8 are MSSQL VARBINARY/VARCHAR(MAX) which have a 8 byte length, although
708 : * data types are still limited to 2GB.
709 : */
710 : TDS_TINYINT column_varint_size;
711 :
712 : TDS_TINYINT column_prec; /**< precision for decimal/numeric and some datetime types */
713 : TDS_TINYINT column_scale; /**< scale for decimal/numeric */
714 :
715 : struct
716 : {
717 : TDS_SERVER_TYPE column_type; /**< type of data, saved from wire */
718 : TDS_INT column_size;
719 : } on_server;
720 :
721 : TDSICONV *char_conv; /**< refers to previously allocated iconv information */
722 :
723 : DSTR table_name;
724 : DSTR column_name;
725 : DSTR table_column_name;
726 :
727 : unsigned char *column_data;
728 : void (*column_data_free)(struct tds_column * column);
729 : uint8_t column_nullable:1;
730 : uint8_t column_writeable:1;
731 : uint8_t column_identity:1;
732 : uint8_t column_key:1;
733 : uint8_t column_hidden:1;
734 : uint8_t column_output:1;
735 : uint8_t column_timestamp:1;
736 : uint8_t column_computed:1;
737 : TDS_UCHAR column_collation[5];
738 :
739 : uint8_t use_iconv_out:1;
740 :
741 : /* additional fields flags for compute results */
742 : TDS_SMALLINT column_operand;
743 : TDS_TINYINT column_operator;
744 :
745 : /* FIXME this is data related, not column */
746 : /** size written in variable (ie: char, text, binary). -1 if NULL. */
747 : TDS_INT column_cur_size;
748 :
749 : /* related to binding or info stored by client libraries */
750 : /* FIXME find a best place to store these data, some are unused */
751 : TDS_SMALLINT column_bindtype;
752 : TDS_SMALLINT column_bindfmt;
753 : TDS_INT column_bindlen;
754 : TDS_SMALLINT *column_nullbind;
755 : TDS_CHAR *column_varaddr;
756 : TDS_INT *column_lenbind;
757 : TDS_INT column_textpos;
758 : TDS_INT column_text_sqlgetdatapos;
759 : TDS_CHAR column_text_sqlputdatainfo;
760 : unsigned char column_iconv_left;
761 : char column_iconv_buf[9];
762 :
763 : BCPCOLDATA *bcp_column_data;
764 : /**
765 : * The length, in bytes, of any length prefix this column may have.
766 : * For example, strings in some non-C programming languages are
767 : * made up of a one-byte length prefix, followed by the string
768 : * data itself.
769 : * If the data do not have a length prefix, set prefixlen to 0.
770 : * Currently not very used in code, however do not remove.
771 : */
772 : TDS_INT bcp_prefix_len;
773 : TDS_INT bcp_term_len;
774 : TDS_CHAR *bcp_terminator;
775 : };
776 :
777 :
778 : /** Hold information for any results */
779 : struct tds_result_info
780 : {
781 : /* TODO those fields can became a struct */
782 : TDSCOLUMN **columns;
783 : TDS_USMALLINT num_cols;
784 : TDS_USMALLINT computeid;
785 : TDS_INT ref_count;
786 : TDSSOCKET *attached_to;
787 : unsigned char *current_row;
788 : void (*row_free)(TDSRESULTINFO* result, unsigned char *row);
789 : TDS_INT row_size;
790 :
791 : TDS_SMALLINT *bycolumns;
792 : TDS_USMALLINT by_cols;
793 : bool rows_exist;
794 : /* TODO remove ?? used only in dblib */
795 : bool more_results;
796 : };
797 :
798 : /** values for tds->state */
799 : typedef enum tds_states
800 : {
801 : TDS_IDLE, /**< no data expected */
802 : TDS_WRITING, /**< client is writing data */
803 : TDS_SENDING, /**< client would send data */
804 : TDS_PENDING, /**< client is waiting for data */
805 : TDS_READING, /**< client is reading data */
806 : TDS_DEAD /**< no connection */
807 : } TDS_STATE;
808 :
809 : typedef enum tds_operations
810 : {
811 : TDS_OP_NONE = 0,
812 :
813 : /* MSSQL operations, these matches protocol definitions */
814 : TDS_OP_CURSOR = TDS_SP_CURSOR,
815 : TDS_OP_CURSOROPEN = TDS_SP_CURSOROPEN,
816 : TDS_OP_CURSORPREPARE = TDS_SP_CURSORPREPARE,
817 : TDS_OP_CURSOREXECUTE = TDS_SP_CURSOREXECUTE,
818 : TDS_OP_CURSORPREPEXEC = TDS_SP_CURSORPREPEXEC,
819 : TDS_OP_CURSORUNPREPARE = TDS_SP_CURSORUNPREPARE,
820 : TDS_OP_CURSORFETCH = TDS_SP_CURSORFETCH,
821 : TDS_OP_CURSOROPTION = TDS_SP_CURSOROPTION,
822 : TDS_OP_CURSORCLOSE = TDS_SP_CURSORCLOSE,
823 : TDS_OP_EXECUTESQL = TDS_SP_EXECUTESQL,
824 : TDS_OP_PREPARE = TDS_SP_PREPARE,
825 : TDS_OP_EXECUTE = TDS_SP_EXECUTE,
826 : TDS_OP_PREPEXEC = TDS_SP_PREPEXEC,
827 : TDS_OP_PREPEXECRPC = TDS_SP_PREPEXECRPC,
828 : TDS_OP_UNPREPARE = TDS_SP_UNPREPARE,
829 :
830 : /* sybase operations */
831 : TDS_OP_DYN_DEALLOC = 100,
832 : } TDS_OPERATION;
833 :
834 : #define TDS_DBG_LOGIN __FILE__, ((__LINE__ << 4) | 11)
835 : #define TDS_DBG_HEADER __FILE__, ((__LINE__ << 4) | 10)
836 : #define TDS_DBG_FUNC __FILE__, ((__LINE__ << 4) | 7)
837 : #define TDS_DBG_INFO2 __FILE__, ((__LINE__ << 4) | 6)
838 : #define TDS_DBG_INFO1 __FILE__, ((__LINE__ << 4) | 5)
839 : #define TDS_DBG_NETWORK __FILE__, ((__LINE__ << 4) | 4)
840 : #define TDS_DBG_WARN __FILE__, ((__LINE__ << 4) | 3)
841 : #define TDS_DBG_ERROR __FILE__, ((__LINE__ << 4) | 2)
842 : #define TDS_DBG_SEVERE __FILE__, ((__LINE__ << 4) | 1)
843 :
844 : #define TDS_DBGFLAG_FUNC 0x80
845 : #define TDS_DBGFLAG_INFO2 0x40
846 : #define TDS_DBGFLAG_INFO1 0x20
847 : #define TDS_DBGFLAG_NETWORK 0x10
848 : #define TDS_DBGFLAG_WARN 0x08
849 : #define TDS_DBGFLAG_ERROR 0x04
850 : #define TDS_DBGFLAG_SEVERE 0x02
851 : #define TDS_DBGFLAG_ALL 0xfff
852 : #define TDS_DBGFLAG_LOGIN 0x0800
853 : #define TDS_DBGFLAG_HEADER 0x0400
854 : #define TDS_DBGFLAG_PID 0x1000
855 : #define TDS_DBGFLAG_TIME 0x2000
856 : #define TDS_DBGFLAG_SOURCE 0x4000
857 : #define TDS_DBGFLAG_THREAD 0x8000
858 :
859 : #if 0
860 : /**
861 : * An attempt at better logging.
862 : * Using these bitmapped values, various logging features can be turned on and off.
863 : * It can be especially helpful to turn packet data on/off for security reasons.
864 : */
865 : enum TDS_DBG_LOG_STATE
866 : {
867 : TDS_DBG_LOGIN = (1 << 0) /**< for diagnosing login problems;
868 : otherwise the username/password information is suppressed. */
869 : , TDS_DBG_API = (1 << 1) /**< Log calls to client libraries */
870 : , TDS_DBG_ASYNC = (1 << 2) /**< Log asynchronous function starts or completes. */
871 : , TDS_DBG_DIAG = (1 << 3) /**< Log client- and server-generated messages */
872 : , TDS_DBG_error = (1 << 4)
873 : /* TODO: ^^^^^ make upper case when old #defines (above) are removed */
874 : /* Log FreeTDS runtime/logic error occurs. */
875 : , TDS_DBG_PACKET = (1 << 5) /**< Log hex dump of packets to/from the server. */
876 : , TDS_DBG_LIBTDS = (1 << 6) /**< Log calls to (and in) libtds */
877 : , TDS_DBG_CONFIG = (1 << 7) /**< replaces TDSDUMPCONFIG */
878 : , TDS_DBG_DEFAULT = 0xFE /**< all above except login packets */
879 : };
880 : #endif
881 :
882 : typedef TDSRESULTINFO TDSCOMPUTEINFO;
883 :
884 : typedef TDSRESULTINFO TDSPARAMINFO;
885 :
886 : typedef struct tds_message
887 : {
888 : TDS_CHAR *server;
889 : TDS_CHAR *message;
890 : TDS_CHAR *proc_name;
891 : TDS_CHAR *sql_state;
892 : TDS_INT msgno;
893 : TDS_INT line_number;
894 : /* -1 .. 255 */
895 : TDS_SMALLINT state;
896 : TDS_TINYINT priv_msg_type;
897 : TDS_TINYINT severity;
898 : /* for library-generated errors */
899 : int oserr;
900 : } TDSMESSAGE;
901 :
902 : typedef struct tds_upd_col
903 : {
904 : struct tds_upd_col *next;
905 : TDS_INT colnamelength;
906 : char * columnname;
907 : } TDSUPDCOL;
908 :
909 : typedef enum {
910 : TDS_CURSOR_STATE_UNACTIONED = 0 /* initial value */
911 : , TDS_CURSOR_STATE_REQUESTED = 1 /* called by ct_cursor */
912 : , TDS_CURSOR_STATE_SENT = 2 /* sent to server */
913 : , TDS_CURSOR_STATE_ACTIONED = 3 /* acknowledged by server */
914 : } TDS_CURSOR_STATE;
915 :
916 : typedef struct tds_cursor_status
917 : {
918 : TDS_CURSOR_STATE declare;
919 : TDS_CURSOR_STATE cursor_row;
920 : TDS_CURSOR_STATE open;
921 : TDS_CURSOR_STATE fetch;
922 : TDS_CURSOR_STATE close;
923 : TDS_CURSOR_STATE dealloc;
924 : } TDS_CURSOR_STATUS;
925 :
926 : typedef enum tds_cursor_operation
927 : {
928 : TDS_CURSOR_POSITION = 0,
929 : TDS_CURSOR_UPDATE = 1,
930 : TDS_CURSOR_DELETE = 2,
931 : TDS_CURSOR_INSERT = 4
932 : } TDS_CURSOR_OPERATION;
933 :
934 : typedef enum tds_cursor_fetch
935 : {
936 : TDS_CURSOR_FETCH_NEXT = 1,
937 : TDS_CURSOR_FETCH_PREV,
938 : TDS_CURSOR_FETCH_FIRST,
939 : TDS_CURSOR_FETCH_LAST,
940 : TDS_CURSOR_FETCH_ABSOLUTE,
941 : TDS_CURSOR_FETCH_RELATIVE
942 : } TDS_CURSOR_FETCH;
943 :
944 : /**
945 : * Holds information about a cursor
946 : */
947 : typedef struct tds_cursor
948 : {
949 : struct tds_cursor *next; /**< next in linked list, keep first */
950 : TDS_INT ref_count; /**< reference counter so client can retain safely a pointer */
951 : char *cursor_name; /**< name of the cursor */
952 : TDS_INT cursor_id; /**< cursor id returned by the server after cursor declare */
953 : TDS_TINYINT options; /**< read only|updatable TODO use it */
954 : /**
955 : * true if cursor was marker to be closed when connection is idle
956 : */
957 : bool defer_close;
958 : char *query; /**< SQL query */
959 : /* TODO for updatable columns */
960 : /* TDS_TINYINT number_upd_cols; */ /**< number of updatable columns */
961 : /* TDSUPDCOL *cur_col_list; */ /**< updatable column list */
962 : TDS_INT cursor_rows; /**< number of cursor rows to fetch */
963 : /* TDSPARAMINFO *params; */ /** cursor parameter */
964 : TDS_CURSOR_STATUS status;
965 : TDS_USMALLINT srv_status;
966 : TDSRESULTINFO *res_info; /** row fetched from this cursor */
967 : TDS_INT type;
968 : TDS_INT concurrency;
969 : } TDSCURSOR;
970 :
971 : /**
972 : * Current environment as reported by the server
973 : */
974 : typedef struct tds_env
975 : {
976 : /** packet size (512-65535) */
977 : int block_size;
978 : char *language;
979 : /** character set encoding */
980 : char *charset;
981 : /** database name */
982 : char *database;
983 : } TDSENV;
984 :
985 : /**
986 : * Holds information for a dynamic (also called prepared) query.
987 : */
988 : typedef struct tds_dynamic
989 : {
990 : struct tds_dynamic *next; /**< next in linked list, keep first */
991 : TDS_INT ref_count; /**< reference counter so client can retain safely a pointer */
992 : /** numeric id for mssql7+*/
993 : TDS_INT num_id;
994 : /**
995 : * id of dynamic.
996 : * Usually this id correspond to server one but if not specified
997 : * is generated automatically by libTDS
998 : */
999 : char id[30];
1000 : /**
1001 : * this dynamic query cannot be prepared so libTDS have to construct a simple query.
1002 : * This can happen for instance is tds protocol doesn't support dynamics or trying
1003 : * to prepare query under Sybase that have BLOBs as parameters.
1004 : */
1005 : bool emulated;
1006 : /**
1007 : * true if dynamic was marker to be closed when connection is idle
1008 : */
1009 : bool defer_close;
1010 : /* int dyn_state; */ /* TODO use it */
1011 : TDSPARAMINFO *res_info; /**< query results */
1012 : /**
1013 : * query parameters.
1014 : * Mostly used executing query however is a good idea to prepare query
1015 : * again if parameter type change in an incompatible way (ie different
1016 : * types or larger size). Is also better to prepare a query knowing
1017 : * parameter types earlier.
1018 : */
1019 : TDSPARAMINFO *params;
1020 : /** saved query, we need to know original query if prepare is impossible */
1021 : char *query;
1022 : } TDSDYNAMIC;
1023 :
1024 : typedef enum {
1025 : TDS_MULTIPLE_QUERY,
1026 : TDS_MULTIPLE_EXECUTE,
1027 : TDS_MULTIPLE_RPC
1028 : } TDS_MULTIPLE_TYPE;
1029 :
1030 : typedef struct tds_multiple
1031 : {
1032 : TDS_MULTIPLE_TYPE type;
1033 : unsigned int flags;
1034 : } TDSMULTIPLE;
1035 :
1036 : /* forward declaration */
1037 : typedef struct tds_context TDSCONTEXT;
1038 : typedef int (*err_handler_t) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1039 : typedef int (*int_handler_t) (void *);
1040 :
1041 : struct tds_context
1042 : {
1043 : TDSLOCALE *locale;
1044 : void *parent;
1045 : /* handlers */
1046 : int (*msg_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1047 : int (*err_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1048 : int (*int_handler) (void *);
1049 : bool money_use_2_digits;
1050 : };
1051 :
1052 : enum TDS_ICONV_ENTRY
1053 : {
1054 : client2ucs2
1055 : , client2server_chardata
1056 : , initial_char_conv_count /* keep last */
1057 : };
1058 :
1059 : typedef struct tds_authentication
1060 : {
1061 : uint8_t *packet;
1062 : int packet_len;
1063 : /* TDS_MSG_TOKEN type, for TDS5 */
1064 : uint16_t msg_type;
1065 : TDSRET (*free)(TDSCONNECTION* conn, struct tds_authentication * auth);
1066 : TDSRET (*handle_next)(TDSSOCKET * tds, struct tds_authentication * auth, size_t len);
1067 : } TDSAUTHENTICATION;
1068 :
1069 : typedef struct tds_packet
1070 : {
1071 : struct tds_packet *next;
1072 : uint16_t sid;
1073 :
1074 : #if ENABLE_ODBC_MARS
1075 : /**
1076 : * Data before TDS data, currently can be 0 or sizeof(TDS72_SMP_HEADER)
1077 : */
1078 : uint8_t data_start;
1079 : #endif
1080 :
1081 : /**
1082 : * data length, this does not account SMP header, only TDS part
1083 : */
1084 : unsigned data_len;
1085 : unsigned capacity;
1086 : unsigned char buf[1];
1087 : } TDSPACKET;
1088 :
1089 : #if ENABLE_ODBC_MARS
1090 : #define tds_packet_zero_data_start(pkt) do { (pkt)->data_start = 0; } while(0)
1091 : #define tds_packet_get_data_start(pkt) ((pkt)->data_start)
1092 : #else
1093 : #define tds_packet_zero_data_start(pkt) do { } while(0)
1094 : #define tds_packet_get_data_start(pkt) 0
1095 : #endif
1096 :
1097 : typedef struct tds_poll_wakeup
1098 : {
1099 : TDS_SYS_SOCKET s_signal, s_signaled;
1100 : } TDSPOLLWAKEUP;
1101 :
1102 : /* field related to connection */
1103 : struct tds_connection
1104 : {
1105 : TDS_USMALLINT tds_version;
1106 : bool corked;
1107 : TDS_UINT product_version; /**< version of product (Sybase/MS and full version) */
1108 : char *product_name;
1109 :
1110 : TDS_SYS_SOCKET s; /**< tcp socket, INVALID_SOCKET if not connected */
1111 : TDSPOLLWAKEUP wakeup;
1112 : const TDSCONTEXT *tds_ctx;
1113 :
1114 : /** environment is shared between all sessions */
1115 : TDSENV env;
1116 :
1117 : /**
1118 : * linked list of cursors allocated for this connection
1119 : * contains only cursors allocated on the server
1120 : */
1121 : TDSCURSOR *cursors;
1122 : /**
1123 : * list of dynamic allocated for this connection
1124 : * contains only dynamic allocated on the server
1125 : */
1126 : TDSDYNAMIC *dyns;
1127 :
1128 : int char_conv_count;
1129 : TDSICONV **char_convs;
1130 :
1131 : TDS_UCHAR collation[5];
1132 : TDS_UCHAR tds72_transaction[8];
1133 :
1134 : TDS_CAPABILITIES capabilities;
1135 : uint8_t use_iconv_in:1;
1136 : uint8_t tds71rev1:1;
1137 : uint8_t pending_close:1; /**< true is connection has pending closing (cursors or dynamic) */
1138 : uint8_t encrypt_single_packet:1;
1139 : #if ENABLE_ODBC_MARS
1140 : uint8_t mars:1;
1141 :
1142 : TDSSOCKET *in_net_tds;
1143 : TDSPACKET *packets;
1144 : TDSPACKET *recv_packet;
1145 : TDSPACKET *send_packets;
1146 : unsigned send_pos, recv_pos;
1147 :
1148 : #define BUSY_SOCKET ((TDSSOCKET*)(TDS_UINTPTR)1)
1149 : #define TDSSOCKET_VALID(tds) (((TDS_UINTPTR)(tds)) > 1)
1150 : TDSSOCKET **sessions;
1151 : unsigned num_sessions;
1152 : #endif
1153 : tds_mutex list_mtx;
1154 :
1155 : unsigned num_cached_packets;
1156 : TDSPACKET *packet_cache;
1157 :
1158 : int spid;
1159 : int client_spid;
1160 :
1161 : /**
1162 : * Ratio between bytes allocated for a NCHAR type and type length (Sybase).
1163 : * For instance in case a NVARCHAR(3) takes 9 bytes it's 3.
1164 : */
1165 : uint8_t ncharsize;
1166 :
1167 : /**
1168 : * Ratio between bytes allocated for a UNICHAR type and type length (Sybase).
1169 : * For instance in case a UNIVARCHAR(2) takes 4 bytes it's 2.
1170 : * It really should be only 2.
1171 : */
1172 : uint8_t unicharsize;
1173 :
1174 : void *tls_session;
1175 : #if defined(HAVE_GNUTLS)
1176 : void *tls_credentials;
1177 : #elif defined(HAVE_OPENSSL)
1178 : void *tls_ctx;
1179 : #else
1180 : void *tls_dummy;
1181 : #endif
1182 : TDSAUTHENTICATION *authentication;
1183 : char *server;
1184 : };
1185 :
1186 : /**
1187 : * Information for a server connection
1188 : */
1189 : struct tds_socket
1190 : {
1191 : #if ENABLE_ODBC_MARS
1192 : TDSCONNECTION *conn;
1193 : #else
1194 : TDSCONNECTION conn[1];
1195 : #endif
1196 :
1197 : void *parent;
1198 :
1199 : /** Input buffer.
1200 : * Points to receiving packet buffer.
1201 : * As input buffer contains just the raw packet actually this pointer
1202 : * is the address of recv_packet->buf.
1203 : */
1204 : unsigned char *in_buf;
1205 :
1206 : /** Output buffer.
1207 : * Points to sending packet buffer.
1208 : * Output buffer can contain additional data before the raw TDS packet
1209 : * so this buffer can point some bytes after send_packet->buf.
1210 : * Specifically this will point to send_packet->buf + send_packet->data_start.
1211 : */
1212 : unsigned char *out_buf;
1213 :
1214 : /** Maximum size of packet pointed by out_buf.
1215 : * The buffer is actually a bit larger to make possible to do some
1216 : * optimizations (at least TDS_ADDITIONAL_SPACE bytes).
1217 : */
1218 : unsigned out_buf_max;
1219 : unsigned in_pos; /**< current position in in_buf */
1220 : unsigned out_pos; /**< current position in out_buf */
1221 : unsigned in_len; /**< input buffer length */
1222 : unsigned char in_flag; /**< input buffer type */
1223 : unsigned char out_flag; /**< output buffer type */
1224 :
1225 : unsigned frozen;
1226 : /**
1227 : * list of packets frozen, points to first one.
1228 : * send_packet is the last packet in the list.
1229 : */
1230 : TDSPACKET *frozen_packets;
1231 :
1232 : #if ENABLE_ODBC_MARS
1233 : /** SID of MARS session.
1234 : * ==0 Not in a MARS session or first session
1235 : * >0 SID of MARS session valid.
1236 : */
1237 : uint16_t sid;
1238 :
1239 : /**
1240 : * This condition will be signaled by the network thread on packet
1241 : * received or sent for this session
1242 : */
1243 : tds_condition packet_cond;
1244 :
1245 : /**
1246 : * Packet we are trying to send to network.
1247 : * This field should be protected by conn->list_mtx
1248 : */
1249 : TDSPACKET *sending_packet;
1250 : TDS_UINT recv_seq;
1251 : TDS_UINT send_seq;
1252 : TDS_UINT recv_wnd;
1253 : TDS_UINT send_wnd;
1254 : #endif
1255 : /* packet we received */
1256 : TDSPACKET *recv_packet;
1257 : /** packet we are preparing to send */
1258 : TDSPACKET *send_packet;
1259 :
1260 : /**
1261 : * Current query information.
1262 : * Contains information in process, both normal and compute results.
1263 : * This pointer shouldn't be freed; it's just an alias to another structure.
1264 : */
1265 : TDSRESULTINFO *current_results;
1266 : TDSRESULTINFO *res_info;
1267 : TDS_UINT num_comp_info;
1268 : TDSCOMPUTEINFO **comp_info;
1269 : TDSPARAMINFO *param_info;
1270 : TDSCURSOR *cur_cursor; /**< cursor in use */
1271 : bool bulk_query; /**< true is query sent was a bulk query so we need to switch state to QUERYING */
1272 : bool has_status; /**< true is ret_status is valid */
1273 : bool in_row; /**< true if we are getting rows */
1274 : volatile
1275 : unsigned char in_cancel; /**< indicate we are waiting a cancel reply; discard tokens till acknowledge;
1276 : 1 mean we have to send cancel packet, 2 already sent. */
1277 : TDS_INT ret_status; /**< return status from store procedure */
1278 : TDS_STATE state;
1279 :
1280 : TDS_INT query_timeout;
1281 : TDS_INT8 rows_affected; /**< rows updated/deleted/inserted/selected, TDS_NO_COUNT if not valid */
1282 :
1283 : TDSDYNAMIC *cur_dyn; /**< dynamic structure in use */
1284 :
1285 : TDSLOGIN *login; /**< config for login stuff. After login this field is NULL */
1286 :
1287 : void (*env_chg_func) (TDSSOCKET * tds, int type, char *oldval, char *newval);
1288 : TDS_OPERATION current_op;
1289 :
1290 : int option_value;
1291 : tds_mutex wire_mtx;
1292 : };
1293 :
1294 : #define tds_get_ctx(tds) ((tds)->conn->tds_ctx)
1295 : #define tds_set_ctx(tds, val) do { ((tds)->conn->tds_ctx) = (val); } while(0)
1296 : #define tds_get_parent(tds) ((tds)->parent)
1297 : #define tds_set_parent(tds, val) do { ((tds)->parent) = (val); } while(0)
1298 : #define tds_get_s(tds) ((tds)->conn->s)
1299 : #define tds_set_s(tds, val) do { ((tds)->conn->s) = (val); } while(0)
1300 :
1301 : typedef struct tds_tvp_row
1302 : {
1303 : TDSPARAMINFO *params;
1304 : struct tds_tvp_row *next;
1305 : } TDS_TVP_ROW;
1306 :
1307 : typedef struct tds_tvp
1308 : {
1309 : char *schema;
1310 : char *name;
1311 : TDSPARAMINFO *metadata;
1312 : TDS_TVP_ROW *row;
1313 : } TDS_TVP;
1314 :
1315 :
1316 : /* config.c */
1317 : const TDS_COMPILETIME_SETTINGS *tds_get_compiletime_settings(void);
1318 : typedef bool (*TDSCONFPARSE) (const char *option, const char *value, void *param);
1319 : bool tds_read_conf_section(FILE * in, const char *section, TDSCONFPARSE tds_conf_parse, void *parse_param);
1320 : bool tds_read_conf_file(TDSLOGIN * login, const char *server);
1321 : bool tds_parse_conf_section(const char *option, const char *value, void *param);
1322 : TDSLOGIN *tds_read_config_info(TDSSOCKET * tds, TDSLOGIN * login, TDSLOCALE * locale);
1323 : void tds_fix_login(TDSLOGIN* login);
1324 : TDS_USMALLINT * tds_config_verstr(const char *tdsver, TDSLOGIN* login);
1325 : struct addrinfo *tds_lookup_host(const char *servername);
1326 : TDSRET tds_lookup_host_set(const char *servername, struct addrinfo **addr);
1327 : const char *tds_addrinfo2str(struct addrinfo *addr, char *name, int namemax);
1328 :
1329 : TDSRET tds_set_interfaces_file_loc(const char *interfloc);
1330 : extern const char STD_DATETIME_FMT[];
1331 : int tds_parse_boolean(const char *value, int default_value);
1332 : int tds_config_boolean(const char *option, const char *value, TDSLOGIN * login);
1333 :
1334 : TDSLOCALE *tds_get_locale(void);
1335 : TDSRET tds_alloc_row(TDSRESULTINFO * res_info);
1336 : TDSRET tds_alloc_compute_row(TDSCOMPUTEINFO * res_info);
1337 : BCPCOLDATA * tds_alloc_bcp_column_data(unsigned int column_size);
1338 : TDSDYNAMIC *tds_lookup_dynamic(TDSCONNECTION * conn, const char *id);
1339 : /*@observer@*/ const char *tds_prtype(int token);
1340 : int tds_get_varint_size(TDSCONNECTION * conn, int datatype);
1341 : TDS_SERVER_TYPE tds_get_cardinal_type(TDS_SERVER_TYPE datatype, int usertype);
1342 : TDSRET tds8_adjust_login(TDSLOGIN *login);
1343 :
1344 :
1345 : /* iconv.c */
1346 : TDSRET tds_iconv_open(TDSCONNECTION * conn, const char *charset, int use_utf16);
1347 : void tds_iconv_close(TDSCONNECTION * conn);
1348 : void tds_srv_charset_changed(TDSCONNECTION * conn, const char *charset);
1349 : void tds7_srv_charset_changed(TDSCONNECTION * conn, TDS_UCHAR collate[5]);
1350 : int tds_iconv_alloc(TDSCONNECTION * conn);
1351 : void tds_iconv_free(TDSCONNECTION * conn);
1352 : TDSICONV *tds_iconv_from_collate(TDSCONNECTION * conn, const TDS_UCHAR collate[5]);
1353 :
1354 :
1355 : /* mem.c */
1356 : void tds_free_socket(TDSSOCKET * tds);
1357 : void tds_free_all_results(TDSSOCKET * tds);
1358 : void tds_free_results(TDSRESULTINFO * res_info);
1359 : void tds_free_param_results(TDSPARAMINFO * param_info);
1360 : void tds_free_param_result(TDSPARAMINFO * param_info);
1361 : void tds_free_msg(TDSMESSAGE * message);
1362 : void tds_cursor_deallocated(TDSCONNECTION *conn, TDSCURSOR *cursor);
1363 : void tds_release_cursor(TDSCURSOR **pcursor);
1364 : void tds_free_bcp_column_data(BCPCOLDATA * coldata);
1365 : TDSRESULTINFO *tds_alloc_results(TDS_USMALLINT num_cols);
1366 : TDSCOMPUTEINFO **tds_alloc_compute_results(TDSSOCKET * tds, TDS_USMALLINT num_cols, TDS_USMALLINT by_cols);
1367 : TDSCONTEXT *tds_alloc_context(void * parent);
1368 : void tds_free_context(TDSCONTEXT * locale);
1369 : TDSPARAMINFO *tds_alloc_param_result(TDSPARAMINFO * old_param);
1370 : void tds_free_input_params(TDSDYNAMIC * dyn);
1371 : void tds_release_dynamic(TDSDYNAMIC ** dyn);
1372 : inline static void
1373 : tds_release_cur_dyn(TDSSOCKET * tds)
1374 : {
1375 89780 : tds_release_dynamic(&tds->cur_dyn);
1376 : }
1377 : void tds_dynamic_deallocated(TDSCONNECTION *conn, TDSDYNAMIC *dyn);
1378 : void tds_set_cur_dyn(TDSSOCKET *tds, TDSDYNAMIC *dyn);
1379 : TDSSOCKET *tds_realloc_socket(TDSSOCKET * tds, unsigned int bufsize);
1380 : char *tds_alloc_client_sqlstate(int msgno);
1381 : char *tds_alloc_lookup_sqlstate(TDSSOCKET * tds, int msgno);
1382 : TDSLOGIN *tds_alloc_login(bool use_environment);
1383 : TDSDYNAMIC *tds_alloc_dynamic(TDSCONNECTION * conn, const char *id);
1384 : void tds_free_login(TDSLOGIN * login);
1385 : TDSLOGIN *tds_init_login(TDSLOGIN * login, TDSLOCALE * locale);
1386 : TDSLOCALE *tds_alloc_locale(void);
1387 : void *tds_alloc_param_data(TDSCOLUMN * curparam);
1388 : void tds_free_locale(TDSLOCALE * locale);
1389 : TDSCURSOR * tds_alloc_cursor(TDSSOCKET * tds, const char *name, size_t namelen, const char *query, size_t querylen);
1390 : void tds_free_row(TDSRESULTINFO * res_info, unsigned char *row);
1391 : TDSSOCKET *tds_alloc_socket(TDSCONTEXT * context, unsigned int bufsize);
1392 : TDSSOCKET *tds_alloc_additional_socket(TDSCONNECTION *conn);
1393 : void tds_set_current_results(TDSSOCKET *tds, TDSRESULTINFO *info);
1394 : void tds_detach_results(TDSRESULTINFO *info);
1395 : void * tds_realloc(void **pp, size_t new_size);
1396 : #define TDS_RESIZE(p, n_elem) \
1397 : tds_realloc((void **) &(p), sizeof(*(p)) * (size_t) (n_elem))
1398 :
1399 : TDSPACKET *tds_alloc_packet(void *buf, unsigned len);
1400 : TDSPACKET *tds_realloc_packet(TDSPACKET *packet, unsigned len);
1401 : void tds_free_packets(TDSPACKET *packet);
1402 : TDSBCPINFO *tds_alloc_bcpinfo(void);
1403 : void tds_free_bcpinfo(TDSBCPINFO *bcpinfo);
1404 : void tds_deinit_bcpinfo(TDSBCPINFO *bcpinfo);
1405 : void tds_deinit_tvp(TDS_TVP *table);
1406 :
1407 :
1408 : /* login.c */
1409 : void tds_set_packet(TDSLOGIN * tds_login, int packet_size);
1410 : void tds_set_port(TDSLOGIN * tds_login, int port);
1411 : bool tds_set_passwd(TDSLOGIN * tds_login, const char *password) TDS_WUR;
1412 : void tds_set_bulk(TDSLOGIN * tds_login, bool enabled);
1413 : bool tds_set_user(TDSLOGIN * tds_login, const char *username) TDS_WUR;
1414 : bool tds_set_app(TDSLOGIN * tds_login, const char *application) TDS_WUR;
1415 : bool tds_set_host(TDSLOGIN * tds_login, const char *hostname) TDS_WUR;
1416 : bool tds_set_library(TDSLOGIN * tds_login, const char *library) TDS_WUR;
1417 : bool tds_set_server(TDSLOGIN * tds_login, const char *server) TDS_WUR;
1418 : bool tds_set_client_charset(TDSLOGIN * tds_login, const char *charset) TDS_WUR;
1419 : bool tds_set_language(TDSLOGIN * tds_login, const char *language) TDS_WUR;
1420 : void tds_set_version(TDSLOGIN * tds_login, TDS_TINYINT major_ver, TDS_TINYINT minor_ver);
1421 : TDSRET tds_connect_and_login(TDSSOCKET * tds, TDSLOGIN * login);
1422 :
1423 :
1424 : /* query.c */
1425 : void tds_start_query(TDSSOCKET *tds, unsigned char packet_type);
1426 :
1427 : TDSRET tds_submit_query(TDSSOCKET * tds, const char *query);
1428 : TDSRET tds_submit_query_params(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1429 : TDSRET tds_submit_queryf(TDSSOCKET * tds, const char *queryf, ...);
1430 : TDSRET tds_submit_prepare(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1431 : TDSRET tds_submit_execdirect(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1432 : TDSRET tds71_submit_prepexec(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1433 : TDSRET tds_submit_execute(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1434 : TDSRET tds_send_cancel(TDSSOCKET * tds);
1435 : const char *tds_next_placeholder(const char *start);
1436 : int tds_count_placeholders(const char *query);
1437 : int tds_needs_unprepare(TDSCONNECTION * conn, TDSDYNAMIC * dyn);
1438 : TDSRET tds_deferred_unprepare(TDSCONNECTION * conn, TDSDYNAMIC * dyn);
1439 : TDSRET tds_submit_unprepare(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1440 : TDSRET tds_submit_rpc(TDSSOCKET * tds, const char *rpc_name, TDSPARAMINFO * params, TDSHEADERS * head);
1441 : TDSRET tds_submit_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD command, TDS_OPTION option, TDS_OPTION_ARG *param, TDS_INT param_size);
1442 : TDSRET tds_submit_begin_tran(TDSSOCKET *tds);
1443 : TDSRET tds_submit_rollback(TDSSOCKET *tds, bool cont);
1444 : TDSRET tds_submit_commit(TDSSOCKET *tds, bool cont);
1445 : TDSRET tds_disconnect(TDSSOCKET * tds);
1446 : size_t tds_quote_id(TDSSOCKET * tds, char *buffer, const char *id, ptrdiff_t idlen);
1447 : size_t tds_quote_id_rpc(TDSSOCKET * tds, char *buffer, const char *id, ptrdiff_t idlen);
1448 : size_t tds_quote_string(TDSSOCKET * tds, char *buffer, const char *str, ptrdiff_t len);
1449 : const char *tds_skip_comment(const char *s);
1450 : const char *tds_skip_quoted(const char *s);
1451 : size_t tds_fix_column_size(TDSSOCKET * tds, TDSCOLUMN * curcol);
1452 : const char *tds_convert_string(TDSSOCKET * tds, TDSICONV * char_conv, const char *s, ptrdiff_t len, size_t *out_len);
1453 : void tds_convert_string_free(const char *original, const char *converted);
1454 : #if !ENABLE_EXTRA_CHECKS
1455 : #define tds_convert_string_free(original, converted) \
1456 : do { if (original != converted) free((char*) converted); } while(0)
1457 : #endif
1458 : TDSRET tds_get_column_declaration(TDSSOCKET * tds, TDSCOLUMN * curcol, char *out);
1459 :
1460 : TDSRET tds_cursor_declare(TDSSOCKET * tds, TDSCURSOR * cursor, bool *send);
1461 : TDSRET tds_cursor_setrows(TDSSOCKET * tds, TDSCURSOR * cursor, bool *send);
1462 : TDSRET tds_cursor_open(TDSSOCKET * tds, TDSCURSOR * cursor, TDSPARAMINFO *params, bool *send);
1463 : TDSRET tds_cursor_fetch(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_FETCH fetch_type, TDS_INT i_row);
1464 : TDSRET tds_cursor_get_cursor_info(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_UINT * row_number, TDS_UINT * row_count);
1465 : TDSRET tds_cursor_close(TDSSOCKET * tds, TDSCURSOR * cursor);
1466 : TDSRET tds_cursor_dealloc(TDSSOCKET * tds, TDSCURSOR * cursor);
1467 : TDSRET tds_deferred_cursor_dealloc(TDSCONNECTION *conn, TDSCURSOR * cursor);
1468 : TDSRET tds_cursor_update(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_OPERATION op, TDS_INT i_row, TDSPARAMINFO * params);
1469 : TDSRET tds_cursor_setname(TDSSOCKET * tds, TDSCURSOR * cursor);
1470 :
1471 : TDSRET tds_multiple_init(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDS_MULTIPLE_TYPE type, TDSHEADERS * head);
1472 : TDSRET tds_multiple_done(TDSSOCKET *tds, TDSMULTIPLE *multiple);
1473 : TDSRET tds_multiple_query(TDSSOCKET *tds, TDSMULTIPLE *multiple, const char *query, TDSPARAMINFO * params);
1474 : TDSRET tds_multiple_execute(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDSDYNAMIC * dyn);
1475 :
1476 :
1477 : /* token.c */
1478 : TDSRET tds_process_cancel(TDSSOCKET * tds);
1479 : TDSRET tds_process_login_tokens(TDSSOCKET * tds);
1480 : TDSRET tds_process_simple_query(TDSSOCKET * tds);
1481 : int tds5_send_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD tds_command, TDS_OPTION tds_option, TDS_OPTION_ARG * tds_argument,
1482 : TDS_INT * tds_argsize);
1483 : TDSRET tds_process_tokens(TDSSOCKET * tds, /*@out@*/ TDS_INT * result_type, /*@out@*/ int *done_flags, unsigned flag);
1484 :
1485 :
1486 : /* data.c */
1487 : void tds_set_param_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
1488 : void tds_set_column_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
1489 : #ifdef WORDS_BIGENDIAN
1490 : void tds_swap_datatype(int coltype, void *b);
1491 : #endif
1492 :
1493 :
1494 : /* tds_convert.c */
1495 : TDSRET tds_datecrack(TDS_INT datetype, const void *di, TDSDATEREC * dr);
1496 : TDS_SERVER_TYPE tds_get_conversion_type(TDS_SERVER_TYPE srctype, int colsize);
1497 : extern const char tds_hex_digits[];
1498 :
1499 :
1500 : /* write.c */
1501 : int tds_init_write_buf(TDSSOCKET * tds);
1502 : int tds_put_n(TDSSOCKET * tds, const void *buf, size_t n);
1503 : int tds_put_string(TDSSOCKET * tds, const char *buf, int len);
1504 : int tds_put_int(TDSSOCKET * tds, TDS_INT i);
1505 : int tds_put_int8(TDSSOCKET * tds, TDS_INT8 i);
1506 : int tds_put_smallint(TDSSOCKET * tds, TDS_SMALLINT si);
1507 : /** Output a tinyint value */
1508 : #define tds_put_tinyint(tds, ti) tds_put_byte(tds,ti)
1509 : int tds_put_byte(TDSSOCKET * tds, unsigned char c);
1510 : TDSRET tds_flush_packet(TDSSOCKET * tds);
1511 :
1512 :
1513 : /* read.c */
1514 : unsigned char tds_get_byte(TDSSOCKET * tds);
1515 : void tds_unget_byte(TDSSOCKET * tds);
1516 : unsigned char tds_peek(TDSSOCKET * tds);
1517 : TDS_USMALLINT tds_get_usmallint(TDSSOCKET * tds);
1518 : #define tds_get_smallint(tds) ((TDS_SMALLINT) tds_get_usmallint(tds))
1519 : TDS_UINT tds_get_uint(TDSSOCKET * tds);
1520 : #define tds_get_int(tds) ((TDS_INT) tds_get_uint(tds))
1521 : TDS_UINT8 tds_get_uint8(TDSSOCKET * tds);
1522 : #define tds_get_int8(tds) ((TDS_INT8) tds_get_uint8(tds))
1523 : size_t tds_get_string(TDSSOCKET * tds, size_t string_len, char *dest, size_t dest_size);
1524 : TDSRET tds_get_char_data(TDSSOCKET * tds, char *dest, size_t wire_size, TDSCOLUMN * curcol);
1525 : bool tds_get_n(TDSSOCKET * tds, /*@out@*/ /*@null@*/ void *dest, size_t n);
1526 : int tds_get_size_by_type(TDS_SERVER_TYPE servertype);
1527 : DSTR* tds_dstr_get(TDSSOCKET * tds, DSTR * s, size_t len);
1528 :
1529 :
1530 : /* util.c */
1531 : int tdserror (const TDSCONTEXT * tds_ctx, TDSSOCKET * tds, int msgno, int errnum);
1532 : TDS_STATE tds_set_state(TDSSOCKET * tds, TDS_STATE state);
1533 : void tds_swap_bytes(void *buf, size_t bytes);
1534 : unsigned int tds_gettime_ms(void);
1535 :
1536 :
1537 : /* log.c */
1538 : typedef struct tdsdump_off_item {
1539 : struct tdsdump_off_item *next;
1540 : tds_thread_id thread_id;
1541 : } TDSDUMP_OFF_ITEM;
1542 : void tdsdump_off(TDSDUMP_OFF_ITEM *off_item);
1543 : void tdsdump_on(TDSDUMP_OFF_ITEM *off_item);
1544 : int tdsdump_isopen(void);
1545 : #include <freetds/popvis.h>
1546 : /* This function is exported by DB-Library, do not change its ABI */
1547 : int tdsdump_open(const char *filename);
1548 : #ifdef _WIN32
1549 : int tdsdump_wopen(const wchar_t *filename);
1550 : #define tdsdump_topen tdsdump_wopen
1551 : #else
1552 : #define tdsdump_topen tdsdump_open
1553 : #endif
1554 : #include <freetds/pushvis.h>
1555 : void tdsdump_close(void);
1556 : void tdsdump_dump_buf_impl(const char* file, unsigned int level_line, const char *msg, const void *buf, size_t length);
1557 : void tdsdump_col(const TDSCOLUMN *col);
1558 : void tdsdump_log_impl(const char* file, unsigned int level_line, const char *fmt, ...)
1559 : #if defined(__GNUC__) && __GNUC__ >= 2
1560 : #if defined(__MINGW32__)
1561 : __attribute__ ((__format__ (ms_printf, 3, 4)))
1562 : #else
1563 : __attribute__ ((__format__ (__printf__, 3, 4)))
1564 : #endif
1565 : #endif
1566 : ;
1567 : #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
1568 : /* If available use C99 and __VA_ARGS__ */
1569 : #define tdsdump_log(...) do { \
1570 : if (TDS_UNLIKELY(tds_write_dump)) tdsdump_log_impl(__VA_ARGS__); \
1571 : } while(0)
1572 : #define tdsdump_dump_buf(...) do { \
1573 : if (TDS_UNLIKELY(tds_write_dump)) tdsdump_dump_buf_impl(__VA_ARGS__); \
1574 : } while(0)
1575 : #else
1576 : #define tdsdump_log if (!TDS_UNLIKELY(tds_write_dump)) {} else tdsdump_log_impl
1577 : #define tdsdump_dump_buf if (!TDS_UNLIKELY(tds_write_dump)) {} else tdsdump_dump_buf_impl
1578 : #endif
1579 :
1580 : extern bool tds_write_dump;
1581 : extern int tds_debug_flags;
1582 : extern int tds_append_mode;
1583 :
1584 :
1585 : /* net.c */
1586 : TDSERRNO tds_open_socket(TDSSOCKET * tds, struct addrinfo *ipaddr, unsigned int port, int timeout, int *p_oserr);
1587 : void tds_close_socket(TDSSOCKET * tds);
1588 : int tds7_get_instance_ports(FILE *output, struct addrinfo *addr);
1589 : int tds7_get_instance_port(struct addrinfo *addr, const char *instance);
1590 : char *tds_prwsaerror(int erc);
1591 : void tds_prwsaerror_free(char *s);
1592 : ptrdiff_t tds_connection_read(TDSSOCKET * tds, unsigned char *buf, size_t buflen);
1593 : ptrdiff_t tds_connection_write(TDSSOCKET *tds, const unsigned char *buf, size_t buflen, int final);
1594 : void tds_connection_coalesce(TDSSOCKET *tds);
1595 : void tds_connection_flush(TDSSOCKET *tds);
1596 : #define TDSSELREAD POLLIN
1597 : #define TDSSELWRITE POLLOUT
1598 : int tds_select(TDSSOCKET * tds, unsigned tds_sel, int timeout_seconds);
1599 : void tds_connection_close(TDSCONNECTION *conn);
1600 : ptrdiff_t tds_goodread(TDSSOCKET * tds, unsigned char *buf, size_t buflen);
1601 : ptrdiff_t tds_goodwrite(TDSSOCKET * tds, const unsigned char *buffer, size_t buflen);
1602 : int tds_socket_set_nonblocking(TDS_SYS_SOCKET sock);
1603 : int tds_wakeup_init(TDSPOLLWAKEUP *wakeup);
1604 : void tds_wakeup_close(TDSPOLLWAKEUP *wakeup);
1605 : void tds_wakeup_send(TDSPOLLWAKEUP *wakeup, char cancel);
1606 : inline static TDS_SYS_SOCKET
1607 : tds_wakeup_get_fd(const TDSPOLLWAKEUP *wakeup)
1608 : {
1609 : return wakeup->s_signaled;
1610 : }
1611 :
1612 :
1613 : /* packet.c */
1614 : int tds_read_packet(TDSSOCKET * tds);
1615 : TDSRET tds_write_packet(TDSSOCKET * tds, unsigned char final);
1616 : #if ENABLE_ODBC_MARS
1617 : int tds_append_cancel(TDSSOCKET *tds);
1618 : TDSRET tds_append_syn(TDSSOCKET *tds);
1619 : TDSRET tds_append_fin(TDSSOCKET *tds);
1620 : #else
1621 : int tds_put_cancel(TDSSOCKET * tds);
1622 : #endif
1623 :
1624 : typedef struct tds_freeze {
1625 : /** which socket we refer to */
1626 : TDSSOCKET *tds;
1627 : /** first packet frozen */
1628 : TDSPACKET *pkt;
1629 : /** position in pkt */
1630 : unsigned pkt_pos;
1631 : /** length size (0, 1, 2 or 4) */
1632 : unsigned size_len;
1633 : } TDSFREEZE;
1634 :
1635 : void tds_freeze(TDSSOCKET *tds, TDSFREEZE *freeze, unsigned size_len);
1636 : unsigned int tds_freeze_written(TDSFREEZE *freeze);
1637 : TDSRET tds_freeze_abort(TDSFREEZE *freeze);
1638 : TDSRET tds_freeze_close(TDSFREEZE *freeze);
1639 : TDSRET tds_freeze_close_string(TDSFREEZE *freeze);
1640 : TDSRET tds_freeze_close_len(TDSFREEZE *freeze, int32_t size);
1641 :
1642 : inline static void
1643 : tds_set_current_send_packet(TDSSOCKET *tds, TDSPACKET *pkt)
1644 : {
1645 59614 : tds->send_packet = pkt;
1646 59614 : tds->out_buf = pkt->buf + tds_packet_get_data_start(pkt);
1647 : }
1648 :
1649 : /* Macros to allow some indentation of the packets.
1650 : *
1651 : * The 3 nested fake loops require some explanation:
1652 : * - first is to allows to declare variables;
1653 : * - second is to force using brackets;
1654 : * - third is to avoids that a break inside will skip the close.
1655 : */
1656 : #define TDS_START_LEN_GENERIC(tds_socket, len) do { \
1657 : TDSFREEZE current_freeze[1]; \
1658 : tds_freeze((tds_socket), current_freeze, (len)); do { do
1659 : #define TDS_END_LEN while(0); } while(tds_freeze_close(current_freeze), 0); } while(0);
1660 : #define TDS_END_LEN_STRING while(0); } while(tds_freeze_close_string(current_freeze), 0); } while(0);
1661 :
1662 : #define TDS_START_LEN_TINYINT(tds_socket) TDS_START_LEN_GENERIC(tds_socket, 1)
1663 : #define TDS_START_LEN_USMALLINT(tds_socket) TDS_START_LEN_GENERIC(tds_socket, 2)
1664 : #define TDS_START_LEN_UINT(tds_socket) TDS_START_LEN_GENERIC(tds_socket, 4)
1665 :
1666 : /* vstrbuild.c */
1667 : TDSRET tds_vstrbuild(char *buffer, int buflen, int *resultlen, const char *text, int textlen, const char *formats, int formatlen,
1668 : va_list ap);
1669 :
1670 :
1671 : /* numeric.c */
1672 : char *tds_money_to_string(const TDS_MONEY * money, char *s, bool use_2_digits);
1673 : TDS_INT tds_numeric_to_string(const TDS_NUMERIC * numeric, char *s);
1674 : TDS_INT tds_numeric_change_prec_scale(TDS_NUMERIC * numeric, unsigned char new_prec, unsigned char new_scale);
1675 :
1676 :
1677 : /* getmac.c */
1678 : void tds_getmac(TDS_SYS_SOCKET s, unsigned char mac[6]);
1679 :
1680 :
1681 : /* challenge.c */
1682 : #ifndef HAVE_SSPI
1683 : TDSAUTHENTICATION * tds_ntlm_get_auth(TDSSOCKET * tds);
1684 : TDSAUTHENTICATION * tds_gss_get_auth(TDSSOCKET * tds);
1685 : #else
1686 : TDSAUTHENTICATION * tds_sspi_get_auth(TDSSOCKET * tds);
1687 : #endif
1688 : TDSRET tds5_gss_send(TDSSOCKET *tds);
1689 :
1690 :
1691 : /* random.c */
1692 : void tds_random_buffer(unsigned char *out, int len);
1693 :
1694 :
1695 : /* sec_negotiate.c */
1696 : TDSAUTHENTICATION * tds5_negotiate_get_auth(TDSSOCKET * tds);
1697 : inline static void
1698 : tds5_negotiate_set_msg_type(TDSAUTHENTICATION * tds_auth, uint16_t msg_type)
1699 : {
1700 0 : if (tds_auth)
1701 0 : tds_auth->msg_type = msg_type;
1702 : }
1703 :
1704 :
1705 : /* bulk.c */
1706 :
1707 : /** bcp direction */
1708 : enum tds_bcp_directions
1709 : {
1710 : TDS_BCP_IN = 1,
1711 : TDS_BCP_OUT = 2,
1712 : TDS_BCP_QUERYOUT = 3
1713 : };
1714 :
1715 : typedef struct tds5_colinfo
1716 : {
1717 : TDS_TINYINT type;
1718 : TDS_TINYINT status;
1719 : TDS_SMALLINT offset;
1720 : TDS_INT length;
1721 : bool dflt;
1722 :
1723 : TDS_INT dflt_size;
1724 : TDS_UCHAR* dflt_value;
1725 : } TDS5COLINFO;
1726 :
1727 : struct tds_bcpinfo
1728 : {
1729 : void *parent;
1730 : DSTR hint;
1731 : DSTR tablename;
1732 : TDS_CHAR *insert_stmt;
1733 : TDS_INT direction;
1734 : bool identity_insert_on;
1735 : bool xfer_init;
1736 : bool datarows_locking;
1737 : TDS_INT bind_count;
1738 : TDSRESULTINFO *bindinfo;
1739 : TDS5COLINFO *sybase_colinfo;
1740 : TDS_INT sybase_count;
1741 : bool with_triggers;
1742 : };
1743 :
1744 : TDSRET tds_bcp_init(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1745 : typedef TDSRET (*tds_bcp_get_col_data) (TDSBCPINFO *bulk, TDSCOLUMN *bcpcol, int offset);
1746 : typedef void (*tds_bcp_null_error) (TDSBCPINFO *bulk, int index, int offset);
1747 : TDSRET tds_bcp_send_record(TDSSOCKET *tds, TDSBCPINFO *bcpinfo, tds_bcp_get_col_data get_col_data, tds_bcp_null_error null_error, int offset);
1748 : TDSRET tds_bcp_done(TDSSOCKET *tds, int *rows_copied);
1749 : TDSRET tds_bcp_start(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1750 : TDSRET tds_bcp_start_copy_in(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1751 :
1752 : TDSRET tds_bcp_fread(TDSSOCKET * tds, TDSICONV * conv, FILE * stream,
1753 : const char *terminator, size_t term_len, char **outbuf, size_t * outbytes);
1754 :
1755 : TDSRET tds_writetext_start(TDSSOCKET *tds, const char *objname, const char *textptr, const char *timestamp, int with_log, TDS_UINT size);
1756 : TDSRET tds_writetext_continue(TDSSOCKET *tds, const TDS_UCHAR *text, TDS_UINT size);
1757 : TDSRET tds_writetext_end(TDSSOCKET *tds);
1758 :
1759 :
1760 : inline static bool
1761 : tds_capability_enabled(const TDS_CAPABILITY_TYPE *cap, unsigned cap_num)
1762 : {
1763 2246 : return (cap->values[sizeof(cap->values)-1-(cap_num>>3)] >> (cap_num&7)) & 1;
1764 : }
1765 : #define tds_capability_has_req(conn, cap) \
1766 : tds_capability_enabled(&conn->capabilities.types[0], cap)
1767 : #define tds_capability_has_res(conn, cap) \
1768 : tds_capability_enabled(&conn->capabilities.types[1], cap)
1769 :
1770 : #define IS_TDS42(x) (x->tds_version==0x402)
1771 : #define IS_TDS46(x) (x->tds_version==0x406)
1772 : #define IS_TDS50(x) (x->tds_version==0x500)
1773 : #define IS_TDS70(x) (x->tds_version==0x700)
1774 : #define IS_TDS71(x) (x->tds_version==0x701)
1775 : #define IS_TDS72(x) (x->tds_version==0x702)
1776 : #define IS_TDS73(x) (x->tds_version==0x703)
1777 :
1778 : #define IS_TDS50_PLUS(x) ((x)->tds_version>=0x500)
1779 : #define IS_TDS7_PLUS(x) ((x)->tds_version>=0x700)
1780 : #define IS_TDS71_PLUS(x) ((x)->tds_version>=0x701)
1781 : #define IS_TDS72_PLUS(x) ((x)->tds_version>=0x702)
1782 : #define IS_TDS73_PLUS(x) ((x)->tds_version>=0x703)
1783 : #define IS_TDS74_PLUS(x) ((x)->tds_version>=0x704)
1784 : #define IS_TDS80_PLUS(x) ((x)->tds_version>=0x800)
1785 :
1786 : #define TDS_MAJOR(x) ((x)->tds_version >> 8)
1787 : #define TDS_MINOR(x) ((x)->tds_version & 0xff)
1788 :
1789 : #define IS_TDSDEAD(x) (((x) == NULL) || (x)->state == TDS_DEAD)
1790 :
1791 : /** Check if product is Sybase (such as Adaptive Server Enterprise). x should be a TDSSOCKET*. */
1792 : #define TDS_IS_SYBASE(x) (!((x)->conn->product_version & 0x80000000u))
1793 : /** Check if product is Microsoft SQL Server. x should be a TDSSOCKET*. */
1794 : #define TDS_IS_MSSQL(x) (((x)->conn->product_version & 0x80000000u)!=0)
1795 :
1796 : /** Calc a version number for mssql. Use with TDS_MS_VER(7,0,842).
1797 : * For test for a range of version you can use check like
1798 : * if (tds->product_version >= TDS_MS_VER(7,0,0) && tds->product_version < TDS_MS_VER(8,0,0)) */
1799 : #define TDS_MS_VER(maj,min,x) (0x80000000u|((maj)<<24)|((min)<<16)|(x))
1800 :
1801 : /* TODO test if not similar to ms one*/
1802 : /** Calc a version number for Sybase. */
1803 : #define TDS_SYB_VER(maj,min,x) (((maj)<<24)|((min)<<16)|(x)<<8)
1804 :
1805 : #ifdef __cplusplus
1806 : #if 0
1807 : {
1808 : #endif
1809 : }
1810 : #endif
1811 :
1812 : #include <freetds/popvis.h>
1813 :
1814 : #define TDS_PUT_INT(tds,v) tds_put_int((tds), ((TDS_INT)(v)))
1815 : #define TDS_PUT_SMALLINT(tds,v) tds_put_smallint((tds), ((TDS_SMALLINT)(v)))
1816 : #define TDS_PUT_BYTE(tds,v) tds_put_byte((tds), ((unsigned char)(v)))
1817 :
1818 : #endif /* _tdsguard_hfOrWb5znoUCWdBPoNQvqN_ */
|
