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