FreeTDS API
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 /* configurable cipher suite to send to openssl's SSL_set_cipher_list() function */
523 #define TLS_STR_OPENSSL_CIPHERS "openssl ciphers"
524 
525 
526 /* TODO do a better check for alignment than this */
527 typedef union
528 {
529  void *p;
530  int i;
531  TDS_INT8 ui;
533 
534 #define TDS_ALIGN_SIZE sizeof(tds_align_struct)
535 
536 typedef struct tds_capability_type
537 {
538  unsigned char type;
539  unsigned char len; /* always sizeof(values) */
540  unsigned char values[TDS_MAX_CAPABILITY/2-2];
542 
543 typedef struct tds_capabilities
544 {
545  TDS_CAPABILITY_TYPE types[2];
547 
548 #define TDS_MAX_LOGIN_STR_SZ 128
549 typedef struct tds_login
550 {
552  int port;
553  TDS_USMALLINT tds_version;
554  int block_size;
555  DSTR language; /* e.g. us-english */
557  TDS_INT connect_timeout;
558  DSTR client_host_name;
559  DSTR server_host_name;
565  DSTR openssl_ciphers;
566  DSTR app_name;
571  DSTR library; /* Ct-Library, DB-Library, TDS-Library or ODBC */
572  TDS_TINYINT encryption_level;
573 
574  TDS_INT query_timeout;
575  TDS_CAPABILITIES capabilities;
576  DSTR client_charset;
577  DSTR database;
578 
579  struct addrinfo *ip_addrs;
580  struct addrinfo *connected_addr; /* ip of connected server */
581  DSTR instance_name;
582  DSTR dump_file;
583  int debug_flags;
584  int text_size;
585 
586  unsigned char option_flag2;
587 
588  unsigned int bulk_copy:1;
589  unsigned int suppress_language:1;
590  unsigned int emul_little_endian:1;
591  unsigned int gssapi_use_delegation:1;
592  unsigned int use_ntlmv2:1;
593  unsigned int use_lanman:1;
594  unsigned int mars:1;
595  unsigned int use_utf16:1;
596  unsigned int use_new_password:1;
597  unsigned int valid_configuration:1;
598  unsigned int check_ssl_hostname:1;
599  unsigned int readonly_intent:1;
600 } TDSLOGIN;
601 
602 typedef struct tds_headers
603 {
604  const char *qn_options;
605  const char *qn_msgtext;
606  TDS_INT qn_timeout;
607  /* TDS 7.4+: trace activity ID char[20] */
608 } TDSHEADERS;
609 
610 typedef struct tds_locale
611 {
612  char *language;
613  char *server_charset;
614  char *date_fmt;
615 } TDSLOCALE;
616 
621 typedef struct tds_blob
622 {
623  TDS_CHAR *textvalue;
624  TDS_CHAR textptr[16];
625  TDS_CHAR timestamp[8];
626  unsigned char valid_ptr;
627 } TDSBLOB;
628 
632 typedef struct tds_variant
633 {
634  /* this MUST have same position and place of textvalue in tds_blob */
635  TDS_CHAR *data;
636  TDS_INT size;
637  TDS_INT data_len;
638  TDS_SERVER_TYPE type;
639  TDS_UCHAR collation[5];
640 } TDSVARIANT;
641 
646 typedef struct tds_encoding
647 {
649  const char *name;
650  unsigned char min_bytes_per_char;
651  unsigned char max_bytes_per_char;
653  unsigned char canonic;
654 } TDS_ENCODING;
655 
656 typedef struct tds_bcpcoldata
657 {
658  TDS_UCHAR *data;
659  TDS_INT datalen;
660  TDS_INT is_null;
661 } BCPCOLDATA;
662 
663 
664 typedef TDSRET tds_func_get_info(TDSSOCKET *tds, TDSCOLUMN *col);
665 typedef TDSRET tds_func_get_data(TDSSOCKET *tds, TDSCOLUMN *col);
666 typedef TDS_INT tds_func_row_len(TDSCOLUMN *col);
667 typedef unsigned tds_func_put_info_len(TDSSOCKET *tds, TDSCOLUMN *col);
668 typedef TDSRET tds_func_put_info(TDSSOCKET *tds, TDSCOLUMN *col);
669 typedef TDSRET tds_func_put_data(TDSSOCKET *tds, TDSCOLUMN *col, int bcp7);
670 typedef int tds_func_check(const TDSCOLUMN *col);
671 
672 typedef struct tds_column_funcs
673 {
674  tds_func_get_info *get_info;
675  tds_func_get_data *get_data;
676  tds_func_row_len *row_len;
682  tds_func_put_info_len *put_info_len;
688  tds_func_put_info *put_info;
698  tds_func_put_data *put_data;
699 #if ENABLE_EXTRA_CHECKS
700 
714  tds_func_check *check;
715 #endif
716 #if 0
717  TDSRET (*convert)(TDSSOCKET *tds, TDSCOLUMN *col);
718 #endif
720 
725 {
726  const TDSCOLUMNFUNCS *funcs;
727  TDS_INT column_usertype;
728  TDS_INT column_flags;
729 
730  TDS_INT column_size;
732  TDS_SERVER_TYPE column_type;
737  TDS_TINYINT column_varint_size;
739  TDS_TINYINT column_prec;
740  TDS_TINYINT column_scale;
742  struct
743  {
744  TDS_SERVER_TYPE column_type;
745  TDS_INT column_size;
746  } on_server;
747 
750  DSTR table_name;
751  DSTR column_name;
752  DSTR table_column_name;
753 
754  unsigned char *column_data;
755  void (*column_data_free)(struct tds_column *column);
756  unsigned int column_nullable:1;
757  unsigned int column_writeable:1;
758  unsigned int column_identity:1;
759  unsigned int column_key:1;
760  unsigned int column_hidden:1;
761  unsigned int column_output:1;
762  unsigned int column_timestamp:1;
763  TDS_UCHAR column_collation[5];
764 
765  /* additional fields flags for compute results */
766  TDS_TINYINT column_operator;
767  TDS_SMALLINT column_operand;
768 
769  /* FIXME this is data related, not column */
772 
773  /* related to binding or info stored by client libraries */
774  /* FIXME find a best place to store these data, some are unused */
775  TDS_SMALLINT column_bindtype;
776  TDS_SMALLINT column_bindfmt;
777  TDS_UINT column_bindlen;
778  TDS_SMALLINT *column_nullbind;
779  TDS_CHAR *column_varaddr;
780  TDS_INT *column_lenbind;
781  TDS_INT column_textpos;
782  TDS_INT column_text_sqlgetdatapos;
783  TDS_CHAR column_text_sqlputdatainfo;
784 
785  BCPCOLDATA *bcp_column_data;
794  TDS_INT bcp_prefix_len;
795  TDS_INT bcp_term_len;
796  TDS_CHAR *bcp_terminator;
797 };
798 
799 
801 typedef struct tds_result_info
802 {
803  /* TODO those fields can became a struct */
804  TDSCOLUMN **columns;
805  TDS_USMALLINT num_cols;
806  TDS_USMALLINT computeid;
807  TDS_INT ref_count;
808  TDSSOCKET *attached_to;
809  unsigned char *current_row;
810  void (*row_free)(struct tds_result_info* result, unsigned char *row);
811  TDS_INT row_size;
812 
813  TDS_SMALLINT *bycolumns;
814  TDS_USMALLINT by_cols;
815  TDS_TINYINT rows_exist;
816  /* TODO remove ?? used only in dblib */
817  TDS_TINYINT more_results;
818 } TDSRESULTINFO;
819 
821 typedef enum tds_states
822 {
829 } TDS_STATE;
830 
831 typedef enum tds_operations
832 {
833  TDS_OP_NONE = 0,
834 
835  /* mssql operations */
836  TDS_OP_CURSOR = TDS_SP_CURSOR,
837  TDS_OP_CURSOROPEN = TDS_SP_CURSOROPEN,
838  TDS_OP_CURSORPREPARE = TDS_SP_CURSORPREPARE,
839  TDS_OP_CURSOREXECUTE = TDS_SP_CURSOREXECUTE,
840  TDS_OP_CURSORPREPEXEC = TDS_SP_CURSORPREPEXEC,
841  TDS_OP_CURSORUNPREPARE = TDS_SP_CURSORUNPREPARE,
842  TDS_OP_CURSORFETCH = TDS_SP_CURSORFETCH,
843  TDS_OP_CURSOROPTION = TDS_SP_CURSOROPTION,
844  TDS_OP_CURSORCLOSE = TDS_SP_CURSORCLOSE,
845  TDS_OP_EXECUTESQL = TDS_SP_EXECUTESQL,
846  TDS_OP_PREPARE = TDS_SP_PREPARE,
847  TDS_OP_EXECUTE = TDS_SP_EXECUTE,
848  TDS_OP_PREPEXEC = TDS_SP_PREPEXEC,
849  TDS_OP_PREPEXECRPC = TDS_SP_PREPEXECRPC,
850  TDS_OP_UNPREPARE = TDS_SP_UNPREPARE,
851 
852  /* sybase operations */
853  TDS_OP_DYN_DEALLOC = 100,
854 } TDS_OPERATION;
855 
856 #define TDS_DBG_LOGIN __FILE__, ((__LINE__ << 4) | 11)
857 #define TDS_DBG_HEADER __FILE__, ((__LINE__ << 4) | 10)
858 #define TDS_DBG_FUNC __FILE__, ((__LINE__ << 4) | 7)
859 #define TDS_DBG_INFO2 __FILE__, ((__LINE__ << 4) | 6)
860 #define TDS_DBG_INFO1 __FILE__, ((__LINE__ << 4) | 5)
861 #define TDS_DBG_NETWORK __FILE__, ((__LINE__ << 4) | 4)
862 #define TDS_DBG_WARN __FILE__, ((__LINE__ << 4) | 3)
863 #define TDS_DBG_ERROR __FILE__, ((__LINE__ << 4) | 2)
864 #define TDS_DBG_SEVERE __FILE__, ((__LINE__ << 4) | 1)
865 
866 #define TDS_DBGFLAG_FUNC 0x80
867 #define TDS_DBGFLAG_INFO2 0x40
868 #define TDS_DBGFLAG_INFO1 0x20
869 #define TDS_DBGFLAG_NETWORK 0x10
870 #define TDS_DBGFLAG_WARN 0x08
871 #define TDS_DBGFLAG_ERROR 0x04
872 #define TDS_DBGFLAG_SEVERE 0x02
873 #define TDS_DBGFLAG_ALL 0xfff
874 #define TDS_DBGFLAG_LOGIN 0x0800
875 #define TDS_DBGFLAG_HEADER 0x0400
876 #define TDS_DBGFLAG_PID 0x1000
877 #define TDS_DBGFLAG_TIME 0x2000
878 #define TDS_DBGFLAG_SOURCE 0x4000
879 #define TDS_DBGFLAG_THREAD 0x8000
880 
881 #if 0
882 
887 enum TDS_DBG_LOG_STATE
888 {
889  TDS_DBG_LOGIN = (1 << 0)
891  , TDS_DBG_API = (1 << 1)
892  , TDS_DBG_ASYNC = (1 << 2)
893  , TDS_DBG_DIAG = (1 << 3)
894  , TDS_DBG_error = (1 << 4)
895  /* TODO: ^^^^^ make upper case when old #defines (above) are removed */
896  /* Log FreeTDS runtime/logic error occurs. */
897  , TDS_DBG_PACKET = (1 << 5)
898  , TDS_DBG_LIBTDS = (1 << 6)
899  , TDS_DBG_CONFIG = (1 << 7)
900  , TDS_DBG_DEFAULT = 0xFE
901 };
902 #endif
903 
904 typedef struct tds_result_info TDSCOMPUTEINFO;
905 
907 
908 typedef struct tds_message
909 {
910  TDS_CHAR *server;
911  TDS_CHAR *message;
912  TDS_CHAR *proc_name;
913  TDS_CHAR *sql_state;
914  TDS_INT msgno;
915  TDS_INT line_number;
916  /* -1 .. 255 */
917  TDS_SMALLINT state;
918  TDS_TINYINT priv_msg_type;
919  TDS_TINYINT severity;
920  /* for library-generated errors */
921  int oserr;
922 } TDSMESSAGE;
923 
924 typedef struct tds_upd_col
925 {
926  struct tds_upd_col *next;
927  TDS_INT colnamelength;
928  char * columnname;
929 } TDSUPDCOL;
930 
931 typedef enum {
932  TDS_CURSOR_STATE_UNACTIONED = 0 /* initial value */
933  , TDS_CURSOR_STATE_REQUESTED = 1 /* called by ct_cursor */
934  , TDS_CURSOR_STATE_SENT = 2 /* sent to server */
935  , TDS_CURSOR_STATE_ACTIONED = 3 /* acknowledged by server */
936 } TDS_CURSOR_STATE;
937 
938 typedef struct tds_cursor_status
939 {
940  TDS_CURSOR_STATE declare;
941  TDS_CURSOR_STATE cursor_row;
942  TDS_CURSOR_STATE open;
943  TDS_CURSOR_STATE fetch;
944  TDS_CURSOR_STATE close;
945  TDS_CURSOR_STATE dealloc;
947 
948 typedef enum tds_cursor_operation
949 {
950  TDS_CURSOR_POSITION = 0,
951  TDS_CURSOR_UPDATE = 1,
952  TDS_CURSOR_DELETE = 2,
953  TDS_CURSOR_INSERT = 4
954 } TDS_CURSOR_OPERATION;
955 
956 typedef enum tds_cursor_fetch
957 {
958  TDS_CURSOR_FETCH_NEXT = 1,
959  TDS_CURSOR_FETCH_PREV,
960  TDS_CURSOR_FETCH_FIRST,
961  TDS_CURSOR_FETCH_LAST,
962  TDS_CURSOR_FETCH_ABSOLUTE,
963  TDS_CURSOR_FETCH_RELATIVE
964 } TDS_CURSOR_FETCH;
965 
969 typedef struct tds_cursor
970 {
971  struct tds_cursor *next;
972  TDS_INT ref_count;
973  char *cursor_name;
974  TDS_INT cursor_id;
975  TDS_TINYINT options;
979  TDS_TINYINT defer_close;
980  char *query;
981  /* TODO for updatable columns */
982  /* TDS_TINYINT number_upd_cols; */
983  /* TDSUPDCOL *cur_col_list; */
984  TDS_INT cursor_rows;
985  /* TDSPARAMINFO *params; */
987  TDS_USMALLINT srv_status;
988  TDSRESULTINFO *res_info;
989  TDS_INT type, concurrency;
990 } TDSCURSOR;
991 
995 typedef struct tds_env
996 {
999  char *language;
1001  char *charset;
1003  char *database;
1004 } TDSENV;
1005 
1009 typedef struct tds_dynamic
1010 {
1011  struct tds_dynamic *next;
1012  TDS_INT ref_count;
1014  TDS_INT num_id;
1020  char id[30];
1026  TDS_TINYINT emulated;
1030  TDS_TINYINT defer_close;
1031  /* int dyn_state; */ /* TODO use it */
1042  char *query;
1043 } TDSDYNAMIC;
1044 
1045 typedef enum {
1046  TDS_MULTIPLE_QUERY,
1047  TDS_MULTIPLE_EXECUTE,
1048  TDS_MULTIPLE_RPC
1049 } TDS_MULTIPLE_TYPE;
1050 
1051 typedef struct tds_multiple
1052 {
1053  TDS_MULTIPLE_TYPE type;
1054  unsigned int flags;
1055 } TDSMULTIPLE;
1056 
1057 /* forward declaration */
1058 typedef struct tds_context TDSCONTEXT;
1059 typedef int (*err_handler_t) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1060 
1062 {
1063  TDSLOCALE *locale;
1064  void *parent;
1065  /* handlers */
1066  int (*msg_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1067  int (*err_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
1068  int (*int_handler) (void *);
1069 };
1070 
1071 enum TDS_ICONV_ENTRY
1072 {
1073  client2ucs2
1074  , client2server_chardata
1075  , initial_char_conv_count /* keep last */
1076 };
1077 
1078 typedef struct tds_authentication
1079 {
1080  TDS_UCHAR *packet;
1081  int packet_len;
1082  TDSRET (*free)(TDSCONNECTION* conn, struct tds_authentication * auth);
1083  TDSRET (*handle_next)(TDSSOCKET * tds, struct tds_authentication * auth, size_t len);
1085 
1086 typedef struct tds_packet
1087 {
1088  struct tds_packet *next;
1089  short sid;
1090  unsigned len, capacity;
1091  unsigned char buf[1];
1092 } TDSPACKET;
1093 
1094 typedef struct tds_poll_wakeup
1095 {
1096  TDS_SYS_SOCKET s_signal, s_signaled;
1097 } TDSPOLLWAKEUP;
1098 
1099 /* field related to connection */
1101 {
1102  TDS_USMALLINT tds_version;
1103  TDS_UINT product_version;
1104  char *product_name;
1105 
1106  TDS_SYS_SOCKET s;
1107  TDSPOLLWAKEUP wakeup;
1108  const TDSCONTEXT *tds_ctx;
1109 
1112 
1123 
1124  int char_conv_count;
1125  TDSICONV **char_convs;
1126 
1127  TDS_UCHAR collation[5];
1128  TDS_UCHAR tds72_transaction[8];
1129 
1130  TDS_CAPABILITIES capabilities;
1131  unsigned int emul_little_endian:1;
1132  unsigned int use_iconv:1;
1133  unsigned int tds71rev1:1;
1134  unsigned int pending_close:1;
1135  unsigned int encrypt_single_packet:1;
1136 #if ENABLE_ODBC_MARS
1137  unsigned int mars:1;
1138 
1139  TDSSOCKET *in_net_tds;
1140  TDSPACKET *packets;
1141  TDSPACKET *recv_packet;
1142  TDSPACKET *send_packets;
1143  unsigned send_pos, recv_pos;
1144 
1145  tds_mutex list_mtx;
1146 #define BUSY_SOCKET ((TDSSOCKET*)(TDS_UINTPTR)1)
1147 #define TDSSOCKET_VALID(tds) (((TDS_UINTPTR)(tds)) > 1)
1148  struct tds_socket **sessions;
1149  unsigned num_sessions;
1150  unsigned num_cached_packets;
1151  TDSPACKET *packet_cache;
1152 #endif
1153 
1154  int spid;
1155  int client_spid;
1156 
1157  void *tls_session;
1158 #if defined(HAVE_GNUTLS)
1159  void *tls_credentials;
1160 #elif defined(HAVE_OPENSSL)
1161  void *tls_ctx;
1162 #else
1163  void *tls_dummy;
1164 #endif
1165  TDSAUTHENTICATION *authentication;
1166  char *server;
1167 };
1168 
1173 {
1174 #if ENABLE_ODBC_MARS
1175  TDSCONNECTION *conn;
1176 #else
1177  TDSCONNECTION conn[1];
1178 #endif
1179 
1185  unsigned char *in_buf;
1186 
1192  unsigned char *out_buf;
1193 
1198  unsigned int out_buf_max;
1199  unsigned in_pos;
1200  unsigned out_pos;
1201  unsigned in_len;
1202  unsigned char in_flag;
1203  unsigned char out_flag;
1205  void *parent;
1206 
1207 #if ENABLE_ODBC_MARS
1208  short sid;
1209  tds_condition packet_cond;
1210  TDS_UINT recv_seq;
1211  TDS_UINT send_seq;
1212  TDS_UINT recv_wnd;
1213  TDS_UINT send_wnd;
1214 #endif
1215  /* packet we received */
1216  TDSPACKET *recv_packet;
1219 
1226  TDSRESULTINFO *res_info;
1227  TDS_UINT num_comp_info;
1228  TDSCOMPUTEINFO **comp_info;
1229  TDSPARAMINFO *param_info;
1231  TDS_TINYINT bulk_query;
1232  TDS_TINYINT has_status;
1233  TDS_INT ret_status;
1234  TDS_STATE state;
1235  volatile
1236  unsigned char in_cancel;
1239  TDS_INT8 rows_affected;
1240  TDS_INT query_timeout;
1241 
1246  void (*env_chg_func) (TDSSOCKET * tds, int type, char *oldval, char *newval);
1247  TDS_OPERATION current_op;
1248 
1249  int option_value;
1250  tds_mutex wire_mtx;
1251 };
1252 
1253 #define tds_get_ctx(tds) ((tds)->conn->tds_ctx)
1254 #define tds_set_ctx(tds, val) do { ((tds)->conn->tds_ctx) = (val); } while(0)
1255 #define tds_get_parent(tds) ((tds)->parent)
1256 #define tds_set_parent(tds, val) do { ((tds)->parent) = (val); } while(0)
1257 #define tds_get_s(tds) ((tds)->conn->s)
1258 #define tds_set_s(tds, val) do { ((tds)->conn->s) = (val); } while(0)
1259 
1260 
1261 /* config.c */
1263 typedef void (*TDSCONFPARSE) (const char *option, const char *value, void *param);
1264 int tds_read_conf_section(FILE * in, const char *section, TDSCONFPARSE tds_conf_parse, void *parse_param);
1265 int tds_read_conf_file(TDSLOGIN * login, const char *server);
1266 void tds_parse_conf_section(const char *option, const char *value, void *param);
1267 TDSLOGIN *tds_read_config_info(TDSSOCKET * tds, TDSLOGIN * login, TDSLOCALE * locale);
1268 void tds_fix_login(TDSLOGIN* login);
1269 TDS_USMALLINT * tds_config_verstr(const char *tdsver, TDSLOGIN* login);
1270 struct addrinfo *tds_lookup_host(const char *servername);
1271 TDSRET tds_lookup_host_set(const char *servername, struct addrinfo **addr);
1272 const char *tds_addrinfo2str(struct addrinfo *addr, char *name, int namemax);
1273 
1274 TDSRET tds_set_interfaces_file_loc(const char *interfloc);
1275 extern const char STD_DATETIME_FMT[];
1276 int tds_parse_boolean(const char *value, int default_value);
1277 int tds_config_boolean(const char *option, const char *value, TDSLOGIN * login);
1278 
1279 TDSLOCALE *tds_get_locale(void);
1280 TDSRET tds_alloc_row(TDSRESULTINFO * res_info);
1281 TDSRET tds_alloc_compute_row(TDSCOMPUTEINFO * res_info);
1282 BCPCOLDATA * tds_alloc_bcp_column_data(unsigned int column_size);
1283 TDSDYNAMIC *tds_lookup_dynamic(TDSCONNECTION * conn, const char *id);
1284 /*@observer@*/ const char *tds_prtype(int token);
1285 int tds_get_varint_size(TDSCONNECTION * conn, int datatype);
1286 TDS_SERVER_TYPE tds_get_cardinal_type(TDS_SERVER_TYPE datatype, int usertype);
1287 
1288 
1289 /* iconv.c */
1290 TDSRET tds_iconv_open(TDSCONNECTION * conn, const char *charset, int use_utf16);
1291 void tds_iconv_close(TDSCONNECTION * conn);
1292 void tds_srv_charset_changed(TDSCONNECTION * conn, const char *charset);
1293 void tds7_srv_charset_changed(TDSCONNECTION * conn, int sql_collate, int lcid);
1294 int tds_iconv_alloc(TDSCONNECTION * conn);
1295 void tds_iconv_free(TDSCONNECTION * conn);
1296 TDSICONV *tds_iconv_from_collate(TDSCONNECTION * conn, TDS_UCHAR collate[5]);
1297 
1298 
1299 /* threadsafe.c */
1300 char *tds_timestamp_str(char *str, int maxlen);
1301 struct tm *tds_localtime_r(const time_t *timep, struct tm *result);
1302 struct hostent *tds_gethostbyname_r(const char *servername, struct hostent *result, char *buffer, int buflen, int *h_errnop);
1303 int tds_getservice(const char *name);
1304 char *tds_get_homedir(void);
1305 
1306 
1307 /* mem.c */
1308 void tds_free_socket(TDSSOCKET * tds);
1309 void tds_free_all_results(TDSSOCKET * tds);
1310 void tds_free_results(TDSRESULTINFO * res_info);
1311 void tds_free_param_results(TDSPARAMINFO * param_info);
1312 void tds_free_param_result(TDSPARAMINFO * param_info);
1313 void tds_free_msg(TDSMESSAGE * message);
1314 void tds_cursor_deallocated(TDSCONNECTION *conn, TDSCURSOR *cursor);
1315 void tds_release_cursor(TDSCURSOR **pcursor);
1316 void tds_free_bcp_column_data(BCPCOLDATA * coldata);
1317 TDSRESULTINFO *tds_alloc_results(TDS_USMALLINT num_cols);
1318 TDSCOMPUTEINFO **tds_alloc_compute_results(TDSSOCKET * tds, TDS_USMALLINT num_cols, TDS_USMALLINT by_cols);
1319 TDSCONTEXT *tds_alloc_context(void * parent);
1320 void tds_free_context(TDSCONTEXT * locale);
1322 void tds_free_input_params(TDSDYNAMIC * dyn);
1323 void tds_release_dynamic(TDSDYNAMIC ** dyn);
1324 static inline
1325 void tds_release_cur_dyn(TDSSOCKET * tds)
1326 {
1328 }
1329 void tds_dynamic_deallocated(TDSCONNECTION *conn, TDSDYNAMIC *dyn);
1330 void tds_set_cur_dyn(TDSSOCKET *tds, TDSDYNAMIC *dyn);
1331 TDSSOCKET *tds_realloc_socket(TDSSOCKET * tds, size_t bufsize);
1332 char *tds_alloc_client_sqlstate(int msgno);
1333 char *tds_alloc_lookup_sqlstate(TDSSOCKET * tds, int msgno);
1334 TDSLOGIN *tds_alloc_login(int use_environment);
1335 TDSDYNAMIC *tds_alloc_dynamic(TDSCONNECTION * conn, const char *id);
1336 void tds_free_login(TDSLOGIN * login);
1337 TDSLOGIN *tds_init_login(TDSLOGIN * login, TDSLOCALE * locale);
1338 TDSLOCALE *tds_alloc_locale(void);
1339 void *tds_alloc_param_data(TDSCOLUMN * curparam);
1340 void tds_free_locale(TDSLOCALE * locale);
1341 TDSCURSOR * tds_alloc_cursor(TDSSOCKET * tds, const char *name, TDS_INT namelen, const char *query, TDS_INT querylen);
1342 void tds_free_row(TDSRESULTINFO * res_info, unsigned char *row);
1343 TDSSOCKET *tds_alloc_socket(TDSCONTEXT * context, unsigned int bufsize);
1344 TDSSOCKET *tds_alloc_additional_socket(TDSCONNECTION *conn);
1345 void tds_set_current_results(TDSSOCKET *tds, TDSRESULTINFO *info);
1346 void tds_detach_results(TDSRESULTINFO *info);
1347 void * tds_realloc(void **pp, size_t new_size);
1348 #define TDS_RESIZE(p, n_elem) \
1349  tds_realloc((void **) &(p), sizeof(*(p)) * (size_t) (n_elem))
1350 #define tds_new(type, n) ((type *) malloc(sizeof(type) * (n)))
1351 #define tds_new0(type, n) ((type *) calloc(n, sizeof(type)))
1352 
1353 TDSPACKET *tds_alloc_packet(void *buf, unsigned len);
1354 TDSPACKET *tds_realloc_packet(TDSPACKET *packet, unsigned len);
1355 void tds_free_packets(TDSPACKET *packet);
1356 TDSBCPINFO *tds_alloc_bcpinfo(void);
1357 void tds_free_bcpinfo(TDSBCPINFO *bcpinfo);
1358 void tds_deinit_bcpinfo(TDSBCPINFO *bcpinfo);
1359 
1360 
1361 /* login.c */
1362 void tds_set_packet(TDSLOGIN * tds_login, int packet_size);
1363 void tds_set_port(TDSLOGIN * tds_login, int port);
1364 bool tds_set_passwd(TDSLOGIN * tds_login, const char *password) TDS_WUR;
1365 void tds_set_bulk(TDSLOGIN * tds_login, TDS_TINYINT enabled);
1366 bool tds_set_user(TDSLOGIN * tds_login, const char *username) TDS_WUR;
1367 bool tds_set_app(TDSLOGIN * tds_login, const char *application) TDS_WUR;
1368 bool tds_set_host(TDSLOGIN * tds_login, const char *hostname) TDS_WUR;
1369 bool tds_set_library(TDSLOGIN * tds_login, const char *library) TDS_WUR;
1370 bool tds_set_server(TDSLOGIN * tds_login, const char *server) TDS_WUR;
1371 bool tds_set_client_charset(TDSLOGIN * tds_login, const char *charset) TDS_WUR;
1372 bool tds_set_language(TDSLOGIN * tds_login, const char *language) TDS_WUR;
1373 void tds_set_version(TDSLOGIN * tds_login, TDS_TINYINT major_ver, TDS_TINYINT minor_ver);
1374 int tds_connect_and_login(TDSSOCKET * tds, TDSLOGIN * login);
1375 
1376 
1377 /* query.c */
1378 void tds_start_query(TDSSOCKET *tds, unsigned char packet_type);
1379 
1380 TDSRET tds_submit_query(TDSSOCKET * tds, const char *query);
1381 TDSRET tds_submit_query_params(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1382 TDSRET tds_submit_queryf(TDSSOCKET * tds, const char *queryf, ...);
1383 TDSRET tds_submit_prepare(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1384 TDSRET tds_submit_execdirect(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params, TDSHEADERS * head);
1385 TDSRET tds71_submit_prepexec(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
1386 TDSRET tds_submit_execute(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1387 TDSRET tds_send_cancel(TDSSOCKET * tds);
1388 const char *tds_next_placeholder(const char *start);
1389 int tds_count_placeholders(const char *query);
1390 int tds_needs_unprepare(TDSCONNECTION * conn, TDSDYNAMIC * dyn);
1391 TDSRET tds_deferred_unprepare(TDSCONNECTION * conn, TDSDYNAMIC * dyn);
1392 TDSRET tds_submit_unprepare(TDSSOCKET * tds, TDSDYNAMIC * dyn);
1393 TDSRET tds_submit_rpc(TDSSOCKET * tds, const char *rpc_name, TDSPARAMINFO * params, TDSHEADERS * head);
1394 TDSRET tds_submit_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD command, TDS_OPTION option, TDS_OPTION_ARG *param, TDS_INT param_size);
1395 TDSRET tds_submit_begin_tran(TDSSOCKET *tds);
1396 TDSRET tds_submit_rollback(TDSSOCKET *tds, int cont);
1397 TDSRET tds_submit_commit(TDSSOCKET *tds, int cont);
1398 TDSRET tds_disconnect(TDSSOCKET * tds);
1399 size_t tds_quote_id(TDSSOCKET * tds, char *buffer, const char *id, int idlen);
1400 size_t tds_quote_string(TDSSOCKET * tds, char *buffer, const char *str, int len);
1401 const char *tds_skip_comment(const char *s);
1402 const char *tds_skip_quoted(const char *s);
1403 size_t tds_fix_column_size(TDSSOCKET * tds, TDSCOLUMN * curcol);
1404 const char *tds_convert_string(TDSSOCKET * tds, TDSICONV * char_conv, const char *s, int len, size_t *out_len);
1405 void tds_convert_string_free(const char *original, const char *converted);
1406 #if !ENABLE_EXTRA_CHECKS
1407 #define tds_convert_string_free(original, converted) \
1408  do { if (original != converted) free((char*) converted); } while(0)
1409 #endif
1410 TDSRET tds_get_column_declaration(TDSSOCKET * tds, TDSCOLUMN * curcol, char *out);
1411 
1412 TDSRET tds_cursor_declare(TDSSOCKET * tds, TDSCURSOR * cursor, TDSPARAMINFO *params, int *send);
1413 TDSRET tds_cursor_setrows(TDSSOCKET * tds, TDSCURSOR * cursor, int *send);
1414 TDSRET tds_cursor_open(TDSSOCKET * tds, TDSCURSOR * cursor, TDSPARAMINFO *params, int *send);
1415 TDSRET tds_cursor_fetch(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_FETCH fetch_type, TDS_INT i_row);
1416 TDSRET tds_cursor_get_cursor_info(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_UINT * row_number, TDS_UINT * row_count);
1417 TDSRET tds_cursor_close(TDSSOCKET * tds, TDSCURSOR * cursor);
1418 TDSRET tds_cursor_dealloc(TDSSOCKET * tds, TDSCURSOR * cursor);
1419 TDSRET tds_deferred_cursor_dealloc(TDSCONNECTION *conn, TDSCURSOR * cursor);
1420 TDSRET tds_cursor_update(TDSSOCKET * tds, TDSCURSOR * cursor, TDS_CURSOR_OPERATION op, TDS_INT i_row, TDSPARAMINFO * params);
1421 TDSRET tds_cursor_setname(TDSSOCKET * tds, TDSCURSOR * cursor);
1422 
1423 TDSRET tds_multiple_init(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDS_MULTIPLE_TYPE type, TDSHEADERS * head);
1424 TDSRET tds_multiple_done(TDSSOCKET *tds, TDSMULTIPLE *multiple);
1425 TDSRET tds_multiple_query(TDSSOCKET *tds, TDSMULTIPLE *multiple, const char *query, TDSPARAMINFO * params);
1426 TDSRET tds_multiple_execute(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDSDYNAMIC * dyn);
1427 
1428 
1429 /* token.c */
1430 TDSRET tds_process_cancel(TDSSOCKET * tds);
1431 int tds_get_token_size(int marker);
1432 TDSRET tds_process_login_tokens(TDSSOCKET * tds);
1433 TDSRET tds_process_simple_query(TDSSOCKET * tds);
1434 int tds5_send_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD tds_command, TDS_OPTION tds_option, TDS_OPTION_ARG * tds_argument,
1435  TDS_INT * tds_argsize);
1436 TDSRET tds_process_tokens(TDSSOCKET * tds, /*@out@*/ TDS_INT * result_type, /*@out@*/ int *done_flags, unsigned flag);
1437 int determine_adjusted_size(const TDSICONV * char_conv, int size);
1438 
1439 
1440 /* data.c */
1441 void tds_set_param_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
1442 void tds_set_column_type(TDSCONNECTION * conn, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
1443 
1444 
1445 /* tds_convert.c */
1446 TDSRET tds_datecrack(TDS_INT datetype, const void *di, TDSDATEREC * dr);
1447 TDS_SERVER_TYPE tds_get_conversion_type(TDS_SERVER_TYPE srctype, int colsize);
1448 extern const char tds_hex_digits[];
1449 
1450 
1451 /* write.c */
1452 int tds_init_write_buf(TDSSOCKET * tds);
1453 int tds_put_n(TDSSOCKET * tds, const void *buf, size_t n);
1454 int tds_put_string(TDSSOCKET * tds, const char *buf, int len);
1455 int tds_put_int(TDSSOCKET * tds, TDS_INT i);
1456 int tds_put_int8(TDSSOCKET * tds, TDS_INT8 i);
1457 int tds_put_smallint(TDSSOCKET * tds, TDS_SMALLINT si);
1459 #define tds_put_tinyint(tds, ti) tds_put_byte(tds,ti)
1460 int tds_put_byte(TDSSOCKET * tds, unsigned char c);
1461 TDSRET tds_flush_packet(TDSSOCKET * tds);
1462 int tds_put_buf(TDSSOCKET * tds, const unsigned char *buf, int dsize, int ssize);
1463 
1464 
1465 /* read.c */
1466 unsigned char tds_get_byte(TDSSOCKET * tds);
1467 void tds_unget_byte(TDSSOCKET * tds);
1468 unsigned char tds_peek(TDSSOCKET * tds);
1469 TDS_USMALLINT tds_get_usmallint(TDSSOCKET * tds);
1470 #define tds_get_smallint(tds) ((TDS_SMALLINT) tds_get_usmallint(tds))
1471 TDS_UINT tds_get_uint(TDSSOCKET * tds);
1472 #define tds_get_int(tds) ((TDS_INT) tds_get_uint(tds))
1473 TDS_UINT8 tds_get_uint8(TDSSOCKET * tds);
1474 #define tds_get_int8(tds) ((TDS_INT8) tds_get_uint8(tds))
1475 size_t tds_get_string(TDSSOCKET * tds, size_t string_len, char *dest, size_t dest_size);
1476 TDSRET tds_get_char_data(TDSSOCKET * tds, char *dest, size_t wire_size, TDSCOLUMN * curcol);
1477 void *tds_get_n(TDSSOCKET * tds, /*@out@*/ /*@null@*/ void *dest, size_t n);
1478 int tds_get_size_by_type(TDS_SERVER_TYPE servertype);
1479 DSTR* tds_dstr_get(TDSSOCKET * tds, DSTR * s, size_t len);
1480 
1481 
1482 /* util.c */
1483 int tdserror (const TDSCONTEXT * tds_ctx, TDSSOCKET * tds, int msgno, int errnum);
1485 void tds_swap_bytes(void *buf, int bytes);
1486 #ifdef ENABLE_DEVELOPING
1487 unsigned int tds_gettime_ms(void);
1488 #endif
1489 char *tds_strndup(const void *s, TDS_INTPTR len);
1490 
1491 
1492 /* log.c */
1493 void tdsdump_off(void);
1494 void tdsdump_on(void);
1495 int tdsdump_isopen(void);
1496 #include <freetds/popvis.h>
1497 int tdsdump_open(const char *filename);
1498 #include <freetds/pushvis.h>
1499 void tdsdump_close(void);
1500 void tdsdump_dump_buf(const char* file, unsigned int level_line, const char *msg, const void *buf, size_t length);
1501 void tdsdump_col(const TDSCOLUMN *col);
1502 #undef tdsdump_log
1503 void tdsdump_log(const char* file, unsigned int level_line, const char *fmt, ...)
1504 #if defined(__GNUC__) && __GNUC__ >= 2
1505 #if defined(__MINGW32__)
1506  __attribute__ ((__format__ (ms_printf, 3, 4)))
1507 #else
1508  __attribute__ ((__format__ (__printf__, 3, 4)))
1509 #endif
1510 #endif
1511 ;
1512 #define TDSDUMP_LOG_FAST if (TDS_UNLIKELY(tds_write_dump)) tdsdump_log
1513 #define tdsdump_log TDSDUMP_LOG_FAST
1514 #define TDSDUMP_BUF_FAST if (TDS_UNLIKELY(tds_write_dump)) tdsdump_dump_buf
1515 #define tdsdump_dump_buf TDSDUMP_BUF_FAST
1516 
1517 extern int tds_write_dump;
1518 extern int tds_debug_flags;
1519 extern int tds_g_append_mode;
1520 
1521 
1522 /* net.c */
1523 TDSERRNO tds_open_socket(TDSSOCKET * tds, struct addrinfo *ipaddr, unsigned int port, int timeout, int *p_oserr);
1524 void tds_close_socket(TDSSOCKET * tds);
1525 int tds7_get_instance_ports(FILE *output, struct addrinfo *addr);
1526 int tds7_get_instance_port(struct addrinfo *addr, const char *instance);
1527 char *tds_prwsaerror(int erc);
1528 void tds_prwsaerror_free(char *s);
1529 int tds_connection_read(TDSSOCKET * tds, unsigned char *buf, int buflen);
1530 int tds_connection_write(TDSSOCKET *tds, const unsigned char *buf, int buflen, int final);
1531 #define TDSSELREAD POLLIN
1532 #define TDSSELWRITE POLLOUT
1533 int tds_select(TDSSOCKET * tds, unsigned tds_sel, int timeout_seconds);
1534 void tds_connection_close(TDSCONNECTION *conn);
1535 int tds_goodread(TDSSOCKET * tds, unsigned char *buf, int buflen);
1536 int tds_goodwrite(TDSSOCKET * tds, const unsigned char *buffer, size_t buflen);
1537 void tds_socket_flush(TDS_SYS_SOCKET sock);
1538 int tds_socket_set_nonblocking(TDS_SYS_SOCKET sock);
1539 int tds_wakeup_init(TDSPOLLWAKEUP *wakeup);
1540 void tds_wakeup_close(TDSPOLLWAKEUP *wakeup);
1541 void tds_wakeup_send(TDSPOLLWAKEUP *wakeup, char cancel);
1542 static inline TDS_SYS_SOCKET tds_wakeup_get_fd(const TDSPOLLWAKEUP *wakeup)
1543 {
1544  return wakeup->s_signaled;
1545 }
1546 
1547 
1548 /* packet.c */
1549 int tds_read_packet(TDSSOCKET * tds);
1550 TDSRET tds_write_packet(TDSSOCKET * tds, unsigned char final);
1551 #if ENABLE_ODBC_MARS
1552 int tds_append_cancel(TDSSOCKET *tds);
1553 TDSRET tds_append_fin(TDSSOCKET *tds);
1554 #else
1555 int tds_put_cancel(TDSSOCKET * tds);
1556 #endif
1557 
1558 
1559 /* vstrbuild.c */
1560 TDSRET tds_vstrbuild(char *buffer, int buflen, int *resultlen, const char *text, int textlen, const char *formats, int formatlen,
1561  va_list ap);
1562 
1563 
1564 /* numeric.c */
1565 char *tds_money_to_string(const TDS_MONEY * money, char *s);
1566 TDS_INT tds_numeric_to_string(const TDS_NUMERIC * numeric, char *s);
1567 TDS_INT tds_numeric_change_prec_scale(TDS_NUMERIC * numeric, unsigned char new_prec, unsigned char new_scale);
1568 
1569 
1570 /* getmac.c */
1571 void tds_getmac(TDS_SYS_SOCKET s, unsigned char mac[6]);
1572 
1573 
1574 /* challenge.c */
1575 #ifndef HAVE_SSPI
1577 TDSAUTHENTICATION * tds_gss_get_auth(TDSSOCKET * tds);
1578 #else
1579 TDSAUTHENTICATION * tds_sspi_get_auth(TDSSOCKET * tds);
1580 #endif
1581 
1582 
1583 /* random.c */
1584 void tds_random_buffer(unsigned char *out, int len);
1585 
1586 
1587 /* sec_negotiate.c */
1588 TDSAUTHENTICATION * tds5_negotiate_get_auth(TDSSOCKET * tds);
1589 void tds5_negotiate_set_msg_type(TDSSOCKET * tds, TDSAUTHENTICATION * auth, unsigned msg_type);
1590 
1591 
1592 /* bulk.c */
1593 
1596 {
1597  TDS_BCP_IN = 1,
1598  TDS_BCP_OUT = 2,
1599  TDS_BCP_QUERYOUT = 3
1600 };
1601 
1603 {
1604  const char *hint;
1605  void *parent;
1606  DSTR tablename;
1607  TDS_CHAR *insert_stmt;
1608  TDS_INT direction;
1609  TDS_INT identity_insert_on;
1610  TDS_INT xfer_init;
1611  TDS_INT bind_count;
1612  TDSRESULTINFO *bindinfo;
1613 };
1614 
1615 TDSRET tds_bcp_init(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1616 typedef TDSRET (*tds_bcp_get_col_data) (TDSBCPINFO *bulk, TDSCOLUMN *bcpcol, int offset);
1617 typedef void (*tds_bcp_null_error) (TDSBCPINFO *bulk, int index, int offset);
1618 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);
1619 TDSRET tds_bcp_done(TDSSOCKET *tds, int *rows_copied);
1620 TDSRET tds_bcp_start(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1621 TDSRET tds_bcp_start_copy_in(TDSSOCKET *tds, TDSBCPINFO *bcpinfo);
1622 
1623 TDSRET tds_bcp_fread(TDSSOCKET * tds, TDSICONV * conv, FILE * stream,
1624  const char *terminator, size_t term_len, char **outbuf, size_t * outbytes);
1625 
1626 TDSRET tds_writetext_start(TDSSOCKET *tds, const char *objname, const char *textptr, const char *timestamp, int with_log, TDS_UINT size);
1627 TDSRET tds_writetext_continue(TDSSOCKET *tds, const TDS_UCHAR *text, TDS_UINT size);
1628 TDSRET tds_writetext_end(TDSSOCKET *tds);
1629 
1630 
1631 static inline
1632 bool tds_capability_enabled(const TDS_CAPABILITY_TYPE *cap, unsigned cap_num)
1633 {
1634  return (cap->values[sizeof(cap->values)-1-(cap_num>>3)] >> (cap_num&7)) & 1;
1635 }
1636 #define tds_capability_has_req(conn, cap) \
1637  tds_capability_enabled(&conn->capabilities.types[0], cap)
1638 
1639 #define IS_TDS42(x) (x->tds_version==0x402)
1640 #define IS_TDS46(x) (x->tds_version==0x406)
1641 #define IS_TDS50(x) (x->tds_version==0x500)
1642 #define IS_TDS70(x) (x->tds_version==0x700)
1643 #define IS_TDS71(x) (x->tds_version==0x701)
1644 #define IS_TDS72(x) (x->tds_version==0x702)
1645 #define IS_TDS73(x) (x->tds_version==0x703)
1646 
1647 #define IS_TDS50_PLUS(x) ((x)->tds_version>=0x500)
1648 #define IS_TDS7_PLUS(x) ((x)->tds_version>=0x700)
1649 #define IS_TDS71_PLUS(x) ((x)->tds_version>=0x701)
1650 #define IS_TDS72_PLUS(x) ((x)->tds_version>=0x702)
1651 #define IS_TDS73_PLUS(x) ((x)->tds_version>=0x703)
1652 #define IS_TDS74_PLUS(x) ((x)->tds_version>=0x704)
1653 
1654 #define TDS_MAJOR(x) ((x)->tds_version >> 8)
1655 #define TDS_MINOR(x) ((x)->tds_version & 0xff)
1656 
1657 #define IS_TDSDEAD(x) (((x) == NULL) || (x)->state == TDS_DEAD)
1658 
1660 #define TDS_IS_SYBASE(x) (!((x)->conn->product_version & 0x80000000u))
1661 
1662 #define TDS_IS_MSSQL(x) (((x)->conn->product_version & 0x80000000u)!=0)
1663 
1667 #define TDS_MS_VER(maj,min,x) (0x80000000u|((maj)<<24)|((min)<<16)|(x))
1668 
1669 /* TODO test if not similar to ms one*/
1671 #define TDS_SYB_VER(maj,min,x) (((maj)<<24)|((min)<<16)|(x)<<8)
1672 
1673 #ifdef __cplusplus
1674 #if 0
1675 {
1676 #endif
1677 }
1678 #endif
1679 
1680 #include <freetds/popvis.h>
1681 
1682 #define TDS_PUT_INT(tds,v) tds_put_int((tds), ((TDS_INT)(v)))
1683 #define TDS_PUT_SMALLINT(tds,v) tds_put_smallint((tds), ((TDS_SMALLINT)(v)))
1684 #define TDS_PUT_BYTE(tds,v) tds_put_byte((tds), ((unsigned char)(v)))
1685 
1686 #endif /* _tds_h_ */
Definition: tds.h:938
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
int tds_goodwrite(TDSSOCKET *tds, const unsigned char *buffer, size_t buflen)
Definition: net.c:783
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
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
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_bcp_start(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Start sending BCP data to server.
Definition: bulk.c:815
int tds_read_conf_file(TDSLOGIN *login, const char *server)
Read configuration info for given server return 0 on error.
Definition: config.c:342
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:499
unsigned char * out_buf
Output buffer.
Definition: tds.h:1192
TDSRET tds_flush_packet(TDSSOCKET *tds)
Flush packet to server.
Definition: write.c:285
TDSRET tds_submit_unprepare(TDSSOCKET *tds, TDSDYNAMIC *dyn)
Send a unprepare request for a prepared query.
Definition: query.c:1890
int tds_goodread(TDSSOCKET *tds, unsigned char *buf, int buflen)
Loops until we have received some characters return -1 on failure.
Definition: net.c:712
void tds_fix_login(TDSLOGIN *login)
Fix configuration after reading it.
Definition: config.c:281
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:1236
Definition: tds.h:543
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
TDSRET tds_deferred_cursor_dealloc(TDSCONNECTION *conn, TDSCURSOR *cursor)
Deallocate cursor on idle.
Definition: query.c:3135
TDSRET tds_get_column_declaration(TDSSOCKET *tds, TDSCOLUMN *curcol, char *out)
Return declaration for column (like "varchar(20)")
Definition: query.c:729
Definition: tds.h:1602
Definition: tds.h:325
char * query
saved query, we need to know original query if prepare is impossible
Definition: tds.h:1042
TDS_INT type
row fetched from this cursor
Definition: tds.h:989
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
void tds_set_column_type(TDSCONNECTION *conn, TDSCOLUMN *curcol, TDS_SERVER_TYPE type)
Set type of column initializing all dependency.
Definition: data.c:225
Definition: tds.h:1094
Structure to hold a string.
Definition: tds.h:94
unsigned in_len
input buffer length
Definition: tds.h:1201
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_count_placeholders(const char *query)
Count the number of placeholders in query.
Definition: query.c:590
TDSRET tds_bcp_start_copy_in(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Start bulk copy to server.
Definition: bulk.c:862
Definition: tds.h:1061
char * charset
character set encoding
Definition: tds.h:1001
struct tds_cursor * next
next in linked list, keep first
Definition: tds.h:971
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_states
values for tds->state
Definition: tds.h:821
TDS_INT column_size
maximun size of data.
Definition: tds.h:730
void tds_close_socket(TDSSOCKET *tds)
Close current socket.
Definition: net.c:355
TDSRET tds_submit_execdirect(TDSSOCKET *tds, const char *query, TDSPARAMINFO *params, TDSHEADERS *head)
Submit a prepared query with parameters.
Definition: query.c:1311
int tdserror(const TDSCONTEXT *tds_ctx, TDSSOCKET *tds, int msgno, int errnum)
Call the client library&#39;s error handler (for library-generated errors only)
Definition: util.c:310
TDS_INT tds_numeric_to_string(const TDS_NUMERIC *numeric, char *s)
Definition: numeric.c:94
TDS_INT minute
0-59
Definition: tds.h:166
int block_size
packet size (512-65535)
Definition: tds.h:998
error occurred
Definition: tds.h:250
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
struct addrinfo * tds_lookup_host(const char *servername)
Get the IP address for a hostname.
Definition: config.c:960
int tds7_get_instance_port(struct addrinfo *addr, const char *instance)
Get port of given instance.
Definition: net.c:1025
const char * tds_skip_comment(const char *s)
Skip a comment in a query.
Definition: query.c:509
Definition: tds.h:536
Information for a server connection.
Definition: tds.h:1172
struct tds_result_info TDSRESULTINFO
Hold information for any results.
TDS_INT8 rows_affected
rows updated/deleted/inserted/selected, TDS_NO_COUNT if not valid
Definition: tds.h:1239
size_t tds_quote_string(TDSSOCKET *tds, char *buffer, const char *str, int len)
Quote a string.
Definition: query.c:2315
unsigned char out_flag
output buffer type
Definition: tds.h:1203
struct tds_variant TDSVARIANT
Store variant informations.
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
TDSRET tds_process_cancel(TDSSOCKET *tds)
Definition: token.c:2474
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
unsigned char in_flag
input buffer type
Definition: tds.h:1202
void tdsdump_off(void)
Temporarily turn off logging.
Definition: log.c:75
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:2677
void tds_detach_results(TDSRESULTINFO *info)
Detach result info from it current socket.
Definition: mem.c:484
TDS_STATE tds_set_state(TDSSOCKET *tds, TDS_STATE state)
Set state of TDS connection, with logging and checking.
Definition: util.c:58
void tds_free_param_result(TDSPARAMINFO *param_info)
Delete latest parameter.
Definition: mem.c:317
TDSRET tds_cursor_dealloc(TDSSOCKET *tds, TDSCURSOR *cursor)
Send a deallocation request to server.
Definition: query.c:3084
no connection
Definition: tds.h:828
int tds_iconv_alloc(TDSCONNECTION *conn)
Allocate iconv stuff.
Definition: iconv.c:265
Definition: tds.h:549
TDSRET tds_submit_execute(TDSSOCKET *tds, TDSDYNAMIC *dyn)
tds_submit_execute() sends a previously prepared dynamic statement to the server. ...
Definition: query.c:1732
char * query
SQL query.
Definition: tds.h:980
final result set, command completed successfully.
Definition: tds.h:248
TDSPARAMINFO * params
query parameters.
Definition: tds.h:1040
TDS_INT num_id
numeric id for mssql7+
Definition: tds.h:1014
TDS_UINT8 time
time, 7 digit precision
Definition: tds.h:146
TDSLOGIN * login
config for login stuff.
Definition: tds.h:1244
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
TDSPARAMINFO * res_info
query results
Definition: tds.h:1032
DSTR password
password of account login
Definition: tds.h:568
unsigned char canonic
internal numeric index into array of all encodings
Definition: tds.h:653
TDSRET tds_deferred_unprepare(TDSCONNECTION *conn, TDSDYNAMIC *dyn)
Unprepare dynamic on idle.
Definition: query.c:1867
const char * tds_skip_quoted(const char *s)
Skip quoting string (like &#39;sfsf&#39;, "dflkdj" or [dfkjd])
Definition: query.c:534
TDSRESULTINFO * current_results
Current query information.
Definition: tds.h:1225
struct tds_dstr * DSTR
Structure to hold a string.
size_t tds_quote_id(TDSSOCKET *tds, char *buffer, const char *id, int idlen)
Quote an id.
Definition: query.c:2271
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 char * in_buf
Input buffer.
Definition: tds.h:1185
TDS_INT year
year
Definition: tds.h:159
TDS_INT dayofyear
day of year (1-366)
Definition: tds.h:163
count field in packet is valid
Definition: tds.h:253
Information relevant to libiconv.
Definition: tds.h:646
unsigned char tds_peek(TDSSOCKET *tds)
Reads a byte from the TDS stream without removing it.
Definition: read.c:100
void tds_release_dynamic(TDSDYNAMIC **dyn)
Frees dynamic statement.
Definition: mem.c:250
cilent is waiting for data
Definition: tds.h:826
TDS_UINT product_version
version of product (Sybase/MS and full version)
Definition: tds.h:1103
acknowledging an attention command (usually a cancel)
Definition: tds.h:254
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:855
DSTR user_name
account for login
Definition: tds.h:567
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
TDSRET tds_writetext_end(TDSSOCKET *tds)
Finish sending writetext data.
Definition: bulk.c:1148
TDSRET tds_set_interfaces_file_loc(const char *interfloc)
Set the full name of interface file.
Definition: config.c:934
DSTR server_realm_name
server realm name (in freetds.conf)
Definition: tds.h:560
char * database
database name
Definition: tds.h:1003
TDS_SERVER_TYPE column_type
This type can be different from wire type because conversion (e.g.
Definition: tds.h:732
TDS_TINYINT column_scale
scale for decimal/numeric
Definition: tds.h:740
TDS_USMALLINT * tds_config_verstr(const char *tdsver, TDSLOGIN *login)
Set TDS version from given string.
Definition: config.c:891
void tds_set_cur_dyn(TDSSOCKET *tds, TDSDYNAMIC *dyn)
Set current dynamic.
Definition: query.c:187
void tdsdump_col(const TDSCOLUMN *col)
Write a column value to the debug log.
Definition: log.c:407
TDSLOCALE * tds_get_locale(void)
Get locale information.
Definition: locale.c:50
TDSRET tds_submit_begin_tran(TDSSOCKET *tds)
Send a rollback request.
Definition: query.c:3704
void tds_start_query(TDSSOCKET *tds, unsigned char packet_type)
Start query packet of a given type.
Definition: query.c:343
void tds_free_input_params(TDSDYNAMIC *dyn)
Frees all allocated input parameters of a dynamic statement.
Definition: mem.c:203
void tdsdump_on(void)
Turn logging back on.
Definition: log.c:87
TDS_USMALLINT tds_version
TDS version.
Definition: tds.h:553
Hold information for any results.
Definition: tds.h:801
size_t tds_fix_column_size(TDSSOCKET *tds, TDSCOLUMN *curcol)
Get column size for wire.
Definition: query.c:1557
TDSPARAMINFO * tds_alloc_param_result(TDSPARAMINFO *old_param)
Adds a output parameter to TDSPARAMINFO.
Definition: mem.c:281
more results follow
Definition: tds.h:249
TDS_INT ref_count
reference counter so client can retain safely a pointer
Definition: tds.h:1012
struct tds_dynamic * next
next in linked list, keep first
Definition: tds.h:1011
TDS_SMALLINT offset
time offset
Definition: tds.h:148
struct tds_compiletime_settings TDS_COMPILETIME_SETTINGS
A structure to hold all the compile-time settings.
TDSRET tds_bcp_done(TDSSOCKET *tds, int *rows_copied)
Tell we finished sending BCP data to server.
Definition: bulk.c:785
bool tds_set_server(TDSLOGIN *tds_login, const char *server) TDS_WUR
Set the servername in a TDSLOGIN structure.
Definition: login.c:122
TDS_INT day
day of month (1-31)
Definition: tds.h:162
struct tds_env TDSENV
Current environment as reported by the server.
DSTR cafile
certificate authorities file
Definition: tds.h:563
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
no data expected
Definition: tds.h:823
TDS_TINYINT has_status
true is ret_status is valid
Definition: tds.h:1232
TDSDYNAMIC * tds_alloc_dynamic(TDSCONNECTION *conn, const char *id)
Allocate a dynamic statement.
Definition: mem.c:157
DSTR server_name
server name (in freetds.conf)
Definition: tds.h:551
TDSDYNAMIC * dyns
list of dynamic allocated for this connection contains only dynamic allocated on the server ...
Definition: tds.h:1122
client is reading data
Definition: tds.h:827
TDSICONV * char_conv
refers to previously allocated iconv information
Definition: tds.h:748
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:3210
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
TDSAUTHENTICATION * tds_ntlm_get_auth(TDSSOCKET *tds)
Build a NTLMSPP packet to send to server.
Definition: challenge.c:690
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
Definition: tds.h:610
TDS_INT month
month number (0-11)
Definition: tds.h:161
struct tds_dynamic TDSDYNAMIC
Holds information for a dynamic (also called prepared) query.
DSTR new_password
new password to set (TDS 7.2+)
Definition: tds.h:569
Current environment as reported by the server.
Definition: tds.h:995
TDS_INT decimicrosecond
0-9999999
Definition: tds.h:168
const char * tds_next_placeholder(const char *start)
Get position of next placeholder.
Definition: query.c:554
TDS_CURSOR_STATUS status
cursor parameter
Definition: tds.h:986
unsigned char tds_get_byte(TDSSOCKET *tds)
Return a single byte from the input buffer.
Definition: read.c:72
void tdsdump_close(void)
Close the TDS dump log file.
Definition: log.c:192
struct tds_blob TDSBLOB
Information about blobs (e.g.
TDSPACKET * send_packet
packet we are preparing to send
Definition: tds.h:1218
TDS_TINYINT defer_close
true if cursor was marker to be closed when connection is idle
Definition: tds.h:979
const char * tds_prtype(int token)
Returns string representation of the given type.
Definition: token.c:2982
struct addrinfo * ip_addrs
ip(s) of server
Definition: tds.h:579
const char * name
name of the encoding (ie UTF-8)
Definition: tds.h:649
TDS_USMALLINT tds_get_usmallint(TDSSOCKET *tds)
Get an int16 from the server.
Definition: read.c:113
TDSENV env
environment is shared between all sessions
Definition: tds.h:1111
TDS_INT date
date, 0 = 1900-01-01
Definition: tds.h:147
void * tds_alloc_param_data(TDSCOLUMN *curparam)
Allocate data for a parameter.
Definition: mem.c:361
int tds_needs_unprepare(TDSCONNECTION *conn, TDSDYNAMIC *dyn)
Check if dynamic request must be unprepared.
Definition: query.c:1845
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
Definition: tds.h:672
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
Used by tds_datecrack.
Definition: tds.h:157
Definition: tds.h:1086
char * cursor_name
name of the cursor
Definition: tds.h:973
Store variant informations.
Definition: tds.h:632
TDSRET tds_submit_commit(TDSSOCKET *tds, int cont)
Send a commit request.
Definition: query.c:3763
Definition: proto.h:25
TDSRET tds_process_tokens(TDSSOCKET *tds, TDS_INT *result_type, int *done_flags, unsigned flag)
process all streams.
Definition: token.c:508
Definition: thread.h:255
Definition: tds.h:602
TDS_INT cursor_id
cursor id returned by the server after cursor declare
Definition: tds.h:974
SQL server server error.
Definition: tds.h:256
tds_bcp_directions
bcp direction
Definition: tds.h:1595
TDS_TINYINT options
read only|updatable TODO use it
Definition: tds.h:975
struct tds_encoding TDS_ENCODING
Information relevant to libiconv.
TDS_TINYINT emulated
this dynamic query cannot be prepared so libTDS have to construct a simple query. ...
Definition: tds.h:1026
int tds_write_dump
Tell if TDS debug logging is turned on or off.
Definition: log.c:57
tds_end
Flags returned in TDS_DONE token.
Definition: tds.h:246
TDSDYNAMIC * cur_dyn
dynamic structure in use
Definition: tds.h:1242
TDS_UINT8 tds_get_uint8(TDSSOCKET *tds)
Get an uint64 from the server.
Definition: read.c:148
TDS_SYS_SOCKET s
tcp socket, INVALID_SOCKET if not connected
Definition: tds.h:1106
int tds_get_size_by_type(TDS_SERVER_TYPE servertype)
Return the number of bytes needed by specified type.
Definition: tds_types.h:9
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_INT hour
0-23
Definition: tds.h:165
Definition: tds.h:924
TDS_TINYINT column_prec
precision for decimal/numeric
Definition: tds.h:739
TDS_INT timezone
-840 - 840 minutes from UTC
Definition: tds.h:169
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
TDS_TINYINT defer_close
true if dynamic was marker to be closed when connection is idle
Definition: tds.h:1030
TDSRET tds_submit_rollback(TDSSOCKET *tds, int cont)
Send a rollback request.
Definition: query.c:3732
Definition: iconv.h:91
int tds_select(TDSSOCKET *tds, unsigned tds_sel, int timeout_seconds)
Select on a socket until it&#39;s available or the timeout expires.
Definition: net.c:417
Definition: tds.h:656
TDSRET tds_submit_queryf(TDSSOCKET *tds, const char *queryf,...)
Format and submit a query.
Definition: query.c:486
int tds_read_packet(TDSSOCKET *tds)
Read in one &#39;packet&#39; from the server.
Definition: packet.c:529
client would send data
Definition: tds.h:825
TDSCURSOR * cur_cursor
cursor in use
Definition: tds.h:1230
Definition: proto.h:38
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:1310
unsigned out_pos
current position in out_buf
Definition: tds.h:1200
Information about blobs (e.g.
Definition: tds.h:621
DSTR crlfile
certificate revocation file
Definition: tds.h:564
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
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 ret_status
return status from store procedure
Definition: tds.h:1233
DSTR db_filename
database filename to attach (MSSQL)
Definition: tds.h:562
TDSRET tds_alloc_row(TDSRESULTINFO *res_info)
Allocate space for row store return NULL on out of memory.
Definition: mem.c:519
TDSCURSOR * cursors
linked list of cursors allocated for this connection contains only cursors allocated on the server ...
Definition: tds.h:1117
A structure to hold all the compile-time settings.
Definition: tds.h:72
client is writing data
Definition: tds.h:824
Definition: tds.h:1051
int port
port of database service
Definition: tds.h:552
unsigned int out_buf_max
Maximum size of packet pointed by out_buf.
Definition: tds.h:1198
void tds_unget_byte(TDSSOCKET *tds)
Unget will always work as long as you don&#39;t call it twice in a row.
Definition: read.c:89
void * tds_realloc(void **pp, size_t new_size)
Reallocate a pointer and update it if success.
Definition: mem.c:1809
transaction in progress
Definition: tds.h:251
TDSRET tds_get_char_data(TDSSOCKET *tds, char *dest, size_t wire_size, TDSCOLUMN *curcol)
Fetch character data the wire.
Definition: read.c:213
TDSDYNAMIC * tds_lookup_dynamic(TDSCONNECTION *conn, const char *id)
Finds a dynamic given string id.
Definition: token.c:2507
TDS_INT quarter
quarter (0-3)
Definition: tds.h:160
Holds informations about a cursor.
Definition: tds.h:969
int tds_socket_set_nonblocking(TDS_SYS_SOCKET sock)
Set socket to non-blocking.
Definition: net.c:154
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
char * tds_get_homedir(void)
Get user home directory.
Definition: threadsafe.c:411
struct tdsdaterec TDSDATEREC
Used by tds_datecrack.
TDSLOGIN * tds_init_login(TDSLOGIN *login, TDSLOCALE *locale)
Initialize login structure with locale information and other stuff for connection.
Definition: mem.c:793
Definition: tds.h:908
DSTR server_spn
server SPN (in freetds.conf)
Definition: tds.h:561
unsigned in_pos
current position in in_buf
Definition: tds.h:1199
TDS_INT second
0-59
Definition: tds.h:167
Metadata about columns in regular and compute rows.
Definition: tds.h:724
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
TDS_UINT tds_get_uint(TDSSOCKET *tds)
Get an int32 from the server.
Definition: read.c:131
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
TDS_INT weekday
day of week (0-6, 0 = sunday)
Definition: tds.h:164
TDS_TINYINT bulk_query
true is query sent was a bulk query so we need to switch state to QUERYING
Definition: tds.h:1231
Definition: tds.h:527
TDSRET tds_bcp_init(TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
Initialize BCP information.
Definition: bulk.c:82
TDS_INT ref_count
reference counter so client can retain safely a pointer
Definition: tds.h:972
Definition: tds.h:1100
TDS_INT cursor_rows
< number of updatable columns
Definition: tds.h:984
TDS_INT column_cur_size
size written in variable (ie: char, text, binary).
Definition: tds.h:771
this structure is not directed connected to a TDS protocol but keeps any DATE/TIME information...
Definition: tds.h:144
enum tds_states TDS_STATE
values for tds->state
results are from a stored procedure
Definition: tds.h:252
struct tds_cursor TDSCURSOR
Holds informations about a cursor.
TDS_TINYINT column_varint_size
size of length when reading from wire (0, 1, 2 or 4)
Definition: tds.h:737
TDS_INT bcp_prefix_len
The length, in bytes, of any length prefix this column may have.
Definition: tds.h:794
Definition: tds.h:1078
DSTR server_charset
charset of server e.g.
Definition: tds.h:556
int tds7_get_instance_ports(FILE *output, struct addrinfo *addr)
Get port of all instances.
Definition: net.c:889
Holds information for a dynamic (also called prepared) query.
Definition: tds.h:1009
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
TDSRET tds_process_login_tokens(TDSSOCKET *tds)
tds_process_login_tokens() is called after sending the login packet to the server.
Definition: token.c:294