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