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