2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2004 The OpenLDAP Foundation.
5 * Portions Copyright 1999 Dmitry Kovalev.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
17 * This work was initially developed by Dmitry Kovalev for inclusion
18 * by OpenLDAP Software.
26 #include "ac/string.h"
27 #include <sys/types.h>
30 #include "proto-sql.h"
32 #define MAX_ATTR_LEN 16384
34 typedef struct backsql_db_conn {
35 unsigned long ldap_cid;
40 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
42 SQLCHAR msg[SQL_MAX_MESSAGE_LENGTH]; /* msg. buffer */
43 SQLCHAR state[SQL_SQLSTATE_SIZE]; /* statement buf. */
44 SDWORD iSqlCode; /* return code */
45 SWORD len = SQL_MAX_MESSAGE_LENGTH - 1; /* return length */
47 Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
49 for ( ; rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
50 SQL_MAX_MESSAGE_LENGTH - 1, &len ), BACKSQL_SUCCESS( rc ); ) {
51 Debug( LDAP_DEBUG_TRACE,
52 " Native error code: %d\n"
53 " SQL engine state: %s\n"
55 (int)iSqlCode, state, msg );
60 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
66 rc = SQLAllocStmt( dbh, sth );
67 if ( rc != SQL_SUCCESS ) {
72 Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
73 #endif /* BACKSQL_TRACE */
75 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
78 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
80 #endif /* BACKSQL_TRACE */
82 ldap_pvt_str2upper( drv_name );
83 if ( !strncmp( drv_name, "SQLSRV32.DLL", sizeof( drv_name ) ) ) {
85 * stupid default result set in MS SQL Server
86 * does not support multiple active statements
87 * on the same connection -- so we are trying
88 * to make it not to use default result set...
90 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
91 "enabling MS SQL Server default result "
92 "set workaround\n", 0, 0, 0 );
93 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
95 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
96 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
97 "SQLSetStmtOption(SQL_CONCURRENCY,"
98 "SQL_CONCUR_ROWVER) failed:\n",
100 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
101 SQLFreeStmt( *sth, SQL_DROP );
107 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
108 "setting query timeout to %d sec.\n",
110 rc = SQLSetStmtOption( *sth, SQL_QUERY_TIMEOUT, timeout );
111 if ( rc != SQL_SUCCESS ) {
112 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
113 SQLFreeStmt( *sth, SQL_DROP );
119 Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
121 #endif /* BACKSQL_TRACE */
123 return SQLPrepare( *sth, query, SQL_NTS );
127 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
130 SQLCHAR colname[ 64 ];
131 SQLSMALLINT name_len, col_type, col_scale, col_null;
140 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
141 #endif /* BACKSQL_TRACE */
143 rc = SQLNumResultCols( sth, &row->ncols );
144 if ( rc != SQL_SUCCESS ) {
146 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
147 "SQLNumResultCols() failed:\n", 0, 0, 0 );
148 #endif /* BACKSQL_TRACE */
150 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
154 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
155 "ncols=%d\n", (int)row->ncols, 0, 0 );
156 #endif /* BACKSQL_TRACE */
158 row->col_names = (BerVarray)ch_calloc( row->ncols + 1,
159 sizeof( struct berval ) );
160 row->cols = (char **)ch_calloc( row->ncols + 1,
162 row->col_prec = (UDWORD *)ch_calloc( row->ncols,
164 row->value_len = (SQLINTEGER *)ch_calloc( row->ncols,
165 sizeof( SQLINTEGER ) );
166 for ( i = 1; i <= row->ncols; i++ ) {
167 rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
168 (SQLUINTEGER)( sizeof( colname ) - 1 ),
169 &name_len, &col_type,
170 &col_prec, &col_scale, &col_null );
171 ber_str2bv( colname, 0, 1, &row->col_names[ i - 1 ] );
173 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
174 "col_name=%s, col_prec[%d]=%d\n",
175 colname, (int)i, (int)col_prec );
176 #endif /* BACKSQL_TRACE */
177 if ( col_type == SQL_LONGVARCHAR
178 || col_type == SQL_LONGVARBINARY) {
180 row->cols[ i - 1 ] = NULL;
181 row->col_prec[ i - 1 ] = -1;
184 * such fields must be handled
185 * in some other way since they return 2G
186 * as their precision (at least it does so
187 * with MS SQL Server w/native driver)
188 * for now, we just set fixed precision
189 * for such fields - dirty hack, but...
190 * no time to deal with SQLGetData()
193 col_prec = MAX_ATTR_LEN;
194 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
195 row->col_prec[ i - 1 ] = col_prec;
196 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
198 (SQLPOINTER)row->cols[ i - 1 ],
200 &row->value_len[ i - 1 ] );
202 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
203 row->col_prec[ i - 1 ] = col_prec;
204 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
206 (SQLPOINTER)row->cols[ i - 1 ],
208 &row->value_len[ i - 1 ] );
212 row->col_names[ i - 1 ].bv_val = NULL;
213 row->col_names[ i - 1 ].bv_len = 0;
214 row->cols[ i - 1 ] = NULL;
218 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
219 #endif /* BACKSQL_TRACE */
225 backsql_FreeRow( BACKSQL_ROW_NTS *row )
227 if ( row->cols == NULL ) {
231 ber_bvarray_free( row->col_names );
232 ldap_charray_free( row->cols );
233 free( row->col_prec );
234 free( row->value_len );
240 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
242 const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
243 if ( c1->ldap_cid > c2->ldap_cid ) {
247 if ( c1->ldap_cid < c2->ldap_cid ) {
255 backsql_close_db_conn( backsql_db_conn *conn )
257 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn()\n", 0, 0, 0 );
260 * Default transact is SQL_ROLLBACK; commit is required only
261 * by write operations, and it is explicitly performed after
262 * each atomic operation succeeds.
266 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
267 SQLDisconnect( conn->dbh );
268 SQLFreeConnect( conn->dbh );
269 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn()\n", 0, 0, 0 );
274 backsql_init_db_env( backsql_info *bi )
277 int ret = SQL_SUCCESS;
279 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
280 rc = SQLAllocEnv( &bi->sql_db_env );
281 if ( rc != SQL_SUCCESS ) {
282 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
284 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
288 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
293 backsql_free_db_env( backsql_info *bi )
295 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
298 Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
300 #endif /* BACKSQL_TRACE */
303 * stop, if frontend waits for all threads to shutdown
304 * before calling this -- then what are we going to delete??
305 * everything is already deleted...
307 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
312 backsql_open_db_conn( backsql_info *bi, unsigned long ldap_cid, backsql_db_conn **pdbc )
316 backsql_db_conn *dbc;
322 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
323 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
324 dbc->ldap_cid = ldap_cid;
325 rc = SQLAllocConnect( bi->sql_db_env, &dbc->dbh );
326 if ( !BACKSQL_SUCCESS( rc ) ) {
327 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
328 "SQLAllocConnect() failed:\n", 0, 0, 0 );
329 backsql_PrintErrors( bi->sql_db_env, SQL_NULL_HDBC,
331 return LDAP_UNAVAILABLE;
334 rc = SQLConnect( dbc->dbh,
335 (SQLCHAR*)bi->sql_dbname, SQL_NTS,
336 (SQLCHAR*)bi->sql_dbuser, SQL_NTS,
337 (SQLCHAR*)bi->sql_dbpasswd, SQL_NTS );
338 if ( rc != SQL_SUCCESS ) {
339 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
340 "SQLConnect() to database \"%s\" as user \"%s\" "
341 "%s:\n", bi->sql_dbname, bi->sql_dbuser,
342 rc == SQL_SUCCESS_WITH_INFO ?
343 "succeeded with info" : "failed" );
344 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
345 if ( rc != SQL_SUCCESS_WITH_INFO ) {
346 return LDAP_UNAVAILABLE;
351 * TimesTen : Turn off autocommit. We must explicitly
352 * commit any transactions.
354 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
357 * See if this connection is to TimesTen. If it is,
358 * remember that fact for later use.
360 /* Assume until proven otherwise */
361 bi->sql_flags &= ~BSQLF_USE_REVERSE_DN;
362 DBMSName[ 0 ] = '\0';
363 rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
364 sizeof( DBMSName ), NULL );
365 if ( rc == SQL_SUCCESS ) {
366 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
367 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
368 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
369 "TimesTen database!\n", 0, 0, 0 );
370 bi->sql_flags |= BSQLF_USE_REVERSE_DN;
373 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
374 "SQLGetInfo() failed:\n", 0, 0, 0 );
375 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
380 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
381 "connected, adding to tree\n", 0, 0, 0 );
382 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
383 if ( avl_insert( &bi->sql_db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
384 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
385 "duplicate connection ID\n", 0, 0, 0 );
388 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
389 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
397 backsql_free_db_conn( Operation *op )
399 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
400 backsql_db_conn tmp = { 0 },
403 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
404 tmp.ldap_cid = op->o_connid;
405 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
406 conn = avl_delete( &bi->sql_db_conns, &tmp, backsql_cmp_connid );
407 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
410 * we have one thread per connection, as I understand -- so we can
411 * get this out of critical section
413 if ( conn != NULL ) {
414 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
415 "closing db connection\n", 0, 0, 0 );
416 backsql_close_db_conn( conn );
418 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
423 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
425 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
426 backsql_db_conn *dbc,
428 int rc = LDAP_SUCCESS;
430 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
433 *dbh = SQL_NULL_HDBC;
435 tmp.ldap_cid = op->o_connid;
438 * we have one thread per connection, as I understand --
439 * so we do not need locking here
441 dbc = avl_find( bi->sql_db_conns, &tmp, backsql_cmp_connid );
443 rc = backsql_open_db_conn( bi, op->o_connid, &dbc );
444 if ( rc != LDAP_SUCCESS) {
445 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
446 "could not get connection handle "
447 "-- returning NULL\n", 0, 0, 0 );
452 ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
453 if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
454 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
455 "first call -- reading schema map\n", 0, 0, 0 );
456 rc = backsql_load_schema_map( bi, dbc->dbh );
457 if ( rc != LDAP_SUCCESS ) {
458 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
459 backsql_free_db_conn( op );
463 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
467 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );
472 #endif /* SLAPD_SQL */