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 "proto-sql.h"
33 #define MAX_ATTR_LEN 16384
35 typedef struct backsql_conn {
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 )
67 rc = SQLAllocStmt( dbh, sth );
68 if ( rc != SQL_SUCCESS ) {
73 Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
74 #endif /* BACKSQL_TRACE */
76 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
79 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
81 #endif /* BACKSQL_TRACE */
83 ldap_pvt_str2upper( drv_name );
84 if ( !strncmp( drv_name, "SQLSRV32.DLL", sizeof( drv_name ) ) ) {
86 * stupid default result set in MS SQL Server
87 * does not support multiple active statements
88 * on the same connection -- so we are trying
89 * to make it not to use default result set...
91 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
92 "enabling MS SQL Server default result "
93 "set workaround\n", 0, 0, 0 );
94 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
96 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
97 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
98 "SQLSetStmtOption(SQL_CONCURRENCY,"
99 "SQL_CONCUR_ROWVER) failed:\n",
101 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
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 );
116 Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
118 #endif /* BACKSQL_TRACE */
120 return SQLPrepare( *sth, query, SQL_NTS );
124 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
127 SQLCHAR colname[ 64 ];
128 SQLSMALLINT name_len, col_type, col_scale, col_null;
137 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
138 #endif /* BACKSQL_TRACE */
140 rc = SQLNumResultCols( sth, &row->ncols );
141 if ( rc != SQL_SUCCESS ) {
143 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
144 "SQLNumResultCols() failed:\n", 0, 0, 0 );
145 #endif /* BACKSQL_TRACE */
147 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
151 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
152 "ncols=%d\n", (int)row->ncols, 0, 0 );
153 #endif /* BACKSQL_TRACE */
155 row->col_names = (BerVarray)ch_calloc( row->ncols + 1,
156 sizeof( struct berval ) );
157 row->cols = (char **)ch_calloc( row->ncols + 1,
159 row->col_prec = (UDWORD *)ch_calloc( row->ncols,
161 row->value_len = (SQLINTEGER *)ch_calloc( row->ncols,
162 sizeof( SQLINTEGER ) );
163 for ( i = 1; i <= row->ncols; i++ ) {
164 rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
165 (SQLUINTEGER)( sizeof( colname ) - 1 ),
166 &name_len, &col_type,
167 &col_prec, &col_scale, &col_null );
168 ber_str2bv( colname, 0, 1, &row->col_names[ i - 1 ] );
170 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
171 "col_name=%s, col_prec[%d]=%d\n",
172 colname, (int)i, (int)col_prec );
173 #endif /* BACKSQL_TRACE */
174 if ( col_type == SQL_LONGVARCHAR
175 || col_type == SQL_LONGVARBINARY) {
177 row->cols[ i - 1 ] = NULL;
178 row->col_prec[ i - 1 ] = -1;
181 * such fields must be handled
182 * in some other way since they return 2G
183 * as their precision (at least it does so
184 * with MS SQL Server w/native driver)
185 * for now, we just set fixed precision
186 * for such fields - dirty hack, but...
187 * no time to deal with SQLGetData()
190 col_prec = MAX_ATTR_LEN;
191 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
192 row->col_prec[ i - 1 ] = col_prec;
193 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
195 (SQLPOINTER)row->cols[ i - 1 ],
197 &row->value_len[ i - 1 ] );
199 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
200 row->col_prec[ i - 1 ] = col_prec;
201 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
203 (SQLPOINTER)row->cols[ i - 1 ],
205 &row->value_len[ i - 1 ] );
209 row->col_names[ i - 1 ].bv_val = NULL;
210 row->col_names[ i - 1 ].bv_len = 0;
211 row->cols[ i - 1 ] = NULL;
215 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
216 #endif /* BACKSQL_TRACE */
222 backsql_FreeRow( BACKSQL_ROW_NTS *row )
224 if ( row->cols == NULL ) {
228 ber_bvarray_free( row->col_names );
229 ldap_charray_free( row->cols );
230 free( row->col_prec );
231 free( row->value_len );
237 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
239 const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
240 if ( c1->ldap_cid > c2->ldap_cid ) {
244 if ( c1->ldap_cid < c2->ldap_cid ) {
252 backsql_close_db_conn( backsql_db_conn *conn )
254 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn()\n", 0, 0, 0 );
257 * Default transact is SQL_ROLLBACK; commit is required only
258 * by write operations, and it is explicitly performed after
259 * each atomic operation succeeds.
263 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
264 SQLDisconnect( conn->dbh );
265 SQLFreeConnect( conn->dbh );
266 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn()\n", 0, 0, 0 );
271 backsql_init_db_env( backsql_info *si )
274 int ret = SQL_SUCCESS;
276 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
277 rc = SQLAllocEnv( &si->db_env );
278 if ( rc != SQL_SUCCESS ) {
279 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
281 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
285 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
290 backsql_free_db_env( backsql_info *si )
292 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
295 Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
297 #endif /* BACKSQL_TRACE */
300 * stop, if frontend waits for all threads to shutdown
301 * before calling this -- then what are we going to delete??
302 * everything is already deleted...
304 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
309 backsql_open_db_conn( backsql_info *si, unsigned long ldap_cid, backsql_db_conn **pdbc )
313 backsql_db_conn *dbc;
319 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
320 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
321 dbc->ldap_cid = ldap_cid;
322 rc = SQLAllocConnect( si->db_env, &dbc->dbh );
323 if ( !BACKSQL_SUCCESS( rc ) ) {
324 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
325 "SQLAllocConnect() failed:\n", 0, 0, 0 );
326 backsql_PrintErrors( si->db_env, SQL_NULL_HDBC,
328 return LDAP_UNAVAILABLE;
331 rc = SQLConnect( dbc->dbh, si->dbname, SQL_NTS, si->dbuser,
332 SQL_NTS, si->dbpasswd, SQL_NTS );
333 if ( rc != SQL_SUCCESS ) {
334 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
335 "SQLConnect() to database \"%s\" as user \"%s\" "
336 "%s:\n", si->dbname, si->dbuser,
337 rc == SQL_SUCCESS_WITH_INFO ?
338 "succeeded with info" : "failed" );
339 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
340 if ( rc != SQL_SUCCESS_WITH_INFO ) {
341 return LDAP_UNAVAILABLE;
346 * TimesTen : Turn off autocommit. We must explicitly
347 * commit any transactions.
349 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
352 * See if this connection is to TimesTen. If it is,
353 * remember that fact for later use.
355 /* Assume until proven otherwise */
356 si->bsql_flags &= ~BSQLF_USE_REVERSE_DN;
357 DBMSName[ 0 ] = '\0';
358 rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
359 sizeof( DBMSName ), NULL );
360 if ( rc == SQL_SUCCESS ) {
361 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
362 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
363 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
364 "TimesTen database!\n", 0, 0, 0 );
365 si->bsql_flags |= BSQLF_USE_REVERSE_DN;
368 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
369 "SQLGetInfo() failed:\n", 0, 0, 0 );
370 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
375 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
376 "connected, adding to tree\n", 0, 0, 0 );
377 ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
378 if ( avl_insert( &si->db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
379 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
380 "duplicate connection ID\n", 0, 0, 0 );
383 ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
384 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
392 backsql_free_db_conn( Operation *op )
394 backsql_info *si = (backsql_info *)op->o_bd->be_private;
395 backsql_db_conn tmp = { 0 },
398 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
399 tmp.ldap_cid = op->o_connid;
400 ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
401 conn = avl_delete( &si->db_conns, &tmp, backsql_cmp_connid );
402 ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
405 * we have one thread per connection, as I understand -- so we can
406 * get this out of critical section
408 if ( conn != NULL ) {
409 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
410 "closing db connection\n", 0, 0, 0 );
411 backsql_close_db_conn( conn );
413 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
418 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
420 backsql_info *si = (backsql_info *)op->o_bd->be_private;
421 backsql_db_conn *dbc,
423 int rc = LDAP_SUCCESS;
425 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
428 *dbh = SQL_NULL_HDBC;
430 tmp.ldap_cid = op->o_connid;
433 * we have one thread per connection, as I understand --
434 * so we do not need locking here
436 dbc = avl_find( si->db_conns, &tmp, backsql_cmp_connid );
438 rc = backsql_open_db_conn( si, op->o_connid, &dbc );
439 if ( rc != LDAP_SUCCESS) {
440 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
441 "could not get connection handle "
442 "-- returning NULL\n", 0, 0, 0 );
447 ldap_pvt_thread_mutex_lock( &si->schema_mutex );
448 if ( !BACKSQL_SCHEMA_LOADED( si ) ) {
449 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
450 "first call -- reading schema map\n", 0, 0, 0 );
451 rc = backsql_load_schema_map( si, dbc->dbh );
452 if ( rc != LDAP_SUCCESS ) {
453 ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
454 backsql_free_db_conn( op );
458 ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
462 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );
467 #endif /* SLAPD_SQL */