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 _tds_h_
22#define _tds_h_
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/sysdep_types.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/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 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) 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 int 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
249{
250 TDS_DONE_FINAL = 0x00
257 , TDS_DONE_EVENT = 0x40 /* part of an event notification. */
258 , TDS_DONE_SRVERROR = 0x100
260 /* after the above flags, a TDS_DONE packet has a field describing the state of the transaction */
261 , TDS_DONE_NO_TRAN = 0 /* No transaction in effect */
262 , TDS_DONE_TRAN_SUCCEED = 1 /* Transaction completed successfully */
263 , TDS_DONE_TRAN_PROGRESS= 2 /* Transaction in progress */
264 , TDS_DONE_STMT_ABORT = 3 /* A statement aborted */
265 , TDS_DONE_TRAN_ABORT = 4 /* Transaction aborted */
266};
267
268
269/*
270 * TDSERRNO is emitted by libtds to the client library's error handler
271 * (which may in turn call the client's error handler).
272 * These match the db-lib msgno, because the same values have the same meaning
273 * in db-lib and ODBC. ct-lib maps them to ct-lib numbers (todo).
274 */
275typedef enum { TDSEOK = TDS_SUCCESS,
276 TDSEVERDOWN = 100,
277 TDSEINPROGRESS,
278 TDSEICONVIU = 2400,
279 TDSEICONVAVAIL = 2401,
280 TDSEICONVO = 2402,
281 TDSEICONVI = 2403,
282 TDSEICONV2BIG = 2404,
283 TDSEPORTINSTANCE = 2500,
284 TDSESYNC = 20001,
285 TDSEFCON = 20002,
286 TDSETIME = 20003,
287 TDSEREAD = 20004,
288 TDSEWRIT = 20006,
289 TDSESOCK = 20008,
290 TDSECONN = 20009,
291 TDSEMEM = 20010,
292 TDSEINTF = 20012, /* Server name not found in interface file */
293 TDSEUHST = 20013, /* Unknown host machine name. */
294 TDSEPWD = 20014,
295 TDSESEOF = 20017,
296 TDSERPND = 20019,
297 TDSEBTOK = 20020,
298 TDSEOOB = 20022,
299 TDSECLOS = 20056,
300 TDSEUSCT = 20058,
301 TDSEUTDS = 20146,
302 TDSEEUNR = 20185,
303 TDSECAP = 20203,
304 TDSENEG = 20210,
305 TDSEUMSG = 20212,
306 TDSECAPTYP = 20213,
307 TDSECONF = 20214,
308 TDSEBPROBADTYP = 20250,
309 TDSECLOSEIN = 20292
310} TDSERRNO;
311
312
313enum {
314 TDS_CUR_ISTAT_UNUSED = 0x00,
315 TDS_CUR_ISTAT_DECLARED = 0x01,
316 TDS_CUR_ISTAT_OPEN = 0x02,
317 TDS_CUR_ISTAT_CLOSED = 0x04,
318 TDS_CUR_ISTAT_RDONLY = 0x08,
319 TDS_CUR_ISTAT_UPDATABLE = 0x10,
320 TDS_CUR_ISTAT_ROWCNT = 0x20,
321 TDS_CUR_ISTAT_DEALLOC = 0x40
322};
323
324/* string types */
325#define TDS_NULLTERM -9
326
327
328typedef union tds_option_arg
329{
330 TDS_TINYINT ti;
331 TDS_INT i;
332 TDS_CHAR *c;
334
335
336typedef enum tds_encryption_level {
337 TDS_ENCRYPTION_DEFAULT,
338 TDS_ENCRYPTION_OFF,
339 TDS_ENCRYPTION_REQUEST,
340 TDS_ENCRYPTION_REQUIRE
341} TDS_ENCRYPTION_LEVEL;
342
343/*
344 * TODO use system macros for optimization
345 * See mcrypt for reference and linux kernel source for optimization
346 * check if unaligned access and use fast write/read when implemented
347 */
348#define TDS_BYTE_SWAP16(value) \
349 (((((uint16_t)value)<<8) & 0xFF00u) | \
350 ((((uint16_t)value)>>8) & 0x00FFu))
351
352#define TDS_BYTE_SWAP32(value) \
353 (((((uint32_t)value)<<24) & 0xFF000000u)| \
354 ((((uint32_t)value)<< 8) & 0x00FF0000u)| \
355 ((((uint32_t)value)>> 8) & 0x0000FF00u)| \
356 ((((uint32_t)value)>>24) & 0x000000FFu))
357
358#define is_end_token(x) ((x) >= TDS_DONE_TOKEN && (x) <= TDS_DONEINPROC_TOKEN)
359
360enum {
361 TDS_TYPEFLAG_INVALID = 0,
362 TDS_TYPEFLAG_NULLABLE = 1,
363 TDS_TYPEFLAG_FIXED = 2,
364 TDS_TYPEFLAG_VARIABLE = 4,
365 TDS_TYPEFLAG_COLLATE = 8,
366 TDS_TYPEFLAG_ASCII = 16,
367 TDS_TYPEFLAG_UNICODE = 32,
368 TDS_TYPEFLAG_BINARY = 64,
369 TDS_TYPEFLAG_DATETIME = 128,
370 TDS_TYPEFLAG_NUMERIC = 256,
371 TDS_TYPEFLAG_VARIANT = 512,
372};
373
374extern const uint16_t tds_type_flags_ms[256];
375#if 0
376extern const uint16_t tds_type_flags_syb[256];
377extern const char *const tds_type_names[256];
378#endif
379
380#define is_fixed_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_FIXED) != 0)
381#define is_nullable_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_NULLABLE) != 0)
382#define is_variable_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_VARIABLE) != 0)
383#define is_variant_inner_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_VARIANT) != 0)
384
385
386#define is_blob_type(x) ((x)==SYBTEXT || (x)==SYBIMAGE || (x)==SYBNTEXT)
387#define is_blob_col(x) ((x)->column_varint_size > 2)
388/* large type means it has a two byte size field */
389/* define is_large_type(x) (x>128) */
390#define is_numeric_type(x) ((x)==SYBNUMERIC || (x)==SYBDECIMAL)
392#define is_datetime_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_DATETIME) != 0)
393#define is_unicode_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_UNICODE) != 0)
394#define is_collate_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_COLLATE) != 0)
395#define is_ascii_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_ASCII) != 0)
396#define is_binary_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_BINARY) != 0)
397#define is_char_type(x) ((tds_type_flags_ms[x] & (TDS_TYPEFLAG_ASCII|TDS_TYPEFLAG_UNICODE)) != 0)
398#define is_similar_type(x, y) (is_char_type(x) && is_char_type(y))
399static inline
400bool is_tds_type_valid(int type)
401{
402 return (unsigned) type < 256u && tds_type_flags_ms[type] != 0;
403}
404
405
406#define TDS_MAX_CAPABILITY 32
407#define MAXPRECISION 77
408#define TDS_MAX_CONN 4096
409#define TDS_MAX_DYNID_LEN 30
410
411/* defaults to use if no others are found */
412#define TDS_DEF_SERVER "SYBASE"
413#define TDS_DEF_BLKSZ 512
414#define TDS_DEF_CHARSET "iso_1"
415#define TDS_DEF_LANG "us_english"
416#if TDS50
417#define TDS_DEFAULT_VERSION 0x500
418#define TDS_DEF_PORT 4000
419#elif TDS71
420#define TDS_DEFAULT_VERSION 0x701
421#define TDS_DEF_PORT 1433
422#elif TDS72
423#define TDS_DEFAULT_VERSION 0x702
424#define TDS_DEF_PORT 1433
425#elif TDS73
426#define TDS_DEFAULT_VERSION 0x703
427#define TDS_DEF_PORT 1433
428#elif TDS74
429#define TDS_DEFAULT_VERSION 0x704
430#define TDS_DEF_PORT 1433
431#else
432#define TDS_DEFAULT_VERSION 0x000
433#define TDS_DEF_PORT 1433
434#endif
435
436/* normalized strings from freetds.conf file */
437#define TDS_STR_VERSION "tds version"
438#define TDS_STR_BLKSZ "initial block size"
439#define TDS_STR_SWAPDT "swap broken dates"
440#define TDS_STR_DUMPFILE "dump file"
441#define TDS_STR_DEBUGLVL "debug level"
442#define TDS_STR_DEBUGFLAGS "debug flags"
443#define TDS_STR_TIMEOUT "timeout"
444#define TDS_STR_QUERY_TIMEOUT "query timeout"
445#define TDS_STR_CONNTIMEOUT "connect timeout"
446#define TDS_STR_HOSTNAME "hostname"
447#define TDS_STR_HOST "host"
448#define TDS_STR_PORT "port"
449#define TDS_STR_TEXTSZ "text size"
450/* for big endian hosts, obsolete, ignored */
451#define TDS_STR_EMUL_LE "emulate little endian"
452#define TDS_STR_CHARSET "charset"
453#define TDS_STR_CLCHARSET "client charset"
454#define TDS_STR_USE_UTF_16 "use utf-16"
455#define TDS_STR_LANGUAGE "language"
456#define TDS_STR_APPENDMODE "dump file append"
457#define TDS_STR_DATETIMEFMT "date format"
458#define TDS_STR_DATEFMT "date-only format"
459#define TDS_STR_TIMEFMT "time-only format"
460#define TDS_STR_INSTANCE "instance"
461#define TDS_STR_ASA_DATABASE "asa database"
462#define TDS_STR_DATABASE "database"
463#define TDS_STR_ENCRYPTION "encryption"
464#define TDS_STR_USENTLMV2 "use ntlmv2"
465#define TDS_STR_USELANMAN "use lanman"
466/* conf values */
467#define TDS_STR_ENCRYPTION_OFF "off"
468#define TDS_STR_ENCRYPTION_REQUEST "request"
469#define TDS_STR_ENCRYPTION_REQUIRE "require"
470/* Defines to enable optional GSSAPI delegation */
471#define TDS_GSSAPI_DELEGATION "enable gssapi delegation"
472/* Mutual authentication */
473#define TDS_STR_MUTUAL_AUTHENTICATION "mutual authentication"
474/* Kerberos realm name */
475#define TDS_STR_REALM "realm"
476/* Kerberos SPN */
477#define TDS_STR_SPN "spn"
478/* CA file */
479#define TDS_STR_CAFILE "ca file"
480/* CRL file */
481#define TDS_STR_CRLFILE "crl file"
482/* check SSL hostname */
483#define TDS_STR_CHECKSSLHOSTNAME "check certificate hostname"
484/* database filename to attach on login (MSSQL) */
485#define TDS_STR_DBFILENAME "database filename"
486/* Application Intent MSSQL 2012 support */
487#define TDS_STR_READONLY_INTENT "read-only intent"
488/* configurable cipher suite to send to openssl's SSL_set_cipher_list() function */
489#define TLS_STR_OPENSSL_CIPHERS "openssl ciphers"
490/* enable old TLS v1, required for instance if you are using a really old Windows XP */
491#define TDS_STR_ENABLE_TLS_V1 "enable tls v1"
492
493
494/* TODO do a better check for alignment than this */
495typedef union
496{
497 void *p;
498 int i;
499 int64_t ui;
501
502#define TDS_ALIGN_SIZE sizeof(tds_align_struct)
503
505{
506 unsigned char type;
507 unsigned char len; /* always sizeof(values) */
508 unsigned char values[TDS_MAX_CAPABILITY/2-2];
510
511typedef struct tds_capabilities
512{
513 TDS_CAPABILITY_TYPE types[2];
515
516#define TDS_MAX_LOGIN_STR_SZ 128
517typedef struct tds_login
518{
520 int port;
521 TDS_USMALLINT tds_version;
522 int block_size;
523 DSTR language; /* e.g. us-english */
525 TDS_INT connect_timeout;
526 DSTR client_host_name;
527 DSTR server_host_name;
533 DSTR openssl_ciphers;
534 DSTR app_name;
539 DSTR library; /* Ct-Library, DB-Library, TDS-Library or ODBC */
540 TDS_TINYINT encryption_level;
541
542 TDS_INT query_timeout;
543 TDS_CAPABILITIES capabilities;
544 DSTR client_charset;
545 DSTR database;
546
547 struct addrinfo *ip_addrs;
548 DSTR instance_name;
549 DSTR dump_file;
550 int debug_flags;
551 int text_size;
552 DSTR routing_address;
553 uint16_t routing_port;
554
555 unsigned char option_flag2;
556
557 unsigned int bulk_copy:1;
558 unsigned int suppress_language:1;
559 unsigned int gssapi_use_delegation:1;
560 unsigned int mutual_authentication:1;
561 unsigned int use_ntlmv2:1;
562 unsigned int use_ntlmv2_specified:1;
563 unsigned int use_lanman:1;
564 unsigned int mars:1;
565 unsigned int use_utf16:1;
566 unsigned int use_new_password:1;
567 unsigned int valid_configuration:1;
568 unsigned int check_ssl_hostname:1;
569 unsigned int readonly_intent:1;
570 unsigned int enable_tls_v1:1;
571 unsigned int server_is_valid:1;
572} TDSLOGIN;
573
574typedef struct tds_headers
575{
576 const char *qn_options;
577 const char *qn_msgtext;
578 TDS_INT qn_timeout;
579 /* TDS 7.4+: trace activity ID char[20] */
580} TDSHEADERS;
581
582typedef struct tds_locale
583{
584 char *language;
585 char *server_charset;
586 char *datetime_fmt;
587 char *date_fmt;
588 char *time_fmt;
589} TDSLOCALE;
590
595typedef struct tds_blob
596{
597 TDS_CHAR *textvalue;
598 TDS_CHAR textptr[16];
599 TDS_CHAR timestamp[8];
600 bool valid_ptr;
602
606typedef struct tds_variant
607{
608 /* this MUST have same position and place of textvalue in tds_blob */
609 TDS_CHAR *data;
610 TDS_INT size;
611 TDS_INT data_len;
612 TDS_SERVER_TYPE type;
613 TDS_UCHAR collation[5];
615
620typedef struct tds_encoding
621{
623 const char *name;
624 unsigned char min_bytes_per_char;
625 unsigned char max_bytes_per_char;
627 unsigned char canonic;
629
630typedef struct tds_bcpcoldata
631{
632 TDS_UCHAR *data;
633 TDS_INT datalen;
634 bool is_null;
635} BCPCOLDATA;
636
637
638typedef TDSRET tds_func_get_info(TDSSOCKET *tds, TDSCOLUMN *col);
639typedef TDSRET tds_func_get_data(TDSSOCKET *tds, TDSCOLUMN *col);
640typedef TDS_INT tds_func_row_len(TDSCOLUMN *col);
641typedef TDSRET tds_func_put_info(TDSSOCKET *tds, TDSCOLUMN *col);
642typedef TDSRET tds_func_put_data(TDSSOCKET *tds, TDSCOLUMN *col, int bcp7);
643typedef int tds_func_check(const TDSCOLUMN *col);
644
645typedef struct tds_column_funcs
646{
647 tds_func_get_info *get_info;
648 tds_func_get_data *get_data;
649 tds_func_row_len *row_len;
655 tds_func_put_info *put_info;
665 tds_func_put_data *put_data;
666#if ENABLE_EXTRA_CHECKS
681 tds_func_check *check;
682#endif
683#if 0
684 TDSRET (*convert)(TDSSOCKET *tds, TDSCOLUMN *col);
685#endif
687
692{
693 const TDSCOLUMNFUNCS *funcs;
694 TDS_INT column_usertype;
695 TDS_INT column_flags;
696
697 TDS_INT column_size;
699 TDS_SERVER_TYPE column_type;
704 TDS_TINYINT column_varint_size;
706 TDS_TINYINT column_prec;
707 TDS_TINYINT column_scale;
709 struct
710 {
711 TDS_SERVER_TYPE column_type;
712 TDS_INT column_size;
713 } on_server;
714
717 DSTR table_name;
718 DSTR column_name;
719 DSTR table_column_name;
720
721 unsigned char *column_data;
722 void (*column_data_free)(struct tds_column *column);
723 unsigned char column_nullable:1;
724 unsigned char column_writeable:1;
725 unsigned char column_identity:1;
726 unsigned char column_key:1;
727 unsigned char column_hidden:1;
728 unsigned char column_output:1;
729 unsigned char column_timestamp:1;
730 unsigned char column_computed:1;
731 TDS_UCHAR column_collation[5];
732
733 /* additional fields flags for compute results */
734 TDS_SMALLINT column_operand;
735 TDS_TINYINT column_operator;
736
737 /* FIXME this is data related, not column */
740
741 /* related to binding or info stored by client libraries */
742 /* FIXME find a best place to store these data, some are unused */
743 TDS_SMALLINT column_bindtype;
744 TDS_SMALLINT column_bindfmt;
745 TDS_UINT column_bindlen;
746 TDS_SMALLINT *column_nullbind;
747 TDS_CHAR *column_varaddr;
748 TDS_INT *column_lenbind;
749 TDS_INT column_textpos;
750 TDS_INT column_text_sqlgetdatapos;
751 TDS_CHAR column_text_sqlputdatainfo;
752 unsigned char column_iconv_left;
753 char column_iconv_buf[9];
754
755 BCPCOLDATA *bcp_column_data;
765 TDS_INT bcp_term_len;
766 TDS_CHAR *bcp_terminator;
767};
768
769
771typedef struct tds_result_info
772{
773 /* TODO those fields can became a struct */
774 TDSCOLUMN **columns;
775 TDS_USMALLINT num_cols;
776 TDS_USMALLINT computeid;
777 TDS_INT ref_count;
778 TDSSOCKET *attached_to;
779 unsigned char *current_row;
780 void (*row_free)(struct tds_result_info* result, unsigned char *row);
781 TDS_INT row_size;
782
783 TDS_SMALLINT *bycolumns;
784 TDS_USMALLINT by_cols;
785 bool rows_exist;
786 /* TODO remove ?? used only in dblib */
787 bool more_results;
789
800
801typedef enum tds_operations
802{
803 TDS_OP_NONE = 0,
804
805 /* mssql operations */
806 TDS_OP_CURSOR = TDS_SP_CURSOR,
807 TDS_OP_CURSOROPEN = TDS_SP_CURSOROPEN,
808 TDS_OP_CURSORPREPARE = TDS_SP_CURSORPREPARE,
809 TDS_OP_CURSOREXECUTE = TDS_SP_CURSOREXECUTE,
810 TDS_OP_CURSORPREPEXEC = TDS_SP_CURSORPREPEXEC,
811 TDS_OP_CURSORUNPREPARE = TDS_SP_CURSORUNPREPARE,
812 TDS_OP_CURSORFETCH = TDS_SP_CURSORFETCH,
813 TDS_OP_CURSOROPTION = TDS_SP_CURSOROPTION,
814 TDS_OP_CURSORCLOSE = TDS_SP_CURSORCLOSE,
815 TDS_OP_EXECUTESQL = TDS_SP_EXECUTESQL,
816 TDS_OP_PREPARE = TDS_SP_PREPARE,
817 TDS_OP_EXECUTE = TDS_SP_EXECUTE,
818 TDS_OP_PREPEXEC = TDS_SP_PREPEXEC,
819 TDS_OP_PREPEXECRPC = TDS_SP_PREPEXECRPC,
820 TDS_OP_UNPREPARE = TDS_SP_UNPREPARE,
821
822 /* sybase operations */
823 TDS_OP_DYN_DEALLOC = 100,
824} TDS_OPERATION;
825
826#define TDS_DBG_LOGIN __FILE__, ((__LINE__ << 4) | 11)
827#define TDS_DBG_HEADER __FILE__, ((__LINE__ << 4) | 10)
828#define TDS_DBG_FUNC __FILE__, ((__LINE__ << 4) | 7)
829#define TDS_DBG_INFO2 __FILE__, ((__LINE__ << 4) | 6)
830#define TDS_DBG_INFO1 __FILE__, ((__LINE__ << 4) | 5)
831#define TDS_DBG_NETWORK __FILE__, ((__LINE__ << 4) | 4)
832#define TDS_DBG_WARN __FILE__, ((__LINE__ << 4) | 3)
833#define TDS_DBG_ERROR __FILE__, ((__LINE__ << 4) | 2)
834#define TDS_DBG_SEVERE __FILE__, ((__LINE__ << 4) | 1)
835
836#define TDS_DBGFLAG_FUNC 0x80
837#define TDS_DBGFLAG_INFO2 0x40
838#define TDS_DBGFLAG_INFO1 0x20
839#define TDS_DBGFLAG_NETWORK 0x10
840#define TDS_DBGFLAG_WARN 0x08
841#define TDS_DBGFLAG_ERROR 0x04
842#define TDS_DBGFLAG_SEVERE 0x02
843#define TDS_DBGFLAG_ALL 0xfff
844#define TDS_DBGFLAG_LOGIN 0x0800
845#define TDS_DBGFLAG_HEADER 0x0400
846#define TDS_DBGFLAG_PID 0x1000
847#define TDS_DBGFLAG_TIME 0x2000
848#define TDS_DBGFLAG_SOURCE 0x4000
849#define TDS_DBGFLAG_THREAD 0x8000
850
851#if 0
857enum TDS_DBG_LOG_STATE
858{
859 TDS_DBG_LOGIN = (1 << 0)
861 , TDS_DBG_API = (1 << 1)
862 , TDS_DBG_ASYNC = (1 << 2)
863 , TDS_DBG_DIAG = (1 << 3)
864 , TDS_DBG_error = (1 << 4)
865 /* TODO: ^^^^^ make upper case when old #defines (above) are removed */
866 /* Log FreeTDS runtime/logic error occurs. */
867 , TDS_DBG_PACKET = (1 << 5)
868 , TDS_DBG_LIBTDS = (1 << 6)
869 , TDS_DBG_CONFIG = (1 << 7)
870 , TDS_DBG_DEFAULT = 0xFE
871};
872#endif
873
874typedef struct tds_result_info TDSCOMPUTEINFO;
875
877
878typedef struct tds_message
879{
880 TDS_CHAR *server;
881 TDS_CHAR *message;
882 TDS_CHAR *proc_name;
883 TDS_CHAR *sql_state;
884 TDS_INT msgno;
885 TDS_INT line_number;
886 /* -1 .. 255 */
887 TDS_SMALLINT state;
888 TDS_TINYINT priv_msg_type;
889 TDS_TINYINT severity;
890 /* for library-generated errors */
891 int oserr;
892} TDSMESSAGE;
893
894typedef struct tds_upd_col
895{
896 struct tds_upd_col *next;
897 TDS_INT colnamelength;
898 char * columnname;
899} TDSUPDCOL;
900
901typedef enum {
902 TDS_CURSOR_STATE_UNACTIONED = 0 /* initial value */
903 , TDS_CURSOR_STATE_REQUESTED = 1 /* called by ct_cursor */
904 , TDS_CURSOR_STATE_SENT = 2 /* sent to server */
905 , TDS_CURSOR_STATE_ACTIONED = 3 /* acknowledged by server */
906} TDS_CURSOR_STATE;
907
908typedef struct tds_cursor_status
909{
910 TDS_CURSOR_STATE declare;
911 TDS_CURSOR_STATE cursor_row;
912 TDS_CURSOR_STATE open;
913 TDS_CURSOR_STATE fetch;
914 TDS_CURSOR_STATE close;
915 TDS_CURSOR_STATE dealloc;
917
918typedef enum tds_cursor_operation
919{
920 TDS_CURSOR_POSITION = 0,
921 TDS_CURSOR_UPDATE = 1,
922 TDS_CURSOR_DELETE = 2,
923 TDS_CURSOR_INSERT = 4
924} TDS_CURSOR_OPERATION;
925
926typedef enum tds_cursor_fetch
927{
928 TDS_CURSOR_FETCH_NEXT = 1,
929 TDS_CURSOR_FETCH_PREV,
930 TDS_CURSOR_FETCH_FIRST,
931 TDS_CURSOR_FETCH_LAST,
932 TDS_CURSOR_FETCH_ABSOLUTE,
933 TDS_CURSOR_FETCH_RELATIVE
934} TDS_CURSOR_FETCH;
935
939typedef struct tds_cursor
940{
941 struct tds_cursor *next;
942 TDS_INT ref_count;
944 TDS_INT cursor_id;
945 TDS_TINYINT options;
950 char *query;
951 /* TODO for updatable columns */
952 /* TDS_TINYINT number_upd_cols; */
953 /* TDSUPDCOL *cur_col_list; */
954 TDS_INT cursor_rows;
955 /* TDSPARAMINFO *params; */
957 TDS_USMALLINT srv_status;
958 TDSRESULTINFO *res_info;
959 TDS_INT type, concurrency;
961
965typedef struct tds_env
966{
969 char *language;
971 char *charset;
973 char *database;
975
979typedef struct tds_dynamic
980{
982 TDS_INT ref_count;
984 TDS_INT num_id;
990 char id[30];
996 TDS_TINYINT emulated;
1001 /* int dyn_state; */ /* TODO use it */
1012 char *query;
1014
1015typedef enum {
1016 TDS_MULTIPLE_QUERY,
1017 TDS_MULTIPLE_EXECUTE,
1018 TDS_MULTIPLE_RPC
1019} TDS_MULTIPLE_TYPE;
1020
1021typedef struct tds_multiple
1022{
1023 TDS_MULTIPLE_TYPE type;
1024 unsigned int flags;
1025} TDSMULTIPLE;
1026
1027/* forward declaration */
1028typedef struct tds_context TDSCONTEXT;
1029typedef int (*err_handler_t) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1030
1032{
1033 TDSLOCALE *locale;
1034 void *parent;
1035 /* handlers */
1036 int (*msg_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1037 int (*err_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1038 int (*int_handler) (void *);
1039 bool money_use_2_digits;
1040};
1041
1042enum TDS_ICONV_ENTRY
1043{
1044 client2ucs2
1045 , client2server_chardata
1046 , initial_char_conv_count /* keep last */
1047};
1048
1050{
1051 uint8_t *packet;
1052 int packet_len;
1053 /* TDS_MSG_TOKEN type, for TDS5 */
1054 uint16_t msg_type;
1055 TDSRET (*free)(TDSCONNECTION* conn, struct tds_authentication * auth);
1056 TDSRET (*handle_next)(TDSSOCKET * tds, struct tds_authentication * auth, size_t len);
1058
1059typedef struct tds_packet
1060{
1061 struct tds_packet *next;
1062 uint16_t sid;
1063
1064#if ENABLE_ODBC_MARS
1068 uint8_t data_start;
1069#endif
1070
1074 unsigned data_len;
1075 unsigned capacity;
1076 unsigned char buf[1];
1077} TDSPACKET;
1078
1079#if ENABLE_ODBC_MARS
1080#define tds_packet_zero_data_start(pkt) do { (pkt)->data_start = 0; } while(0)
1081#define tds_packet_get_data_start(pkt) ((pkt)->data_start)
1082#else
1083#define tds_packet_zero_data_start(pkt) do { } while(0)
1084#define tds_packet_get_data_start(pkt) 0
1085#endif
1086
1087typedef struct tds_poll_wakeup
1088{
1089 TDS_SYS_SOCKET s_signal, s_signaled;
1091
1092/* field related to connection */
1094{
1095 TDS_USMALLINT tds_version;
1097 char *product_name;
1098
1099 TDS_SYS_SOCKET s;
1100 TDSPOLLWAKEUP wakeup;
1101 const TDSCONTEXT *tds_ctx;
1102
1105
1116
1117 int char_conv_count;
1118 TDSICONV **char_convs;
1119
1120 TDS_UCHAR collation[5];
1121 TDS_UCHAR tds72_transaction[8];
1122
1123 TDS_CAPABILITIES capabilities;
1124 unsigned int use_iconv:1;
1125 unsigned int tds71rev1:1;
1126 unsigned int pending_close:1;
1127 unsigned int encrypt_single_packet:1;
1128#if ENABLE_ODBC_MARS
1129 unsigned int mars:1;
1130
1131 TDSSOCKET *in_net_tds;
1132 TDSPACKET *packets;
1133 TDSPACKET *recv_packet;
1134 TDSPACKET *send_packets;
1135 unsigned send_pos, recv_pos;
1136
1137#define BUSY_SOCKET ((TDSSOCKET*)(TDS_UINTPTR)1)
1138#define TDSSOCKET_VALID(tds) (((TDS_UINTPTR)(tds)) > 1)
1139 struct tds_socket **sessions;
1140 unsigned num_sessions;
1141#endif
1142 tds_mutex list_mtx;
1143
1144 unsigned num_cached_packets;
1145 TDSPACKET *packet_cache;
1146
1147 int spid;
1148 int client_spid;
1149
1154 uint8_t ncharsize;
1155
1162
1163 void *tls_session;
1164#if defined(HAVE_GNUTLS)
1165 void *tls_credentials;
1166#elif defined(HAVE_OPENSSL)
1167 void *tls_ctx;
1168#else
1169 void *tls_dummy;
1170#endif
1171 TDSAUTHENTICATION *authentication;
1172 char *server;
1173};
1174
1179{
1180#if ENABLE_ODBC_MARS
1181 TDSCONNECTION *conn;
1182#else
1183 TDSCONNECTION conn[1];
1184#endif
1185
1186 void *parent;
1187
1193 unsigned char *in_buf;
1194
1201 unsigned char *out_buf;
1202
1207 unsigned int out_buf_max;
1208 unsigned in_pos;
1209 unsigned out_pos;
1210 unsigned in_len;
1211 unsigned char in_flag;
1212 unsigned char out_flag;
1214 unsigned frozen;
1220
1221#if ENABLE_ODBC_MARS
1226 uint16_t sid;
1227
1232 tds_condition packet_cond;
1233
1238 TDSPACKET *sending_packet;
1239 TDS_UINT recv_seq;
1240 TDS_UINT send_seq;
1241 TDS_UINT recv_wnd;
1242 TDS_UINT send_wnd;
1243#endif
1244 /* packet we received */
1245 TDSPACKET *recv_packet;
1248
1255 TDSRESULTINFO *res_info;
1256 TDS_UINT num_comp_info;
1257 TDSCOMPUTEINFO **comp_info;
1258 TDSPARAMINFO *param_info;
1262 bool in_row;
1263 volatile
1264 unsigned char in_cancel;
1266 TDS_INT ret_status;
1267 TDS_STATE state;
1268
1269 TDS_INT query_timeout;
1270 TDS_INT8 rows_affected;
1276 void (*env_chg_func) (TDSSOCKET * tds, int type, char *oldval, char *newval);
1277 TDS_OPERATION current_op;
1278
1279 int option_value;
1280 tds_mutex wire_mtx;
1281};
1282
1283#define tds_get_ctx(tds) ((tds)->conn->tds_ctx)
1284#define tds_set_ctx(tds, val) do { ((tds)->conn->tds_ctx) = (val); } while(0)
1285#define tds_get_parent(tds) ((tds)->parent)
1286#define tds_set_parent(tds, val) do { ((tds)->parent) = (val); } while(0)
1287#define tds_get_s(tds) ((tds)->conn->s)
1288#define tds_set_s(tds, val) do { ((tds)->conn->s) = (val); } while(0)
1289
1290typedef struct tds_tvp_row
1291{
1292 TDSPARAMINFO *params;
1293 struct tds_tvp_row *next;
1294} TDS_TVP_ROW;
1295
1296typedef struct tds_tvp
1297{
1298 char *schema;
1299 char *name;
1300 TDSPARAMINFO *metadata;
1301 TDS_TVP_ROW *row;
1302} TDS_TVP;
1303
1304
1305/* config.c */
1307typedef void (*TDSCONFPARSE) (const char *option, const char *value, void *param);
1308bool tds_read_conf_section(FILE * in, const char *section, TDSCONFPARSE tds_conf_parse, void *parse_param);
1309bool tds_read_conf_file(TDSLOGIN * login, const char *server);
1310void tds_parse_conf_section(const char *option, const char *value, void *param);
1311TDSLOGIN *tds_read_config_info(TDSSOCKET * tds, TDSLOGIN * login, TDSLOCALE * locale);
1312void tds_fix_login(TDSLOGIN* login);
1313TDS_USMALLINT * tds_config_verstr(const char *tdsver, TDSLOGIN* login);
1314struct addrinfo *tds_lookup_host(const char *servername);
1315TDSRET tds_lookup_host_set(const char *servername, struct addrinfo **addr);
1316const char *tds_addrinfo2str(struct addrinfo *addr, char *name, int namemax);
1317char *tds_get_home_file(const char *file);
1318
1319TDSRET tds_set_interfaces_file_loc(const char *interfloc);
1320extern const char STD_DATETIME_FMT[];
1321int tds_parse_boolean(const char *value, int default_value);
1322int tds_config_boolean(const char *option, const char *value, TDSLOGIN * login);
1323
1325TDSRET tds_alloc_row(TDSRESULTINFO * res_info);
1326TDSRET tds_alloc_compute_row(TDSCOMPUTEINFO * res_info);
1327BCPCOLDATA * tds_alloc_bcp_column_data(unsigned int column_size);
1328TDSDYNAMIC *tds_lookup_dynamic(TDSCONNECTION * conn, const char *id);
1329/*@observer@*/ const char *tds_prtype(int token);
1330int tds_get_varint_size(TDSCONNECTION * conn, int datatype);
1331TDS_SERVER_TYPE tds_get_cardinal_type(TDS_SERVER_TYPE datatype, int usertype);
1332
1333
1334/* iconv.c */
1335TDSRET tds_iconv_open(TDSCONNECTION * conn, const char *charset, int use_utf16);
1336void tds_iconv_close(TDSCONNECTION * conn);
1337void tds_srv_charset_changed(TDSCONNECTION * conn, const char *charset);
1338void tds7_srv_charset_changed(TDSCONNECTION * conn, TDS_UCHAR collate[5]);
1339int tds_iconv_alloc(TDSCONNECTION * conn);
1340void tds_iconv_free(TDSCONNECTION * conn);
1341TDSICONV *tds_iconv_from_collate(TDSCONNECTION * conn, TDS_UCHAR collate[5]);
1342
1343
1344/* mem.c */
1345void tds_free_socket(TDSSOCKET * tds);
1346void tds_free_all_results(TDSSOCKET * tds);
1347void tds_free_results(TDSRESULTINFO * res_info);
1348void tds_free_param_results(TDSPARAMINFO * param_info);
1349void tds_free_param_result(TDSPARAMINFO * param_info);
1350void tds_free_msg(TDSMESSAGE * message);
1351void tds_cursor_deallocated(TDSCONNECTION *conn, TDSCURSOR *cursor);
1352void tds_release_cursor(TDSCURSOR **pcursor);
1353void tds_free_bcp_column_data(BCPCOLDATA * coldata);
1354TDSRESULTINFO *tds_alloc_results(TDS_USMALLINT num_cols);
1355TDSCOMPUTEINFO **tds_alloc_compute_results(TDSSOCKET * tds, TDS_USMALLINT num_cols, TDS_USMALLINT by_cols);
1356TDSCONTEXT *tds_alloc_context(void * parent);
1357void tds_free_context(TDSCONTEXT * locale);
1360void tds_release_dynamic(TDSDYNAMIC ** dyn);
1361static inline
1362void tds_release_cur_dyn(TDSSOCKET * tds)
1363{
1365}
1366void tds_dynamic_deallocated(TDSCONNECTION *conn, TDSDYNAMIC *dyn);
1367void tds_set_cur_dyn(TDSSOCKET *tds, TDSDYNAMIC *dyn);
1368TDSSOCKET *tds_realloc_socket(TDSSOCKET * tds, size_t bufsize);
1369char *tds_alloc_client_sqlstate(int msgno);
1370char *tds_alloc_lookup_sqlstate(TDSSOCKET * tds, int msgno);
1371TDSLOGIN *tds_alloc_login(int use_environment);
1372TDSDYNAMIC *tds_alloc_dynamic(TDSCONNECTION * conn, const char *id);
1373void tds_free_login(TDSLOGIN * login);
1374TDSLOGIN *tds_init_login(TDSLOGIN * login, TDSLOCALE * locale);
1375TDSLOCALE *tds_alloc_locale(void);
1376void *tds_alloc_param_data(TDSCOLUMN * curparam);
1377void tds_free_locale(TDSLOCALE * locale);
1378TDSCURSOR * tds_alloc_cursor(TDSSOCKET * tds, const char *name, TDS_INT namelen, const char *query, TDS_INT querylen);
1379void tds_free_row(TDSRESULTINFO * res_info, unsigned char *row);
1380TDSSOCKET *tds_alloc_socket(TDSCONTEXT * context, unsigned int bufsize);
1381TDSSOCKET *tds_alloc_additional_socket(TDSCONNECTION *conn);
1382void tds_set_current_results(TDSSOCKET *tds, TDSRESULTINFO *info);
1384void * tds_realloc(void **pp, size_t new_size);
1385#define TDS_RESIZE(p, n_elem) \
1386 tds_realloc((void **) &(p), sizeof(*(p)) * (size_t) (n_elem))
1387#define tds_new(type, n) ((type *) malloc(sizeof(type) * (n)))
1388#define tds_new0(type, n) ((type *) calloc(n, sizeof(type)))
1389
1390TDSPACKET *tds_alloc_packet(void *buf, unsigned len);
1391TDSPACKET *tds_realloc_packet(TDSPACKET *packet, unsigned len);
1392void tds_free_packets(TDSPACKET *packet);
1393TDSBCPINFO *tds_alloc_bcpinfo(void);
1394void tds_free_bcpinfo(TDSBCPINFO *bcpinfo);
1395void tds_deinit_bcpinfo(TDSBCPINFO *bcpinfo);
1396void tds_deinit_tvp(TDS_TVP *table);
1397
1398
1399/* login.c */
1400void tds_set_packet(TDSLOGIN * tds_login, int packet_size);
1401void tds_set_port(TDSLOGIN * tds_login, int port);
1402bool tds_set_passwd(TDSLOGIN * tds_login, const char *password) TDS_WUR;
1403void tds_set_bulk(TDSLOGIN * tds_login, bool enabled);
1404bool tds_set_user(TDSLOGIN * tds_login, const char *username) TDS_WUR;
1405bool tds_set_app(TDSLOGIN * tds_login, const char *application) TDS_WUR;
1406bool tds_set_host(TDSLOGIN * tds_login, const char *hostname) TDS_WUR;
1407bool tds_set_library(TDSLOGIN * tds_login, const char *library) TDS_WUR;
1408bool tds_set_server(TDSLOGIN * tds_login, const char *server) TDS_WUR;
1409bool tds_set_client_charset(TDSLOGIN * tds_login, const char *charset) TDS_WUR;
1410bool tds_set_language(TDSLOGIN * tds_login, const char *language) TDS_WUR;
1411void tds_set_version(TDSLOGIN * tds_login, TDS_TINYINT major_ver, TDS_TINYINT minor_ver);
1412int tds_connect_and_login(TDSSOCKET * tds, TDSLOGIN * login);
1413
1414
1415/* query.c */
1416void tds_start_query(TDSSOCKET *tds, unsigned char packet_type);
1417
1418TDSRET tds_submit_query(TDSSOCKET * tds, const char *query);
1419TDSRET tds_submit_query_params(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1420TDSRET tds_submit_queryf(TDSSOCKET * tds, const char *queryf, ...);
1421TDSRET tds_submit_prepare(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1422TDSRET tds_submit_execdirect(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1423TDSRET tds71_submit_prepexec(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1424TDSRET tds_submit_execute(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1425TDSRET tds_send_cancel(TDSSOCKET * tds);
1426const char *tds_next_placeholder(const char *start);
1427int tds_count_placeholders(const char *query);
1429TDSRET tds_deferred_unprepare(TDSCONNECTION * conn, TDSDYNAMIC * dyn);
1430TDSRET tds_submit_unprepare(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1431TDSRET tds_submit_rpc(TDSSOCKET * tds, const char *rpc_name, TDSPARAMINFO * params, TDSHEADERS * head);
1432TDSRET tds_submit_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD command, TDS_OPTION option, TDS_OPTION_ARG *param, TDS_INT param_size);
1433TDSRET tds_submit_begin_tran(TDSSOCKET *tds);
1434TDSRET tds_submit_rollback(TDSSOCKET *tds, bool cont);
1435TDSRET tds_submit_commit(TDSSOCKET *tds, bool cont);
1436TDSRET tds_disconnect(TDSSOCKET * tds);
1437size_t tds_quote_id(TDSSOCKET * tds, char *buffer, const char *id, int idlen);
1438size_t tds_quote_id_rpc(TDSSOCKET * tds, char *buffer, const char *id, int idlen);
1439size_t tds_quote_string(TDSSOCKET * tds, char *buffer, const char *str, int len);
1440const char *tds_skip_comment(const char *s);
1441const char *tds_skip_quoted(const char *s);
1442size_t tds_fix_column_size(TDSSOCKET * tds, TDSCOLUMN * curcol);
1443const char *tds_convert_string(TDSSOCKET * tds, TDSICONV * char_conv, const char *s, int len, size_t *out_len);
1444void tds_convert_string_free(const char *original, const char *converted);
1445#if !ENABLE_EXTRA_CHECKS
1446#define tds_convert_string_free(original, converted) \
1447 do { if (original != converted) free((char*) converted); } while(0)
1448#endif
1449TDSRET tds_get_column_declaration(TDSSOCKET * tds, TDSCOLUMN * curcol, char *out);
1450
1451TDSRET tds_cursor_declare(TDSSOCKET * tds, TDSCURSOR * cursor, TDSPARAMINFO *params, int *send);
1452TDSRET tds_cursor_setrows(TDSSOCKET * tds, TDSCURSOR * cursor, int *send);
1453TDSRET tds_cursor_open(TDSSOCKET * tds, TDSCURSOR * cursor, TDSPARAMINFO *params, int *send);
1454TDSRET tds_cursor_fetch(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_FETCH fetch_type, TDS_INT i_row);
1455TDSRET tds_cursor_get_cursor_info(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_UINT * row_number, TDS_UINT * row_count);
1456TDSRET tds_cursor_close(TDSSOCKET * tds, TDSCURSOR * cursor);
1457TDSRET tds_cursor_dealloc(TDSSOCKET * tds, TDSCURSOR * cursor);
1459TDSRET tds_cursor_update(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_OPERATION op, TDS_INT i_row, TDSPARAMINFO * params);
1460TDSRET tds_cursor_setname(TDSSOCKET * tds, TDSCURSOR * cursor);
1461
1462TDSRET tds_multiple_init(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDS_MULTIPLE_TYPE type, TDSHEADERS * head);
1463TDSRET tds_multiple_done(TDSSOCKET *tds, TDSMULTIPLE *multiple);
1464TDSRET tds_multiple_query(TDSSOCKET *tds, TDSMULTIPLE *multiple, const char *query, TDSPARAMINFO * params);
1465TDSRET tds_multiple_execute(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDSDYNAMIC * dyn);
1466
1467
1468/* token.c */
1469TDSRET tds_process_cancel(TDSSOCKET * tds);
1472int tds5_send_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD tds_command, TDS_OPTION tds_option, TDS_OPTION_ARG * tds_argument,
1473 TDS_INT * tds_argsize);
1474TDSRET tds_process_tokens(TDSSOCKET * tds, /*@out@*/ TDS_INT * result_type, /*@out@*/ int *done_flags, unsigned flag);
1475
1476
1477/* data.c */
1478void tds_set_param_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
1479void tds_set_column_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
1480#ifdef WORDS_BIGENDIAN
1481void tds_swap_datatype(int coltype, void *b);
1482#endif
1483
1484
1485/* tds_convert.c */
1486TDSRET tds_datecrack(TDS_INT datetype, const void *di, TDSDATEREC * dr);
1487TDS_SERVER_TYPE tds_get_conversion_type(TDS_SERVER_TYPE srctype, int colsize);
1488extern const char tds_hex_digits[];
1489
1490
1491/* write.c */
1492int tds_init_write_buf(TDSSOCKET * tds);
1493int tds_put_n(TDSSOCKET * tds, const void *buf, size_t n);
1494int tds_put_string(TDSSOCKET * tds, const char *buf, int len);
1495int tds_put_int(TDSSOCKET * tds, TDS_INT i);
1496int tds_put_int8(TDSSOCKET * tds, TDS_INT8 i);
1497int tds_put_smallint(TDSSOCKET * tds, TDS_SMALLINT si);
1499#define tds_put_tinyint(tds, ti) tds_put_byte(tds,ti)
1500int tds_put_byte(TDSSOCKET * tds, unsigned char c);
1501TDSRET tds_flush_packet(TDSSOCKET * tds);
1502int tds_put_buf(TDSSOCKET * tds, const unsigned char *buf, int dsize, int ssize);
1503
1504
1505/* read.c */
1506unsigned char tds_get_byte(TDSSOCKET * tds);
1507void tds_unget_byte(TDSSOCKET * tds);
1508unsigned char tds_peek(TDSSOCKET * tds);
1509TDS_USMALLINT tds_get_usmallint(TDSSOCKET * tds);
1510#define tds_get_smallint(tds) ((TDS_SMALLINT) tds_get_usmallint(tds))
1511TDS_UINT tds_get_uint(TDSSOCKET * tds);
1512#define tds_get_int(tds) ((TDS_INT) tds_get_uint(tds))
1513TDS_UINT8 tds_get_uint8(TDSSOCKET * tds);
1514#define tds_get_int8(tds) ((TDS_INT8) tds_get_uint8(tds))
1515size_t tds_get_string(TDSSOCKET * tds, size_t string_len, char *dest, size_t dest_size);
1516TDSRET tds_get_char_data(TDSSOCKET * tds, char *dest, size_t wire_size, TDSCOLUMN * curcol);
1517bool tds_get_n(TDSSOCKET * tds, /*@out@*/ /*@null@*/ void *dest, size_t n);
1518int tds_get_size_by_type(TDS_SERVER_TYPE servertype);
1519DSTR* tds_dstr_get(TDSSOCKET * tds, DSTR * s, size_t len);
1520
1521
1522/* util.c */
1523int tdserror (const TDSCONTEXT * tds_ctx, TDSSOCKET * tds, int msgno, int errnum);
1525void tds_swap_bytes(void *buf, int bytes);
1526unsigned int tds_gettime_ms(void);
1527char *tds_strndup(const void *s, TDS_INTPTR len);
1528
1529
1530/* log.c */
1531typedef struct tdsdump_off_item {
1532 struct tdsdump_off_item *next;
1533 tds_thread_id thread_id;
1535void tdsdump_off(TDSDUMP_OFF_ITEM *off_item);
1536void tdsdump_on(TDSDUMP_OFF_ITEM *off_item);
1537int tdsdump_isopen(void);
1538#include <freetds/popvis.h>
1539int tdsdump_open(const char *filename);
1540#include <freetds/pushvis.h>
1541void tdsdump_close(void);
1542void tdsdump_dump_buf(const char* file, unsigned int level_line, const char *msg, const void *buf, size_t length);
1543void tdsdump_col(const TDSCOLUMN *col);
1544#undef tdsdump_log
1545void tdsdump_log(const char* file, unsigned int level_line, const char *fmt, ...)
1546#if defined(__GNUC__) && __GNUC__ >= 2
1547#if defined(__MINGW32__)
1548 __attribute__ ((__format__ (ms_printf, 3, 4)))
1549#else
1550 __attribute__ ((__format__ (__printf__, 3, 4)))
1551#endif
1552#endif
1553;
1554#define TDSDUMP_LOG_FAST if (TDS_UNLIKELY(tds_write_dump)) tdsdump_log
1555#define tdsdump_log TDSDUMP_LOG_FAST
1556#define TDSDUMP_BUF_FAST if (TDS_UNLIKELY(tds_write_dump)) tdsdump_dump_buf
1557#define tdsdump_dump_buf TDSDUMP_BUF_FAST
1558
1559extern int tds_write_dump;
1560extern int tds_debug_flags;
1561extern int tds_g_append_mode;
1562
1563
1564/* net.c */
1565TDSERRNO tds_open_socket(TDSSOCKET * tds, struct addrinfo *ipaddr, unsigned int port, int timeout, int *p_oserr);
1566void tds_close_socket(TDSSOCKET * tds);
1567int tds7_get_instance_ports(FILE *output, struct addrinfo *addr);
1568int tds7_get_instance_port(struct addrinfo *addr, const char *instance);
1569char *tds_prwsaerror(int erc);
1570void tds_prwsaerror_free(char *s);
1571int tds_connection_read(TDSSOCKET * tds, unsigned char *buf, int buflen);
1572int tds_connection_write(TDSSOCKET *tds, const unsigned char *buf, int buflen, int final);
1573#define TDSSELREAD POLLIN
1574#define TDSSELWRITE POLLOUT
1575int tds_select(TDSSOCKET * tds, unsigned tds_sel, int timeout_seconds);
1576void tds_connection_close(TDSCONNECTION *conn);
1577int tds_goodread(TDSSOCKET * tds, unsigned char *buf, int buflen);
1578int tds_goodwrite(TDSSOCKET * tds, const unsigned char *buffer, size_t buflen);
1579void tds_socket_flush(TDS_SYS_SOCKET sock);
1580int tds_socket_set_nonblocking(TDS_SYS_SOCKET sock);
1581int tds_wakeup_init(TDSPOLLWAKEUP *wakeup);
1582void tds_wakeup_close(TDSPOLLWAKEUP *wakeup);
1583void tds_wakeup_send(TDSPOLLWAKEUP *wakeup, char cancel);
1584static inline TDS_SYS_SOCKET tds_wakeup_get_fd(const TDSPOLLWAKEUP *wakeup)
1585{
1586 return wakeup->s_signaled;
1587}
1588
1589
1590/* packet.c */
1591int tds_read_packet(TDSSOCKET * tds);
1592TDSRET tds_write_packet(TDSSOCKET * tds, unsigned char final);
1593#if ENABLE_ODBC_MARS
1594int tds_append_cancel(TDSSOCKET *tds);
1595TDSRET tds_append_syn(TDSSOCKET *tds);
1596TDSRET tds_append_fin(TDSSOCKET *tds);
1597#else
1598int tds_put_cancel(TDSSOCKET * tds);
1599#endif
1600
1601typedef struct tds_freeze {
1607 unsigned pkt_pos;
1609 unsigned size_len;
1610} TDSFREEZE;
1611
1612void tds_freeze(TDSSOCKET *tds, TDSFREEZE *freeze, unsigned size_len);
1613size_t tds_freeze_written(TDSFREEZE *freeze);
1614TDSRET tds_freeze_abort(TDSFREEZE *freeze);
1615TDSRET tds_freeze_close(TDSFREEZE *freeze);
1616TDSRET tds_freeze_close_len(TDSFREEZE *freeze, int32_t size);
1617
1618static void inline
1619tds_set_current_send_packet(TDSSOCKET *tds, TDSPACKET *pkt)
1620{
1621 tds->send_packet = pkt;
1622 tds->out_buf = pkt->buf + tds_packet_get_data_start(pkt);
1623}
1624
1625/* Macros to allow some indentation of the packets.
1626 *
1627 * The 3 nested fake loops require some explanation:
1628 * - first is to allows to declare variables;
1629 * - second is to force using brackets;
1630 * - third is to avoids that a break inside will skip the close.
1631 */
1632#define TDS_START_LEN_GENERIC(tds_socket, len) do { \
1633 TDSFREEZE current_freeze[1]; \
1634 tds_freeze((tds_socket), current_freeze, (len)); do { do
1635#define TDS_END_LEN while(0); } while(tds_freeze_close(current_freeze), 0); } while(0);
1636
1637#define TDS_START_LEN_TINYINT(tds_socket) TDS_START_LEN_GENERIC(tds_socket, 1)
1638#define TDS_START_LEN_USMALLINT(tds_socket) TDS_START_LEN_GENERIC(tds_socket, 2)
1639#define TDS_START_LEN_UINT(tds_socket) TDS_START_LEN_GENERIC(tds_socket, 4)
1640
1641/* vstrbuild.c */
1642TDSRET tds_vstrbuild(char *buffer, int buflen, int *resultlen, const char *text, int textlen, const char *formats, int formatlen,
1643 va_list ap);
1644
1645
1646/* numeric.c */
1647char *tds_money_to_string(const TDS_MONEY * money, char *s, bool use_2_digits);
1648TDS_INT tds_numeric_to_string(const TDS_NUMERIC * numeric, char *s);
1649TDS_INT tds_numeric_change_prec_scale(TDS_NUMERIC * numeric, unsigned char new_prec, unsigned char new_scale);
1650
1651
1652/* getmac.c */
1653void tds_getmac(TDS_SYS_SOCKET s, unsigned char mac[6]);
1654
1655
1656/* challenge.c */
1657#ifndef HAVE_SSPI
1659TDSAUTHENTICATION * tds_gss_get_auth(TDSSOCKET * tds);
1660#else
1661TDSAUTHENTICATION * tds_sspi_get_auth(TDSSOCKET * tds);
1662#endif
1663TDSRET tds5_gss_send(TDSSOCKET *tds);
1664
1665
1666/* random.c */
1667void tds_random_buffer(unsigned char *out, int len);
1668
1669
1670/* sec_negotiate.c */
1671TDSAUTHENTICATION * tds5_negotiate_get_auth(TDSSOCKET * tds);
1672static inline
1673void tds5_negotiate_set_msg_type(TDSAUTHENTICATION * tds_auth, unsigned msg_type)
1674{
1675 if (tds_auth)
1676 tds_auth->msg_type = msg_type;
1677}
1678
1679
1680/* bulk.c */
1681
1684{
1685 TDS_BCP_IN = 1,
1686 TDS_BCP_OUT = 2,
1687 TDS_BCP_QUERYOUT = 3
1688};
1689
1690typedef struct tds5_colinfo
1691{
1692 TDS_TINYINT type;
1693 TDS_TINYINT status;
1694 TDS_SMALLINT offset;
1695 TDS_INT length;
1696} TDS5COLINFO;
1697
1699{
1700 const char *hint;
1701 void *parent;
1702 DSTR tablename;
1703 TDS_CHAR *insert_stmt;
1704 TDS_INT direction;
1705 TDS_INT identity_insert_on;
1706 TDS_INT xfer_init;
1707 TDS_INT bind_count;
1708 TDSRESULTINFO *bindinfo;
1709 TDS5COLINFO *sybase_colinfo;
1710 TDS_INT sybase_count;
1711};
1712
1713TDSRET tds_bcp_init(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1714typedef TDSRET (*tds_bcp_get_col_data) (TDSBCPINFO *bulk, TDSCOLUMN *bcpcol, int offset);
1715typedef void (*tds_bcp_null_error) (TDSBCPINFO *bulk, int index, int offset);
1716TDSRET tds_bcp_send_record(TDSSOCKET *tds, TDSBCPINFO *bcpinfo, tds_bcp_get_col_data get_col_data, tds_bcp_null_error null_error, int offset);
1717TDSRET tds_bcp_done(TDSSOCKET *tds, int *rows_copied);
1718TDSRET tds_bcp_start(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1719TDSRET tds_bcp_start_copy_in(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1720
1721TDSRET tds_bcp_fread(TDSSOCKET * tds, TDSICONV * conv, FILE * stream,
1722 const char *terminator, size_t term_len, char **outbuf, size_t * outbytes);
1723
1724TDSRET tds_writetext_start(TDSSOCKET *tds, const char *objname, const char *textptr, const char *timestamp, int with_log, TDS_UINT size);
1725TDSRET tds_writetext_continue(TDSSOCKET *tds, const TDS_UCHAR *text, TDS_UINT size);
1726TDSRET tds_writetext_end(TDSSOCKET *tds);
1727
1728
1729static inline
1730bool tds_capability_enabled(const TDS_CAPABILITY_TYPE *cap, unsigned cap_num)
1731{
1732 return (cap->values[sizeof(cap->values)-1-(cap_num>>3)] >> (cap_num&7)) & 1;
1733}
1734#define tds_capability_has_req(conn, cap) \
1735 tds_capability_enabled(&conn->capabilities.types[0], cap)
1736#define tds_capability_has_res(conn, cap) \
1737 tds_capability_enabled(&conn->capabilities.types[1], cap)
1738
1739#define IS_TDS42(x) (x->tds_version==0x402)
1740#define IS_TDS46(x) (x->tds_version==0x406)
1741#define IS_TDS50(x) (x->tds_version==0x500)
1742#define IS_TDS70(x) (x->tds_version==0x700)
1743#define IS_TDS71(x) (x->tds_version==0x701)
1744#define IS_TDS72(x) (x->tds_version==0x702)
1745#define IS_TDS73(x) (x->tds_version==0x703)
1746
1747#define IS_TDS50_PLUS(x) ((x)->tds_version>=0x500)
1748#define IS_TDS7_PLUS(x) ((x)->tds_version>=0x700)
1749#define IS_TDS71_PLUS(x) ((x)->tds_version>=0x701)
1750#define IS_TDS72_PLUS(x) ((x)->tds_version>=0x702)
1751#define IS_TDS73_PLUS(x) ((x)->tds_version>=0x703)
1752#define IS_TDS74_PLUS(x) ((x)->tds_version>=0x704)
1753
1754#define TDS_MAJOR(x) ((x)->tds_version >> 8)
1755#define TDS_MINOR(x) ((x)->tds_version & 0xff)
1756
1757#define IS_TDSDEAD(x) (((x) == NULL) || (x)->state == TDS_DEAD)
1758
1760#define TDS_IS_SYBASE(x) (!((x)->conn->product_version & 0x80000000u))
1762#define TDS_IS_MSSQL(x) (((x)->conn->product_version & 0x80000000u)!=0)
1763
1767#define TDS_MS_VER(maj,min,x) (0x80000000u|((maj)<<24)|((min)<<16)|(x))
1768
1769/* TODO test if not similar to ms one*/
1771#define TDS_SYB_VER(maj,min,x) (((maj)<<24)|((min)<<16)|(x)<<8)
1772
1773#ifdef __cplusplus
1774#if 0
1775{
1776#endif
1777}
1778#endif
1779
1780#include <freetds/popvis.h>
1781
1782#define TDS_PUT_INT(tds,v) tds_put_int((tds), ((TDS_INT)(v)))
1783#define TDS_PUT_SMALLINT(tds,v) tds_put_smallint((tds), ((TDS_SMALLINT)(v)))
1784#define TDS_PUT_BYTE(tds,v) tds_put_byte((tds), ((unsigned char)(v)))
1785
1786#endif /* _tds_h_ */
int tds_iconv_alloc(TDSCONNECTION *conn)
Allocate iconv stuff.
Definition iconv.c:311
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
char * tds_strndup(const void *s, TDS_INTPTR len)
Copy a string of length len to a new allocated buffer This function does not read more than len bytes...
Definition util.c:406
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.
int tdsdump_open(const char *filename)
Create and truncate a human readable dump file for the TDS traffic.
Definition log.c:131
struct tds_variant TDSVARIANT
Store variant informations.
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:224
bool tds_set_server(TDSLOGIN *tds_login, const char *server) TDS_WUR
Set the servername in a TDSLOGIN structure.
Definition login.c:129
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.
int tds_write_dump
Tell if TDS debug logging is turned on or off.
Definition log.c:58
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
const int 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:41
TDSRET tds_bcp_start_copy_in(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Start bulk copy to server.
Definition bulk.c:1081
TDS_INT tds_numeric_to_string(const TDS_NUMERIC *numeric, char *s)
Definition numeric.c:95
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:1312
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:1242
TDSRET tds_bcp_start(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Start sending BCP data to server.
Definition bulk.c:876
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:246
tds_states
values for tds->state
Definition tds.h:792
@ TDS_PENDING
cilent is waiting for data
Definition tds.h:796
@ TDS_SENDING
client would send data
Definition tds.h:795
@ TDS_READING
client is reading data
Definition tds.h:797
@ TDS_WRITING
client is writing data
Definition tds.h:794
@ TDS_IDLE
no data expected
Definition tds.h:793
@ TDS_DEAD
no connection
Definition tds.h:798
tds_end
Flags returned in TDS_DONE token.
Definition tds.h:249
@ TDS_DONE_CANCELLED
acknowledging an attention command (usually a cancel)
Definition tds.h:256
@ TDS_DONE_MORE_RESULTS
more results follow
Definition tds.h:251
@ TDS_DONE_SRVERROR
SQL server server error.
Definition tds.h:258
@ TDS_DONE_FINAL
final result set, command completed successfully.
Definition tds.h:250
@ TDS_DONE_ERROR
error occurred
Definition tds.h:252
@ TDS_DONE_INXACT
transaction in progress
Definition tds.h:253
@ TDS_DONE_PROC
results are from a stored procedure
Definition tds.h:254
@ TDS_DONE_COUNT
count field in packet is valid
Definition tds.h:255
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:1350
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:1367
TDSRET tds_bcp_init(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Initialize BCP information.
Definition bulk.c:86
tds_bcp_directions
bcp direction
Definition tds.h:1684
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:469
TDSRET tds_bcp_done(TDSSOCKET *tds, int *rows_copied)
Tell we finished sending BCP data to server.
Definition bulk.c:846
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 informations 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:923
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:1345
struct addrinfo * tds_lookup_host(const char *servername)
Get the IP address for a hostname.
Definition config.c:987
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:503
bool tds_read_conf_file(TDSLOGIN *login, const char *server)
Read configuration info for given server return 0 on error.
Definition config.c:346
TDSRET tds_set_interfaces_file_loc(const char *interfloc)
Set the full name of interface file.
Definition config.c:961
char * tds_get_home_file(const char *file)
Return filename from HOME directory.
Definition config.c:325
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:285
TDSRET tds_datecrack(TDS_INT datetype, const void *di, TDSDATEREC *dr)
Convert from db date format to a structured date format.
Definition convert.c:3185
TDSICONV * tds_iconv_from_collate(TDSCONNECTION *conn, TDS_UCHAR collate[5])
Get iconv information from a LCID (to support different column encoding under MSSQL2K)
Definition iconv.c:1246
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:809
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:1891
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:1802
const char * tds_skip_quoted(const char *s)
Skip quoting string (like 'sfsf', "dflkdj" or [dfkjd])
Definition query.c:515
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:1451
void tds_start_query(TDSSOCKET *tds, unsigned char packet_type)
Start query packet of a given type.
Definition query.c:332
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:2076
TDSRET tds_submit_execute(TDSSOCKET *tds, TDSDYNAMIC *dyn)
Sends a previously prepared dynamic statement to the server.
Definition query.c:1680
size_t tds_fix_column_size(TDSSOCKET *tds, TDSCOLUMN *curcol)
Get column size for wire.
Definition query.c:1541
TDSRET tds_get_column_declaration(TDSSOCKET *tds, TDSCOLUMN *curcol, char *out)
Return declaration for column (like "varchar(20)").
Definition query.c:738
TDSRET tds_deferred_cursor_dealloc(TDSCONNECTION *conn, TDSCURSOR *cursor)
Deallocate cursor on idle.
Definition query.c:3104
TDSRET tds_submit_query(TDSSOCKET *tds, const char *query)
Sends a language string to the database server for processing.
Definition query.c:210
TDSRET tds_submit_rpc(TDSSOCKET *tds, const char *rpc_name, TDSPARAMINFO *params, TDSHEADERS *head)
Calls a RPC from server.
Definition query.c:1979
size_t tds_quote_id_rpc(TDSSOCKET *tds, char *buffer, const char *id, int idlen)
Quote an id for a RPC call.
Definition query.c:2263
size_t tds_quote_string(TDSSOCKET *tds, char *buffer, const char *str, int len)
Quote a string.
Definition query.c:2288
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:1174
TDSRET tds_submit_begin_tran(TDSSOCKET *tds)
Send a rollback request.
Definition query.c:3712
TDSRET tds_submit_commit(TDSSOCKET *tds, bool cont)
Send a commit request.
Definition query.c:3771
TDSRET tds_submit_rollback(TDSSOCKET *tds, bool cont)
Send a rollback request.
Definition query.c:3740
size_t tds_quote_id(TDSSOCKET *tds, char *buffer, const char *id, int idlen)
Quote an id.
Definition query.c:2218
const char * tds_next_placeholder(const char *start)
Get position of next placeholder.
Definition query.c:535
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:350
TDSRET tds_deferred_unprepare(TDSCONNECTION *conn, TDSDYNAMIC *dyn)
Unprepare dynamic on idle.
Definition query.c:1824
int tds_count_placeholders(const char *query)
Count the number of placeholders ('?') in a query.
Definition query.c:571
TDSRET tds_cursor_dealloc(TDSSOCKET *tds, TDSCURSOR *cursor)
Send a deallocation request to server.
Definition query.c:3053
const char * tds_skip_comment(const char *s)
Skip a comment in a query.
Definition query.c:490
const char * tds_convert_string(TDSSOCKET *tds, TDSICONV *char_conv, const char *s, int len, size_t *out_len)
Convert a string in an allocated buffer.
Definition query.c:126
TDSRET tds_submit_queryf(TDSSOCKET *tds, const char *queryf,...)
Format and submit a query.
Definition query.c:467
TDSRET tds_submit_execdirect(TDSSOCKET *tds, const char *query, TDSPARAMINFO *params, TDSHEADERS *head)
Submit a prepared query with parameters.
Definition query.c:1306
void tds_set_cur_dyn(TDSSOCKET *tds, TDSDYNAMIC *dyn)
Set current dynamic.
Definition query.c:192
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:3436
TDSRET tds_submit_unprepare(TDSSOCKET *tds, TDSDYNAMIC *dyn)
Send a unprepare request for a prepared query.
Definition query.c:1847
DSTR * tds_dstr_get(TDSSOCKET *tds, DSTR *s, size_t len)
Reads a string from wire and put in a DSTR.
Definition read.c:293
unsigned char tds_get_byte(TDSSOCKET *tds)
Return a single byte from the input buffer.
Definition read.c:72
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:1031
int tds_goodwrite(TDSSOCKET *tds, const unsigned char *buffer, size_t buflen)
Definition net.c:985
int tds_socket_set_nonblocking(TDS_SYS_SOCKET sock)
Set socket to non-blocking.
Definition net.c:168
void tds_close_socket(TDSSOCKET *tds)
Close current socket.
Definition net.c:548
int tds_read_packet(TDSSOCKET *tds)
Read in one 'packet' from the server.
Definition packet.c:527
size_t tds_freeze_written(TDSFREEZE *freeze)
Compute how many bytes has been written from freeze.
Definition packet.c:935
TDSRET tds_flush_packet(TDSSOCKET *tds)
Flush packet to server.
Definition write.c:224
TDSRET tds_freeze_close(TDSFREEZE *freeze)
Stop keeping data for this specific freeze.
Definition packet.c:996
int tds_goodread(TDSSOCKET *tds, unsigned char *buf, int buflen)
Loops until we have received some characters return -1 on failure.
Definition net.c:914
TDSRET tds_freeze_abort(TDSFREEZE *freeze)
Discard all data written after the freeze.
Definition packet.c:961
TDS_UINT8 tds_get_uint8(TDSSOCKET *tds)
Get an uint64 from the server.
Definition read.c:140
TDSRET tds_get_char_data(TDSSOCKET *tds, char *dest, size_t wire_size, TDSCOLUMN *curcol)
Fetch character data the wire.
Definition read.c:195
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:166
int tds7_get_instance_ports(FILE *output, struct addrinfo *addr)
Get port of all instances.
Definition net.c:1091
TDS_UINT tds_get_uint(TDSSOCKET *tds)
Get an int32 from the server.
Definition read.c:127
int tds7_get_instance_port(struct addrinfo *addr, const char *instance)
Get port of given instance.
Definition net.c:1227
TDS_USMALLINT tds_get_usmallint(TDSSOCKET *tds)
Get an int16 from the server.
Definition read.c:113
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:610
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:230
const char * tds_prtype(int token)
Returns string representation of the given type.
Definition token.c:3032
TDSDYNAMIC * tds_lookup_dynamic(TDSCONNECTION *conn, const char *id)
Finds a dynamic given string id.
Definition token.c:2587
TDSRET tds_process_login_tokens(TDSSOCKET *tds)
tds_process_login_tokens() is called after sending the login packet to the server.
Definition token.c:411
TDSRET tds_process_tokens(TDSSOCKET *tds, TDS_INT *result_type, int *done_flags, unsigned flag)
process all streams.
Definition token.c:531
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:881
TDSRET tds_process_cancel(TDSSOCKET *tds)
Definition token.c:2554
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 directed connected to a 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:329
Definition tds.h:496
Definition tds.h:505
Definition tds.h:512
Definition tds.h:518
DSTR crlfile
certificate revocation file
Definition tds.h:532
DSTR server_realm_name
server realm name (in freetds.conf)
Definition tds.h:528
DSTR user_name
account for login
Definition tds.h:535
DSTR password
password of account login
Definition tds.h:536
DSTR db_filename
database filename to attach (MSSQL)
Definition tds.h:530
DSTR server_name
server name (in freetds.conf)
Definition tds.h:519
struct addrinfo * ip_addrs
ip(s) of server
Definition tds.h:547
DSTR server_charset
charset of server e.g.
Definition tds.h:524
TDS_USMALLINT tds_version
TDS version.
Definition tds.h:521
DSTR new_password
new password to set (TDS 7.2+)
Definition tds.h:537
unsigned int bulk_copy
if bulk copy should be enabled
Definition tds.h:557
DSTR cafile
certificate authorities file
Definition tds.h:531
DSTR server_spn
server SPN (in freetds.conf)
Definition tds.h:529
int port
port of database service
Definition tds.h:520
Definition tds.h:575
Definition tds.h:583
Information about blobs (e.g.
Definition tds.h:596
Store variant informations.
Definition tds.h:607
Information relevant to libiconv.
Definition tds.h:621
const char * name
name of the encoding (ie UTF-8)
Definition tds.h:623
unsigned char canonic
internal numeric index into array of all encodings
Definition tds.h:627
Definition tds.h:631
Definition tds.h:646
tds_func_put_data * put_data
Send column data to server.
Definition tds.h:665
tds_func_put_info * put_info
Send metadata column information to server.
Definition tds.h:655
Metadata about columns in regular and compute rows.
Definition tds.h:692
TDS_INT bcp_prefix_len
The length, in bytes, of any length prefix this column may have.
Definition tds.h:764
TDS_TINYINT column_varint_size
size of length when reading from wire (0, 1, 2 or 4)
Definition tds.h:704
TDS_INT column_size
maximun size of data.
Definition tds.h:697
TDS_TINYINT column_prec
precision for decimal/numeric
Definition tds.h:706
TDS_SERVER_TYPE column_type
This type can be different from wire type because conversion (e.g.
Definition tds.h:699
TDSICONV * char_conv
refers to previously allocated iconv information
Definition tds.h:715
TDS_TINYINT column_scale
scale for decimal/numeric
Definition tds.h:707
TDS_INT column_cur_size
size written in variable (ie: char, text, binary).
Definition tds.h:739
Hold information for any results.
Definition tds.h:772
Definition tds.h:879
Definition tds.h:895
Definition tds.h:909
Holds informations about a cursor.
Definition tds.h:940
TDS_TINYINT options
read only|updatable TODO use it
Definition tds.h:945
bool defer_close
true if cursor was marker to be closed when connection is idle
Definition tds.h:949
TDS_INT ref_count
reference counter so client can retain safely a pointer
Definition tds.h:942
TDS_INT cursor_id
cursor id returned by the server after cursor declare
Definition tds.h:944
TDS_INT cursor_rows
< number of updatable columns
Definition tds.h:954
struct tds_cursor * next
next in linked list, keep first
Definition tds.h:941
TDS_INT type
row fetched from this cursor
Definition tds.h:959
TDS_CURSOR_STATUS status
cursor parameter
Definition tds.h:956
char * query
SQL query.
Definition tds.h:950
char * cursor_name
name of the cursor
Definition tds.h:943
Current environment as reported by the server.
Definition tds.h:966
char * charset
character set encoding
Definition tds.h:971
int block_size
packet size (512-65535)
Definition tds.h:968
char * database
database name
Definition tds.h:973
Holds information for a dynamic (also called prepared) query.
Definition tds.h:980
char * query
saved query, we need to know original query if prepare is impossible
Definition tds.h:1012
TDS_INT ref_count
reference counter so client can retain safely a pointer
Definition tds.h:982
bool defer_close
true if dynamic was marker to be closed when connection is idle
Definition tds.h:1000
TDSPARAMINFO * res_info
query results
Definition tds.h:1002
TDS_TINYINT emulated
this dynamic query cannot be prepared so libTDS have to construct a simple query.
Definition tds.h:996
TDSPARAMINFO * params
query parameters.
Definition tds.h:1010
struct tds_dynamic * next
next in linked list, keep first
Definition tds.h:981
TDS_INT num_id
numeric id for mssql7+
Definition tds.h:984
Definition tds.h:1022
Definition tds.h:1032
Definition tds.h:1050
Definition tds.h:1060
unsigned data_len
data length, this does not account SMP header, only TDS part
Definition tds.h:1074
Definition tds.h:1088
Definition tds.h:1094
TDSENV env
environment is shared between all sessions
Definition tds.h:1104
uint8_t unicharsize
Ratio between bytes allocated for a UNICHAR type and type length (Sybase).
Definition tds.h:1161
TDSCURSOR * cursors
linked list of cursors allocated for this connection contains only cursors allocated on the server
Definition tds.h:1110
TDS_SYS_SOCKET s
tcp socket, INVALID_SOCKET if not connected
Definition tds.h:1099
TDS_UINT product_version
version of product (Sybase/MS and full version)
Definition tds.h:1096
TDSDYNAMIC * dyns
list of dynamic allocated for this connection contains only dynamic allocated on the server
Definition tds.h:1115
unsigned int pending_close
true is connection has pending closing (cursors or dynamic)
Definition tds.h:1126
uint8_t ncharsize
Ratio between bytes allocated for a NCHAR type and type length (Sybase).
Definition tds.h:1154
Information for a server connection.
Definition tds.h:1179
TDSLOGIN * login
config for login stuff.
Definition tds.h:1274
unsigned in_len
input buffer length
Definition tds.h:1210
TDSPACKET * frozen_packets
list of packets frozen, points to first one.
Definition tds.h:1219
TDSPACKET * send_packet
packet we are preparing to send
Definition tds.h:1247
unsigned char * in_buf
Input buffer.
Definition tds.h:1193
TDS_INT ret_status
return status from store procedure
Definition tds.h:1266
unsigned out_pos
current position in out_buf
Definition tds.h:1209
TDSRESULTINFO * current_results
Current query information.
Definition tds.h:1254
unsigned char in_flag
input buffer type
Definition tds.h:1211
TDS_INT8 rows_affected
rows updated/deleted/inserted/selected, TDS_NO_COUNT if not valid
Definition tds.h:1270
unsigned char out_flag
output buffer type
Definition tds.h:1212
unsigned in_pos
current position in in_buf
Definition tds.h:1208
TDSCURSOR * cur_cursor
cursor in use
Definition tds.h:1259
bool in_row
true if we are getting rows
Definition tds.h:1262
bool bulk_query
true is query sent was a bulk query so we need to switch state to QUERYING
Definition tds.h:1260
bool has_status
true is ret_status is valid
Definition tds.h:1261
unsigned char * out_buf
Output buffer.
Definition tds.h:1201
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:1264
unsigned int out_buf_max
Maximum size of packet pointed by out_buf.
Definition tds.h:1207
TDSDYNAMIC * cur_dyn
dynamic structure in use
Definition tds.h:1272
Definition tds.h:1291
Definition tds.h:1297
Definition tds.h:1531
Definition tds.h:1601
TDSSOCKET * tds
which socket we refer to
Definition tds.h:1603
unsigned pkt_pos
position in pkt
Definition tds.h:1607
unsigned size_len
length size (0, 1, 2 or 4)
Definition tds.h:1609
TDSPACKET * pkt
first packet frozen
Definition tds.h:1605
Definition tds.h:1691
Definition tds.h:1699
Definition thread.h:279
Structure to hold a string.
Definition string.h:36