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