Main Page | Modules | Class List | Directories | File List | Class Members | File Members | Related Pages

tds.h

Go to the documentation of this file.
00001 /* FreeTDS - Library of routines accessing Sybase and Microsoft databases
00002  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005  Brian Bruns
00003  *
00004  * This library is free software; you can redistribute it and/or
00005  * modify it under the terms of the GNU Library General Public
00006  * License as published by the Free Software Foundation; either
00007  * version 2 of the License, or (at your option) any later version.
00008  *
00009  * This library is distributed in the hope that it will be useful,
00010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012  * Library General Public License for more details.
00013  *
00014  * You should have received a copy of the GNU Library General Public
00015  * License along with this library; if not, write to the
00016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00017  * Boston, MA 02111-1307, USA.
00018  */
00019 
00020 #ifndef _tds_h_
00021 #define _tds_h_
00022 
00023 static const char rcsid_tds_h[] = "$Id: tds.h,v 1.242 2005/08/16 15:04:02 freddy77 Exp $";
00024 static const void *const no_unused_tds_h_warn[] = { rcsid_tds_h, no_unused_tds_h_warn };
00025 
00026 #include <stdio.h>
00027 #include <stdarg.h>
00028 #include <time.h>
00029 
00030 /* forward declaration */
00031 typedef struct tdsiconvinfo TDSICONV;
00032 typedef struct tds_socket TDSSOCKET;
00033 
00034 #include "tdsver.h"
00035 #include "tds_sysdep_public.h"
00036 #ifdef _FREETDS_LIBRARY_SOURCE
00037 #include "tds_sysdep_private.h"
00038 #endif /* _FREETDS_LIBRARY_SOURCE */
00039 
00040 #ifdef __cplusplus
00041 extern "C"
00042 {
00043 #if 0
00044 }
00045 #endif
00046 #endif
00047 
00053 typedef struct _tds_compiletime_settings
00054 {
00055         const char *freetds_version;    /* release version of FreeTDS */
00056         const char *last_update;        /* latest software_version date among the modules */
00057         int msdblib;            /* for MS style dblib */
00058         int sybase_compat;      /* enable increased Open Client binary compatibility */
00059         int threadsafe;         /* compile for thread safety default=no */
00060         int libiconv;           /* search for libiconv in DIR/include and DIR/lib */
00061         const char *tdsver;     /* TDS protocol version (4.2/4.6/5.0/7.0/8.0) 5.0 */
00062         int iodbc;              /* build odbc driver against iODBC in DIR */
00063         int unixodbc;           /* build odbc driver against unixODBC in DIR */
00064 
00065 } TDS_COMPILETIME_SETTINGS;
00066 
00067 struct DSTR_STRUCT {
00068         /* keep always at last */
00069         char dstr_s[1];
00070 };
00071 typedef struct DSTR_STRUCT *DSTR;
00072 
00088 /* 
00089  * All references to data that touch the wire should use the following typedefs.  
00090  *
00091  * If you have problems on 64-bit machines and the code is 
00092  * using a native datatype, please change it to use
00093  * these. (In the TDS layer only, the API layers have their
00094  * own typedefs which equate to these).
00095  */
00096 typedef char TDS_CHAR;                                  /*  8-bit char     */
00097 typedef unsigned char TDS_UCHAR;                        /*  8-bit uchar    */
00098 typedef unsigned char TDS_TINYINT;                      /*  8-bit unsigned */
00099 typedef tds_sysdep_int16_type TDS_SMALLINT;             /* 16-bit int      */
00100 typedef unsigned tds_sysdep_int16_type TDS_USMALLINT;   /* 16-bit unsigned */
00101 typedef tds_sysdep_int32_type TDS_INT;                  /* 32-bit int      */
00102 typedef unsigned tds_sysdep_int32_type TDS_UINT;        /* 32-bit unsigned */
00103 typedef tds_sysdep_real32_type TDS_REAL;                /* 32-bit real     */
00104 typedef tds_sysdep_real64_type TDS_FLOAT;               /* 64-bit real     */
00105 typedef tds_sysdep_int64_type TDS_INT8;                 /* 64-bit integer  */
00106 typedef unsigned tds_sysdep_int64_type TDS_UINT8;       /* 64-bit unsigned */
00107 typedef tds_sysdep_intptr_type TDS_INTPTR;
00108 
00109 typedef struct tdsnumeric
00110 {
00111         unsigned char precision;
00112         unsigned char scale;
00113         unsigned char array[33];
00114 } TDS_NUMERIC;
00115 
00116 typedef struct tdsoldmoney
00117 {
00118         TDS_INT mnyhigh;
00119         TDS_UINT mnylow;
00120 } TDS_OLD_MONEY;
00121 
00122 typedef union tdsmoney
00123 {
00124         TDS_OLD_MONEY tdsoldmoney;
00125         TDS_INT8 mny;
00126 } TDS_MONEY;
00127 
00128 typedef struct tdsmoney4
00129 {
00130         TDS_INT mny4;
00131 } TDS_MONEY4;
00132 
00133 typedef struct tdsdatetime
00134 {
00135         TDS_INT dtdays;
00136         TDS_INT dttime;
00137 } TDS_DATETIME;
00138 
00139 typedef struct tdsdatetime4
00140 {
00141         TDS_USMALLINT days;
00142         TDS_USMALLINT minutes;
00143 } TDS_DATETIME4;
00144 
00145 typedef struct tdsvarbinary
00146 {
00147         TDS_INT len;
00148         TDS_CHAR array[256];
00149 } TDS_VARBINARY;
00150 typedef struct tdsvarchar
00151 {
00152         TDS_INT len;
00153         TDS_CHAR array[256];
00154 } TDS_VARCHAR;
00155 
00156 typedef struct tdsunique
00157 {
00158         TDS_UINT Data1;
00159         TDS_USMALLINT Data2;
00160         TDS_USMALLINT Data3;
00161         TDS_UCHAR Data4[8];
00162 } TDS_UNIQUE;
00163 
00165 typedef struct tdsdaterec
00166 {
00167         TDS_INT year;          
00168         TDS_INT month;         
00169         TDS_INT day;           
00170         TDS_INT dayofyear;     
00171         TDS_INT weekday;       
00172         TDS_INT hour;          
00173         TDS_INT minute;        
00174         TDS_INT second;        
00175         TDS_INT millisecond;   
00176         TDS_INT tzone;
00177 } TDSDATEREC;
00178 
00184 extern const int tds_numeric_bytes_per_prec[];
00185 
00186 #define TDS_SUCCEED          1
00187 #define TDS_FAIL             0
00188 #define TDS_NO_MORE_RESULTS  2
00189 #define TDS_CANCELLED        3
00190 
00191 #define TDS_INT_EXIT 0
00192 #define TDS_INT_CONTINUE 1
00193 #define TDS_INT_CANCEL 2
00194 #define TDS_INT_TIMEOUT 3
00195 
00196 
00197 #define TDS_NO_COUNT         -1
00198 
00199 #define TDS_ROW_RESULT        4040
00200 #define TDS_PARAM_RESULT      4042
00201 #define TDS_STATUS_RESULT     4043
00202 #define TDS_MSG_RESULT        4044
00203 #define TDS_COMPUTE_RESULT    4045
00204 #define TDS_CMD_DONE          4046
00205 #define TDS_CMD_SUCCEED       4047
00206 #define TDS_CMD_FAIL          4048
00207 #define TDS_ROWFMT_RESULT     4049
00208 #define TDS_COMPUTEFMT_RESULT 4050
00209 #define TDS_DESCRIBE_RESULT   4051
00210 #define TDS_DONE_RESULT       4052
00211 #define TDS_DONEPROC_RESULT   4053
00212 #define TDS_DONEINPROC_RESULT 4054
00213 #define TDS_OTHERS_RESULT     4055
00214 
00215 enum tds_token_results
00216 {
00217         TDS_TOKEN_RES_OTHERS,
00218         TDS_TOKEN_RES_ROWFMT,
00219         TDS_TOKEN_RES_COMPUTEFMT,
00220         TDS_TOKEN_RES_PARAMFMT,
00221         TDS_TOKEN_RES_DONE,
00222         TDS_TOKEN_RES_ROW,
00223         TDS_TOKEN_RES_COMPUTE,
00224         TDS_TOKEN_RES_PROC
00225 };
00226 
00227 #define TDS_TOKEN_FLAG(flag) TDS_RETURN_##flag = (1 << (TDS_TOKEN_RES_##flag*2)), TDS_STOPAT_##flag = (2 << (TDS_TOKEN_RES_##flag*2))
00228 
00229 enum tds_token_flags
00230 {
00231         TDS_HANDLE_ALL = 0,
00232         TDS_TOKEN_FLAG(OTHERS),
00233         TDS_TOKEN_FLAG(ROWFMT),
00234         TDS_TOKEN_FLAG(COMPUTEFMT),
00235         TDS_TOKEN_FLAG(PARAMFMT),
00236         TDS_TOKEN_FLAG(DONE),
00237         TDS_TOKEN_FLAG(ROW),
00238         TDS_TOKEN_FLAG(COMPUTE),
00239         TDS_TOKEN_FLAG(PROC),
00240         TDS_TOKEN_RESULTS = TDS_RETURN_ROWFMT|TDS_RETURN_COMPUTEFMT|TDS_RETURN_DONE|TDS_STOPAT_ROW|TDS_STOPAT_COMPUTE|TDS_RETURN_PROC,
00241         TDS_TOKEN_TRAILING = TDS_STOPAT_ROWFMT|TDS_STOPAT_COMPUTEFMT|TDS_STOPAT_ROW|TDS_STOPAT_COMPUTE|TDS_STOPAT_OTHERS
00242 };
00243 
00244 enum tds_end
00245 {
00246           TDS_DONE_FINAL        = 0x00  /* final result set, command completed successfully. */
00247         , TDS_DONE_MORE_RESULTS = 0x01  /* more results follow */
00248         , TDS_DONE_ERROR        = 0x02  /* error occurred */
00249         , TDS_DONE_INXACT       = 0x04  /* transaction in progress */
00250         , TDS_DONE_PROC         = 0x08  /* results are from a stored procedure */
00251         , TDS_DONE_COUNT        = 0x10  /* count field in packet is valid */
00252         , TDS_DONE_CANCELLED    = 0x20  /* acknowledging an attention command (usually a cancel) */
00253         , TDS_DONE_EVENT        = 0x40  /* part of an event notification. */
00254         , TDS_DONE_SRVERROR     = 0x100 /* SQL server server error */
00255         
00256         /* after the above flags, a TDS_DONE packet has a field describing the state of the transaction */
00257         , TDS_DONE_NO_TRAN      = 0     /* No transaction in effect */
00258         , TDS_DONE_TRAN_SUCCEED = 1     /* Transaction completed successfully */
00259         , TDS_DONE_TRAN_PROGRESS= 2     /* Transaction in progress */
00260         , TDS_DONE_STMT_ABORT   = 3     /* A statement aborted */
00261         , TDS_DONE_TRAN_ABORT   = 4     /* Transaction aborted */
00262 };
00263 
00264 /*
00265  * TDS_ERROR indicates a successful processing, but that a TDS_ERROR_TOKEN or TDS_EED_TOKEN error was encountered.  
00266  * TDS_FAIL indicates an unrecoverable failure.
00267  */
00268 #define TDS_ERROR            3
00269 #define TDS_DONT_RETURN      42
00270 
00271 #define TDS5_PARAMFMT2_TOKEN       32   /* 0x20 */
00272 #define TDS_LANGUAGE_TOKEN         33   /* 0x21    TDS 5.0 only              */
00273 #define TDS_ORDERBY2_TOKEN         34   /* 0x22 */
00274 #define TDS_ROWFMT2_TOKEN          97   /* 0x61    TDS 5.0 only              */
00275 #define TDS_LOGOUT_TOKEN          113   /* 0x71    TDS 5.0 only? ct_close()  */
00276 #define TDS_RETURNSTATUS_TOKEN    121   /* 0x79                              */
00277 #define TDS_PROCID_TOKEN          124   /* 0x7C    TDS 4.2 only - TDS_PROCID */
00278 #define TDS7_RESULT_TOKEN         129   /* 0x81    TDS 7.0 only              */
00279 #define TDS7_COMPUTE_RESULT_TOKEN 136   /* 0x88    TDS 7.0 only              */
00280 #define TDS_COLNAME_TOKEN         160   /* 0xA0    TDS 4.2 only              */
00281 #define TDS_COLFMT_TOKEN          161   /* 0xA1    TDS 4.2 only - TDS_COLFMT */
00282 #define TDS_DYNAMIC2_TOKEN        163   /* 0xA3 */
00283 #define TDS_TABNAME_TOKEN         164   /* 0xA4 */
00284 #define TDS_COLINFO_TOKEN         165   /* 0xA5 */
00285 #define TDS_OPTIONCMD_TOKEN       166   /* 0xA6 */
00286 #define TDS_COMPUTE_NAMES_TOKEN   167   /* 0xA7 */
00287 #define TDS_COMPUTE_RESULT_TOKEN  168   /* 0xA8 */
00288 #define TDS_ORDERBY_TOKEN         169   /* 0xA9    TDS_ORDER                 */
00289 #define TDS_ERROR_TOKEN           170   /* 0xAA                              */
00290 #define TDS_INFO_TOKEN            171   /* 0xAB                              */
00291 #define TDS_PARAM_TOKEN           172   /* 0xAC    RETURNVALUE?              */
00292 #define TDS_LOGINACK_TOKEN        173   /* 0xAD                              */
00293 #define TDS_CONTROL_TOKEN         174   /* 0xAE    TDS_CONTROL               */
00294 #define TDS_ROW_TOKEN             209   /* 0xD1                              */
00295 #define TDS_CMP_ROW_TOKEN         211   /* 0xD3                              */
00296 #define TDS5_PARAMS_TOKEN         215   /* 0xD7    TDS 5.0 only              */
00297 #define TDS_CAPABILITY_TOKEN      226   /* 0xE2                              */
00298 #define TDS_ENVCHANGE_TOKEN       227   /* 0xE3                              */
00299 #define TDS_EED_TOKEN             229   /* 0xE5                              */
00300 #define TDS_DBRPC_TOKEN           230   /* 0xE6                              */
00301 #define TDS5_DYNAMIC_TOKEN        231   /* 0xE7    TDS 5.0 only              */
00302 #define TDS5_PARAMFMT_TOKEN       236   /* 0xEC    TDS 5.0 only              */
00303 #define TDS_AUTH_TOKEN            237   /* 0xED                              */
00304 #define TDS_RESULT_TOKEN          238   /* 0xEE                              */
00305 #define TDS_DONE_TOKEN            253   /* 0xFD    TDS_DONE                  */
00306 #define TDS_DONEPROC_TOKEN        254   /* 0xFE    TDS_DONEPROC              */
00307 #define TDS_DONEINPROC_TOKEN      255   /* 0xFF    TDS_DONEINPROC            */
00308 
00309 /* CURSOR support: TDS 5.0 only*/
00310 #define TDS_CURCLOSE_TOKEN        128  /* 0x80    TDS 5.0 only              */
00311 #define TDS_CURFETCH_TOKEN        130  /* 0x82    TDS 5.0 only              */
00312 #define TDS_CURINFO_TOKEN         131  /* 0x83    TDS 5.0 only              */
00313 #define TDS_CUROPEN_TOKEN         132  /* 0x84    TDS 5.0 only              */
00314 #define TDS_CURDECLARE_TOKEN      134  /* 0x86    TDS 5.0 only              */
00315 
00316 enum {
00317         TDS_CUR_ISTAT_UNUSED    = 0x00,
00318         TDS_CUR_ISTAT_DECLARED  = 0x01,
00319         TDS_CUR_ISTAT_OPEN      = 0x02,
00320         TDS_CUR_ISTAT_CLOSED    = 0x04,
00321         TDS_CUR_ISTAT_RDONLY    = 0x08,
00322         TDS_CUR_ISTAT_UPDATABLE = 0x10,
00323         TDS_CUR_ISTAT_ROWCNT    = 0x20,
00324         TDS_CUR_ISTAT_DEALLOC   = 0x40
00325 };
00326 
00327 /* 
00328  * Cursor Declare, SetRows, Open and Close all return 0x83 token. 
00329  * But only SetRows includes the rowcount (4 byte) in the stream. 
00330  * So for Setrows we read the rowcount from the stream and not for others. 
00331  * These values are useful to determine when to read the rowcount from the packet
00332  */
00333 #define IS_DECLARE  100
00334 #define IS_CURROW   200
00335 #define IS_OPEN     300
00336 #define IS_CLOSE    400
00337 
00338 /* states for tds_process_messages() */
00339 #define PROCESS_ROWS    0
00340 #define PROCESS_RESULTS 1
00341 #define CANCEL_PROCESS  2
00342 #define GOTO_1ST_ROW    3
00343 #define LOGIN           4
00344 
00345 /* environment type field */
00346 #define TDS_ENV_DATABASE        1
00347 #define TDS_ENV_LANG            2
00348 #define TDS_ENV_CHARSET         3
00349 #define TDS_ENV_PACKSIZE        4
00350 #define TDS_ENV_LCID            5
00351 #define TDS_ENV_SQLCOLLATION    7
00352 
00353 /* string types */
00354 #define TDS_NULLTERM -9
00355 
00356 /* Microsoft internal stored procedure id's */
00357 
00358 #define TDS_SP_CURSOR           1
00359 #define TDS_SP_CURSOROPEN       2
00360 #define TDS_SP_CURSORPREPARE    3
00361 #define TDS_SP_CURSOREXECUTE    4
00362 #define TDS_SP_CURSORPREPEXEC   5
00363 #define TDS_SP_CURSORUNPREPARE  6
00364 #define TDS_SP_CURSORFETCH      7
00365 #define TDS_SP_CURSOROPTION     8
00366 #define TDS_SP_CURSORCLOSE      9
00367 #define TDS_SP_EXECUTESQL      10
00368 #define TDS_SP_PREPARE         11
00369 #define TDS_SP_EXECUTE         12
00370 #define TDS_SP_PREPEXEC        13
00371 #define TDS_SP_PREPEXECRPC     14
00372 #define TDS_SP_UNPREPARE       15
00373 /* 
00374  * <rant> Sybase does an awful job of this stuff, non null ints of size 1 2 
00375  * and 4 have there own codes but nullable ints are lumped into INTN
00376  * sheesh! </rant>
00377  */
00378 typedef enum
00379 {
00380         SYBCHAR = 47,           /* 0x2F */
00381 #define SYBCHAR SYBCHAR
00382         SYBVARCHAR = 39,        /* 0x27 */
00383 #define SYBVARCHAR      SYBVARCHAR
00384         SYBINTN = 38,           /* 0x26 */
00385 #define SYBINTN SYBINTN
00386         SYBINT1 = 48,           /* 0x30 */
00387 #define SYBINT1 SYBINT1
00388         SYBINT2 = 52,           /* 0x34 */
00389 #define SYBINT2 SYBINT2
00390         SYBINT4 = 56,           /* 0x38 */
00391 #define SYBINT4 SYBINT4
00392         SYBINT8 = 127,          /* 0x7F */
00393 #define SYBINT8 SYBINT8
00394         SYBFLT8 = 62,           /* 0x3E */
00395 #define SYBFLT8 SYBFLT8
00396         SYBDATETIME = 61,       /* 0x3D */
00397 #define SYBDATETIME     SYBDATETIME
00398         SYBBIT = 50,            /* 0x32 */
00399 #define SYBBIT  SYBBIT
00400         SYBTEXT = 35,           /* 0x23 */
00401 #define SYBTEXT SYBTEXT
00402         SYBNTEXT = 99,          /* 0x63 */
00403 #define SYBNTEXT        SYBNTEXT
00404         SYBIMAGE = 34,          /* 0x22 */
00405 #define SYBIMAGE        SYBIMAGE
00406         SYBMONEY4 = 122,        /* 0x7A */
00407 #define SYBMONEY4       SYBMONEY4
00408         SYBMONEY = 60,          /* 0x3C */
00409 #define SYBMONEY        SYBMONEY
00410         SYBDATETIME4 = 58,      /* 0x3A */
00411 #define SYBDATETIME4    SYBDATETIME4
00412         SYBREAL = 59,           /* 0x3B */
00413 #define SYBREAL SYBREAL
00414         SYBBINARY = 45,         /* 0x2D */
00415 #define SYBBINARY       SYBBINARY
00416         SYBVOID = 31,           /* 0x1F */
00417 #define SYBVOID SYBVOID
00418         SYBVARBINARY = 37,      /* 0x25 */
00419 #define SYBVARBINARY    SYBVARBINARY
00420         SYBNVARCHAR = 103,      /* 0x67 */
00421 #define SYBNVARCHAR     SYBNVARCHAR
00422         SYBBITN = 104,          /* 0x68 */
00423 #define SYBBITN SYBBITN
00424         SYBNUMERIC = 108,       /* 0x6C */
00425 #define SYBNUMERIC      SYBNUMERIC
00426         SYBDECIMAL = 106,       /* 0x6A */
00427 #define SYBDECIMAL      SYBDECIMAL
00428         SYBFLTN = 109,          /* 0x6D */
00429 #define SYBFLTN SYBFLTN
00430         SYBMONEYN = 110,        /* 0x6E */
00431 #define SYBMONEYN       SYBMONEYN
00432         SYBDATETIMN = 111,      /* 0x6F */
00433 #define SYBDATETIMN     SYBDATETIMN
00434         XSYBCHAR = 175,         /* 0xAF */
00435 #define XSYBCHAR        XSYBCHAR
00436         XSYBVARCHAR = 167,      /* 0xA7 */
00437 #define XSYBVARCHAR     XSYBVARCHAR
00438         XSYBNVARCHAR = 231,     /* 0xE7 */
00439 #define XSYBNVARCHAR    XSYBNVARCHAR
00440         XSYBNCHAR = 239,        /* 0xEF */
00441 #define XSYBNCHAR       XSYBNCHAR
00442         XSYBVARBINARY = 165,    /* 0xA5 */
00443 #define XSYBVARBINARY   XSYBVARBINARY
00444         XSYBBINARY = 173,       /* 0xAD */
00445 #define XSYBBINARY      XSYBBINARY
00446         SYBLONGBINARY = 225,    /* 0xE1 */
00447 #define SYBLONGBINARY   SYBLONGBINARY
00448         SYBSINT1 = 64,          /* 0x40 */
00449 #define SYBSINT1        SYBSINT1
00450         SYBUINT2 = 65,          /* 0x41 */
00451 #define SYBUINT2        SYBUINT2
00452         SYBUINT4 = 66,          /* 0x42 */
00453 #define SYBUINT4        SYBUINT4
00454         SYBUINT8 = 67,          /* 0x43 */
00455 #define SYBUINT8        SYBUINT8
00456 
00457         SYBUNIQUE = 36,         /* 0x24 */
00458 #define SYBUNIQUE       SYBUNIQUE
00459         SYBVARIANT = 98         /* 0x62 */
00460 #define SYBVARIANT      SYBVARIANT
00461 } TDS_SERVER_TYPE;
00462 
00463 
00464 typedef enum
00465 {
00466         USER_UNICHAR_TYPE = 34,         /* 0x22 */
00467         USER_UNIVARCHAR_TYPE = 35       /* 0x23 */
00468 } TDS_USER_TYPE;
00469 
00470 #define SYBAOPCNT  0x4b
00471 #define SYBAOPCNTU 0x4c
00472 #define SYBAOPSUM  0x4d
00473 #define SYBAOPSUMU 0x4e
00474 #define SYBAOPAVG  0x4f
00475 #define SYBAOPAVGU 0x50
00476 #define SYBAOPMIN  0x51
00477 #define SYBAOPMAX  0x52
00478 
00479 /* mssql2k compute operator */
00480 #define SYBAOPCNT_BIG           0x09
00481 #define SYBAOPSTDEV             0x30
00482 #define SYBAOPSTDEVP            0x31
00483 #define SYBAOPVAR               0x32
00484 #define SYBAOPVARP              0x33
00485 #define SYBAOPCHECKSUM_AGG      0x72
00486 
00487 
00491 typedef enum
00492 {
00493           TDS_OPT_SET = 1       /* Set an option. */
00494         , TDS_OPT_DEFAULT = 2   /* Set option to its default value. */
00495         , TDS_OPT_LIST = 3      /* Request current setting of a specific option. */
00496         , TDS_OPT_INFO = 4      /* Report current setting of a specific option. */
00497 } TDS_OPTION_CMD;
00498 
00499 typedef enum
00500 {
00501           TDS_OPT_DATEFIRST = 1         /* 0x01 */
00502         , TDS_OPT_TEXTSIZE = 2          /* 0x02 */
00503         , TDS_OPT_STAT_TIME = 3         /* 0x03 */
00504         , TDS_OPT_STAT_IO = 4           /* 0x04 */
00505         , TDS_OPT_ROWCOUNT = 5          /* 0x05 */
00506         , TDS_OPT_NATLANG = 6           /* 0x06 */
00507         , TDS_OPT_DATEFORMAT = 7        /* 0x07 */
00508         , TDS_OPT_ISOLATION = 8         /* 0x08 */
00509         , TDS_OPT_AUTHON = 9            /* 0x09 */
00510         , TDS_OPT_CHARSET = 10          /* 0x0a */
00511         , TDS_OPT_SHOWPLAN = 13         /* 0x0d */
00512         , TDS_OPT_NOEXEC = 14           /* 0x0e */
00513         , TDS_OPT_ARITHIGNOREON = 15    /* 0x0f */
00514         , TDS_OPT_ARITHABORTON = 17     /* 0x11 */
00515         , TDS_OPT_PARSEONLY = 18        /* 0x12 */
00516         , TDS_OPT_GETDATA = 20          /* 0x14 */
00517         , TDS_OPT_NOCOUNT = 21          /* 0x15 */
00518         , TDS_OPT_FORCEPLAN = 23        /* 0x17 */
00519         , TDS_OPT_FORMATONLY = 24       /* 0x18 */
00520         , TDS_OPT_CHAINXACTS = 25       /* 0x19 */
00521         , TDS_OPT_CURCLOSEONXACT = 26   /* 0x1a */
00522         , TDS_OPT_FIPSFLAG = 27         /* 0x1b */
00523         , TDS_OPT_RESTREES = 28         /* 0x1c */
00524         , TDS_OPT_IDENTITYON = 29       /* 0x1d */
00525         , TDS_OPT_CURREAD = 30          /* 0x1e */
00526         , TDS_OPT_CURWRITE = 31         /* 0x1f */
00527         , TDS_OPT_IDENTITYOFF = 32      /* 0x20 */
00528         , TDS_OPT_AUTHOFF = 33          /* 0x21 */
00529         , TDS_OPT_ANSINULL = 34         /* 0x22 */
00530         , TDS_OPT_QUOTED_IDENT = 35     /* 0x23 */
00531         , TDS_OPT_ARITHIGNOREOFF = 36   /* 0x24 */
00532         , TDS_OPT_ARITHABORTOFF = 37    /* 0x25 */
00533         , TDS_OPT_TRUNCABORT = 38       /* 0x26 */
00534 } TDS_OPTION;
00535 
00536 typedef union tds_option_arg
00537 {
00538         TDS_TINYINT ti;
00539         TDS_INT i;
00540         TDS_CHAR *c;
00541 } TDS_OPTION_ARG;
00542 
00543 enum {
00544         TDS_OPT_ARITHOVERFLOW = 0x01,
00545         TDS_OPT_NUMERICTRUNC = 0x02
00546 };
00547 
00548 enum TDS_OPT_DATEFIRST_CHOICE
00549 {
00550         TDS_OPT_MONDAY = 1, TDS_OPT_TUESDAY = 2, TDS_OPT_WEDNESDAY = 3, TDS_OPT_THURSDAY = 4, TDS_OPT_FRIDAY = 5, TDS_OPT_SATURDAY =
00551                 6, TDS_OPT_SUNDAY = 7
00552 };
00553 
00554 enum TDS_OPT_DATEFORMAT_CHOICE
00555 {
00556         TDS_OPT_FMTMDY = 1, TDS_OPT_FMTDMY = 2, TDS_OPT_FMTYMD = 3, TDS_OPT_FMTYDM = 4, TDS_OPT_FMTMYD = 5, TDS_OPT_FMTDYM = 6
00557 };
00558 enum TDS_OPT_ISOLATION_CHOICE
00559 {
00560         TDS_OPT_LEVEL1 = 1, TDS_OPT_LEVEL3 = 3
00561 };
00562 
00563 typedef enum tds_packet_type
00564 {
00565         TDS_QUERY = 1,
00566         TDS_RPC = 3,
00567         TDS_CANCEL = 6,
00568         TDS_BULK = 7,
00569         TDS_NORMAL = 15
00570 } TDS_PACKET_TYPE;
00571 
00572 
00573 #define TDS_ZERO_FREE(x) do {free((x)); (x) = NULL;} while(0)
00574 #define TDS_VECTOR_SIZE(x) (sizeof(x)/sizeof(x[0]))
00575 
00576 /*
00577  * TODO use system macros for optimization
00578  * See mcrypt for reference and linux kernel source for optimization
00579  * check if unaligned access and use fast write/read when implemented
00580  */
00581 #define TDS_BYTE_SWAP16(value)                 \
00582          (((((unsigned short)value)<<8) & 0xFF00)   | \
00583           ((((unsigned short)value)>>8) & 0x00FF))
00584 
00585 #define TDS_BYTE_SWAP32(value)                     \
00586          (((((unsigned long)value)<<24) & 0xFF000000)  | \
00587           ((((unsigned long)value)<< 8) & 0x00FF0000)  | \
00588           ((((unsigned long)value)>> 8) & 0x0000FF00)  | \
00589           ((((unsigned long)value)>>24) & 0x000000FF))
00590 
00591 #define is_end_token(x) (x==TDS_DONE_TOKEN    || \
00592                         x==TDS_DONEPROC_TOKEN    || \
00593                         x==TDS_DONEINPROC_TOKEN)
00594 
00595 #define is_hard_end_token(x) (x==TDS_DONE_TOKEN    || \
00596                         x==TDS_DONEPROC_TOKEN)
00597 
00598 #define is_msg_token(x) (x==TDS_INFO_TOKEN    || \
00599                         x==TDS_ERROR_TOKEN    || \
00600                         x==TDS_EED_TOKEN)
00601 
00602 #define is_result_token(x) (x==TDS_RESULT_TOKEN || \
00603                         x==TDS_ROWFMT2_TOKEN    || \
00604                         x==TDS7_RESULT_TOKEN    || \
00605                         x==TDS_COLFMT_TOKEN     || \
00606                         x==TDS_COLNAME_TOKEN    || \
00607                         x==TDS_RETURNSTATUS_TOKEN)
00608 
00609 /* FIX ME -- not a complete list */
00610 #define is_fixed_type(x) (x==SYBINT1    || \
00611                         x==SYBINT2      || \
00612                         x==SYBINT4      || \
00613                         x==SYBINT8      || \
00614                         x==SYBREAL      || \
00615                         x==SYBFLT8      || \
00616                         x==SYBDATETIME  || \
00617                         x==SYBDATETIME4 || \
00618                         x==SYBBIT       || \
00619                         x==SYBMONEY     || \
00620                         x==SYBMONEY4    || \
00621                         x==SYBVOID      || \
00622                         x==SYBUNIQUE)
00623 #define is_nullable_type(x) ( \
00624                         x==SYBBITN      || \
00625                      x==SYBINTN      || \
00626                      x==SYBFLTN      || \
00627                      x==SYBMONEYN    || \
00628                      x==SYBDATETIMN  || \
00629                      x==SYBVARCHAR   || \
00630                      x==SYBBINARY    || \
00631                      x==SYBVARBINARY || \
00632                      x==SYBTEXT      || \
00633                      x==SYBNTEXT     || \
00634                      x==SYBIMAGE)
00635 
00636 #define is_blob_type(x) (x==SYBTEXT || x==SYBIMAGE || x==SYBNTEXT)
00637 /* large type means it has a two byte size field */
00638 /* define is_large_type(x) (x>128) */
00639 #define is_numeric_type(x) (x==SYBNUMERIC || x==SYBDECIMAL)
00640 #define is_unicode_type(x) (x==XSYBNVARCHAR || x==XSYBNCHAR || x==SYBNTEXT)
00641 #define is_collate_type(x) (x==XSYBVARCHAR || x==XSYBCHAR || x==SYBTEXT || x==XSYBNVARCHAR || x==XSYBNCHAR || x==SYBNTEXT)
00642 #define is_ascii_type(x) ( x==XSYBCHAR || x==XSYBVARCHAR || x==SYBTEXT || x==SYBCHAR || x==SYBVARCHAR)
00643 #define is_binary_type(x) (x==SYBLONGBINARY)
00644 #define is_char_type(x) (is_unicode_type(x) || is_ascii_type(x))
00645 #define is_similar_type(x, y) ((is_char_type(x) && is_char_type(y)) || ((is_unicode_type(x) && is_unicode_type(y))))
00646 
00647 
00648 #define TDS_MAX_CAPABILITY      22
00649 #define MAXPRECISION            80
00650 #define TDS_MAX_CONN            4096
00651 #define TDS_MAX_DYNID_LEN       30
00652 
00653 /* defaults to use if no others are found */
00654 #define TDS_DEF_SERVER          "SYBASE"
00655 #define TDS_DEF_BLKSZ           512
00656 #define TDS_DEF_CHARSET         "iso_1"
00657 #define TDS_DEF_LANG            "us_english"
00658 #if TDS42
00659 #define TDS_DEF_MAJOR           4
00660 #define TDS_DEF_MINOR           2
00661 #define TDS_DEF_PORT            1433
00662 #elif TDS46
00663 #define TDS_DEF_MAJOR           4
00664 #define TDS_DEF_MINOR           6
00665 #define TDS_DEF_PORT            4000
00666 #elif TDS70
00667 #define TDS_DEF_MAJOR           7
00668 #define TDS_DEF_MINOR           0
00669 #define TDS_DEF_PORT            1433
00670 #elif TDS80
00671 #define TDS_DEF_MAJOR           8
00672 #define TDS_DEF_MINOR           0
00673 #define TDS_DEF_PORT            1433
00674 #else
00675 #define TDS_DEF_MAJOR           5
00676 #define TDS_DEF_MINOR           0
00677 #define TDS_DEF_PORT            4000
00678 #endif
00679 
00680 /* normalized strings from freetds.conf file */
00681 #define TDS_STR_VERSION  "tds version"
00682 #define TDS_STR_BLKSZ    "initial block size"
00683 #define TDS_STR_SWAPDT   "swap broken dates"
00684 #define TDS_STR_SWAPMNY  "swap broken money"
00685 #define TDS_STR_DUMPFILE "dump file"
00686 #define TDS_STR_DEBUGLVL "debug level"
00687 #define TDS_STR_DEBUGFLAGS "debug flags"
00688 #define TDS_STR_TIMEOUT  "timeout"
00689 #define TDS_STR_QUERY_TIMEOUT  "query timeout"
00690 #define TDS_STR_CONNTIMEOUT "connect timeout"
00691 #define TDS_STR_HOSTNAME "hostname"
00692 #define TDS_STR_HOST     "host"
00693 #define TDS_STR_PORT     "port"
00694 #define TDS_STR_TEXTSZ   "text size"
00695 /* for big endian hosts */
00696 #define TDS_STR_EMUL_LE "emulate little endian"
00697 #define TDS_STR_CHARSET "charset"
00698 #define TDS_STR_CLCHARSET       "client charset"
00699 #define TDS_STR_LANGUAGE        "language"
00700 #define TDS_STR_APPENDMODE      "dump file append"
00701 #define TDS_STR_DATEFMT "date format"
00702 #define TDS_STR_INSTANCE "instance"
00703 
00704 /* TODO do a better check for alignment than this */
00705 typedef union
00706 {
00707         void *p;
00708         int i;
00709 } tds_align_struct;
00710 
00711 #define TDS_ALIGN_SIZE sizeof(tds_align_struct)
00712 
00713 #define TDS_MAX_LOGIN_STR_SZ 30
00714 typedef struct tds_login
00715 {
00716         DSTR server_name;
00717         DSTR server_addr;
00718         int port;
00719         TDS_TINYINT major_version;      /* TDS version */
00720         TDS_TINYINT minor_version;      /* TDS version */
00721         int block_size;
00722         DSTR language;          /* ie us-english */
00723         DSTR server_charset;    /*  ie iso_1 */
00724         TDS_INT connect_timeout;
00725         DSTR host_name;
00726         DSTR app_name;
00727         DSTR user_name;
00728         DSTR password;
00729         
00730         DSTR library;   /* Ct-Library, DB-Library,  TDS-Library or ODBC */
00731         TDS_TINYINT bulk_copy;
00732         TDS_TINYINT suppress_language;
00733         TDS_TINYINT encrypted;
00734 
00735         TDS_INT query_timeout;
00736         unsigned char capabilities[TDS_MAX_CAPABILITY];
00737         DSTR client_charset;
00738 } TDSLOGIN;
00739 
00740 typedef struct tds_connection
00741 {
00742         /* first part of structure is the same of login one */
00743         DSTR server_name; 
00744         int port;          
00745         TDS_TINYINT major_version;
00746         TDS_TINYINT minor_version;
00747         int block_size;
00748         DSTR language;
00749         DSTR server_charset;    
00750         TDS_INT connect_timeout;
00751         DSTR host_name;     
00752         DSTR app_name;
00753         DSTR user_name;     
00754         DSTR password;      
00755         DSTR library;
00756         TDS_TINYINT bulk_copy;
00757         TDS_TINYINT suppress_language;
00758         TDS_TINYINT encrypted;
00759 
00760         TDS_INT query_timeout;
00761         unsigned char capabilities[TDS_MAX_CAPABILITY];
00762         DSTR client_charset;
00763 
00764         DSTR ip_addr;     
00765         DSTR instance_name;
00766         DSTR database;
00767         DSTR dump_file;
00768         int debug_flags;
00769         int text_size;
00770         int broken_dates;
00771         int broken_money;
00772         int emul_little_endian;
00773 } TDSCONNECTION;
00774 
00775 typedef struct tds_locale
00776 {
00777         char *language;
00778         char *char_set;
00779         char *date_fmt;
00780 } TDSLOCALE;
00781 
00786 typedef struct tds_blob
00787 {
00788         TDS_CHAR *textvalue;
00789         TDS_CHAR textptr[16];
00790         TDS_CHAR timestamp[8];
00791 } TDSBLOB;
00792 
00796 typedef struct
00797 {
00798         TDS_USMALLINT locale_id;        /* master..syslanguages.lcid */
00799         TDS_USMALLINT flags;
00800         TDS_UCHAR charset_id;           /* or zero */
00801 } TDS8_COLLATION;
00802 
00803 /* SF stands for "sort flag" */
00804 #define TDS_SF_BIN                   (TDS_USMALLINT) 0x100
00805 #define TDS_SF_WIDTH_INSENSITIVE     (TDS_USMALLINT) 0x080
00806 #define TDS_SF_KATATYPE_INSENSITIVE  (TDS_USMALLINT) 0x040
00807 #define TDS_SF_ACCENT_SENSITIVE      (TDS_USMALLINT) 0x020
00808 #define TDS_SF_CASE_INSENSITIVE      (TDS_USMALLINT) 0x010
00809 
00810 /* UT stands for user type */
00811 #define TDS_UT_TIMESTAMP             80
00812 
00813 
00818 typedef struct _tds_encoding
00819 {
00820         const char *name;
00821         unsigned char min_bytes_per_char;
00822         unsigned char max_bytes_per_char;
00823 } TDS_ENCODING;
00824 
00825 typedef struct _tds_bcpcoldata
00826 {
00827         TDS_UCHAR *data;
00828         TDS_INT    datalen;
00829         TDS_INT    null_column;
00830 } BCPCOLDATA;
00831 
00832 
00833 enum
00834 { TDS_SYSNAME_SIZE = 512 };
00835 
00839 typedef struct tds_column
00840 {
00841         TDS_SMALLINT column_type;       
00846         TDS_INT column_usertype;
00847         TDS_INT column_flags;
00848 
00849         TDS_INT column_size;            
00851         TDS_TINYINT column_varint_size; 
00853         TDS_TINYINT column_prec;        
00854         TDS_TINYINT column_scale;       
00856         TDS_SMALLINT column_namelen;    
00857         TDS_SMALLINT table_namelen;
00858         struct
00859         {
00860                 TDS_SMALLINT column_type;       
00861                 TDS_INT column_size;
00862         } on_server;
00863 
00864         const TDSICONV *char_conv;      
00866         TDS_CHAR table_name[TDS_SYSNAME_SIZE];
00867         TDS_CHAR column_name[TDS_SYSNAME_SIZE];
00868 
00869         TDS_INT column_offset;          
00870         unsigned int column_nullable:1;
00871         unsigned int column_writeable:1;
00872         unsigned int column_identity:1;
00873         unsigned int column_key:1;
00874         unsigned int column_hidden:1;
00875         unsigned int column_output:1;
00876         unsigned int column_timestamp:1;
00877         TDS_UCHAR column_collation[5];
00878 
00879         /* additional fields flags for compute results */
00880         TDS_TINYINT column_operator;
00881         TDS_SMALLINT column_operand;
00882 
00883         /* FIXME this is data related, not column */
00885         TDS_INT column_cur_size;
00886 
00887         /* related to binding or info stored by client libraries */
00888         /* FIXME find a best place to store these data, some are unused */
00889         TDS_SMALLINT column_bindtype;
00890         TDS_SMALLINT column_bindfmt;
00891         TDS_UINT column_bindlen;
00892         TDS_SMALLINT *column_nullbind;
00893         TDS_CHAR *column_varaddr;
00894         TDS_INT *column_lenbind;
00895         TDS_INT column_textpos;
00896         TDS_INT column_text_sqlgetdatapos;
00897 
00898         BCPCOLDATA *bcp_column_data;
00907         TDS_INT bcp_prefix_len;
00908         TDS_INT bcp_term_len;
00909         TDS_CHAR *bcp_terminator;
00910 } TDSCOLUMN;
00911 
00912 
00914 typedef struct tds_result_info
00915 {
00916         /* TODO those fields can became a struct */
00917         TDS_SMALLINT num_cols;
00918         TDSCOLUMN **columns;
00919         TDS_INT row_size;
00920         TDS_INT ref_count;
00921         unsigned char *current_row;
00922 
00923         TDS_SMALLINT rows_exist;
00924         /* TODO remove ?? used only in dblib */
00925         TDS_INT row_count;
00926         /* TODO remove ?? used only in dblib */
00927         TDS_TINYINT more_results;
00928         TDS_SMALLINT computeid;
00929         TDS_SMALLINT *bycolumns;
00930         TDS_SMALLINT by_cols;
00931 } TDSRESULTINFO;
00932 
00933 /* values for tds->state */
00934 typedef enum _TDS_STATE
00935 {
00936         TDS_IDLE,
00937         TDS_QUERYING,
00938         TDS_PENDING,
00939         TDS_READING,
00940         TDS_DEAD
00941 } TDS_STATE;
00942 
00943 #define TDS_DBG_FUNC    __FILE__, ((__LINE__ << 4) | 7)
00944 #define TDS_DBG_INFO2   __FILE__, ((__LINE__ << 4) | 6)
00945 #define TDS_DBG_INFO1   __FILE__, ((__LINE__ << 4) | 5)
00946 #define TDS_DBG_NETWORK __FILE__, ((__LINE__ << 4) | 4)
00947 #define TDS_DBG_WARN    __FILE__, ((__LINE__ << 4) | 3)
00948 #define TDS_DBG_ERROR   __FILE__, ((__LINE__ << 4) | 2)
00949 #define TDS_DBG_SEVERE  __FILE__, ((__LINE__ << 4) | 1)
00950 
00951 #define TDS_DBGFLAG_FUNC    0x80
00952 #define TDS_DBGFLAG_INFO2   0x40
00953 #define TDS_DBGFLAG_INFO1   0x20
00954 #define TDS_DBGFLAG_NETWORK 0x10
00955 #define TDS_DBGFLAG_WARN    0x08
00956 #define TDS_DBGFLAG_ERROR   0x04
00957 #define TDS_DBGFLAG_SEVERE  0x02
00958 #define TDS_DBGFLAG_ALLLVL  0xfff
00959 #define TDS_DBGFLAG_PID     0x1000
00960 #define TDS_DBGFLAG_TIME    0x2000
00961 #define TDS_DBGFLAG_SOURCE  0x4000
00962 #define TDS_DBGFLAG_THREAD  0x8000
00963 
00969 enum TDS_DBG_LOG_STATE
00970 {
00971           TDS_DBG_LOGIN = 1             /* for diagnosing login problems;                                       
00972                                            otherwise the username/password information is suppressed. */
00973         , TDS_DBG_API =    (1 << 1)     /* Log calls to client libraries */
00974         , TDS_DBG_ASYNC =  (1 << 2)     /* Log asynchronous function starts or completes. */
00975         , TDS_DBG_DIAG =   (1 << 3)     /* Log client- and server-generated messages */
00976         , TDS_DBG_error =  (1 << 4)
00977         /* TODO:  ^^^^^ make upper case when old #defines (above) are removed */
00978         /* Log FreeTDS runtime/logic error occurs. */
00979         , TDS_DBG_PACKET = (1 << 5)     /* Log hex dump of packets to/from the server. */
00980         , TDS_DBG_LIBTDS = (1 << 6)     /* Log calls to (and in) libtds */
00981         , TDS_DBG_CONFIG = (1 << 7)     /* replaces TDSDUMPCONFIG */
00982         , TDS_DBG_DEFAULT = 0xFE        /* all above except login packets */
00983 };
00984 
00985 typedef struct tds_result_info TDSCOMPUTEINFO;
00986 
00987 typedef TDSRESULTINFO TDSPARAMINFO;
00988 
00989 typedef struct tds_message
00990 {
00991         TDS_SMALLINT priv_msg_type;
00992         TDS_SMALLINT line_number;
00993         TDS_UINT msgno;
00994         TDS_SMALLINT state;
00995         TDS_SMALLINT severity;
00996         TDS_CHAR *server;
00997         TDS_CHAR *message;
00998         TDS_CHAR *proc_name;
00999         TDS_CHAR *sql_state;
01000 } TDSMESSAGE;
01001 
01002 typedef struct tds_upd_col
01003 {
01004         struct tds_upd_col *next;       
01005         TDS_INT colnamelength;
01006         char * columnname;
01007 } TDSUPDCOL;
01008 
01009 typedef enum {
01010           TDS_CURSOR_STATE_UNACTIONED = 0   /* initial value */
01011         , TDS_CURSOR_STATE_REQUESTED = 1        /* called by ct_cursor */ 
01012         , TDS_CURSOR_STATE_SENT = 2             /* sent to server */
01013         , TDS_CURSOR_STATE_ACTIONED = 3         /* acknowledged by server */
01014 } TDS_CURSOR_STATE;
01015 
01016 typedef struct _tds_cursor_status
01017 {
01018         TDS_CURSOR_STATE declare;
01019         TDS_CURSOR_STATE cursor_row;
01020         TDS_CURSOR_STATE open;
01021         TDS_CURSOR_STATE fetch;
01022         TDS_CURSOR_STATE close; 
01023         TDS_CURSOR_STATE dealloc;
01024 } TDS_CURSOR_STATUS;
01025 
01026 typedef struct _tds_cursor 
01027 {
01028         struct _tds_cursor *next;       
01029         TDS_INT length;                 
01030         TDS_TINYINT cursor_name_len;    
01031         char *cursor_name;              
01032         TDS_INT cursor_id;              
01033         TDS_TINYINT options;            
01034         TDS_TINYINT hasargs;            
01035         TDS_USMALLINT query_len;        
01036         char *query;                    
01037         /* TODO for updatable columns */
01038         TDS_TINYINT number_upd_cols;    
01039         TDS_INT cursor_rows;            
01040         /*TODO when cursor has parameters*/
01041         /*TDS_PARAM *param_list;         cursor parameter */
01042         TDSUPDCOL *cur_col_list;        
01043         TDS_CURSOR_STATUS status;
01044         TDS_SMALLINT srv_status;
01045         TDSRESULTINFO *res_info;
01046 } TDSCURSOR;
01047 
01048 /*
01049  * Current environment as reported by the server
01050  */
01051 typedef struct tds_env
01052 {
01053         int block_size;
01054         char *language;
01055         char *charset;
01056         char *database;
01057 } TDSENV;
01058 
01059 typedef struct tds_dynamic
01060 {
01061         struct tds_dynamic *next;       
01062         char id[30];
01063         int dyn_state;
01065         TDS_INT num_id;
01066         TDSPARAMINFO *res_info;
01067         TDSPARAMINFO *params;
01068         int emulated;
01070         char *query;
01071 } TDSDYNAMIC;
01072 
01073 typedef enum {
01074         TDS_MULTIPLE_QUERY,
01075         TDS_MULTIPLE_EXECUTE,
01076         TDS_MULTIPLE_RPC
01077 } TDS_MULTIPLE_TYPE;
01078 
01079 typedef struct tds_multiple
01080 {
01081         TDS_MULTIPLE_TYPE type;
01082         unsigned int flags;
01083 } TDSMULTIPLE;
01084 
01085 /* forward declaration */
01086 typedef struct tds_context TDSCONTEXT;
01087 
01088 struct tds_context
01089 {
01090         TDSLOCALE *locale;
01091         void *parent;
01092         /* handler */
01093         int (*msg_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
01094         int (*err_handler) (const TDSCONTEXT *, TDSSOCKET *, TDSMESSAGE *);
01095 };
01096 
01097 enum TDS_ICONV_ENTRY
01098 { 
01099           client2ucs2
01100         , client2server_chardata
01101         , iso2server_metadata
01102         , initial_char_conv_count       /* keep last */
01103 };
01104 
01105 struct tds_socket
01106 {
01107         /* fixed and connect time */
01108         TDS_SYS_SOCKET s;
01109         TDS_SMALLINT major_version;
01110         TDS_SMALLINT minor_version;
01112         TDS_UINT product_version;
01113         char *product_name;
01114         unsigned char capabilities[TDS_MAX_CAPABILITY];
01115         unsigned char broken_dates;
01116         unsigned char option_flag2;
01117         /* in/out buffers */
01118         unsigned char *in_buf;
01119         unsigned char *out_buf;
01120         unsigned int in_buf_max;
01121         unsigned in_pos;
01122         unsigned out_pos;
01123         unsigned in_len;
01124         /* TODO remove blocksize from env and use out_len ?? */
01125 /*      unsigned out_len; */
01126         unsigned char in_flag;
01127         unsigned char out_flag;
01128         unsigned char last_packet;
01129         void *parent;
01135         TDSRESULTINFO *current_results;
01136         TDSRESULTINFO *res_info;
01137         TDS_INT num_comp_info;
01138         TDSCOMPUTEINFO **comp_info;
01139         TDSPARAMINFO *param_info;
01140         TDSCURSOR *cur_cursor;  
01141         TDSCURSOR *cursors;     
01142         TDS_TINYINT has_status;
01143         TDS_INT ret_status;
01144         TDS_STATE state;
01145         volatile unsigned char in_cancel;
01146         int rows_affected;
01147         /* timeout stuff from Jeff */
01148         TDS_INT query_timeout;
01149         int (*query_timeout_func) (void *param, unsigned int total_timeout);
01150         void *query_timeout_param;
01151         time_t query_start_time;
01152         TDSENV env;
01153 
01154         /* dynamic placeholder stuff */
01155         TDSDYNAMIC *cur_dyn;    
01156         TDSDYNAMIC *dyns;       
01158         int emul_little_endian;
01159         char *date_fmt;
01160         const TDSCONTEXT *tds_ctx;
01161         int char_conv_count;
01162         TDSICONV **char_convs;
01163 
01165         TDSCONNECTION *connection;
01166 
01167         int spid;
01168         TDS_UCHAR collation[5];
01169         void (*env_chg_func) (TDSSOCKET * tds, int type, char *oldval, char *newval);
01170         int internal_sp_called;
01171 
01172         void *tls_session;
01173         void *tls_credentials;
01174         int option_value;
01175 };
01176 
01177 int tds_init_write_buf(TDSSOCKET * tds);
01178 void tds_free_result_info(TDSRESULTINFO * info);
01179 void tds_free_socket(TDSSOCKET * tds);
01180 void tds_free_connection(TDSCONNECTION * connection);
01181 void tds_free_all_results(TDSSOCKET * tds);
01182 void tds_free_results(TDSRESULTINFO * res_info);
01183 void tds_free_param_results(TDSPARAMINFO * param_info);
01184 void tds_free_msg(TDSMESSAGE * message);
01185 void tds_free_cursor(TDSSOCKET * tds, TDSCURSOR * cursor);
01186 void tds_free_bcp_column_data(BCPCOLDATA * coldata);
01187 
01188 int tds_put_n(TDSSOCKET * tds, const void *buf, int n);
01189 int tds_put_string(TDSSOCKET * tds, const char *buf, int len);
01190 int tds_put_int(TDSSOCKET * tds, TDS_INT i);
01191 int tds_put_int8(TDSSOCKET * tds, TDS_INT8 i);
01192 int tds_put_smallint(TDSSOCKET * tds, TDS_SMALLINT si);
01194 #define tds_put_tinyint(tds, ti) tds_put_byte(tds,ti)
01195 int tds_put_byte(TDSSOCKET * tds, unsigned char c);
01196 TDSRESULTINFO *tds_alloc_results(int num_cols);
01197 TDSCOMPUTEINFO **tds_alloc_compute_results(TDSSOCKET * tds, int num_cols, int by_cols);
01198 TDSCONTEXT *tds_alloc_context(void * parent);
01199 void tds_free_context(TDSCONTEXT * locale);
01200 TDSSOCKET *tds_alloc_socket(TDSCONTEXT * context, int bufsize);
01201 
01202 /* config.c */
01203 const TDS_COMPILETIME_SETTINGS *tds_get_compiletime_settings(void);
01204 typedef void (*TDSCONFPARSE) (const char *option, const char *value, void *param);
01205 int tds_read_conf_section(FILE * in, const char *section, TDSCONFPARSE tds_conf_parse, void *parse_param);
01206 int tds_read_conf_file(TDSCONNECTION * connection, const char *server);
01207 TDSCONNECTION *tds_read_config_info(TDSSOCKET * tds, TDSLOGIN * login, TDSLOCALE * locale);
01208 void tds_fix_connection(TDSCONNECTION * connection);
01209 void tds_config_verstr(const char *tdsver, TDSCONNECTION * connection);
01210 void tds_lookup_host(const char *servername, char *ip);
01211 int tds_set_interfaces_file_loc(const char *interfloc);
01212 
01213 TDSLOCALE *tds_get_locale(void);
01214 unsigned char *tds_alloc_row(TDSRESULTINFO * res_info);
01215 unsigned char *tds_alloc_compute_row(TDSCOMPUTEINFO * res_info);
01216 BCPCOLDATA * tds_alloc_bcp_column_data(int column_size);
01217 int tds_alloc_get_string(TDSSOCKET * tds, char **string, int len);
01218 unsigned char *tds7_crypt_pass(const unsigned char *clear_pass, int len, unsigned char *crypt_pass);
01219 TDSDYNAMIC *tds_lookup_dynamic(TDSSOCKET * tds, char *id);
01220 const char *tds_prtype(int token);
01221 
01222 
01223 
01224 /* iconv.c */
01225 void tds_iconv_open(TDSSOCKET * tds, const char *charset);
01226 void tds_iconv_close(TDSSOCKET * tds);
01227 void tds_srv_charset_changed(TDSSOCKET * tds, const char *charset);
01228 void tds7_srv_charset_changed(TDSSOCKET * tds, int sql_collate, int lcid);
01229 int tds_iconv_alloc(TDSSOCKET * tds);
01230 void tds_iconv_free(TDSSOCKET * tds);
01231 TDSICONV *tds_iconv_from_collate(TDSSOCKET * tds, int sql_collate, int lcid);
01232 
01233 /* threadsafe.c */
01234 char *tds_timestamp_str(char *str, int maxlen);
01235 struct hostent *tds_gethostbyname_r(const char *servername, struct hostent *result, char *buffer, int buflen, int *h_errnop);
01236 struct hostent *tds_gethostbyaddr_r(const char *addr, int len, int type, struct hostent *result, char *buffer, int buflen,
01237                                     int *h_errnop);
01238 struct servent *tds_getservbyname_r(const char *name, const char *proto, struct servent *result, char *buffer, int buflen);
01239 #ifdef INADDR_NONE
01240 const char *tds_inet_ntoa_r(struct in_addr iaddr, char *ip, size_t len);
01241 #endif
01242 char *tds_get_homedir(void);
01243 
01244 /* mem.c */
01245 TDSPARAMINFO *tds_alloc_param_result(TDSPARAMINFO * old_param);
01246 void tds_free_input_params(TDSDYNAMIC * dyn);
01247 void tds_free_dynamic(TDSSOCKET * tds, TDSDYNAMIC * dyn);
01248 TDSSOCKET *tds_realloc_socket(TDSSOCKET * tds, int bufsize);
01249 unsigned char *tds_alloc_param_row(TDSPARAMINFO * info, TDSCOLUMN * curparam);
01250 char *tds_alloc_client_sqlstate(int msgno);
01251 char *tds_alloc_lookup_sqlstate(TDSSOCKET * tds, int msgno);
01252 TDSLOGIN *tds_alloc_login(void);
01253 TDSDYNAMIC *tds_alloc_dynamic(TDSSOCKET * tds, const char *id);
01254 void tds_free_login(TDSLOGIN * login);
01255 TDSCONNECTION *tds_alloc_connection(TDSLOCALE * locale);
01256 TDSLOCALE *tds_alloc_locale(void);
01257 void tds_free_locale(TDSLOCALE * locale);
01258 TDSCURSOR * tds_alloc_cursor(TDSSOCKET * tds, const char *name, TDS_INT namelen, const char *query, TDS_INT querylen);
01259 void tds_free_row(const TDSRESULTINFO * res_info, unsigned char *row);
01260 
01261 /* login.c */
01262 int tds7_send_auth(TDSSOCKET * tds, const unsigned char *challenge);
01263 void tds_set_packet(TDSLOGIN * tds_login, int packet_size);
01264 void tds_set_port(TDSLOGIN * tds_login, int port);
01265 void tds_set_passwd(TDSLOGIN * tds_login, const char *password);
01266 void tds_set_bulk(TDSLOGIN * tds_login, TDS_TINYINT enabled);
01267 void tds_set_user(TDSLOGIN * tds_login, const char *username);
01268 void tds_set_app(TDSLOGIN * tds_login, const char *application);
01269 void tds_set_host(TDSLOGIN * tds_login, const char *hostname);
01270 void tds_set_server_addr(TDSLOGIN * tds_login, const char *server_addr);
01271 void tds_set_library(TDSLOGIN * tds_login, const char *library);
01272 void tds_set_server(TDSLOGIN * tds_login, const char *server);
01273 void tds_set_client_charset(TDSLOGIN * tds_login, const char *charset);
01274 void tds_set_language(TDSLOGIN * tds_login, const char *language);
01275 void tds_set_version(TDSLOGIN * tds_login, short major_ver, short minor_ver);
01276 void tds_set_capabilities(TDSLOGIN * tds_login, unsigned char *capabilities, int size);
01277 int tds_connect(TDSSOCKET * tds, TDSCONNECTION * connection);
01278 
01279 /* query.c */
01280 int tds_submit_query(TDSSOCKET * tds, const char *query);
01281 int tds_submit_query_params(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params);
01282 int tds_submit_queryf(TDSSOCKET * tds, const char *queryf, ...);
01283 int tds_submit_prepare(TDSSOCKET * tds, const char *query, const char *id, TDSDYNAMIC ** dyn_out, TDSPARAMINFO * params);
01284 int tds_submit_execdirect(TDSSOCKET * tds, const char *query, TDSPARAMINFO * params);
01285 int tds_submit_execute(TDSSOCKET * tds, TDSDYNAMIC * dyn);
01286 int tds_send_cancel(TDSSOCKET * tds);
01287 const char *tds_next_placeholder(const char *start);
01288 int tds_count_placeholders(const char *query);
01289 int tds_get_dynid(TDSSOCKET * tds, char **id);
01290 int tds_submit_unprepare(TDSSOCKET * tds, TDSDYNAMIC * dyn);
01291 int tds_submit_rpc(TDSSOCKET * tds, const char *rpc_name, TDSPARAMINFO * params);
01292 int tds_submit_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD command, TDS_OPTION option, TDS_OPTION_ARG *param, TDS_INT param_size);
01293 int tds_quote_id(TDSSOCKET * tds, char *buffer, const char *id, int idlen);
01294 int tds_quote_string(TDSSOCKET * tds, char *buffer, const char *str, int len);
01295 const char *tds_skip_quoted(const char *s);
01296 
01297 int tds_cursor_declare(TDSSOCKET * tds, TDSCURSOR * cursor, int *send);
01298 int tds_cursor_setrows(TDSSOCKET * tds, TDSCURSOR * cursor, int *send);
01299 int tds_cursor_open(TDSSOCKET * tds, TDSCURSOR * cursor, int *send);
01300 int tds_cursor_fetch(TDSSOCKET * tds, TDSCURSOR * cursor);
01301 int tds_cursor_close(TDSSOCKET * tds, TDSCURSOR * cursor);
01302 int tds_cursor_dealloc(TDSSOCKET * tds, TDSCURSOR * cursor);
01303 
01304 int tds_multiple_init(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDS_MULTIPLE_TYPE type);
01305 int tds_multiple_done(TDSSOCKET *tds, TDSMULTIPLE *multiple);
01306 int tds_multiple_query(TDSSOCKET *tds, TDSMULTIPLE *multiple, const char *query, TDSPARAMINFO * params);
01307 int tds_multiple_execute(TDSSOCKET *tds, TDSMULTIPLE *multiple, TDSDYNAMIC * dyn);
01308 
01309 /* token.c */
01310 int tds_process_cancel(TDSSOCKET * tds);
01311 void tds_swap_datatype(int coltype, unsigned char *buf);
01312 void tds_swap_numeric(TDS_NUMERIC *num);
01313 int tds_get_token_size(int marker);
01314 int tds_process_login_tokens(TDSSOCKET * tds);
01315 void tds_add_row_column_size(TDSRESULTINFO * info, TDSCOLUMN * curcol);
01316 int tds_process_simple_query(TDSSOCKET * tds);
01317 int tds5_send_optioncmd(TDSSOCKET * tds, TDS_OPTION_CMD tds_command, TDS_OPTION tds_option, TDS_OPTION_ARG * tds_argument,
01318                         TDS_INT * tds_argsize);
01319 int tds_client_msg(const TDSCONTEXT * tds_ctx, TDSSOCKET * tds, int msgno, int severity, int state, int line, const char *message);
01320 int tds_process_tokens(TDSSOCKET * tds, TDS_INT * result_type, int *done_flags, unsigned flag);
01321 
01322 /* data.c */
01323 void tds_set_param_type(TDSSOCKET * tds, TDSCOLUMN * curcol, TDS_SERVER_TYPE type);
01324 void tds_set_column_type(TDSCOLUMN * curcol, int type);
01325 
01326 
01327 /* tds_convert.c */
01328 TDS_INT tds_datecrack(TDS_INT datetype, const void *di, TDSDATEREC * dr);
01329 int tds_get_conversion_type(int srctype, int colsize);
01330 extern const char tds_hex_digits[];
01331 
01332 /* write.c */
01333 int tds_flush_packet(TDSSOCKET * tds);
01334 int tds_put_buf(TDSSOCKET * tds, const unsigned char *buf, int dsize, int ssize);
01335 
01336 /* read.c */
01337 unsigned char tds_get_byte(TDSSOCKET * tds);
01338 void tds_unget_byte(TDSSOCKET * tds);
01339 unsigned char tds_peek(TDSSOCKET * tds);
01340 TDS_SMALLINT tds_get_smallint(TDSSOCKET * tds);
01341 TDS_INT tds_get_int(TDSSOCKET * tds);
01342 int tds_get_string(TDSSOCKET * tds, int string_len, char *dest, size_t dest_size);
01343 int tds_get_char_data(TDSSOCKET * tds, char *dest, size_t wire_size, TDSCOLUMN * curcol);
01344 void *tds_get_n(TDSSOCKET * tds, void *dest, int n);
01345 int tds_get_size_by_type(int servertype);
01346 
01347 
01348 /* util.c */
01349 TDS_STATE tds_set_state(TDSSOCKET * tds, TDS_STATE state);
01350 void tds_set_parent(TDSSOCKET * tds, void *the_parent);
01351 void *tds_get_parent(TDSSOCKET * tds);
01352 int tds_swap_bytes(unsigned char *buf, int bytes);
01353 int tds_version(TDSSOCKET * tds_socket, char *pversion_string);
01354 void tdsdump_off(void);
01355 void tdsdump_on(void);
01356 int tdsdump_open(const char *filename);
01357 void tdsdump_close(void);
01358 void tdsdump_dump_buf(const char* file, unsigned int level_line, const char *msg, const void *buf, int length);
01359 void tdsdump_log(const char* file, unsigned int level_line, const char *fmt, ...) 
01360 #if defined(__GNUC__) && __GNUC__ >= 2
01361         __attribute__ ((__format__ (__printf__, 3, 4)))
01362 #endif
01363 ;
01364 extern int tds_debug_flags;
01365 
01366 /* net.c */
01367 int tds_open_socket(TDSSOCKET * tds, const char *ip_addr, unsigned int port, int timeout);
01368 int tds_close_socket(TDSSOCKET * tds);
01369 int tds_read_packet(TDSSOCKET * tds);
01370 int tds_write_packet(TDSSOCKET * tds, unsigned char final);
01371 int tds7_get_instance_port(const char *ip_addr, const char *instance);
01372 int tds_ssl_init(TDSSOCKET *tds);
01373 void tds_ssl_deinit(TDSSOCKET *tds);
01374 
01375 
01376 
01377 /* vstrbuild.c */
01378 int tds_vstrbuild(char *buffer, int buflen, int *resultlen, char *text, int textlen, const char *formats, int formatlen,
01379                   va_list ap);
01380 
01381 /* numeric.c */
01382 char *tds_money_to_string(const TDS_MONEY * money, char *s);
01383 TDS_INT tds_numeric_to_string(const TDS_NUMERIC * numeric, char *s);
01384 TDS_INT tds_numeric_change_prec_scale(TDS_NUMERIC * numeric, unsigned char new_prec, unsigned char new_scale);
01385 
01386 /* getmac.c */
01387 void tds_getmac(int s, unsigned char mac[6]);
01388 
01389 typedef struct tds_answer
01390 {
01391         unsigned char lm_resp[24];
01392         unsigned char nt_resp[24];
01393 } TDSANSWER;
01394 void tds_answer_challenge(const char *passwd, const unsigned char *challenge, TDSANSWER * answer);
01395 
01396 #define IS_TDS42(x) (x->major_version==4 && x->minor_version==2)
01397 #define IS_TDS46(x) (x->major_version==4 && x->minor_version==6)
01398 #define IS_TDS50(x) (x->major_version==5 && x->minor_version==0)
01399 #define IS_TDS70(x) (x->major_version==7 && x->minor_version==0)
01400 #define IS_TDS80(x) (x->major_version==8 && x->minor_version==0)
01401 
01402 #define IS_TDS7_PLUS(x) ( IS_TDS70(x) || IS_TDS80(x) )
01403 
01404 #define IS_TDSDEAD(x) (((x) == NULL) || TDS_IS_SOCKET_INVALID((x)->s))
01405 
01407 #define TDS_IS_SYBASE(x) (!(x->product_version & 0x80000000u))
01408 
01409 #define TDS_IS_MSSQL(x) ((x->product_version & 0x80000000u)!=0)
01410 
01414 #define TDS_MS_VER(maj,min,x) (0x80000000u|((maj)<<24)|((min)<<16)|(x))
01415 
01416 /* TODO test if not similar to ms one*/
01418 #define TDS_SYB_VER(maj,min,x) (((maj)<<24)|((min)<<16)|(x)<<8)
01419 
01420 #ifdef __cplusplus
01421 #if 0
01422 {
01423 #endif
01424 }
01425 #endif
01426 
01427 #endif /* _tds_h_ */

Generated on Thu Sep 1 00:36:11 2005 for FreeTDS API by  doxygen 1.4.4