git.sur5r.net Git - openldap/blob - servers/slapd/back-sql/sql-wrap.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1999-2005 The OpenLDAP Foundation.
   5  * Portions Copyright 1999 Dmitry Kovalev.
   6  * Portions Copyright 2002 Pierangelo Masarati.
   7  * Portions Copyright 2004 Mark Adamson.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted only as authorized by the OpenLDAP
  12  * Public License.
  13  *
  14  * A copy of this license is available in the file LICENSE in the
  15  * top-level directory of the distribution or, alternatively, at
  16  * <http://www.OpenLDAP.org/license.html>.
  17  */
  18 /* ACKNOWLEDGEMENTS:
  19  * This work was initially developed by Dmitry Kovalev for inclusion
  20  * by OpenLDAP Software.  Additional significant contributors include
  21  * Pierangelo Masarati and Mark Adamson.
  22  */
  23
  24 #include "portable.h"
  25
  26 #include <stdio.h>
  27 #include "ac/string.h"
  28 #include <sys/types.h>
  29
  30 #include "slap.h"
  31 #include "proto-sql.h"
  32
  33 #define MAX_ATTR_LEN 16384
  34
  35 typedef struct backsql_db_conn {
  36         unsigned long   ldap_cid;
  37         SQLHDBC         dbh;
  38 } backsql_db_conn;
  39
  40 void
  41 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
  42 {
  43         SQLCHAR msg[SQL_MAX_MESSAGE_LENGTH];            /* msg. buffer    */
  44         SQLCHAR state[SQL_SQLSTATE_SIZE];               /* statement buf. */
  45         SDWORD  iSqlCode;                               /* return code    */
  46         SWORD   len = SQL_MAX_MESSAGE_LENGTH - 1;       /* return length  */
  47
  48         Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
  49
  50         for ( ; rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
  51                         SQL_MAX_MESSAGE_LENGTH - 1, &len ), BACKSQL_SUCCESS( rc ); ) {
  52                 Debug( LDAP_DEBUG_TRACE,
  53                                 "   Native error code: %d\n"
  54                                 "   SQL engine state:  %s\n"
  55                                 "   Message:           %s\n",
  56                                 (int)iSqlCode, state, msg );
  57         }
  58 }
  59
  60 RETCODE
  61 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
  62 {
  63         RETCODE         rc;
  64
  65         rc = SQLAllocStmt( dbh, sth );
  66         if ( rc != SQL_SUCCESS ) {
  67                 return rc;
  68         }
  69
  70 #ifdef BACKSQL_TRACE
  71         Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
  72 #endif /* BACKSQL_TRACE */
  73
  74 #ifdef BACKSQL_MSSQL_WORKAROUND
  75         {
  76                 char            drv_name[ 30 ];
  77                 SWORD           len;
  78
  79                 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
  80
  81 #ifdef BACKSQL_TRACE
  82                 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
  83                                 drv_name, 0, 0 );
  84 #endif /* BACKSQL_TRACE */
  85
  86                 ldap_pvt_str2upper( drv_name );
  87                 if ( !strncmp( drv_name, "SQLSRV32.DLL", STRLENOF( "SQLSRV32.DLL" ) ) ) {
  88                         /*
  89                          * stupid default result set in MS SQL Server
  90                          * does not support multiple active statements
  91                          * on the same connection -- so we are trying
  92                          * to make it not to use default result set...
  93                          */
  94                         Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
  95                                 "enabling MS SQL Server default result "
  96                                 "set workaround\n", 0, 0, 0 );
  97                         rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
  98                                         SQL_CONCUR_ROWVER );
  99                         if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
 100                                 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
 101                                         "SQLSetStmtOption(SQL_CONCURRENCY,"
 102                                         "SQL_CONCUR_ROWVER) failed:\n",
 103                                         0, 0, 0 );
 104                                 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
 105                                 SQLFreeStmt( *sth, SQL_DROP );
 106                                 return rc;
 107                         }
 108                 }
 109         }
 110 #endif /* BACKSQL_MSSQL_WORKAROUND */
 111
 112         if ( timeout > 0 ) {
 113                 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
 114                         "setting query timeout to %d sec.\n",
 115                         timeout, 0, 0 );
 116                 rc = SQLSetStmtOption( *sth, SQL_QUERY_TIMEOUT, timeout );
 117                 if ( rc != SQL_SUCCESS ) {
 118                         backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
 119                         SQLFreeStmt( *sth, SQL_DROP );
 120                         return rc;
 121                 }
 122         }
 123
 124 #ifdef BACKSQL_TRACE
 125         Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
 126                         0, 0, 0 );
 127 #endif /* BACKSQL_TRACE */
 128
 129         return SQLPrepare( *sth, (SQLCHAR *)query, SQL_NTS );
 130 }
 131
 132 RETCODE
 133 backsql_BindRowAsStrings_x( SQLHSTMT sth, BACKSQL_ROW_NTS *row, void *ctx )
 134 {
 135         RETCODE         rc;
 136         SQLCHAR         colname[ 64 ];
 137         SQLSMALLINT     name_len, col_type, col_scale, col_null;
 138         UDWORD          col_prec;
 139         int             i;
 140
 141         if ( row == NULL ) {
 142                 return SQL_ERROR;
 143         }
 144
 145 #ifdef BACKSQL_TRACE
 146         Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
 147 #endif /* BACKSQL_TRACE */
 148
 149         rc = SQLNumResultCols( sth, &row->ncols );
 150         if ( rc != SQL_SUCCESS ) {
 151 #ifdef BACKSQL_TRACE
 152                 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
 153                         "SQLNumResultCols() failed:\n", 0, 0, 0 );
 154 #endif /* BACKSQL_TRACE */
 155
 156                 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
 157
 158         } else {
 159 #ifdef BACKSQL_TRACE
 160                 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
 161                         "ncols=%d\n", (int)row->ncols, 0, 0 );
 162 #endif /* BACKSQL_TRACE */
 163
 164                 row->col_names = (BerVarray)ber_memcalloc_x( row->ncols + 1,
 165                                 sizeof( struct berval ), ctx );
 166                 row->cols = (char **)ber_memcalloc_x( row->ncols + 1,
 167                                 sizeof( char * ), ctx );
 168                 row->col_prec = (UDWORD *)ber_memcalloc_x( row->ncols,
 169                                 sizeof( UDWORD ), ctx );
 170                 row->value_len = (SQLINTEGER *)ber_memcalloc_x( row->ncols,
 171                                 sizeof( SQLINTEGER ), ctx );
 172                 for ( i = 1; i <= row->ncols; i++ ) {
 173                         rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
 174                                         (SQLUINTEGER)( sizeof( colname ) - 1 ),
 175                                         &name_len, &col_type,
 176                                         &col_prec, &col_scale, &col_null );
 177                         /* FIXME: test rc? */
 178
 179                         ber_str2bv_x( (char *)colname, 0, 1,
 180                                         &row->col_names[ i - 1 ], ctx );
 181 #ifdef BACKSQL_TRACE
 182                         Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
 183                                 "col_name=%s, col_prec[%d]=%d\n",
 184                                 colname, (int)i, (int)col_prec );
 185 #endif /* BACKSQL_TRACE */
 186                         if ( col_type != SQL_CHAR && col_type != SQL_VARCHAR )
 187                         {
 188                                 col_prec = MAX_ATTR_LEN;
 189                         }
 190
 191                         row->cols[ i - 1 ] = (char *)ber_memcalloc_x( col_prec + 1,
 192                                         sizeof( char ), ctx );
 193                         row->col_prec[ i - 1 ] = col_prec;
 194                         rc = SQLBindCol( sth, (SQLUSMALLINT)i,
 195                                          SQL_C_CHAR,
 196                                          (SQLPOINTER)row->cols[ i - 1 ],
 197                                          col_prec + 1,
 198                                          &row->value_len[ i - 1 ] );
 199                         /* FIXME: test rc? */
 200                 }
 201
 202                 BER_BVZERO( &row->col_names[ i - 1 ] );
 203                 row->cols[ i - 1 ] = NULL;
 204         }
 205
 206 #ifdef BACKSQL_TRACE
 207         Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
 208 #endif /* BACKSQL_TRACE */
 209
 210         return rc;
 211 }
 212
 213 RETCODE
 214 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
 215 {
 216         return backsql_BindRowAsStrings_x( sth, row, NULL );
 217 }
 218
 219 RETCODE
 220 backsql_FreeRow_x( BACKSQL_ROW_NTS *row, void *ctx )
 221 {
 222         if ( row->cols == NULL ) {
 223                 return SQL_ERROR;
 224         }
 225
 226         ber_bvarray_free_x( row->col_names, ctx );
 227         ber_memvfree_x( (void **)row->cols, ctx );
 228         ber_memfree_x( row->col_prec, ctx );
 229         ber_memfree_x( row->value_len, ctx );
 230
 231         return SQL_SUCCESS;
 232 }
 233
 234
 235 RETCODE
 236 backsql_FreeRow( BACKSQL_ROW_NTS *row )
 237 {
 238         return backsql_FreeRow_x( row, NULL );
 239 }
 240
 241 static int
 242 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
 243 {
 244         const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
 245         if ( c1->ldap_cid > c2->ldap_cid ) {
 246                 return 1;
 247         }
 248
 249         if ( c1->ldap_cid < c2->ldap_cid ) {
 250                 return -1;
 251         }
 252
 253         return 0;
 254 }
 255
 256 static void
 257 backsql_close_db_conn( void *v_conn )
 258 {
 259         backsql_db_conn *conn =         (backsql_db_conn *)v_conn;
 260
 261         Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn(%lu)\n",
 262                 conn->ldap_cid, 0, 0 );
 263
 264         /*
 265          * Default transact is SQL_ROLLBACK; commit is required only
 266          * by write operations, and it is explicitly performed after
 267          * each atomic operation succeeds.
 268          */
 269
 270         /* TimesTen */
 271         SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
 272         SQLDisconnect( conn->dbh );
 273         SQLFreeConnect( conn->dbh );
 274         ch_free( conn );
 275
 276         Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn(%lu)\n",
 277                 conn->ldap_cid, 0, 0 );
 278 }
 279
 280 int
 281 backsql_conn_destroy(
 282         backsql_info    *bi )
 283 {
 284         avl_free( bi->sql_db_conns, backsql_close_db_conn );
 285
 286         return 0;
 287 }
 288
 289 int
 290 backsql_init_db_env( backsql_info *bi )
 291 {
 292         RETCODE         rc;
 293         int             ret = SQL_SUCCESS;
 294
 295         Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
 296
 297         rc = SQLAllocEnv( &bi->sql_db_env );
 298         if ( rc != SQL_SUCCESS ) {
 299                 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
 300                                 0, 0, 0 );
 301                 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
 302                                 SQL_NULL_HENV, rc );
 303                 ret = SQL_ERROR;
 304         }
 305
 306         Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
 307
 308         return ret;
 309 }
 310
 311 int
 312 backsql_free_db_env( backsql_info *bi )
 313 {
 314         Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
 315
 316         (void)SQLFreeEnv( bi->sql_db_env );
 317         bi->sql_db_env = SQL_NULL_HENV;
 318
 319         /*
 320          * stop, if frontend waits for all threads to shutdown
 321          * before calling this -- then what are we going to delete??
 322          * everything is already deleted...
 323          */
 324         Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
 325
 326         return SQL_SUCCESS;
 327 }
 328
 329 static int
 330 backsql_open_db_conn( backsql_info *bi, unsigned long ldap_cid, backsql_db_conn **pdbc )
 331 {
 332         /* TimesTen */
 333         char                    DBMSName[ 32 ];
 334         backsql_db_conn         *dbc;
 335         int                     rc;
 336
 337         assert( pdbc != NULL );
 338         *pdbc = NULL;
 339
 340         Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn(%lu)\n",
 341                 ldap_cid, 0, 0 );
 342
 343         dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
 344         dbc->ldap_cid = ldap_cid;
 345         rc = SQLAllocConnect( bi->sql_db_env, &dbc->dbh );
 346         if ( !BACKSQL_SUCCESS( rc ) ) {
 347                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
 348                         "SQLAllocConnect() failed:\n", ldap_cid, 0, 0 );
 349                 backsql_PrintErrors( bi->sql_db_env, SQL_NULL_HDBC,
 350                                 SQL_NULL_HENV, rc );
 351                 return LDAP_UNAVAILABLE;
 352         }
 353
 354         rc = SQLConnect( dbc->dbh,
 355                         (SQLCHAR*)bi->sql_dbname, SQL_NTS,
 356                         (SQLCHAR*)bi->sql_dbuser, SQL_NTS,
 357                         (SQLCHAR*)bi->sql_dbpasswd, SQL_NTS );
 358         if ( rc != SQL_SUCCESS ) {
 359                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
 360                         "SQLConnect() to database \"%s\" %s.\n",
 361                         ldap_cid, bi->sql_dbname,
 362                         rc == SQL_SUCCESS_WITH_INFO ?
 363                         "succeeded with info" : "failed" );
 364                 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
 365                 if ( rc != SQL_SUCCESS_WITH_INFO ) {
 366                         return LDAP_UNAVAILABLE;
 367                 }
 368         }
 369
 370         /*
 371          * TimesTen : Turn off autocommit.  We must explicitly
 372          * commit any transactions.
 373          */
 374         SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
 375
 376         /*
 377          * See if this connection is to TimesTen.  If it is,
 378          * remember that fact for later use.
 379          */
 380         /* Assume until proven otherwise */
 381         bi->sql_flags &= ~BSQLF_USE_REVERSE_DN;
 382         DBMSName[ 0 ] = '\0';
 383         rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
 384                         sizeof( DBMSName ), NULL );
 385         if ( rc == SQL_SUCCESS ) {
 386                 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
 387                                 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
 388                         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
 389                                 "TimesTen database!\n", ldap_cid, 0, 0 );
 390                         bi->sql_flags |= BSQLF_USE_REVERSE_DN;
 391                 }
 392         } else {
 393                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
 394                         "SQLGetInfo() failed.\n", ldap_cid, 0, 0 );
 395                 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
 396                 return rc;
 397         }
 398         /* end TimesTen */
 399
 400         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
 401                 "connected, adding to tree.\n", ldap_cid, 0, 0 );
 402         ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
 403         if ( avl_insert( &bi->sql_db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
 404                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
 405                         "duplicate connection ID.\n", ldap_cid, 0, 0 );
 406                 return LDAP_OTHER;
 407         }
 408         ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
 409         Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn(%lu)\n", ldap_cid, 0, 0 );
 410
 411         *pdbc = dbc;
 412
 413         return LDAP_SUCCESS;
 414 }
 415
 416 int
 417 backsql_free_db_conn( Operation *op )
 418 {
 419         backsql_info            *bi = (backsql_info *)op->o_bd->be_private;
 420         backsql_db_conn         tmp = { 0 },
 421                                 *conn;
 422
 423         Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
 424         tmp.ldap_cid = op->o_connid;
 425         ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
 426         conn = avl_delete( &bi->sql_db_conns, &tmp, backsql_cmp_connid );
 427         ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
 428
 429         /*
 430          * we have one thread per connection, as I understand -- so we can
 431          * get this out of critical section
 432          */
 433         if ( conn != NULL ) {
 434                 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
 435                         "closing db connection %lu (%p)\n",
 436                         op->o_connid, conn, 0 );
 437                 backsql_close_db_conn( (void *)conn );
 438         }
 439
 440         Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
 441
 442         return conn ? SQL_SUCCESS : SQL_ERROR;
 443 }
 444
 445 int
 446 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
 447 {
 448         backsql_info            *bi = (backsql_info *)op->o_bd->be_private;
 449         backsql_db_conn         *dbc,
 450                                 tmp = { 0 };
 451         int                     rc = LDAP_SUCCESS;
 452
 453         Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
 454
 455         assert( dbh != NULL );
 456         *dbh = SQL_NULL_HDBC;
 457
 458         tmp.ldap_cid = op->o_connid;
 459
 460         /*
 461          * we have one thread per connection, as I understand --
 462          * so we do not need locking here
 463          */
 464         dbc = avl_find( bi->sql_db_conns, &tmp, backsql_cmp_connid );
 465         if ( !dbc ) {
 466                 rc = backsql_open_db_conn( bi, op->o_connid, &dbc );
 467                 if ( rc != LDAP_SUCCESS) {
 468                         Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
 469                                 "could not get connection handle "
 470                                 "-- returning NULL\n", 0, 0, 0 );
 471                         return rc;
 472                 }
 473         }
 474
 475         ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
 476         if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
 477                 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
 478                         "first call -- reading schema map\n", 0, 0, 0 );
 479                 rc = backsql_load_schema_map( bi, dbc->dbh );
 480                 if ( rc != LDAP_SUCCESS ) {
 481                         ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
 482                         backsql_free_db_conn( op );
 483                         return rc;
 484                 }
 485         }
 486         ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
 487
 488         *dbh = dbc->dbh;
 489
 490         Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );
 491
 492         return LDAP_SUCCESS;
 493 }
 494