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