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