2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
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.
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 ); ) {
52 Debug( LDAP_DEBUG_TRACE,
53 " Native error code: %d\n"
54 " SQL engine state: %s\n"
56 (int)iSqlCode, state, msg );
61 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
65 rc = SQLAllocStmt( dbh, sth );
66 if ( rc != SQL_SUCCESS ) {
71 Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
72 #endif /* BACKSQL_TRACE */
74 #ifdef BACKSQL_MSSQL_WORKAROUND
79 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
82 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
84 #endif /* BACKSQL_TRACE */
86 ldap_pvt_str2upper( drv_name );
87 if ( !strncmp( drv_name, "SQLSRV32.DLL", STRLENOF( "SQLSRV32.DLL" ) ) ) {
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...
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,
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",
104 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
105 SQLFreeStmt( *sth, SQL_DROP );
110 #endif /* BACKSQL_MSSQL_WORKAROUND */
113 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
114 "setting query timeout to %d sec.\n",
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 );
125 Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
127 #endif /* BACKSQL_TRACE */
129 return SQLPrepare( *sth, (SQLCHAR *)query, SQL_NTS );
133 backsql_BindRowAsStrings_x( SQLHSTMT sth, BACKSQL_ROW_NTS *row, void *ctx )
136 SQLCHAR colname[ 64 ];
137 SQLSMALLINT name_len, col_type, col_scale, col_null;
146 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
147 #endif /* BACKSQL_TRACE */
149 rc = SQLNumResultCols( sth, &row->ncols );
150 if ( rc != SQL_SUCCESS ) {
152 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
153 "SQLNumResultCols() failed:\n", 0, 0, 0 );
154 #endif /* BACKSQL_TRACE */
156 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
160 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
161 "ncols=%d\n", (int)row->ncols, 0, 0 );
162 #endif /* BACKSQL_TRACE */
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? */
179 ber_str2bv_x( (char *)colname, 0, 1,
180 &row->col_names[ i - 1 ], ctx );
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 )
188 col_prec = MAX_ATTR_LEN;
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,
196 (SQLPOINTER)row->cols[ i - 1 ],
198 &row->value_len[ i - 1 ] );
199 /* FIXME: test rc? */
202 BER_BVZERO( &row->col_names[ i - 1 ] );
203 row->cols[ i - 1 ] = NULL;
207 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
208 #endif /* BACKSQL_TRACE */
214 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
216 return backsql_BindRowAsStrings_x( sth, row, NULL );
220 backsql_FreeRow_x( BACKSQL_ROW_NTS *row, void *ctx )
222 if ( row->cols == NULL ) {
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 );
236 backsql_FreeRow( BACKSQL_ROW_NTS *row )
238 return backsql_FreeRow_x( row, NULL );
242 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
244 const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
245 if ( c1->ldap_cid > c2->ldap_cid ) {
249 if ( c1->ldap_cid < c2->ldap_cid ) {
257 backsql_close_db_conn( void *v_conn )
259 backsql_db_conn *conn = (backsql_db_conn *)v_conn;
260 unsigned long cid = conn->ldap_cid;
262 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn(%lu)\n",
266 * Default transact is SQL_ROLLBACK; commit is required only
267 * by write operations, and it is explicitly performed after
268 * each atomic operation succeeds.
272 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
273 SQLDisconnect( conn->dbh );
274 SQLFreeConnect( conn->dbh );
277 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn(%lu)\n",
282 backsql_conn_destroy(
285 avl_free( bi->sql_db_conns, backsql_close_db_conn );
291 backsql_init_db_env( backsql_info *bi )
294 int ret = SQL_SUCCESS;
296 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
298 rc = SQLAllocEnv( &bi->sql_db_env );
299 if ( rc != SQL_SUCCESS ) {
300 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
302 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
307 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
313 backsql_free_db_env( backsql_info *bi )
315 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
317 (void)SQLFreeEnv( bi->sql_db_env );
318 bi->sql_db_env = SQL_NULL_HENV;
321 * stop, if frontend waits for all threads to shutdown
322 * before calling this -- then what are we going to delete??
323 * everything is already deleted...
325 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
331 backsql_open_db_conn( backsql_info *bi, unsigned long ldap_cid, backsql_db_conn **pdbc )
335 backsql_db_conn *dbc;
338 assert( pdbc != NULL );
341 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn(%lu)\n",
344 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
345 dbc->ldap_cid = ldap_cid;
346 rc = SQLAllocConnect( bi->sql_db_env, &dbc->dbh );
347 if ( !BACKSQL_SUCCESS( rc ) ) {
348 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
349 "SQLAllocConnect() failed:\n", ldap_cid, 0, 0 );
350 backsql_PrintErrors( bi->sql_db_env, SQL_NULL_HDBC,
352 return LDAP_UNAVAILABLE;
355 rc = SQLConnect( dbc->dbh,
356 (SQLCHAR*)bi->sql_dbname, SQL_NTS,
357 (SQLCHAR*)bi->sql_dbuser, SQL_NTS,
358 (SQLCHAR*)bi->sql_dbpasswd, SQL_NTS );
359 if ( rc != SQL_SUCCESS ) {
360 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
361 "SQLConnect() to database \"%s\" %s.\n",
362 ldap_cid, bi->sql_dbname,
363 rc == SQL_SUCCESS_WITH_INFO ?
364 "succeeded with info" : "failed" );
365 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
366 if ( rc != SQL_SUCCESS_WITH_INFO ) {
367 return LDAP_UNAVAILABLE;
372 * TimesTen : Turn off autocommit. We must explicitly
373 * commit any transactions.
375 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
378 * See if this connection is to TimesTen. If it is,
379 * remember that fact for later use.
381 /* Assume until proven otherwise */
382 bi->sql_flags &= ~BSQLF_USE_REVERSE_DN;
383 DBMSName[ 0 ] = '\0';
384 rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
385 sizeof( DBMSName ), NULL );
386 if ( rc == SQL_SUCCESS ) {
387 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
388 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
389 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
390 "TimesTen database!\n", ldap_cid, 0, 0 );
391 bi->sql_flags |= BSQLF_USE_REVERSE_DN;
394 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
395 "SQLGetInfo() failed.\n", ldap_cid, 0, 0 );
396 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
401 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
402 "connected, adding to tree.\n", ldap_cid, 0, 0 );
403 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
404 if ( avl_insert( &bi->sql_db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
405 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
406 "duplicate connection ID.\n", ldap_cid, 0, 0 );
409 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
410 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn(%lu)\n", ldap_cid, 0, 0 );
418 backsql_free_db_conn( Operation *op )
420 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
421 backsql_db_conn tmp = { 0 },
424 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
425 tmp.ldap_cid = op->o_connid;
426 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
427 conn = avl_delete( &bi->sql_db_conns, &tmp, backsql_cmp_connid );
428 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
431 * we have one thread per connection, as I understand -- so we can
432 * get this out of critical section
434 if ( conn != NULL ) {
435 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
436 "closing db connection %lu (%p)\n",
437 op->o_connid, (void *)conn, 0 );
438 backsql_close_db_conn( (void *)conn );
441 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
443 return conn ? SQL_SUCCESS : SQL_ERROR;
447 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
449 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
450 backsql_db_conn *dbc,
452 int rc = LDAP_SUCCESS;
454 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
456 assert( dbh != NULL );
457 *dbh = SQL_NULL_HDBC;
459 tmp.ldap_cid = op->o_connid;
462 * we have one thread per connection, as I understand --
463 * so we do not need locking here
465 dbc = avl_find( bi->sql_db_conns, &tmp, backsql_cmp_connid );
467 rc = backsql_open_db_conn( bi, op->o_connid, &dbc );
468 if ( rc != LDAP_SUCCESS) {
469 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
470 "could not get connection handle "
471 "-- returning NULL\n", 0, 0, 0 );
476 ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
477 if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
478 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
479 "first call -- reading schema map\n", 0, 0, 0 );
480 rc = backsql_load_schema_map( bi, dbc->dbh );
481 if ( rc != LDAP_SUCCESS ) {
482 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
483 backsql_free_db_conn( op );
487 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
491 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );