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.
6 * Portions Copyright 2004 Mark Adamson.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Dmitry Kovalev for inclusion
19 * by OpenLDAP Software.
25 #include "ac/string.h"
26 #include <sys/types.h>
29 #include "proto-sql.h"
31 #define MAX_ATTR_LEN 16384
33 typedef struct backsql_db_conn {
34 unsigned long ldap_cid;
39 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
41 SQLCHAR msg[SQL_MAX_MESSAGE_LENGTH]; /* msg. buffer */
42 SQLCHAR state[SQL_SQLSTATE_SIZE]; /* statement buf. */
43 SDWORD iSqlCode; /* return code */
44 SWORD len = SQL_MAX_MESSAGE_LENGTH - 1; /* return length */
46 Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
48 for ( ; rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
49 SQL_MAX_MESSAGE_LENGTH - 1, &len ), BACKSQL_SUCCESS( rc ); ) {
50 Debug( LDAP_DEBUG_TRACE,
51 " Native error code: %d\n"
52 " SQL engine state: %s\n"
54 (int)iSqlCode, state, msg );
59 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 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
77 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
79 #endif /* BACKSQL_TRACE */
81 ldap_pvt_str2upper( drv_name );
82 if ( !strncmp( drv_name, "SQLSRV32.DLL", sizeof( drv_name ) ) ) {
84 * stupid default result set in MS SQL Server
85 * does not support multiple active statements
86 * on the same connection -- so we are trying
87 * to make it not to use default result set...
89 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
90 "enabling MS SQL Server default result "
91 "set workaround\n", 0, 0, 0 );
92 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
94 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
95 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
96 "SQLSetStmtOption(SQL_CONCURRENCY,"
97 "SQL_CONCUR_ROWVER) failed:\n",
99 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
100 SQLFreeStmt( *sth, SQL_DROP );
106 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
107 "setting query timeout to %d sec.\n",
109 rc = SQLSetStmtOption( *sth, SQL_QUERY_TIMEOUT, timeout );
110 if ( rc != SQL_SUCCESS ) {
111 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
112 SQLFreeStmt( *sth, SQL_DROP );
118 Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
120 #endif /* BACKSQL_TRACE */
122 return SQLPrepare( *sth, query, SQL_NTS );
126 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
129 SQLCHAR colname[ 64 ];
130 SQLSMALLINT name_len, col_type, col_scale, col_null;
139 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
140 #endif /* BACKSQL_TRACE */
142 rc = SQLNumResultCols( sth, &row->ncols );
143 if ( rc != SQL_SUCCESS ) {
145 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
146 "SQLNumResultCols() failed:\n", 0, 0, 0 );
147 #endif /* BACKSQL_TRACE */
149 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
153 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
154 "ncols=%d\n", (int)row->ncols, 0, 0 );
155 #endif /* BACKSQL_TRACE */
157 row->col_names = (BerVarray)ch_calloc( row->ncols + 1,
158 sizeof( struct berval ) );
159 row->cols = (char **)ch_calloc( row->ncols + 1,
161 row->col_prec = (UDWORD *)ch_calloc( row->ncols,
163 row->value_len = (SQLINTEGER *)ch_calloc( row->ncols,
164 sizeof( SQLINTEGER ) );
165 for ( i = 1; i <= row->ncols; i++ ) {
166 rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
167 (SQLUINTEGER)( sizeof( colname ) - 1 ),
168 &name_len, &col_type,
169 &col_prec, &col_scale, &col_null );
170 ber_str2bv( colname, 0, 1, &row->col_names[ i - 1 ] );
172 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
173 "col_name=%s, col_prec[%d]=%d\n",
174 colname, (int)i, (int)col_prec );
175 #endif /* BACKSQL_TRACE */
176 if ( col_type == SQL_LONGVARCHAR
177 || col_type == SQL_LONGVARBINARY) {
179 row->cols[ i - 1 ] = NULL;
180 row->col_prec[ i - 1 ] = -1;
183 * such fields must be handled
184 * in some other way since they return 2G
185 * as their precision (at least it does so
186 * with MS SQL Server w/native driver)
187 * for now, we just set fixed precision
188 * for such fields - dirty hack, but...
189 * no time to deal with SQLGetData()
192 col_prec = MAX_ATTR_LEN;
193 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
194 row->col_prec[ i - 1 ] = col_prec;
195 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
197 (SQLPOINTER)row->cols[ i - 1 ],
199 &row->value_len[ i - 1 ] );
201 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
202 row->col_prec[ i - 1 ] = col_prec;
203 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
205 (SQLPOINTER)row->cols[ i - 1 ],
207 &row->value_len[ i - 1 ] );
211 row->col_names[ i - 1 ].bv_val = NULL;
212 row->col_names[ i - 1 ].bv_len = 0;
213 row->cols[ i - 1 ] = NULL;
217 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
218 #endif /* BACKSQL_TRACE */
224 backsql_FreeRow( BACKSQL_ROW_NTS *row )
226 if ( row->cols == NULL ) {
230 ber_bvarray_free( row->col_names );
231 ldap_charray_free( row->cols );
232 free( row->col_prec );
233 free( row->value_len );
239 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
241 const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
242 if ( c1->ldap_cid > c2->ldap_cid ) {
246 if ( c1->ldap_cid < c2->ldap_cid ) {
254 backsql_close_db_conn( backsql_db_conn *conn )
256 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn()\n", 0, 0, 0 );
259 * Default transact is SQL_ROLLBACK; commit is required only
260 * by write operations, and it is explicitly performed after
261 * each atomic operation succeeds.
265 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
266 SQLDisconnect( conn->dbh );
267 SQLFreeConnect( conn->dbh );
268 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn()\n", 0, 0, 0 );
273 backsql_init_db_env( backsql_info *bi )
276 int ret = SQL_SUCCESS;
278 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
279 rc = SQLAllocEnv( &bi->sql_db_env );
280 if ( rc != SQL_SUCCESS ) {
281 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
283 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
287 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
292 backsql_free_db_env( backsql_info *bi )
294 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
297 Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
299 #endif /* BACKSQL_TRACE */
302 * stop, if frontend waits for all threads to shutdown
303 * before calling this -- then what are we going to delete??
304 * everything is already deleted...
306 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
311 backsql_open_db_conn( backsql_info *bi, unsigned long ldap_cid, backsql_db_conn **pdbc )
315 backsql_db_conn *dbc;
321 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
322 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
323 dbc->ldap_cid = ldap_cid;
324 rc = SQLAllocConnect( bi->sql_db_env, &dbc->dbh );
325 if ( !BACKSQL_SUCCESS( rc ) ) {
326 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
327 "SQLAllocConnect() failed:\n", 0, 0, 0 );
328 backsql_PrintErrors( bi->sql_db_env, SQL_NULL_HDBC,
330 return LDAP_UNAVAILABLE;
333 rc = SQLConnect( dbc->dbh,
334 (SQLCHAR*)bi->sql_dbname, SQL_NTS,
335 (SQLCHAR*)bi->sql_dbuser, SQL_NTS,
336 (SQLCHAR*)bi->sql_dbpasswd, SQL_NTS );
337 if ( rc != SQL_SUCCESS ) {
338 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
339 "SQLConnect() to database \"%s\" as user \"%s\" "
340 "%s:\n", bi->sql_dbname, bi->sql_dbuser,
341 rc == SQL_SUCCESS_WITH_INFO ?
342 "succeeded with info" : "failed" );
343 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
344 if ( rc != SQL_SUCCESS_WITH_INFO ) {
345 return LDAP_UNAVAILABLE;
350 * TimesTen : Turn off autocommit. We must explicitly
351 * commit any transactions.
353 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
356 * See if this connection is to TimesTen. If it is,
357 * remember that fact for later use.
359 /* Assume until proven otherwise */
360 bi->sql_flags &= ~BSQLF_USE_REVERSE_DN;
361 DBMSName[ 0 ] = '\0';
362 rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
363 sizeof( DBMSName ), NULL );
364 if ( rc == SQL_SUCCESS ) {
365 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
366 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
367 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
368 "TimesTen database!\n", 0, 0, 0 );
369 bi->sql_flags |= BSQLF_USE_REVERSE_DN;
372 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
373 "SQLGetInfo() failed:\n", 0, 0, 0 );
374 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
379 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
380 "connected, adding to tree\n", 0, 0, 0 );
381 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
382 if ( avl_insert( &bi->sql_db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
383 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
384 "duplicate connection ID\n", 0, 0, 0 );
387 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
388 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
396 backsql_free_db_conn( Operation *op )
398 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
399 backsql_db_conn tmp = { 0 },
402 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
403 tmp.ldap_cid = op->o_connid;
404 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
405 conn = avl_delete( &bi->sql_db_conns, &tmp, backsql_cmp_connid );
406 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
409 * we have one thread per connection, as I understand -- so we can
410 * get this out of critical section
412 if ( conn != NULL ) {
413 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
414 "closing db connection\n", 0, 0, 0 );
415 backsql_close_db_conn( conn );
417 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
422 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
424 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
425 backsql_db_conn *dbc,
427 int rc = LDAP_SUCCESS;
429 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
432 *dbh = SQL_NULL_HDBC;
434 tmp.ldap_cid = op->o_connid;
437 * we have one thread per connection, as I understand --
438 * so we do not need locking here
440 dbc = avl_find( bi->sql_db_conns, &tmp, backsql_cmp_connid );
442 rc = backsql_open_db_conn( bi, op->o_connid, &dbc );
443 if ( rc != LDAP_SUCCESS) {
444 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
445 "could not get connection handle "
446 "-- returning NULL\n", 0, 0, 0 );
451 ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
452 if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
453 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
454 "first call -- reading schema map\n", 0, 0, 0 );
455 rc = backsql_load_schema_map( bi, dbc->dbh );
456 if ( rc != LDAP_SUCCESS ) {
457 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
458 backsql_free_db_conn( op );
462 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
466 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );