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