2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2006 The OpenLDAP Foundation.
5 * Portions Copyright 1999 Dmitry Kovalev.
6 * Portions Copyright 2002 Pierangelo Masarati.
7 * Portions Copyright 2004 Mark Adamson.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted only as authorized by the OpenLDAP
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>.
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.
27 #include "ac/string.h"
28 #include <sys/types.h>
31 #include "proto-sql.h"
33 #define MAX_ATTR_LEN 16384
35 typedef struct backsql_db_conn {
36 unsigned long ldap_cid;
41 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
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 */
48 Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
50 for ( ; rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
51 SQL_MAX_MESSAGE_LENGTH - 1, &len ), BACKSQL_SUCCESS( rc ); )
53 Debug( LDAP_DEBUG_TRACE,
54 " nativeErrCode=%d SQLengineState=%s msg=\"%s\"\n",
55 (int)iSqlCode, state, msg );
60 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
64 rc = SQLAllocStmt( dbh, sth );
65 if ( rc != SQL_SUCCESS ) {
70 Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
71 #endif /* BACKSQL_TRACE */
73 #ifdef BACKSQL_MSSQL_WORKAROUND
78 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
81 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
83 #endif /* BACKSQL_TRACE */
85 ldap_pvt_str2upper( drv_name );
86 if ( !strncmp( drv_name, "SQLSRV32.DLL", STRLENOF( "SQLSRV32.DLL" ) ) ) {
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...
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,
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",
103 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
104 SQLFreeStmt( *sth, SQL_DROP );
109 #endif /* BACKSQL_MSSQL_WORKAROUND */
112 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
113 "setting query timeout to %d sec.\n",
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 );
124 Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
126 #endif /* BACKSQL_TRACE */
128 return SQLPrepare( *sth, (SQLCHAR *)query, SQL_NTS );
132 backsql_BindRowAsStrings_x( SQLHSTMT sth, BACKSQL_ROW_NTS *row, void *ctx )
135 SQLCHAR colname[ 64 ];
136 SQLSMALLINT name_len, col_type, col_scale, col_null;
145 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
146 #endif /* BACKSQL_TRACE */
148 rc = SQLNumResultCols( sth, &row->ncols );
149 if ( rc != SQL_SUCCESS ) {
151 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
152 "SQLNumResultCols() failed:\n", 0, 0, 0 );
153 #endif /* BACKSQL_TRACE */
155 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
159 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
160 "ncols=%d\n", (int)row->ncols, 0, 0 );
161 #endif /* BACKSQL_TRACE */
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 );
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;
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? */
192 ber_str2bv_x( (char *)colname, 0, 1,
193 &row->col_names[ i - 1 ], ctx );
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 )
201 col_prec = MAX_ATTR_LEN;
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,
209 (SQLPOINTER)row->cols[ i - 1 ],
211 &row->value_len[ i - 1 ] );
212 /* FIXME: test rc? */
215 BER_BVZERO( &row->col_names[ i - 1 ] );
216 row->cols[ i - 1 ] = NULL;
220 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
221 #endif /* BACKSQL_TRACE */
227 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
229 return backsql_BindRowAsStrings_x( sth, row, NULL );
233 backsql_FreeRow_x( BACKSQL_ROW_NTS *row, void *ctx )
235 if ( row->cols == NULL ) {
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 );
249 backsql_FreeRow( BACKSQL_ROW_NTS *row )
251 return backsql_FreeRow_x( row, NULL );
255 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
257 const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
258 if ( c1->ldap_cid > c2->ldap_cid ) {
262 if ( c1->ldap_cid < c2->ldap_cid ) {
270 backsql_close_db_conn( void *v_conn )
272 backsql_db_conn *conn = (backsql_db_conn *)v_conn;
273 unsigned long cid = conn->ldap_cid;
275 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn(%lu)\n",
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.
285 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
286 SQLDisconnect( conn->dbh );
287 SQLFreeConnect( conn->dbh );
290 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn(%lu)\n",
295 backsql_conn_destroy(
298 avl_free( bi->sql_db_conns, backsql_close_db_conn );
304 backsql_init_db_env( backsql_info *bi )
307 int ret = SQL_SUCCESS;
309 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
311 rc = SQLAllocEnv( &bi->sql_db_env );
312 if ( rc != SQL_SUCCESS ) {
313 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
315 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
320 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
326 backsql_free_db_env( backsql_info *bi )
328 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
330 (void)SQLFreeEnv( bi->sql_db_env );
331 bi->sql_db_env = SQL_NULL_HENV;
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...
338 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
344 backsql_open_db_conn( backsql_info *bi, unsigned long ldap_cid, backsql_db_conn **pdbc )
348 backsql_db_conn *dbc;
351 assert( pdbc != NULL );
354 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn(%lu)\n",
357 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
358 dbc->ldap_cid = ldap_cid;
359 rc = SQLAllocConnect( bi->sql_db_env, &dbc->dbh );
360 if ( !BACKSQL_SUCCESS( rc ) ) {
361 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
362 "SQLAllocConnect() failed:\n", ldap_cid, 0, 0 );
363 backsql_PrintErrors( bi->sql_db_env, SQL_NULL_HDBC,
365 return LDAP_UNAVAILABLE;
368 rc = SQLConnect( dbc->dbh,
369 (SQLCHAR*)bi->sql_dbname, SQL_NTS,
370 (SQLCHAR*)bi->sql_dbuser, SQL_NTS,
371 (SQLCHAR*)bi->sql_dbpasswd, SQL_NTS );
372 if ( rc != SQL_SUCCESS ) {
373 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
374 "SQLConnect() to database \"%s\" %s.\n",
375 ldap_cid, bi->sql_dbname,
376 rc == SQL_SUCCESS_WITH_INFO ?
377 "succeeded with info" : "failed" );
378 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
379 if ( rc != SQL_SUCCESS_WITH_INFO ) {
380 return LDAP_UNAVAILABLE;
385 * TimesTen : Turn off autocommit. We must explicitly
386 * commit any transactions.
388 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
391 * See if this connection is to TimesTen. If it is,
392 * remember that fact for later use.
394 /* Assume until proven otherwise */
395 bi->sql_flags &= ~BSQLF_USE_REVERSE_DN;
396 DBMSName[ 0 ] = '\0';
397 rc = SQLGetInfo( dbc->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;
407 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
408 "SQLGetInfo() failed.\n", ldap_cid, 0, 0 );
409 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
414 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
415 "connected, adding to tree.\n", ldap_cid, 0, 0 );
416 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
417 if ( avl_insert( &bi->sql_db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
418 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
419 "duplicate connection ID.\n", ldap_cid, 0, 0 );
422 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
423 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn(%lu)\n", ldap_cid, 0, 0 );
431 backsql_free_db_conn( Operation *op )
433 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
434 backsql_db_conn tmp = { 0 },
437 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
438 tmp.ldap_cid = op->o_connid;
439 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
440 conn = avl_delete( &bi->sql_db_conns, &tmp, backsql_cmp_connid );
441 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
444 * we have one thread per connection, as I understand -- so we can
445 * get this out of critical section
447 if ( conn != NULL ) {
448 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
449 "closing db connection %lu (%p)\n",
450 op->o_connid, (void *)conn, 0 );
451 backsql_close_db_conn( (void *)conn );
454 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
456 return conn ? SQL_SUCCESS : SQL_ERROR;
460 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
462 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
463 backsql_db_conn *dbc,
465 int rc = LDAP_SUCCESS;
467 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
469 assert( dbh != NULL );
470 *dbh = SQL_NULL_HDBC;
472 tmp.ldap_cid = op->o_connid;
475 * we have one thread per connection, as I understand --
476 * so we do not need locking here
478 dbc = avl_find( bi->sql_db_conns, &tmp, backsql_cmp_connid );
480 rc = backsql_open_db_conn( bi, op->o_connid, &dbc );
481 if ( rc != LDAP_SUCCESS) {
482 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
483 "could not get connection handle "
484 "-- returning NULL\n", 0, 0, 0 );
489 ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
490 if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
491 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
492 "first call -- reading schema map\n", 0, 0, 0 );
493 rc = backsql_load_schema_map( bi, dbc->dbh );
494 if ( rc != LDAP_SUCCESS ) {
495 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
496 backsql_free_db_conn( op );
500 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
504 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );