FreeTDS API
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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 #include <stdarg.h>
25 #include <stdio.h>
26 #include <time.h>
27 
28 #ifdef HAVE_STDDEF_H
29 #include <stddef.h>
30 #endif
31 
32 #if HAVE_NETDB_H
33 #include <netdb.h>
34 #endif /* HAVE_NETDB_H */
35 
36 #if HAVE_NETINET_IN_H
37 #include <netinet/in.h>
38 #endif /* HAVE_NET_INET_IN_H */
39 #if HAVE_ARPA_INET_H
40 #include <arpa/inet.h>
41 #endif /* HAVE_ARPA_INET_H */
42 
43 /* forward declaration */
44 typedef struct tdsiconvinfo TDSICONV;
45 typedef struct tds_connection TDSCONNECTION;
46 typedef struct tds_socket TDSSOCKET;
47 typedef struct tds_column TDSCOLUMN;
48 typedef struct tds_bcpinfo TDSBCPINFO;
49 
50 #include <freetds/version.h>
51 #include "tds_sysdep_public.h"
52 #include <freetds/sysdep_private.h>
53 #include <freetds/thread.h>
54 #include <freetds/bool.h>
55 #include "replacements.h"
56 
57 #include <freetds/pushvis.h>
58 
59 #ifdef __cplusplus
60 extern "C"
61 {
62 #if 0
63 }
64 #endif
65 #endif
66 
73 {
74  const char *freetds_version; /* release version of FreeTDS */
75  const char *sysconfdir; /* location of freetds.conf */
76  const char *last_update; /* latest software_version date among the modules */
77  int msdblib; /* for MS style dblib */
78  int sybase_compat; /* enable increased Open Client binary compatibility */
79  int threadsafe; /* compile for thread safety default=no */
80  int libiconv; /* search for libiconv in DIR/include and DIR/lib */
81  const char *tdsver; /* TDS protocol version (4.2/4.6/5.0/7.0/7.1) 5.0 */
82  int iodbc; /* build odbc driver against iODBC in DIR */
83  int unixodbc; /* build odbc driver against unixODBC in DIR */
84  int openssl; /* build against OpenSSL */
85  int gnutls; /* build against GnuTLS */
86  int mars; /* MARS enabled */
88 
94 typedef struct tds_dstr {
95  size_t dstr_size;
96  char dstr_s[1];
97 } *DSTR;
98 
114 /*
115  * All references to data that touch the wire should use the following typedefs.
116  *
117  * If you have problems on 64-bit machines and the code is
118  * using a native datatype, please change it to use
119  * these. (In the TDS layer only, the API layers have their
120  * own typedefs which equate to these).
121  */
122 typedef char TDS_CHAR; /* 8-bit char */
123 typedef unsigned char TDS_UCHAR; /* 8-bit uchar */
124 typedef unsigned char TDS_TINYINT; /* 8-bit unsigned */
125 typedef tds_sysdep_int16_type TDS_SMALLINT; /* 16-bit int */
126 typedef unsigned tds_sysdep_int16_type TDS_USMALLINT; /* 16-bit unsigned */
127 typedef tds_sysdep_int32_type TDS_INT; /* 32-bit int */
128 typedef unsigned tds_sysdep_int32_type TDS_UINT; /* 32-bit unsigned */
129 typedef tds_sysdep_real32_type TDS_REAL; /* 32-bit real */
130 typedef tds_sysdep_real64_type TDS_FLOAT; /* 64-bit real */
131 typedef tds_sysdep_int64_type TDS_INT8; /* 64-bit integer */
132 typedef unsigned tds_sysdep_int64_type TDS_UINT8; /* 64-bit unsigned */
133 typedef tds_sysdep_intptr_type TDS_INTPTR;
134 typedef unsigned tds_sysdep_intptr_type TDS_UINTPTR;
135 
136 #include <freetds/proto.h>
137 
142 typedef struct
143 {
144  TDS_UINT8 time;
145  TDS_INT date;
146  TDS_SMALLINT offset;
147  TDS_USMALLINT time_prec:3;
148  TDS_USMALLINT _res:10;
149  TDS_USMALLINT has_time:1;
150  TDS_USMALLINT has_date:1;
151  TDS_USMALLINT has_offset:1;
153 
155 typedef struct tdsdaterec
156 {
157  TDS_INT year;
158  TDS_INT quarter;
159  TDS_INT month;
160  TDS_INT day;
161  TDS_INT dayofyear;
162  TDS_INT weekday;
163  TDS_INT hour;
164  TDS_INT minute;
165  TDS_INT second;
166  TDS_INT decimicrosecond;
167  TDS_INT timezone;
168 } TDSDATEREC;
169 
175 extern const int tds_numeric_bytes_per_prec[];
176 
177 typedef int TDSRET;
178 #define TDS_NO_MORE_RESULTS ((TDSRET)1)
179 #define TDS_SUCCESS ((TDSRET)0)
180 #define TDS_FAIL ((TDSRET)-1)
181 #define TDS_CANCELLED ((TDSRET)-2)
182 #define TDS_FAILED(rc) ((rc)<0)
183 #define TDS_SUCCEED(rc) ((rc)>=0)
184 
185 #define TDS_INT_CONTINUE 1
186 #define TDS_INT_CANCEL 2
187 #define TDS_INT_TIMEOUT 3
188 
189 
190 #define TDS_NO_COUNT -1
191 
192 #define TDS_ROW_RESULT 4040
193 #define TDS_PARAM_RESULT 4042
194 #define TDS_STATUS_RESULT 4043
195 #define TDS_MSG_RESULT 4044
196 #define TDS_COMPUTE_RESULT 4045
197 #define TDS_CMD_DONE 4046
198 #define TDS_CMD_SUCCEED 4047
199 #define TDS_CMD_FAIL 4048
200 #define TDS_ROWFMT_RESULT 4049
201 #define TDS_COMPUTEFMT_RESULT 4050
202 #define TDS_DESCRIBE_RESULT 4051
203 #define TDS_DONE_RESULT 4052
204 #define TDS_DONEPROC_RESULT 4053
205 #define TDS_DONEINPROC_RESULT 4054
206 #define TDS_OTHERS_RESULT 4055
207 
208 enum tds_token_results
209 {
210  TDS_TOKEN_RES_OTHERS,
211  TDS_TOKEN_RES_ROWFMT,
212  TDS_TOKEN_RES_COMPUTEFMT,
213  TDS_TOKEN_RES_PARAMFMT,
214  TDS_TOKEN_RES_DONE,
215  TDS_TOKEN_RES_ROW,
216  TDS_TOKEN_RES_COMPUTE,
217  TDS_TOKEN_RES_PROC,
218  TDS_TOKEN_RES_MSG,
219  TDS_TOKEN_RES_ENV,
220 };
221 
222 #define TDS_TOKEN_FLAG(flag) TDS_RETURN_##flag = (1 << (TDS_TOKEN_RES_##flag*2)), TDS_STOPAT_##flag = (2 << (TDS_TOKEN_RES_##flag*2))
223 
224 enum tds_token_flags
225 {
226  TDS_HANDLE_ALL = 0,
227  TDS_TOKEN_FLAG(OTHERS),
228  TDS_TOKEN_FLAG(ROWFMT),
229  TDS_TOKEN_FLAG(COMPUTEFMT),
230  TDS_TOKEN_FLAG(PARAMFMT),
231  TDS_TOKEN_FLAG(DONE),
232  TDS_TOKEN_FLAG(ROW),
233  TDS_TOKEN_FLAG(COMPUTE),
234  TDS_TOKEN_FLAG(PROC),
235  TDS_TOKEN_FLAG(MSG),
236  TDS_TOKEN_FLAG(ENV),
237  TDS_TOKEN_RESULTS = TDS_RETURN_ROWFMT|TDS_RETURN_COMPUTEFMT|TDS_RETURN_DONE|TDS_STOPAT_ROW|TDS_STOPAT_COMPUTE|TDS_RETURN_PROC,
238  TDS_TOKEN_TRAILING = TDS_STOPAT_ROWFMT|TDS_STOPAT_COMPUTEFMT|TDS_STOPAT_ROW|TDS_STOPAT_COMPUTE|TDS_STOPAT_MSG|TDS_STOPAT_OTHERS
239 };
240 
245 {
248  , TDS_DONE_ERROR = 0x02
249  , TDS_DONE_INXACT = 0x04
250  , TDS_DONE_PROC = 0x08
251  , TDS_DONE_COUNT = 0x10
253  , TDS_DONE_EVENT = 0x40 /* part of an event notification. */
254  , TDS_DONE_SRVERROR = 0x100
256  /* after the above flags, a TDS_DONE packet has a field describing the state of the transaction */
257  , TDS_DONE_NO_TRAN = 0 /* No transaction in effect */
258  , TDS_DONE_TRAN_SUCCEED = 1 /* Transaction completed successfully */
259  , TDS_DONE_TRAN_PROGRESS= 2 /* Transaction in progress */
260  , TDS_DONE_STMT_ABORT = 3 /* A statement aborted */
261  , TDS_DONE_TRAN_ABORT = 4 /* Transaction aborted */
262 };
263 
264 
265 /*
266  * TDSERRNO is emitted by libtds to the client library's error handler
267  * (which may in turn call the client's error handler).
268  * These match the db-lib msgno, because the same values have the same meaning
269  * in db-lib and ODBC. ct-lib maps them to ct-lib numbers (todo).
270  */
271 typedef enum { TDSEOK = TDS_SUCCESS,
272  TDSEVERDOWN = 100,
273  TDSEICONVIU = 2400,
274  TDSEICONVAVAIL = 2401,
275  TDSEICONVO = 2402,
276  TDSEICONVI = 2403,
277  TDSEICONV2BIG = 2404,
278  TDSEPORTINSTANCE = 2500,
279  TDSESYNC = 20001,
280  TDSEFCON = 20002,
281  TDSETIME = 20003,
282  TDSEREAD = 20004,
283  TDSEWRIT = 20006,
284  TDSESOCK = 20008,
285  TDSECONN = 20009,
286  TDSEMEM = 20010,
287  TDSEINTF = 20012, /* Server name not found in interface file */
288  TDSEUHST = 20013, /* Unknown host machine name. */
289  TDSEPWD = 20014,
290  TDSESEOF = 20017,
291  TDSERPND = 20019,
292  TDSEBTOK = 20020,
293  TDSEOOB = 20022,
294  TDSECLOS = 20056,
295  TDSEUSCT = 20058,
296  TDSEUTDS = 20146,
297  TDSEEUNR = 20185,
298  TDSECAP = 20203,
299  TDSENEG = 20210,
300  TDSEUMSG = 20212,
301  TDSECAPTYP = 20213,
302  TDSECONF = 20214,
303  TDSEBPROBADTYP = 20250,
304  TDSECLOSEIN = 20292
305 } TDSERRNO;
306 
307 
308 enum {
309  TDS_CUR_ISTAT_UNUSED = 0x00,
310  TDS_CUR_ISTAT_DECLARED = 0x01,
311  TDS_CUR_ISTAT_OPEN = 0x02,
312  TDS_CUR_ISTAT_CLOSED = 0x04,
313  TDS_CUR_ISTAT_RDONLY = 0x08,
314  TDS_CUR_ISTAT_UPDATABLE = 0x10,
315  TDS_CUR_ISTAT_ROWCNT = 0x20,
316  TDS_CUR_ISTAT_DEALLOC = 0x40
317 };
318 
319 /* string types */
320 #define TDS_NULLTERM -9
321 
322 
323 typedef union tds_option_arg
324 {
325  TDS_TINYINT ti;
326  TDS_INT i;
327  TDS_CHAR *c;
329 
330 
331 typedef enum tds_encryption_level {
332  TDS_ENCRYPTION_OFF, TDS_ENCRYPTION_REQUEST, TDS_ENCRYPTION_REQUIRE
333 } TDS_ENCRYPTION_LEVEL;
334 
335 #define TDS_ZERO_FREE(x) do {free((x)); (x) = NULL;} while(0)
336 #define TDS_VECTOR_SIZE(x) (sizeof(x)/sizeof(x[0]))
337 #ifdef offsetof
338 #define TDS_OFFSET(str, field) offsetof(str, field)
339 #else
340 #define TDS_OFFSET(str, field) (((char*)&((str*)0)->field)-((char*)0))
341 #endif
342 
343 #if defined(__GNUC__) && __GNUC__ >= 3
344 # define TDS_LIKELY(x) __builtin_expect(!!(x), 1)
345 # define TDS_UNLIKELY(x) __builtin_expect(!!(x), 0)
346 #else
347 # define TDS_LIKELY(x) (x)
348 # define TDS_UNLIKELY(x) (x)
349 #endif
350 
351 #if ENABLE_EXTRA_CHECKS
352 # if defined(__GNUC__) && __GNUC__ >= 2
353 # define TDS_COMPILE_CHECK(name,check) \
354  extern int name[(check)?1:-1] __attribute__ ((unused))
355 # else
356 # define TDS_COMPILE_CHECK(name,check) \
357  extern int name[(check)?1:-1]
358 # endif
359 # define TDS_EXTRA_CHECK(stmt) stmt
360 #else
361 # define TDS_COMPILE_CHECK(name,check) \
362  extern int disabled_check_##name
363 # define TDS_EXTRA_CHECK(stmt)
364 #endif
365 
366 #if ENABLE_EXTRA_CHECKS && defined(__GNUC__) && __GNUC__ >= 4
367 #define TDS_WUR __attribute__ ((__warn_unused_result__))
368 #else
369 #define TDS_WUR
370 #endif
371 
372 /*
373  * TODO use system macros for optimization
374  * See mcrypt for reference and linux kernel source for optimization
375  * check if unaligned access and use fast write/read when implemented
376  */
377 #define TDS_BYTE_SWAP16(value) \
378  (((((unsigned short)value)<<8) & 0xFF00) | \
379  ((((unsigned short)value)>>8) & 0x00FF))
380 
381 #define TDS_BYTE_SWAP32(value) \
382  (((((unsigned long)value)<<24) & 0xFF000000) | \
383  ((((unsigned long)value)<< 8) & 0x00FF0000) | \
384  ((((unsigned long)value)>> 8) & 0x0000FF00) | \
385  ((((unsigned long)value)>>24) & 0x000000FF))
386 
387 #define is_end_token(x) (x==TDS_DONE_TOKEN || \
388  x==TDS_DONEPROC_TOKEN || \
389  x==TDS_DONEINPROC_TOKEN)
390 
391 enum {
392  TDS_TYPEFLAG_INVALID = 0,
393  TDS_TYPEFLAG_NULLABLE = 1,
394  TDS_TYPEFLAG_FIXED = 2,
395  TDS_TYPEFLAG_VARIABLE = 4,
396  TDS_TYPEFLAG_COLLATE = 8,
397  TDS_TYPEFLAG_ASCII = 16,
398  TDS_TYPEFLAG_UNICODE = 32,
399  TDS_TYPEFLAG_NUMERIC = 64,
400  TDS_TYPEFLAG_DATETIME = 128,
401 };
402 
403 extern const unsigned char tds_type_flags_ms[256];
404 #if 0
405 extern const unsigned char tds_type_flags_syb[256];
406 extern const char *const tds_type_names[256];
407 #endif
408 
409 #define is_fixed_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_FIXED) != 0)
410 #define is_nullable_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_NULLABLE) != 0)
411 #define is_variable_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_VARIABLE) != 0)
412 
413 
414 #define is_blob_type(x) ((x)==SYBTEXT || (x)==SYBIMAGE || (x)==SYBNTEXT)
415 #define is_blob_col(x) ((x)->column_varint_size > 2)
416 /* large type means it has a two byte size field */
417 /* define is_large_type(x) (x>128) */
418 #define is_numeric_type(x) ((x)==SYBNUMERIC || (x)==SYBDECIMAL)
419 
420 #define is_datetime_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_DATETIME) != 0)
421 #define is_unicode_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_UNICODE) != 0)
422 #define is_collate_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_COLLATE) != 0)
423 #define is_ascii_type(x) ((tds_type_flags_ms[x] & TDS_TYPEFLAG_ASCII) != 0)
424 #define is_char_type(x) ((tds_type_flags_ms[x] & (TDS_TYPEFLAG_ASCII|TDS_TYPEFLAG_UNICODE)) != 0)
425 #define is_similar_type(x, y) (is_char_type(x) && is_char_type(y))
426 
427 
428 #define TDS_MAX_CAPABILITY 32
429 #define MAXPRECISION 77
430 #define TDS_MAX_CONN 4096
431 #define TDS_MAX_DYNID_LEN 30
432 
433 /* defaults to use if no others are found */
434 #define TDS_DEF_SERVER "SYBASE"
435 #define TDS_DEF_BLKSZ 512
436 #define TDS_DEF_CHARSET "iso_1"
437 #define TDS_DEF_LANG "us_english"
438 #if TDS42
439 #define TDS_DEFAULT_VERSION 0x402
440 #define TDS_DEF_PORT 1433
441 #elif TDS46
442 #define TDS_DEFAULT_VERSION 0x406
443 #define TDS_DEF_PORT 4000
444 #elif TDS50
445 #define TDS_DEFAULT_VERSION 0x500
446 #define TDS_DEF_PORT 4000
447 #elif TDS70
448 #define TDS_DEFAULT_VERSION 0x700
449 #define TDS_DEF_PORT 1433
450 #elif TDS71
451 #define TDS_DEFAULT_VERSION 0x701
452 #define TDS_DEF_PORT 1433
453 #elif TDS72
454 #define TDS_DEFAULT_VERSION 0x702
455 #define TDS_DEF_PORT 1433
456 #elif TDS73
457 #define TDS_DEFAULT_VERSION 0x703
458 #define TDS_DEF_PORT 1433
459 #elif TDS74
460 #define TDS_DEFAULT_VERSION 0x704
461 #define TDS_DEF_PORT 1433
462 #else
463 #define TDS_DEFAULT_VERSION 0x000
464 #define TDS_DEF_PORT 1433
465 #endif
466 
467 /* normalized strings from freetds.conf file */
468 #define TDS_STR_VERSION "tds version"
469 #define TDS_STR_BLKSZ "initial block size"
470 #define TDS_STR_SWAPDT "swap broken dates"
471 #define TDS_STR_DUMPFILE "dump file"
472 #define TDS_STR_DEBUGLVL "debug level"
473 #define TDS_STR_DEBUGFLAGS "debug flags"
474 #define TDS_STR_TIMEOUT "timeout"
475 #define TDS_STR_QUERY_TIMEOUT "query timeout"
476 #define TDS_STR_CONNTIMEOUT "connect timeout"
477 #define TDS_STR_HOSTNAME "hostname"
478 #define TDS_STR_HOST "host"
479 #define TDS_STR_PORT "port"
480 #define TDS_STR_TEXTSZ "text size"
481 /* for big endian hosts */
482 #define TDS_STR_EMUL_LE "emulate little endian"
483 #define TDS_STR_CHARSET "charset"
484 #define TDS_STR_CLCHARSET "client charset"
485 #define TDS_STR_USE_UTF_16 "use utf-16"
486 #define TDS_STR_LANGUAGE "language"
487 #define TDS_STR_APPENDMODE "dump file append"
488 #define TDS_STR_DATEFMT "date format"
489 #define TDS_STR_INSTANCE "instance"
490 #define TDS_STR_ASA_DATABASE "asa database"
491 #define TDS_STR_DATABASE "database"
492 #define TDS_STR_ENCRYPTION "encryption"
493 #define TDS_STR_USENTLMV2 "use ntlmv2"
494 #define TDS_STR_USELANMAN "use lanman"
495 /* conf values */
496 #define TDS_STR_ENCRYPTION_OFF "off"
497 #define TDS_STR_ENCRYPTION_REQUEST "request"
498 #define TDS_STR_ENCRYPTION_REQUIRE "require"
499 /* Defines to enable optional GSSAPI delegation */
500 #define TDS_GSSAPI_DELEGATION "enable gssapi delegation"
501 /* Kerberos realm name */
502 #define TDS_STR_REALM "realm"
503 /* Kerberos SPN */
504 #define TDS_STR_SPN "spn"
505 /* CA file */
506 #define TDS_STR_CAFILE "ca file"
507 /* CRL file */
508 #define TDS_STR_CRLFILE "crl file"
509 /* check SSL hostname */
510 #define TDS_STR_CHECKSSLHOSTNAME "check certificate hostname"
511 /* database filename to attach on login (MSSQL) */
512 #define TDS_STR_DBFILENAME "database filename"
513 /* Application Intent MSSQL 2012 support */
514 #define TDS_STR_READONLY_INTENT "read-only intent"
515 
516 
517 /* TODO do a better check for alignment than this */
518 typedef union
519 {
520  void *p;
521  int i;
523 
524 #define TDS_ALIGN_SIZE sizeof(tds_align_struct)
525 
526 typedef struct tds_capability_type
527 {
528  unsigned char type;
529  unsigned char len; /* always sizeof(values) */
530  unsigned char values[TDS_MAX_CAPABILITY/2-2];
532 
533 typedef struct tds_capabilities
534 {
535  TDS_CAPABILITY_TYPE types[2];
537 
538 #define TDS_MAX_LOGIN_STR_SZ 128
539 typedef struct tds_login
540 {
542  int port;
543  TDS_USMALLINT tds_version;
544  int block_size;
545  DSTR language; /* e.g. us-english */
547  TDS_INT connect_timeout;
548  DSTR client_host_name;
549  DSTR server_host_name;
555  DSTR app_name;
560  DSTR library; /* Ct-Library, DB-Library, TDS-Library or ODBC */
561  TDS_TINYINT encryption_level;
562 
563  TDS_INT query_timeout;
564  TDS_CAPABILITIES capabilities;
565  DSTR client_charset;
566  DSTR database;
567 
568  struct addrinfo *ip_addrs;
569  struct addrinfo *connected_addr; /* ip of connected server */
570  DSTR instance_name;
571  DSTR dump_file;
572  int debug_flags;
573  int text_size;
574 
575  unsigned char option_flag2;
576 
577  unsigned int bulk_copy:1;
578  unsigned int suppress_language:1;
579  unsigned int emul_little_endian:1;
580  unsigned int gssapi_use_delegation:1;
581  unsigned int use_ntlmv2:1;
582  unsigned int use_lanman:1;
583  unsigned int mars:1;
584  unsigned int use_utf16:1;
585  unsigned int use_new_password:1;
586  unsigned int valid_configuration:1;
587  unsigned int check_ssl_hostname:1;
588  unsigned int readonly_intent:1;
589 } TDSLOGIN;
590 
591 typedef struct tds_headers
592 {
593  const char *qn_options;
594  const char *qn_msgtext;
595  TDS_INT qn_timeout;
596  /* TDS 7.4+: trace activity ID char[20] */
597 } TDSHEADERS;
598 
599 typedef struct tds_locale
600 {
601  char *language;
602  char *server_charset;
603  char *date_fmt;
604 } TDSLOCALE;
605 
610 typedef struct tds_blob
611 {
612  TDS_CHAR *textvalue;
613  TDS_CHAR textptr[16];
614  TDS_CHAR timestamp[8];
615  unsigned char valid_ptr;
616 } TDSBLOB;
617 
621 typedef struct tds_variant
622 {
623  /* this MUST have same position and place of textvalue in tds_blob */
624  TDS_CHAR *data;
625  TDS_INT size;
626  TDS_INT data_len;
627  TDS_UCHAR type;
628  TDS_UCHAR collation[5];
629 } TDSVARIANT;
630 
635 typedef struct tds_encoding
636 {
638  const char *name;
639  unsigned char min_bytes_per_char;
640  unsigned char max_bytes_per_char;
642  unsigned char canonic;
643 } TDS_ENCODING;
644 
645 typedef struct tds_bcpcoldata
646 {
647  TDS_UCHAR *data;
648  TDS_INT datalen;
649  TDS_INT is_null;
650 } BCPCOLDATA;
651 
652 
653 typedef TDSRET tds_func_get_info(TDSSOCKET *tds, TDSCOLUMN *col);
654 typedef TDSRET tds_func_get_data(TDSSOCKET *tds, TDSCOLUMN *col);
655 typedef TDS_INT tds_func_row_len(TDSCOLUMN *col);
656 typedef unsigned tds_func_put_info_len(TDSSOCKET *tds, TDSCOLUMN *col);
657 typedef TDSRET tds_func_put_info(TDSSOCKET *tds, TDSCOLUMN *col);
658 typedef TDSRET tds_func_put_data(TDSSOCKET *tds, TDSCOLUMN *col, int bcp7);
659 typedef int tds_func_check(const TDSCOLUMN *col);
660 
661 typedef struct tds_column_funcs
662 {
663  tds_func_get_info *get_info;
664  tds_func_get_data *get_data;
665  tds_func_row_len *row_len;
671  tds_func_put_info_len *put_info_len;
677  tds_func_put_info *put_info;
687  tds_func_put_data *put_data;
688 #if ENABLE_EXTRA_CHECKS
689 
703  tds_func_check *check;
704 #endif
705 #if 0
706  TDSRET (*convert)(TDSSOCKET *tds, TDSCOLUMN *col);
707 #endif
709 
714 {
715  const TDSCOLUMNFUNCS *funcs;
716  TDS_INT column_usertype;
717  TDS_INT column_flags;
718 
719  TDS_INT column_size;
721  TDS_TINYINT column_type;
726  TDS_TINYINT column_varint_size;
728  TDS_TINYINT column_prec;
729  TDS_TINYINT column_scale;
731  struct
732  {
733  TDS_TINYINT column_type;
734  TDS_INT column_size;
735  } on_server;
736 
739  DSTR table_name;
740  DSTR column_name;
741  DSTR table_column_name;
742 
743  unsigned char *column_data;
744  void (*column_data_free)(struct tds_column *column);
745  unsigned int column_nullable:1;
746  unsigned int column_writeable:1;
747  unsigned int column_identity:1;
748  unsigned int column_key:1;
749  unsigned int column_hidden:1;
750  unsigned int column_output:1;
751  unsigned int column_timestamp:1;
752  TDS_UCHAR column_collation[5];
753 
754  /* additional fields flags for compute results */
755  TDS_TINYINT column_operator;
756  TDS_SMALLINT column_operand;
757 
758  /* FIXME this is data related, not column */
761 
762  /* related to binding or info stored by client libraries */
763  /* FIXME find a best place to store these data, some are unused */
764  TDS_SMALLINT column_bindtype;
765  TDS_SMALLINT column_bindfmt;
766  TDS_UINT column_bindlen;
767  TDS_SMALLINT *column_nullbind;
768  TDS_CHAR *column_varaddr;
769  TDS_INT *column_lenbind;
770  TDS_INT column_textpos;
771  TDS_INT column_text_sqlgetdatapos;
772  TDS_CHAR column_text_sqlputdatainfo;
773 
774  BCPCOLDATA *bcp_column_data;
783  TDS_INT bcp_prefix_len;
784  TDS_INT bcp_term_len;
785  TDS_CHAR *bcp_terminator;
786 };
787 
788 
790 typedef struct tds_result_info
791 {
792  /* TODO those fields can became a struct */
793  TDSCOLUMN **columns;
794  TDS_USMALLINT num_cols;
795  TDS_USMALLINT computeid;
796  TDS_INT ref_count;
797  TDSSOCKET *attached_to;
798  unsigned char *current_row;
799  void (*row_free)(struct tds_result_info* result, unsigned char *row);
800  TDS_INT row_size;
801 
802  TDS_SMALLINT *bycolumns;
803  TDS_USMALLINT by_cols;
804  TDS_TINYINT rows_exist;
805  /* TODO remove ?? used only in dblib */
806  TDS_TINYINT more_results;
807 } TDSRESULTINFO;
808 
810 typedef enum tds_states
811 {
818 } TDS_STATE;
819 
820 typedef enum tds_operations
821 {
822  TDS_OP_NONE = 0,
823 
824  /* mssql operations */
825  TDS_OP_CURSOR = TDS_SP_CURSOR,
826  TDS_OP_CURSOROPEN = TDS_SP_CURSOROPEN,
827  TDS_OP_CURSORPREPARE = TDS_SP_CURSORPREPARE,
828  TDS_OP_CURSOREXECUTE = TDS_SP_CURSOREXECUTE,
829  TDS_OP_CURSORPREPEXEC = TDS_SP_CURSORPREPEXEC,
830  TDS_OP_CURSORUNPREPARE = TDS_SP_CURSORUNPREPARE,
831  TDS_OP_CURSORFETCH = TDS_SP_CURSORFETCH,
832  TDS_OP_CURSOROPTION = TDS_SP_CURSOROPTION,
833  TDS_OP_CURSORCLOSE = TDS_SP_CURSORCLOSE,
834  TDS_OP_EXECUTESQL = TDS_SP_EXECUTESQL,
835  TDS_OP_PREPARE = TDS_SP_PREPARE,
836  TDS_OP_EXECUTE = TDS_SP_EXECUTE,
837  TDS_OP_PREPEXEC = TDS_SP_PREPEXEC,
838  TDS_OP_PREPEXECRPC = TDS_SP_PREPEXECRPC,
839  TDS_OP_UNPREPARE = TDS_SP_UNPREPARE,
840 
841  /* sybase operations */
842  TDS_OP_DYN_DEALLOC = 100,
843 } TDS_OPERATION;
844 
845 #define TDS_DBG_LOGIN __FILE__, ((__LINE__ << 4) | 11)
846 #define TDS_DBG_HEADER __FILE__, ((__LINE__ << 4) | 10)
847 #define TDS_DBG_FUNC __FILE__, ((__LINE__ << 4) | 7)
848 #define TDS_DBG_INFO2 __FILE__, ((__LINE__ << 4) | 6)
849 #define TDS_DBG_INFO1 __FILE__, ((__LINE__ << 4) | 5)
850 #define TDS_DBG_NETWORK __FILE__, ((__LINE__ << 4) | 4)
851 #define TDS_DBG_WARN __FILE__, ((__LINE__ << 4) | 3)
852 #define TDS_DBG_ERROR __FILE__, ((__LINE__ << 4) | 2)
853 #define TDS_DBG_SEVERE __FILE__, ((__LINE__ << 4) | 1)
854 
855 #define TDS_DBGFLAG_FUNC 0x80
856 #define TDS_DBGFLAG_INFO2 0x40
857 #define TDS_DBGFLAG_INFO1 0x20
858 #define TDS_DBGFLAG_NETWORK 0x10
859 #define TDS_DBGFLAG_WARN 0x08
860 #define TDS_DBGFLAG_ERROR 0x04
861 #define TDS_DBGFLAG_SEVERE 0x02
862 #define TDS_DBGFLAG_ALL 0xfff
863 #define TDS_DBGFLAG_LOGIN 0x0800
864 #define TDS_DBGFLAG_HEADER 0x0400
865 #define TDS_DBGFLAG_PID 0x1000
866 #define TDS_DBGFLAG_TIME 0x2000
867 #define TDS_DBGFLAG_SOURCE 0x4000
868 #define TDS_DBGFLAG_THREAD 0x8000
869 
870 #if 0
871 
876 enum TDS_DBG_LOG_STATE
877 {
878  TDS_DBG_LOGIN = (1 << 0)
880  , TDS_DBG_API = (1 << 1)
881  , TDS_DBG_ASYNC = (1 << 2)
882  , TDS_DBG_DIAG = (1 << 3)
883  , TDS_DBG_error = (1 << 4)
884  /* TODO: ^^^^^ make upper case when old #defines (above) are removed */
885  /* Log FreeTDS runtime/logic error occurs. */
886  , TDS_DBG_PACKET = (1 << 5)
887  , TDS_DBG_LIBTDS = (1 << 6)
888  , TDS_DBG_CONFIG = (1 << 7)
889  , TDS_DBG_DEFAULT = 0xFE
890 };
891 #endif
892 
893 typedef struct tds_result_info TDSCOMPUTEINFO;
894 
896 
897 typedef struct tds_message
898 {
899  TDS_CHAR *server;
900  TDS_CHAR *message;
901  TDS_CHAR *proc_name;
902  TDS_CHAR *sql_state;
903  TDS_INT msgno;
904  TDS_INT line_number;
905  /* -1 .. 255 */
906  TDS_SMALLINT state;
907  TDS_TINYINT priv_msg_type;
908  TDS_TINYINT severity;
909  /* for library-generated errors */
910  int oserr;
911 } TDSMESSAGE;
912 
913 typedef struct tds_upd_col
914 {
915  struct tds_upd_col *next;
916  TDS_INT colnamelength;
917  char * columnname;
918 } TDSUPDCOL;
919 
920 typedef enum {
921  TDS_CURSOR_STATE_UNACTIONED = 0 /* initial value */
922  , TDS_CURSOR_STATE_REQUESTED = 1 /* called by ct_cursor */
923  , TDS_CURSOR_STATE_SENT = 2 /* sent to server */
924  , TDS_CURSOR_STATE_ACTIONED = 3 /* acknowledged by server */
925 } TDS_CURSOR_STATE;
926 
927 typedef struct tds_cursor_status
928 {
929  TDS_CURSOR_STATE declare;
930  TDS_CURSOR_STATE cursor_row;
931  TDS_CURSOR_STATE open;
932  TDS_CURSOR_STATE fetch;
933  TDS_CURSOR_STATE close;
934  TDS_CURSOR_STATE dealloc;
936 
937 typedef enum tds_cursor_operation
938 {
939  TDS_CURSOR_POSITION = 0,
940  TDS_CURSOR_UPDATE = 1,
941  TDS_CURSOR_DELETE = 2,
942  TDS_CURSOR_INSERT = 4
943 } TDS_CURSOR_OPERATION;
944 
945 typedef enum tds_cursor_fetch
946 {
947  TDS_CURSOR_FETCH_NEXT = 1,
948  TDS_CURSOR_FETCH_PREV,
949  TDS_CURSOR_FETCH_FIRST,
950  TDS_CURSOR_FETCH_LAST,
951  TDS_CURSOR_FETCH_ABSOLUTE,
952  TDS_CURSOR_FETCH_RELATIVE
953 } TDS_CURSOR_FETCH;
954 
958 typedef struct tds_cursor
959 {
960  struct tds_cursor *next;
961  TDS_INT ref_count;
962  char *cursor_name;
963  TDS_INT cursor_id;
964  TDS_TINYINT options;
968  TDS_TINYINT defer_close;
969  char *query;
970  /* TODO for updatable columns */
971  /* TDS_TINYINT number_upd_cols; */
972  /* TDSUPDCOL *cur_col_list; */
973  TDS_INT cursor_rows;
974  /* TDSPARAMINFO *params; */
976  TDS_USMALLINT srv_status;
977  TDSRESULTINFO *res_info;
978  TDS_INT type, concurrency;
979 } TDSCURSOR;
980 
984 typedef struct tds_env
985 {
988  char *language;
990  char *charset;
992  char *database;
993 } TDSENV;
994 
998 typedef struct tds_dynamic
999 {
1000  struct tds_dynamic *next;
1001  TDS_INT ref_count;
1003  TDS_INT num_id;
1009  char id[30];
1015  TDS_TINYINT emulated;
1019  TDS_TINYINT defer_close;
1020  /* int dyn_state; */ /* TODO use it */
1021  TDSPARAMINFO *res_info;
1029  TDSPARAMINFO *params;
1031  char *query;
1032 } TDSDYNAMIC;
1033 
1034 typedef enum {
1035  TDS_MULTIPLE_QUERY,
1036  TDS_MULTIPLE_EXECUTE,
1037  TDS_MULTIPLE_RPC
1038 } TDS_MULTIPLE_TYPE;
1039 
1040 typedef struct tds_multiple
1041 {
1042  TDS_MULTIPLE_TYPE type;
1043  unsigned int flags;
1044 } TDSMULTIPLE;
1045 
1046 /* forward declaration */
1047 typedef struct tds_context TDSCONTEXT;
1048 typedef int (*err_handler_t) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1049 
1051 {
1052  TDSLOCALE *locale;
1053  void *parent;
1054  /* handlers */
1055  int (*msg_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1056  int (*err_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1057  int (*int_handler) (void *);
1058 };
1059 
1060 enum TDS_ICONV_ENTRY
1061 {
1062  client2ucs2
1063  , client2server_chardata
1064  , iso2server_metadata
1065  , initial_char_conv_count /* keep last */
1066 };
1067 
1068 typedef struct tds_authentication
1069 {
1070  TDS_UCHAR *packet;
1071  int packet_len;
1072  TDSRET (*free)(TDSCONNECTION* conn, struct tds_authentication * auth);
1073  TDSRET (*handle_next)(TDSSOCKET * tds, struct tds_authentication * auth, size_t len);
1075 
1076 typedef struct tds_packet
1077 {
1078  struct tds_packet *next;
1079  short sid;
1080  unsigned len, capacity;
1081  unsigned char buf[1];
1082 } TDSPACKET;
1083 
1084 /* field related to connection */
1086 {
1087  TDS_USMALLINT tds_version;
1088  TDS_UINT product_version;
1089  char *product_name;
1090 
1091  TDS_SYS_SOCKET s;
1092  TDS_SYS_SOCKET s_signal, s_signaled;
1093  const TDSCONTEXT *tds_ctx;
1094 
1097 
1108 
1109  int char_conv_count;
1110  TDSICONV **char_convs;
1111 
1112  TDS_UCHAR collation[5];
1113  TDS_UCHAR tds72_transaction[8];
1114 
1115  TDS_CAPABILITIES capabilities;
1116  unsigned int emul_little_endian:1;
1117  unsigned int use_iconv:1;
1118  unsigned int tds71rev1:1;
1119  unsigned int pending_close:1;
1120 #if ENABLE_ODBC_MARS
1121  unsigned int mars:1;
1122 
1123  TDSSOCKET *in_net_tds;
1124  TDSPACKET *packets;
1125  TDSPACKET *recv_packet;
1126  TDSPACKET *send_packets;
1127  unsigned send_pos, recv_pos;
1128 
1129  tds_mutex list_mtx;
1130 #define BUSY_SOCKET ((TDSSOCKET*)(TDS_UINTPTR)1)
1131 #define TDSSOCKET_VALID(tds) (((TDS_UINTPTR)(tds)) > 1)
1132  struct tds_socket **sessions;
1133  unsigned num_sessions;
1134  unsigned num_cached_packets;
1135  TDSPACKET *packet_cache;
1136 #endif
1137 
1138  int spid;
1139  int client_spid;
1140 
1141  void *tls_session;
1142 #if defined(HAVE_GNUTLS)
1143  void *tls_credentials;
1144 #elif defined(HAVE_OPENSSL)
1145  void *tls_ctx;
1146 #else
1147  void *tls_dummy;
1148 #endif
1149  TDSAUTHENTICATION *authentication;
1150 };
1151 
1156 {
1157 #if ENABLE_ODBC_MARS
1158  TDSCONNECTION *conn;
1159 #else
1160  TDSCONNECTION conn[1];
1161 #endif
1162 
1168  unsigned char *in_buf;
1169 
1175  unsigned char *out_buf;
1176 
1181  unsigned int out_buf_max;
1182  unsigned in_pos;
1183  unsigned out_pos;
1184  unsigned in_len;
1185  unsigned char in_flag;
1186  unsigned char out_flag;
1188  void *parent;
1189 
1190 #if ENABLE_ODBC_MARS
1191  short sid;
1192  tds_condition packet_cond;
1193  TDS_UINT recv_seq;
1194  TDS_UINT send_seq;
1195  TDS_UINT recv_wnd;
1196  TDS_UINT send_wnd;
1197 #endif
1198  /* packet we received */
1199  TDSPACKET *recv_packet;
1202 
1209  TDSRESULTINFO *res_info;
1210  TDS_UINT num_comp_info;
1211  TDSCOMPUTEINFO **comp_info;
1212  TDSPARAMINFO *param_info;
1214  TDS_TINYINT bulk_query;
1215  TDS_TINYINT has_status;
1216  TDS_INT ret_status;
1217  TDS_STATE state;
1218  volatile
1219  unsigned char in_cancel;
1222  TDS_INT8 rows_affected;
1223  TDS_INT query_timeout;
1224 
1229  void (*env_chg_func) (TDSSOCKET * tds, int type, char *oldval, char *newval);
1230  TDS_OPERATION current_op;
1231 
1232  int option_value;
1233  tds_mutex wire_mtx;
1234 };
1235 
1236 #define tds_get_ctx(tds) ((tds)->conn->tds_ctx)
1237 #define tds_set_ctx(tds, val) do { ((tds)->conn->tds_ctx) = (val); } while(0)
1238 #define tds_get_parent(tds) ((tds)->parent)
1239 #define tds_set_parent(tds, val) do { ((tds)->parent) = (val); } while(0)
1240 #define tds_get_s(tds) ((tds)->conn->s)
1241 #define tds_set_s(tds, val) do { ((tds)->conn->s) = (val); } while(0)
1242 
1243 
1244 /* config.c */
1246 typedef void (*TDSCONFPARSE) (const char *option, const char *value, void *param);
1247 int tds_read_conf_section(FILE * in, const char *section, TDSCONFPARSE tds_conf_parse, void *parse_param);
1248 int tds_read_conf_file(TDSLOGIN * login, const char *server);
1249 void tds_parse_conf_section(const char *option, const char *value, void *param);
1250 TDSLOGIN *tds_read_config_info(TDSSOCKET * tds, TDSLOGIN * login, TDSLOCALE * locale);
1251 void tds_fix_login(TDSLOGIN* login);
1252 TDS_USMALLINT * tds_config_verstr(const char *tdsver, TDSLOGIN* login);
1253 struct addrinfo *tds_lookup_host(const char *servername);
1254 TDSRET tds_lookup_host_set(const char *servername, struct addrinfo **addr);
1255 const char *tds_addrinfo2str(struct addrinfo *addr, char *name, int namemax);
1256 
1257 TDSRET tds_set_interfaces_file_loc(const char *interfloc);
1258 extern const char STD_DATETIME_FMT[];
1259 int tds_parse_boolean(const char *value, int default_value);
1260 int tds_config_boolean(const char *option, const char *value, TDSLOGIN * login);
1261 
1262 TDSLOCALE *tds_get_locale(void);
1263 TDSRET tds_alloc_row(TDSRESULTINFO * res_info);
1264 TDSRET tds_alloc_compute_row(TDSCOMPUTEINFO * res_info);
1265 BCPCOLDATA * tds_alloc_bcp_column_data(unsigned int column_size);
1266 TDSDYNAMIC *tds_lookup_dynamic(TDSCONNECTION * conn, const char *id);
1267 /*@observer@*/ const char *tds_prtype(int token);
1268 int tds_get_varint_size(TDSCONNECTION * conn, int datatype);
1269 int tds_get_cardinal_type(int datatype, int usertype);
1270 
1271 
1272 /* iconv.c */
1273 TDSRET tds_iconv_open(TDSCONNECTION * conn, const char *charset, int use_utf16);
1274 void tds_iconv_close(TDSCONNECTION * conn);
1275 void tds_srv_charset_changed(TDSCONNECTION * conn, const char *charset);
1276 void tds7_srv_charset_changed(TDSCONNECTION * conn, int sql_collate, int lcid);
1277 int tds_iconv_alloc(TDSCONNECTION * conn);
1278 void tds_iconv_free(TDSCONNECTION * conn);
1279 TDSICONV *tds_iconv_from_collate(TDSCONNECTION * conn, TDS_UCHAR collate[5]);
1280 
1281 
1282 /* threadsafe.c */
1283 char *tds_timestamp_str(char *str, int maxlen);
1284 struct tm *tds_localtime_r(const time_t *timep, struct tm *result);
1285 struct hostent *tds_gethostbyname_r(const char *servername, struct hostent *result, char *buffer, int buflen, int *h_errnop);
1286 int tds_getservice(const char *name);
1287 char *tds_get_homedir(void);
1288 
1289 
1290 /* mem.c */
1291 void tds_free_socket(TDSSOCKET * tds);
1292 void tds_free_all_results(TDSSOCKET * tds);
1293 void tds_free_results(TDSRESULTINFO * res_info);
1294 void tds_free_param_results(TDSPARAMINFO * param_info);
1295 void tds_free_param_result(TDSPARAMINFO * param_info);
1296 void tds_free_msg(TDSMESSAGE * message);
1297 void tds_cursor_deallocated(TDSCONNECTION *conn, TDSCURSOR *cursor);
1298 void tds_release_cursor(TDSCURSOR **pcursor);
1299 void tds_free_bcp_column_data(BCPCOLDATA * coldata);
1300 TDSRESULTINFO *tds_alloc_results(TDS_USMALLINT num_cols);
1301 TDSCOMPUTEINFO **tds_alloc_compute_results(TDSSOCKET * tds, TDS_USMALLINT num_cols, TDS_USMALLINT by_cols);
1302 TDSCONTEXT *tds_alloc_context(void * parent);
1303 void tds_free_context(TDSCONTEXT * locale);
1304 TDSPARAMINFO *tds_alloc_param_result(TDSPARAMINFO * old_param);
1305 void tds_free_input_params(TDSDYNAMIC * dyn);
1306 void tds_release_dynamic(TDSDYNAMIC ** dyn);
1307 static inline
1308 void tds_release_cur_dyn(TDSSOCKET * tds)
1309 {
1311 }
1312 void tds_dynamic_deallocated(TDSCONNECTION *conn, TDSDYNAMIC *dyn);
1313 void tds_set_cur_dyn(TDSSOCKET *tds, TDSDYNAMIC *dyn);
1314 TDSSOCKET *tds_realloc_socket(TDSSOCKET * tds, size_t bufsize);
1315 char *tds_alloc_client_sqlstate(int msgno);
1316 char *tds_alloc_lookup_sqlstate(TDSSOCKET * tds, int msgno);
1317 TDSLOGIN *tds_alloc_login(int use_environment);
1318 TDSDYNAMIC *tds_alloc_dynamic(TDSCONNECTION * conn, const char *id);
1319 void tds_free_login(TDSLOGIN * login);
1320 TDSLOGIN *tds_init_login(TDSLOGIN * login, TDSLOCALE * locale);
1321 TDSLOCALE *tds_alloc_locale(void);
1322 void *tds_alloc_param_data(TDSCOLUMN * curparam);
1323 void tds_free_locale(TDSLOCALE * locale);
1324 TDSCURSOR * tds_alloc_cursor(TDSSOCKET * tds, const char *name, TDS_INT namelen, const char *query, TDS_INT querylen);
1325 void tds_free_row(TDSRESULTINFO * res_info, unsigned char *row);
1326 TDSSOCKET *tds_alloc_socket(TDSCONTEXT * context, unsigned int bufsize);
1327 TDSSOCKET *tds_alloc_additional_socket(TDSCONNECTION *conn);
1328 void tds_set_current_results(TDSSOCKET *tds, TDSRESULTINFO *info);
1329 void tds_detach_results(TDSRESULTINFO *info);
1330 void * tds_realloc(void **pp, size_t new_size);
1331 #define TDS_RESIZE(p, n_elem) \
1332  tds_realloc((void **) &(p), sizeof(*(p)) * (size_t) (n_elem))
1333 
1334 TDSPACKET *tds_alloc_packet(void *buf, unsigned len);
1335 TDSPACKET *tds_realloc_packet(TDSPACKET *packet, unsigned len);
1336 void tds_free_packets(TDSPACKET *packet);
1337 TDSBCPINFO *tds_alloc_bcpinfo(void);
1338 void tds_free_bcpinfo(TDSBCPINFO *bcpinfo);
1339 void tds_deinit_bcpinfo(TDSBCPINFO *bcpinfo);
1340 
1341 
1342 /* login.c */
1343 void tds_set_packet(TDSLOGIN * tds_login, int packet_size);
1344 void tds_set_port(TDSLOGIN * tds_login, int port);
1345 bool tds_set_passwd(TDSLOGIN * tds_login, const char *password) TDS_WUR;
1346 void tds_set_bulk(TDSLOGIN * tds_login, TDS_TINYINT enabled);
1347 bool tds_set_user(TDSLOGIN * tds_login, const char *username) TDS_WUR;
1348 bool tds_set_app(TDSLOGIN * tds_login, const char *application) TDS_WUR;
1349 bool tds_set_host(TDSLOGIN * tds_login, const char *hostname) TDS_WUR;
1350 bool tds_set_library(TDSLOGIN * tds_login, const char *library) TDS_WUR;
1351 bool tds_set_server(TDSLOGIN * tds_login, const char *server) TDS_WUR;
1352 bool tds_set_client_charset(TDSLOGIN * tds_login, const char *charset) TDS_WUR;
1353 bool tds_set_language(TDSLOGIN * tds_login, const char *language) TDS_WUR;
1354 void tds_set_version(TDSLOGIN * tds_login, TDS_TINYINT major_ver, TDS_TINYINT minor_ver);
1355 int tds_connect_and_login(TDSSOCKET * tds, TDSLOGIN * login);
1356 
1357 
1358 /* query.c */
1359 void tds_start_query(TDSSOCKET *tds, unsigned char packet_type);
1360 
1361 TDSRET tds_submit_query(TDSSOCKET * tds, const char *query);
1362 TDSRET tds_submit_query_params(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1363 TDSRET tds_submit_queryf(TDSSOCKET * tds, const char *queryf, ...);
1364 TDSRET tds_submit_prepare(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1365 TDSRET tds_submit_execdirect(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1366 TDSRET tds71_submit_prepexec(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1367 TDSRET tds_submit_execute(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1368 TDSRET tds_send_cancel(TDSSOCKET * tds);
1369 const char *tds_next_placeholder(const char *start);
1370 int tds_count_placeholders(const char *query);
1371 int tds_needs_unprepare(TDSCONNECTION * conn, TDSDYNAMIC * dyn);
1372 TDSRET tds_deferred_unprepare(TDSCONNECTION * conn, TDSDYNAMIC * dyn);
1373 TDSRET tds_submit_unprepare(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1374 TDSRET tds_submit_rpc(TDSSOCKET * tds, const char *rpc_name, TDSPARAMINFO * params, TDSHEADERS * head);
1375 TDSRET tds_submit_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD command, TDS_OPTION option, TDS_OPTION_ARG *param, TDS_INT param_size);
1376 TDSRET tds_submit_begin_tran(TDSSOCKET *tds);
1377 TDSRET tds_submit_rollback(TDSSOCKET *tds, int cont);
1378 TDSRET tds_submit_commit(TDSSOCKET *tds, int cont);
1379 TDSRET tds_disconnect(TDSSOCKET * tds);
1380 size_t tds_quote_id(TDSSOCKET * tds, char *buffer, const char *id, int idlen);
1381 size_t tds_quote_string(TDSSOCKET * tds, char *buffer, const char *str, int len);
1382 const char *tds_skip_comment(const char *s);
1383 const char *tds_skip_quoted(const char *s);
1384 size_t tds_fix_column_size(TDSSOCKET * tds, TDSCOLUMN * curcol);
1385 const char *tds_convert_string(TDSSOCKET * tds, TDSICONV * char_conv, const char *s, int len, size_t *out_len);
1386 void tds_convert_string_free(const char *original, const char *converted);
1387 #if !ENABLE_EXTRA_CHECKS
1388 #define tds_convert_string_free(original, converted) \
1389  do { if (original != converted) free((char*) converted); } while(0)
1390 #endif
1391 TDSRET tds_get_column_declaration(TDSSOCKET * tds, TDSCOLUMN * curcol, char *out);
1392 
1393 TDSRET tds_cursor_declare(TDSSOCKET * tds, TDSCURSOR * cursor, TDSPARAMINFO *params, int *send);
1394 TDSRET tds_cursor_setrows(TDSSOCKET * tds, TDSCURSOR * cursor, int *send);
1395 TDSRET tds_cursor_open(TDSSOCKET * tds, TDSCURSOR * cursor, TDSPARAMINFO *params, int *send);
1396 TDSRET tds_cursor_fetch(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_FETCH fetch_type, TDS_INT i_row);
1397 TDSRET tds_cursor_get_cursor_info(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_UINT * row_number, TDS_UINT * row_count);
1398 TDSRET tds_cursor_close(TDSSOCKET * tds, TDSCURSOR * cursor);
1399 TDSRET tds_cursor_dealloc(TDSSOCKET * tds, TDSCURSOR * cursor);
1400 TDSRET tds_deferred_cursor_dealloc(TDSCONNECTION *conn, TDSCURSOR * cursor);
1401 TDSRET tds_cursor_update(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_OPERATION op, TDS_INT i_row, TDSPARAMINFO * params);
1402 TDSRET tds_cursor_setname(TDSSOCKET * tds, TDSCURSOR * cursor);
1403 
1404 TDSRET tds_multiple_init(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDS_MULTIPLE_TYPE type, TDSHEADERS * head);
1405 TDSRET tds_multiple_done(TDSSOCKET *tds, TDSMULTIPLE *multiple);
1406 TDSRET tds_multiple_query(TDSSOCKET *tds, TDSMULTIPLE *multiple, const char *query, TDSPARAMINFO * params);
1407 TDSRET tds_multiple_execute(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDSDYNAMIC * dyn);
1408 
1409 
1410 /* token.c */
1411 TDSRET tds_process_cancel(TDSSOCKET * tds);
1412 int tds_get_token_size(int marker);
1413 TDSRET tds_process_login_tokens(TDSSOCKET * tds);
1414 TDSRET tds_process_simple_query(TDSSOCKET * tds);
1415 int tds5_send_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD tds_command, TDS_OPTION tds_option, TDS_OPTION_ARG * tds_argument,
1416  TDS_INT * tds_argsize);
1417 TDSRET tds_process_tokens(TDSSOCKET * tds, /*@out@*/ TDS_INT * result_type, /*@out@*/ int *done_flags, unsigned flag);
1418 int determine_adjusted_size(const TDSICONV * char_conv, int size);
1419 
1420 
1421 /* data.c */
1422 void tds_set_param_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
1423 void tds_set_column_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, int type);
1424 
1425 
1426 /* tds_convert.c */
1427 TDSRET tds_datecrack(TDS_INT datetype, const void *di, TDSDATEREC * dr);
1428 int tds_get_conversion_type(int srctype, int colsize);
1429 extern const char tds_hex_digits[];
1430 
1431 
1432 /* write.c */
1433 int tds_init_write_buf(TDSSOCKET * tds);
1434 int tds_put_n(TDSSOCKET * tds, const void *buf, size_t n);
1435 int tds_put_string(TDSSOCKET * tds, const char *buf, int len);
1436 int tds_put_int(TDSSOCKET * tds, TDS_INT i);
1437 int tds_put_int8(TDSSOCKET * tds, TDS_INT8 i);
1438 int tds_put_smallint(TDSSOCKET * tds, TDS_SMALLINT si);
1440 #define tds_put_tinyint(tds, ti) tds_put_byte(tds,ti)
1441 int tds_put_byte(TDSSOCKET * tds, unsigned char c);
1442 TDSRET tds_flush_packet(TDSSOCKET * tds);
1443 int tds_put_buf(TDSSOCKET * tds, const unsigned char *buf, int dsize, int ssize);
1444 
1445 
1446 /* read.c */
1447 unsigned char tds_get_byte(TDSSOCKET * tds);
1448 void tds_unget_byte(TDSSOCKET * tds);
1449 unsigned char tds_peek(TDSSOCKET * tds);
1450 TDS_USMALLINT tds_get_usmallint(TDSSOCKET * tds);
1451 #define tds_get_smallint(tds) ((TDS_SMALLINT) tds_get_usmallint(tds))
1452 TDS_UINT tds_get_uint(TDSSOCKET * tds);
1453 #define tds_get_int(tds) ((TDS_INT) tds_get_uint(tds))
1454 TDS_UINT8 tds_get_uint8(TDSSOCKET * tds);
1455 #define tds_get_int8(tds) ((TDS_INT8) tds_get_uint8(tds))
1456 size_t tds_get_string(TDSSOCKET * tds, size_t string_len, char *dest, size_t dest_size);
1457 TDSRET tds_get_char_data(TDSSOCKET * tds, char *dest, size_t wire_size, TDSCOLUMN * curcol);
1458 void *tds_get_n(TDSSOCKET * tds, /*@out@*/ /*@null@*/ void *dest, size_t n);
1459 int tds_get_size_by_type(int servertype);
1460 DSTR* tds_dstr_get(TDSSOCKET * tds, DSTR * s, size_t len);
1461 
1462 
1463 /* util.c */
1464 int tdserror (const TDSCONTEXT * tds_ctx, TDSSOCKET * tds, int msgno, int errnum);
1465 TDS_STATE tds_set_state(TDSSOCKET * tds, TDS_STATE state);
1466 void tds_swap_bytes(void *buf, int bytes);
1467 #ifdef ENABLE_DEVELOPING
1468 unsigned int tds_gettime_ms(void);
1469 #endif
1470 char *tds_strndup(const void *s, TDS_INTPTR len);
1471 
1472 
1473 /* log.c */
1474 void tdsdump_off(void);
1475 void tdsdump_on(void);
1476 int tdsdump_isopen(void);
1477 #include <freetds/popvis.h>
1478 int tdsdump_open(const char *filename);
1479 #include <freetds/pushvis.h>
1480 void tdsdump_close(void);
1481 void tdsdump_dump_buf(const char* file, unsigned int level_line, const char *msg, const void *buf, size_t length);
1482 void tdsdump_col(const TDSCOLUMN *col);
1483 #undef tdsdump_log
1484 void tdsdump_log(const char* file, unsigned int level_line, const char *fmt, ...)
1485 #if defined(__GNUC__) && __GNUC__ >= 2
1486 #if defined(__MINGW32__)
1487  __attribute__ ((__format__ (ms_printf, 3, 4)))
1488 #else
1489  __attribute__ ((__format__ (__printf__, 3, 4)))
1490 #endif
1491 #endif
1492 ;
1493 #define TDSDUMP_LOG_FAST if (TDS_UNLIKELY(tds_write_dump)) tdsdump_log
1494 #define tdsdump_log TDSDUMP_LOG_FAST
1495 #define TDSDUMP_BUF_FAST if (TDS_UNLIKELY(tds_write_dump)) tdsdump_dump_buf
1496 #define tdsdump_dump_buf TDSDUMP_BUF_FAST
1497 
1498 extern int tds_write_dump;
1499 extern int tds_debug_flags;
1500 extern int tds_g_append_mode;
1501 
1502 
1503 /* net.c */
1504 TDSERRNO tds_open_socket(TDSSOCKET * tds, struct addrinfo *ipaddr, unsigned int port, int timeout, int *p_oserr);
1505 void tds_close_socket(TDSSOCKET * tds);
1506 int tds7_get_instance_ports(FILE *output, struct addrinfo *addr);
1507 int tds7_get_instance_port(struct addrinfo *addr, const char *instance);
1508 char *tds_prwsaerror(int erc);
1509 void tds_prwsaerror_free(char *s);
1510 int tds_connection_read(TDSSOCKET * tds, unsigned char *buf, int buflen);
1511 int tds_connection_write(TDSSOCKET *tds, const unsigned char *buf, int buflen, int final);
1512 #define TDSSELREAD POLLIN
1513 #define TDSSELWRITE POLLOUT
1514 int tds_select(TDSSOCKET * tds, unsigned tds_sel, int timeout_seconds);
1515 #if ENABLE_ODBC_MARS
1516 void tds_connection_close(TDSCONNECTION *conn);
1517 #endif
1518 int tds_goodread(TDSSOCKET * tds, unsigned char *buf, int buflen);
1519 int tds_goodwrite(TDSSOCKET * tds, const unsigned char *buffer, size_t buflen);
1520 void tds_socket_flush(TDS_SYS_SOCKET sock);
1521 int tds_socket_set_nonblocking(TDS_SYS_SOCKET sock);
1522 
1523 
1524 /* packet.c */
1525 int tds_read_packet(TDSSOCKET * tds);
1526 TDSRET tds_write_packet(TDSSOCKET * tds, unsigned char final);
1527 #if ENABLE_ODBC_MARS
1528 int tds_append_cancel(TDSSOCKET *tds);
1529 TDSRET tds_append_fin(TDSSOCKET *tds);
1530 #else
1531 int tds_put_cancel(TDSSOCKET * tds);
1532 static inline
1533 void tds_connection_close(TDSCONNECTION *connection)
1534 {
1535  tds_close_socket((TDSSOCKET* ) connection);
1536 }
1537 #endif
1538 
1539 
1540 /* vstrbuild.c */
1541 TDSRET tds_vstrbuild(char *buffer, int buflen, int *resultlen, const char *text, int textlen, const char *formats, int formatlen,
1542  va_list ap);
1543 
1544 
1545 /* numeric.c */
1546 char *tds_money_to_string(const TDS_MONEY * money, char *s);
1547 TDS_INT tds_numeric_to_string(const TDS_NUMERIC * numeric, char *s);
1548 TDS_INT tds_numeric_change_prec_scale(TDS_NUMERIC * numeric, unsigned char new_prec, unsigned char new_scale);
1549 
1550 
1551 /* getmac.c */
1552 void tds_getmac(TDS_SYS_SOCKET s, unsigned char mac[6]);
1553 
1554 
1555 /* challenge.c */
1556 #ifndef HAVE_SSPI
1557 TDSAUTHENTICATION * tds_ntlm_get_auth(TDSSOCKET * tds);
1558 TDSAUTHENTICATION * tds_gss_get_auth(TDSSOCKET * tds);
1559 #else
1560 TDSAUTHENTICATION * tds_sspi_get_auth(TDSSOCKET * tds);
1561 #endif
1562 
1563 
1564 /* random.c */
1565 void tds_random_buffer(unsigned char *out, int len);
1566 
1567 
1568 /* sec_negotiate.c */
1569 TDSAUTHENTICATION * tds5_negotiate_get_auth(TDSSOCKET * tds);
1570 void tds5_negotiate_set_msg_type(TDSSOCKET * tds, TDSAUTHENTICATION * auth, unsigned msg_type);
1571 
1572 
1573 /* bulk.c */
1574 
1577 {
1578  TDS_BCP_IN = 1,
1579  TDS_BCP_OUT = 2,
1580  TDS_BCP_QUERYOUT = 3
1581 };
1582 
1584 {
1585  const char *hint;
1586  void *parent;
1587  DSTR tablename;
1588  TDS_CHAR *insert_stmt;
1589  TDS_INT direction;
1590  TDS_INT identity_insert_on;
1591  TDS_INT xfer_init;
1592  TDS_INT bind_count;
1593  TDSRESULTINFO *bindinfo;
1594 };
1595 
1596 TDSRET tds_bcp_init(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1597 typedef TDSRET (*tds_bcp_get_col_data) (TDSBCPINFO *bulk, TDSCOLUMN *bcpcol, int offset);
1598 typedef void (*tds_bcp_null_error) (TDSBCPINFO *bulk, int index, int offset);
1599 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);
1600 TDSRET tds_bcp_done(TDSSOCKET *tds, int *rows_copied);
1601 TDSRET tds_bcp_start(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1602 TDSRET tds_bcp_start_copy_in(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1603 
1604 TDSRET tds_bcp_fread(TDSSOCKET * tds, TDSICONV * conv, FILE * stream,
1605  const char *terminator, size_t term_len, char **outbuf, size_t * outbytes);
1606 
1607 TDSRET tds_writetext_start(TDSSOCKET *tds, const char *objname, const char *textptr, const char *timestamp, int with_log, TDS_UINT size);
1608 TDSRET tds_writetext_continue(TDSSOCKET *tds, const TDS_UCHAR *text, TDS_UINT size);
1609 TDSRET tds_writetext_end(TDSSOCKET *tds);
1610 
1611 
1612 static inline
1613 bool tds_capability_enabled(const TDS_CAPABILITY_TYPE *cap, unsigned cap_num)
1614 {
1615  return (cap->values[sizeof(cap->values)-1-(cap_num>>3)] >> (cap_num&7)) & 1;
1616 }
1617 #define tds_capability_has_req(conn, cap) \
1618  tds_capability_enabled(&conn->capabilities.types[0], cap)
1619 
1620 #define IS_TDS42(x) (x->tds_version==0x402)
1621 #define IS_TDS46(x) (x->tds_version==0x406)
1622 #define IS_TDS50(x) (x->tds_version==0x500)
1623 #define IS_TDS70(x) (x->tds_version==0x700)
1624 #define IS_TDS71(x) (x->tds_version==0x701)
1625 #define IS_TDS72(x) (x->tds_version==0x702)
1626 #define IS_TDS73(x) (x->tds_version==0x703)
1627 
1628 #define IS_TDS50_PLUS(x) ((x)->tds_version>=0x500)
1629 #define IS_TDS7_PLUS(x) ((x)->tds_version>=0x700)
1630 #define IS_TDS71_PLUS(x) ((x)->tds_version>=0x701)
1631 #define IS_TDS72_PLUS(x) ((x)->tds_version>=0x702)
1632 #define IS_TDS73_PLUS(x) ((x)->tds_version>=0x703)
1633 #define IS_TDS74_PLUS(x) ((x)->tds_version>=0x704)
1634 
1635 #define TDS_MAJOR(x) ((x)->tds_version >> 8)
1636 #define TDS_MINOR(x) ((x)->tds_version & 0xff)
1637 
1638 #define IS_TDSDEAD(x) (((x) == NULL) || (x)->state == TDS_DEAD)
1639 
1641 #define TDS_IS_SYBASE(x) (!((x)->conn->product_version & 0x80000000u))
1642 
1643 #define TDS_IS_MSSQL(x) (((x)->conn->product_version & 0x80000000u)!=0)
1644 
1648 #define TDS_MS_VER(maj,min,x) (0x80000000u|((maj)<<24)|((min)<<16)|(x))
1649 
1650 /* TODO test if not similar to ms one*/
1652 #define TDS_SYB_VER(maj,min,x) (((maj)<<24)|((min)<<16)|(x)<<8)
1653 
1654 #ifdef __cplusplus
1655 #if 0
1656 {
1657 #endif
1658 }
1659 #endif
1660 
1661 #include <freetds/popvis.h>
1662 
1663 #define TDS_PUT_INT(tds,v) tds_put_int((tds), ((TDS_INT)(v)))
1664 #define TDS_PUT_SMALLINT(tds,v) tds_put_smallint((tds), ((TDS_SMALLINT)(v)))
1665 #define TDS_PUT_BYTE(tds,v) tds_put_byte((tds), ((unsigned char)(v)))
1666 
1667 #endif /* _tds_h_ */
transaction in progress
Definition: tds.h:249
int tds_read_conf_file(TDSLOGIN *login, const char *server)
Read configuration info for given server return 0 on error.
Definition: config.c:339
Definition: tds.h:927
enum tds_states TDS_STATE
values for tds->state
TDSPARAMINFO * tds_alloc_param_result(TDSPARAMINFO *old_param)
Adds a output parameter to TDSPARAMINFO.
Definition: mem.c:278
TDSRET tds_submit_commit(TDSSOCKET *tds, int cont)
Send a commit request.
Definition: query.c:3754
struct addrinfo * tds_lookup_host(const char *servername)
Get the IP address for a hostname.
Definition: config.c:951
TDSENV env
environment is shared between all sessions
Definition: tds.h:1096
TDSRET tds_bcp_start_copy_in(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Start bulk copy to server.
Definition: bulk.c:862
tds_func_put_info * put_info
Send metadata column information to server.
Definition: tds.h:677
Definition: tds.h:1050
struct tdsdaterec TDSDATEREC
Used by tds_datecrack.
unsigned char tds_peek(TDSSOCKET *tds)
Reads a byte from the TDS stream without removing it.
Definition: read.c:100
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:137
const char * name
name of the encoding (ie UTF-8)
Definition: tds.h:638
void tds_release_dynamic(TDSDYNAMIC **dyn)
Frees dynamic statement.
Definition: mem.c:247
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:2124
Definition: tds.h:591
void tds_set_cur_dyn(TDSSOCKET *tds, TDSDYNAMIC *dyn)
Set current dynamic.
Definition: query.c:187
TDS_INT tds_numeric_to_string(const TDS_NUMERIC *numeric, char *s)
Definition: numeric.c:94
tds_func_put_data * put_data
Send column data to server.
Definition: tds.h:687
this structure is not directed connected to a TDS protocol but keeps any DATE/TIME information...
Definition: tds.h:142
TDSRET tds_set_interfaces_file_loc(const char *interfloc)
Set the full name of interface file.
Definition: config.c:925
int tds_goodread(TDSSOCKET *tds, unsigned char *buf, int buflen)
Loops until we have received some characters return -1 on failure.
Definition: net.c:630
TDSRESULTINFO * current_results
Current query information.
Definition: tds.h:1208
Definition: tds.h:897
Definition: tds.h:533
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:838
void tds_free_input_params(TDSDYNAMIC *dyn)
Frees all allocated input parameters of a dynamic statement.
Definition: mem.c:200
TDS_UINT product_version
version of product (Sybase/MS and full version)
Definition: tds.h:1088
int block_size
packet size (512-65535)
Definition: tds.h:987
TDS_TINYINT bulk_query
true is query sent was a bulk query so we need to switch state to QUERYING
Definition: tds.h:1214
TDS_INT num_id
numeric id for mssql7+
Definition: tds.h:1003
Definition: tds.h:539
char * query
saved query, we need to know original query if prepare is impossible
Definition: tds.h:1031
Structure to hold a string.
Definition: tds.h:94
struct tds_cursor TDSCURSOR
Holds informations about a cursor.
TDS_INT second
0-59
Definition: tds.h:165
TDSRET tds_get_column_declaration(TDSSOCKET *tds, TDSCOLUMN *curcol, char *out)
Return declaration for column (like "varchar(20)")
Definition: query.c:729
tds_states
values for tds->state
Definition: tds.h:810
Definition: tds.h:1040
char * database
database name
Definition: tds.h:992
int tds_get_varint_size(TDSCONNECTION *conn, int datatype)
tds_get_varint_size() returns the size of a variable length integer returned in a TDS 7...
Definition: tds_types.h:57
DSTR server_realm_name
server realm name (in freetds.conf)
Definition: tds.h:550
TDSCURSOR * cursors
linked list of cursors allocated for this connection contains only cursors allocated on the server ...
Definition: tds.h:1102
Information for a server connection.
Definition: tds.h:1155
error occurred
Definition: tds.h:248
TDS_TINYINT defer_close
true if dynamic was marker to be closed when connection is idle
Definition: tds.h:1019
void tds_start_query(TDSSOCKET *tds, unsigned char packet_type)
Start query packet of a given type.
Definition: query.c:343
Holds informations about a cursor.
Definition: tds.h:958
DSTR cafile
certificate authorities file
Definition: tds.h:553
TDSAUTHENTICATION * tds_ntlm_get_auth(TDSSOCKET *tds)
Build a NTLMSPP packet to send to server.
Definition: challenge.c:687
TDS_INT bcp_prefix_len
The length, in bytes, of any length prefix this column may have.
Definition: tds.h:783
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
unsigned char * out_buf
Output buffer.
Definition: tds.h:1175
void tds_set_column_type(TDSCONNECTION *conn, TDSCOLUMN *curcol, int type)
Set type of column initializing all dependency.
Definition: data.c:225
TDS_USMALLINT tds_version
TDS version.
Definition: tds.h:543
Definition: tds.h:1085
TDSRET tds_writetext_end(TDSSOCKET *tds)
Finish sending writetext data.
Definition: bulk.c:1148
void * tds_realloc(void **pp, size_t new_size)
Reallocate a pointer and update it if success.
Definition: mem.c:1807
unsigned char out_flag
output buffer type
Definition: tds.h:1186
Definition: proto.h:38
TDSICONV * char_conv
refers to previously allocated iconv information
Definition: tds.h:737
const char * tds_skip_comment(const char *s)
Skip a comment in a query.
Definition: query.c:509
int determine_adjusted_size(const TDSICONV *char_conv, int size)
Allow for maximum possible size of converted data, while being careful about integer division truncat...
Definition: token.c:3170
TDS_INT ref_count
reference counter so client can retain safely a pointer
Definition: tds.h:961
struct tds_variant TDSVARIANT
Store variant informations.
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:3416
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:123
TDSRET tds_alloc_row(TDSRESULTINFO *res_info)
Allocate space for row store return NULL on out of memory.
Definition: mem.c:517
unsigned char in_flag
input buffer type
Definition: tds.h:1185
void tdsdump_on(void)
Turn logging back on.
Definition: log.c:87
void tds_fix_login(TDSLOGIN *login)
Fix configuration after reading it.
Definition: config.c:278
TDSRET tds_process_tokens(TDSSOCKET *tds, TDS_INT *result_type, int *done_flags, unsigned flag)
process all streams.
Definition: token.c:493
void * 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:248
unsigned char * in_buf
Input buffer.
Definition: tds.h:1168
TDS_INT date
date, 0 = 1900-01-01
Definition: tds.h:145
bool tds_set_server(TDSLOGIN *tds_login, const char *server) TDS_WUR
Set the servername in a TDSLOGIN structure.
Definition: login.c:122
unsigned in_len
input buffer length
Definition: tds.h:1184
Definition: tds.h:661
TDS_INT ret_status
return status from store procedure
Definition: tds.h:1216
unsigned char tds_get_byte(TDSSOCKET *tds)
Return a single byte from the input buffer.
Definition: read.c:72
final result set, command completed successfully.
Definition: tds.h:246
TDS_INT day
day of month (1-31)
Definition: tds.h:160
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:310
Definition: tds.h:599
cilent is waiting for data
Definition: tds.h:815
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:334
TDS_SMALLINT offset
time offset
Definition: tds.h:146
size_t tds_quote_id(TDSSOCKET *tds, char *buffer, const char *id, int idlen)
Quote an id.
Definition: query.c:2269
struct tds_dynamic TDSDYNAMIC
Holds information for a dynamic (also called prepared) query.
TDS_TINYINT column_prec
precision for decimal/numeric
Definition: tds.h:728
unsigned char canonic
internal numeric index into array of all encodings
Definition: tds.h:642
int tds_get_size_by_type(int servertype)
Return the number of bytes needed by specified type.
Definition: tds_types.h:9
TDSRET tds_process_cancel(TDSSOCKET *tds)
Definition: token.c:2445
TDSDYNAMIC * dyns
list of dynamic allocated for this connection contains only dynamic allocated on the server ...
Definition: tds.h:1107
void tds_set_param_type(TDSCONNECTION *conn, TDSCOLUMN *curcol, TDS_SERVER_TYPE type)
Set type of column initializing all dependency.
Definition: data.c:247
client is reading data
Definition: tds.h:816
char * cursor_name
name of the cursor
Definition: tds.h:962
void tdsdump_off(void)
Temporarily turn off logging.
Definition: log.c:75
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:184
count field in packet is valid
Definition: tds.h:251
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:1023
no connection
Definition: tds.h:817
TDS_INT quarter
quarter (0-3)
Definition: tds.h:158
Definition: tds.h:518
tds_end
Flags returned in TDS_DONE token.
Definition: tds.h:244
TDSRET tds_get_char_data(TDSSOCKET *tds, char *dest, size_t wire_size, TDSCOLUMN *curcol)
Fetch character data the wire.
Definition: read.c:213
TDS_TINYINT emulated
this dynamic query cannot be prepared so libTDS have to construct a simple query. ...
Definition: tds.h:1015
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:1093
int tds_iconv_alloc(TDSCONNECTION *conn)
Allocate iconv stuff.
Definition: iconv.c:265
struct tds_compiletime_settings TDS_COMPILETIME_SETTINGS
A structure to hold all the compile-time settings.
TDS_STATE tds_set_state(TDSSOCKET *tds, TDS_STATE state)
Set state of TDS connection, with logging and checking.
Definition: util.c:58
DSTR password
password of account login
Definition: tds.h:557
TDS_TINYINT defer_close
true if cursor was marker to be closed when connection is idle
Definition: tds.h:968
int tds_read_packet(TDSSOCKET *tds)
Read in one 'packet' from the server.
Definition: packet.c:530
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:397
Information about blobs (e.g.
Definition: tds.h:610
char * charset
character set encoding
Definition: tds.h:990
TDS_INT column_cur_size
size written in variable (ie: char, text, binary).
Definition: tds.h:760
TDS_UINT8 time
time, 7 digit precision
Definition: tds.h:144
TDSDYNAMIC * tds_lookup_dynamic(TDSCONNECTION *conn, const char *id)
Finds a dynamic given string id.
Definition: token.c:2478
no data expected
Definition: tds.h:812
TDS_INT ref_count
reference counter so client can retain safely a pointer
Definition: tds.h:1001
Definition: tds.h:645
TDSRET tds_submit_query(TDSSOCKET *tds, const char *query)
tds_submit_query() sends a language string to the database server for processing. ...
Definition: query.c:205
unsigned in_pos
current position in in_buf
Definition: tds.h:1182
int tds7_get_instance_port(struct addrinfo *addr, const char *instance)
Get port of given instance.
Definition: net.c:943
struct tds_dstr * DSTR
Structure to hold a string.
TDSLOCALE * tds_get_locale(void)
Get locale information.
Definition: locale.c:50
int tdsdump_open(const char *filename)
Create and truncate a human readable dump file for the TDS traffic.
Definition: log.c:111
int tds_getservice(const char *name)
Return service port given the name.
Definition: threadsafe.c:343
TDSRET tds_deferred_unprepare(TDSCONNECTION *conn, TDSDYNAMIC *dyn)
Unprepare dynamic on idle.
Definition: query.c:1863
void tdsdump_close(void)
Close the TDS dump log file.
Definition: log.c:192
int port
port of database service
Definition: tds.h:542
more results follow
Definition: tds.h:247
TDSLOGIN * tds_init_login(TDSLOGIN *login, TDSLOCALE *locale)
Initialize login structure with locale information and other stuff for connection.
Definition: mem.c:786
TDS_UINT8 tds_get_uint8(TDSSOCKET *tds)
Get an uint64 from the server.
Definition: read.c:148
unsigned int out_buf_max
Maximum size of packet pointed by out_buf.
Definition: tds.h:1181
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:2645
void * tds_alloc_param_data(TDSCOLUMN *curparam)
Allocate data for a parameter.
Definition: mem.c:356
TDS_INT hour
0-23
Definition: tds.h:163
int tds_socket_set_nonblocking(TDS_SYS_SOCKET sock)
Set socket to non-blocking.
Definition: net.c:150
Definition: proto.h:25
void tdsdump_log(const char *file, unsigned int level_line, const char *fmt,...)
Write a message to the debug log.
Definition: log.c:353
TDSRET tds_flush_packet(TDSSOCKET *tds)
Flush packet to server.
Definition: write.c:285
Metadata about columns in regular and compute rows.
Definition: tds.h:713
acknowledging an attention command (usually a cancel)
Definition: tds.h:252
TDSRET tds71_submit_prepexec(TDSSOCKET *tds, const char *query, const char *id, TDSDYNAMIC **dyn_out, TDSPARAMINFO *params)
tds71_submit_prepexec() creates a temporary stored procedure in the server.
Definition: query.c:1458
TDS_INT timezone
-840 - 840 minutes from UTC
Definition: tds.h:167
size_t tds_quote_string(TDSSOCKET *tds, char *buffer, const char *str, int len)
Quote a string.
Definition: query.c:2313
TDSRET tds_submit_prepare(TDSSOCKET *tds, const char *query, const char *id, TDSDYNAMIC **dyn_out, TDSPARAMINFO *params)
tds_submit_prepare() creates a temporary stored procedure in the server.
Definition: query.c:1172
TDS_INT type
row fetched from this cursor
Definition: tds.h:978
Current environment as reported by the server.
Definition: tds.h:984
SQL server server error.
Definition: tds.h:254
int tds_goodwrite(TDSSOCKET *tds, const unsigned char *buffer, size_t buflen)
Definition: net.c:702
TDS_INT year
year
Definition: tds.h:157
void tds_close_socket(TDSSOCKET *tds)
Close current socket for last socket close entire connection for MARS send FIN request.
Definition: net.c:340
TDSPARAMINFO * params
query parameters.
Definition: tds.h:1029
DSTR db_filename
database filename to attach (MSSQL)
Definition: tds.h:552
TDS_INT decimicrosecond
0-9999999
Definition: tds.h:166
struct tds_env TDSENV
Current environment as reported by the server.
const char * tds_skip_quoted(const char *s)
Skip quoting string (like 'sfsf', "dflkdj" or [dfkjd])
Definition: query.c:534
void tdsdump_col(const TDSCOLUMN *col)
Write a column value to the debug log.
Definition: log.c:407
Definition: thread.h:237
Definition: iconv.h:91
Definition: tds.h:323
TDS_USMALLINT * tds_config_verstr(const char *tdsver, TDSLOGIN *login)
Set TDS version from given string.
Definition: config.c:882
TDSRET tds_submit_execute(TDSSOCKET *tds, TDSDYNAMIC *dyn)
tds_submit_execute() sends a previously prepared dynamic statement to the server. ...
Definition: query.c:1728
TDS_INT cursor_id
cursor id returned by the server after cursor declare
Definition: tds.h:963
TDS_CURSOR_STATUS status
cursor parameter
Definition: tds.h:975
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:93
TDS_INT month
month number (0-11)
Definition: tds.h:159
int tds_get_conversion_type(int srctype, int colsize)
Return type suitable for conversions (convert all nullable types to fixed type)
Definition: tds_types.h:125
TDSCURSOR * cur_cursor
cursor in use
Definition: tds.h:1213
TDSRET tds_submit_queryf(TDSSOCKET *tds, const char *queryf,...)
Format and submit a query.
Definition: query.c:486
TDS_INT dayofyear
day of year (1-366)
Definition: tds.h:161
TDSRET tds_cursor_dealloc(TDSSOCKET *tds, TDSCURSOR *cursor)
Send a deallocation request to server.
Definition: query.c:3082
TDSRET tds_bcp_done(TDSSOCKET *tds, int *rows_copied)
Tell we finished sending BCP data to server.
Definition: bulk.c:785
TDSRET tds_submit_begin_tran(TDSSOCKET *tds)
Send a rollback request.
Definition: query.c:3695
Definition: tds.h:1583
struct tds_cursor * next
next in linked list, keep first
Definition: tds.h:960
TDS_INT column_size
maximun size of data.
Definition: tds.h:719
Definition: tds.h:1068
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:398
TDSRET tds_bcp_start(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Start sending BCP data to server.
Definition: bulk.c:815
DSTR * tds_dstr_get(TDSSOCKET *tds, DSTR *s, size_t len)
Reads a string from wire and put in a DSTR.
Definition: read.c:313
DSTR user_name
account for login
Definition: tds.h:556
TDS_TINYINT column_type
This type can be different from wire type because conversion (e.g.
Definition: tds.h:721
Used by tds_datecrack.
Definition: tds.h:155
TDS_SYS_SOCKET s
tcp socket, INVALID_SOCKET if not connected
Definition: tds.h:1091
unsigned out_pos
current position in out_buf
Definition: tds.h:1183
TDSDYNAMIC * tds_alloc_dynamic(TDSCONNECTION *conn, const char *id)
Allocate a dynamic statement.
Definition: mem.c:154
TDSRET tds_bcp_init(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Initialize BCP information.
Definition: bulk.c:82
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:1300
Store variant informations.
Definition: tds.h:621
size_t tds_fix_column_size(TDSSOCKET *tds, TDSCOLUMN *curcol)
Get column size for wire.
Definition: query.c:1553
Information relevant to libiconv.
Definition: tds.h:635
struct tds_encoding TDS_ENCODING
Information relevant to libiconv.
int tds_write_dump
Tell if TDS debug logging is turned on or off.
Definition: log.c:57
TDS_TINYINT options
read only|updatable TODO use it
Definition: tds.h:964
Hold information for any results.
Definition: tds.h:790
int tds_count_placeholders(const char *query)
Count the number of placeholders in query.
Definition: query.c:590
TDSRET tds_submit_rollback(TDSSOCKET *tds, int cont)
Send a rollback request.
Definition: query.c:3723
const char * tds_prtype(int token)
Returns string representation of the given type.
Definition: token.c:2942
Holds information for a dynamic (also called prepared) query.
Definition: tds.h:998
struct tds_blob TDSBLOB
Information about blobs (e.g.
char * tds_get_homedir(void)
Get user home directory.
Definition: threadsafe.c:411
TDS_INT8 rows_affected
rows updated/deleted/inserted/selected, TDS_NO_COUNT if not valid
Definition: tds.h:1222
TDS_USMALLINT tds_get_usmallint(TDSSOCKET *tds)
Get an int16 from the server.
Definition: read.c:113
int tds7_get_instance_ports(FILE *output, struct addrinfo *addr)
Get port of all instances.
Definition: net.c:808
int tds_needs_unprepare(TDSCONNECTION *conn, TDSDYNAMIC *dyn)
Check if dynamic request must be unprepared.
Definition: query.c:1841
client would send data
Definition: tds.h:814
TDSRET tds_datecrack(TDS_INT datetype, const void *di, TDSDATEREC *dr)
Convert from db date format to a structured date format.
Definition: convert.c:3129
TDS_TINYINT column_scale
scale for decimal/numeric
Definition: tds.h:729
void tds_detach_results(TDSRESULTINFO *info)
Detach result info from it current socket.
Definition: mem.c:482
TDSPACKET * send_packet
packet we are preparing to send
Definition: tds.h:1201
TDS_TINYINT column_varint_size
size of length when reading from wire (0, 1, 2 or 4)
Definition: tds.h:726
void tds_free_param_result(TDSPARAMINFO *param_info)
Delete latest parameter.
Definition: mem.c:312
TDSRET tds_submit_unprepare(TDSSOCKET *tds, TDSDYNAMIC *dyn)
Send a unprepare request for a prepared query.
Definition: query.c:1886
TDSPARAMINFO * res_info
query results
Definition: tds.h:1021
TDS_INT minute
0-59
Definition: tds.h:164
TDSRET tds_deferred_cursor_dealloc(TDSCONNECTION *conn, TDSCURSOR *cursor)
Deallocate cursor on idle.
Definition: query.c:3133
tds_func_put_info_len * put_info_len
Returns metadata column information size.
Definition: tds.h:671
TDSRET tds_submit_rpc(TDSSOCKET *tds, const char *rpc_name, TDSPARAMINFO *params, TDSHEADERS *head)
tds_submit_rpc() call a RPC from server.
Definition: query.c:2020
DSTR crlfile
certificate revocation file
Definition: tds.h:554
const char * tds_next_placeholder(const char *start)
Get position of next placeholder.
Definition: query.c:554
DSTR new_password
new password to set (TDS 7.2+)
Definition: tds.h:558
TDSRET tds_submit_query_params(TDSSOCKET *tds, const char *query, TDSPARAMINFO *params, TDSHEADERS *head)
tds_submit_query_params() sends a language string to the database server for processing.
Definition: query.c:361
int 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:496
Definition: tds.h:1076
DSTR server_charset
charset of server e.g.
Definition: tds.h:546
Definition: tds.h:526
TDSRET tds_process_login_tokens(TDSSOCKET *tds)
tds_process_login_tokens() is called after sending the login packet to the server.
Definition: token.c:279
results are from a stored procedure
Definition: tds.h:250
TDS_INT weekday
day of week (0-6, 0 = sunday)
Definition: tds.h:162
tds_bcp_directions
bcp direction
Definition: tds.h:1576
struct addrinfo * ip_addrs
ip(s) of server
Definition: tds.h:568
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:1226
DSTR server_spn
server SPN (in freetds.conf)
Definition: tds.h:551
unsigned int pending_close
true is connection has pending closing (cursors or dynamic)
Definition: tds.h:1119
struct tds_dynamic * next
next in linked list, keep first
Definition: tds.h:1000
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
char * tds_timestamp_str(char *str, int maxlen)
Definition: threadsafe.c:101
char * query
SQL query.
Definition: tds.h:969
TDS_TINYINT has_status
true is ret_status is valid
Definition: tds.h:1215
TDSDYNAMIC * cur_dyn
dynamic structure in use
Definition: tds.h:1225
TDS_INT cursor_rows
< number of updatable columns
Definition: tds.h:973
DSTR server_name
server name (in freetds.conf)
Definition: tds.h:541
void tdsdump_dump_buf(const char *file, unsigned int level_line, const char *msg, const void *buf, size_t length)
Dump the contents of data into the log file in a human readable format.
Definition: log.c:255
TDSLOGIN * login
config for login stuff.
Definition: tds.h:1227
A structure to hold all the compile-time settings.
Definition: tds.h:72
TDS_UINT tds_get_uint(TDSSOCKET *tds)
Get an int32 from the server.
Definition: read.c:131
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:1131
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:1219
Definition: tds.h:913
client is writing data
Definition: tds.h:813
struct tds_result_info TDSRESULTINFO
Hold information for any results.
TDSRET tds_submit_execdirect(TDSSOCKET *tds, const char *query, TDSPARAMINFO *params, TDSHEADERS *head)
Submit a prepared query with parameters.
Definition: query.c:1311