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>
31 #include "sql-types.h"
33 #include "schema-map.h"
35 #define MAX_ATTR_LEN 16384
37 typedef struct backsql_conn {
43 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
45 SQLCHAR msg[SQL_MAX_MESSAGE_LENGTH]; /* msg. buffer */
46 SQLCHAR state[SQL_SQLSTATE_SIZE]; /* statement buf. */
47 SDWORD iSqlCode; /* return code */
48 SWORD len = SQL_MAX_MESSAGE_LENGTH - 1; /* return length */
50 Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
53 rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
54 SQL_MAX_MESSAGE_LENGTH - 1, &len );
55 for ( ; BACKSQL_SUCCESS( rc ); ) {
56 Debug( LDAP_DEBUG_TRACE, "Native error code: %d\n",
57 (int)iSqlCode, 0, 0 );
58 Debug( LDAP_DEBUG_TRACE, "SQL engine state: %s\n",
60 Debug( LDAP_DEBUG_TRACE, "Message: %s\n", msg, 0, 0 );
61 rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
62 SQL_MAX_MESSAGE_LENGTH - 1, &len );
67 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
73 rc = SQLAllocStmt( dbh, sth );
74 if ( rc != SQL_SUCCESS ) {
79 Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
80 #endif /* BACKSQL_TRACE */
82 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
85 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name='%s'\n",
87 #endif /* BACKSQL_TRACE */
89 ldap_pvt_str2upper( drv_name );
90 if ( !strncmp( drv_name, "SQLSRV32.DLL", sizeof( drv_name ) ) ) {
92 * stupid default result set in MS SQL Server
93 * does not support multiple active statements
94 * on the same connection -- so we are trying
95 * to make it not to use default result set...
97 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
98 "enabling MS SQL Server default result "
99 "set workaround\n", 0, 0, 0 );
100 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
102 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
103 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
104 "SQLSetStmtOption(SQL_CONCURRENCY,"
105 "SQL_CONCUR_ROWVER) failed:\n",
107 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
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 );
122 Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
124 #endif /* BACKSQL_TRACE */
126 return SQLPrepare( *sth, query, SQL_NTS );
131 * Turned into macros --- see sql-wrap.h
134 backsql_BindParamStr( SQLHSTMT sth, int par_ind, char *str, int maxlen )
138 rc = SQLBindParameter( sth, (SQLUSMALLINT)par_ind, SQL_PARAM_INPUT,
139 SQL_C_CHAR, SQL_VARCHAR,
140 (SQLUINTEGER)maxlen, 0, (SQLPOINTER)str,
141 (SQLUINTEGER)maxlen, NULL );
146 backsql_BindParamID( SQLHSTMT sth, int par_ind, unsigned long *id )
148 return SQLBindParameter( sth, (SQLUSMALLINT)par_ind,
149 SQL_PARAM_INPUT, SQL_C_ULONG, SQL_INTEGER,
150 0, 0, (SQLPOINTER)id, 0, (SQLINTEGER*)NULL );
155 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
158 SQLCHAR colname[ 64 ];
159 SQLSMALLINT name_len, col_type, col_scale, col_null;
168 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
169 #endif /* BACKSQL_TRACE */
171 rc = SQLNumResultCols( sth, &row->ncols );
172 if ( rc != SQL_SUCCESS ) {
174 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
175 "SQLNumResultCols() failed:\n", 0, 0, 0 );
176 #endif /* BACKSQL_TRACE */
178 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
181 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
182 "ncols=%d\n", (int)row->ncols, 0, 0 );
183 #endif /* BACKSQL_TRACE */
185 row->col_names = (BerVarray)ch_calloc( row->ncols + 1,
186 sizeof( struct berval ) );
187 row->cols = (char **)ch_calloc( row->ncols + 1,
189 row->col_prec = (UDWORD *)ch_calloc( row->ncols,
191 row->value_len = (SQLINTEGER *)ch_calloc( row->ncols,
192 sizeof( SQLINTEGER ) );
193 for ( i = 1; i <= row->ncols; i++ ) {
194 rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
195 (SQLUINTEGER)( sizeof( colname ) - 1 ),
196 &name_len, &col_type,
197 &col_prec, &col_scale, &col_null );
198 ber_str2bv( colname, 0, 1, &row->col_names[ i - 1 ] );
200 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
201 "col_name=%s, col_prec[%d]=%d\n",
202 colname, (int)i, (int)col_prec );
203 #endif /* BACKSQL_TRACE */
204 if ( col_type == SQL_LONGVARCHAR
205 || col_type == SQL_LONGVARBINARY) {
207 row->cols[ i - 1 ] = NULL;
208 row->col_prec[ i - 1 ] = -1;
211 * such fields must be handled
212 * in some other way since they return 2G
213 * as their precision (at least it does so
214 * with MS SQL Server w/native driver)
215 * for now, we just set fixed precision
216 * for such fields - dirty hack, but...
217 * no time to deal with SQLGetData()
220 col_prec = MAX_ATTR_LEN;
221 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
222 row->col_prec[ i - 1 ] = col_prec;
223 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
225 (SQLPOINTER)row->cols[ i - 1 ],
227 &row->value_len[ i - 1 ] );
229 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
230 row->col_prec[ i - 1 ] = col_prec;
231 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
233 (SQLPOINTER)row->cols[ i - 1 ],
235 &row->value_len[ i - 1 ] );
239 row->col_names[ i - 1 ].bv_val = NULL;
240 row->col_names[ i - 1 ].bv_len = 0;
241 row->cols[ i - 1 ] = NULL;
245 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
246 #endif /* BACKSQL_TRACE */
252 backsql_FreeRow( BACKSQL_ROW_NTS *row )
254 if ( row->cols == NULL ) {
258 ber_bvarray_free( row->col_names );
259 ldap_charray_free( row->cols );
260 free( row->col_prec );
261 free( row->value_len );
267 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
269 const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
270 if ( c1->ldap_cid > c2->ldap_cid ) {
274 if ( c1->ldap_cid < c2->ldap_cid ) {
282 backsql_close_db_conn( backsql_db_conn *conn )
284 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn()\n", 0, 0, 0 );
287 * Default transact is SQL_ROLLBACK; commit is required only
288 * by write operations, and it is explicitly performed after
289 * each atomic operation succeeds.
293 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
294 SQLDisconnect( conn->dbh );
295 SQLFreeConnect( conn->dbh );
296 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn()\n", 0, 0, 0 );
301 backsql_init_db_env( backsql_info *si )
305 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
306 rc = SQLAllocEnv( &si->db_env );
307 if ( rc != SQL_SUCCESS ) {
308 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
310 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
313 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()\n", 0, 0, 0 );
318 backsql_free_db_env( backsql_info *si )
320 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
323 Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
325 #endif /* BACKSQL_TRACE */
328 * stop, if frontend waits for all threads to shutdown
329 * before calling this -- then what are we going to delete??
330 * everything is already deleted...
332 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
337 backsql_open_db_conn( backsql_info *si, int ldap_cid, backsql_db_conn **pdbc )
341 backsql_db_conn *dbc;
347 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
348 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
349 dbc->ldap_cid = ldap_cid;
350 rc = SQLAllocConnect( si->db_env, &dbc->dbh );
351 if ( !BACKSQL_SUCCESS( rc ) ) {
352 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
353 "SQLAllocConnect() failed:\n", 0, 0, 0 );
354 backsql_PrintErrors( si->db_env, SQL_NULL_HDBC,
356 return LDAP_UNAVAILABLE;
359 rc = SQLConnect( dbc->dbh, si->dbname, SQL_NTS, si->dbuser,
360 SQL_NTS, si->dbpasswd, SQL_NTS );
361 if ( rc != SQL_SUCCESS ) {
362 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
363 "SQLConnect() to database '%s' as user '%s' "
364 "%s:\n", si->dbname, si->dbuser,
365 rc == SQL_SUCCESS_WITH_INFO ?
366 "succeeded with info" : "failed" );
367 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
368 if ( rc != SQL_SUCCESS_WITH_INFO ) {
369 return LDAP_UNAVAILABLE;
374 * TimesTen : Turn off autocommit. We must explicitly
375 * commit any transactions.
377 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
380 * See if this connection is to TimesTen. If it is,
381 * remember that fact for later use.
383 /* Assume until proven otherwise */
384 si->bsql_flags &= ~BSQLF_USE_REVERSE_DN;
385 DBMSName[ 0 ] = '\0';
386 rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
387 sizeof( DBMSName ), NULL );
388 if ( rc == SQL_SUCCESS ) {
389 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
390 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
391 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
392 "TimesTen database!\n", 0, 0, 0 );
393 si->bsql_flags |= BSQLF_USE_REVERSE_DN;
396 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
397 "SQLGetInfo() failed:\n", 0, 0, 0 );
398 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
403 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
404 "connected, adding to tree\n", 0, 0, 0 );
405 ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
406 if ( avl_insert( &si->db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
407 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
408 "duplicate connection ID\n", 0, 0, 0 );
411 ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
412 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
420 backsql_free_db_conn( Operation *op )
422 backsql_info *si = (backsql_info *)op->o_bd->be_private;
423 backsql_db_conn tmp, *conn;
425 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
426 tmp.ldap_cid = op->o_connid;
427 ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
428 conn = avl_delete( &si->db_conns, &tmp, backsql_cmp_connid );
429 ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
432 * we have one thread per connection, as I understand -- so we can
433 * get this out of critical section
435 if ( conn != NULL ) {
436 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
437 "closing db connection\n", 0, 0, 0 );
438 backsql_close_db_conn( conn );
440 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
445 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
447 backsql_info *si = (backsql_info *)op->o_bd->be_private;
448 backsql_db_conn *dbc;
450 int rc = LDAP_SUCCESS;
452 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
455 *dbh = SQL_NULL_HDBC;
457 tmp.ldap_cid = op->o_connid;
460 * we have one thread per connection, as I understand --
461 * so we do not need locking here
463 dbc = avl_find( si->db_conns, &tmp, backsql_cmp_connid );
465 rc = backsql_open_db_conn( si, op->o_connid, &dbc );
466 if ( rc != LDAP_SUCCESS) {
467 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
468 "could not get connection handle "
469 "-- returning NULL\n", 0, 0, 0 );
474 ldap_pvt_thread_mutex_lock( &si->schema_mutex );
475 if ( !BACKSQL_SCHEMA_LOADED( si ) ) {
476 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
477 "first call -- reading schema map\n", 0, 0, 0 );
478 rc = backsql_load_schema_map( si, dbc->dbh );
479 if ( rc != LDAP_SUCCESS ) {
480 ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
481 backsql_free_db_conn( op );
485 ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
489 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );
494 #endif /* SLAPD_SQL */