2 * Copyright 1999, Dmitry Kovalev <mit@openldap.org>, All rights reserved.
4 * Redistribution and use in source and binary forms are permitted only
5 * as authorized by the OpenLDAP Public License. A copy of this
6 * license is available at http://www.OpenLDAP.org/license.html or
7 * in file LICENSE in the top-level directory of the distribution.
15 #include "ac/string.h"
16 #include <sys/types.h>
20 #include "sql-types.h"
22 #include "schema-map.h"
24 #define MAX_ATTR_LEN 16384
26 typedef struct backsql_conn {
32 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
34 SQLCHAR msg[SQL_MAX_MESSAGE_LENGTH]; /* msg. buffer */
35 SQLCHAR state[SQL_SQLSTATE_SIZE]; /* statement buf. */
36 SDWORD iSqlCode; /* return code */
37 SWORD len = SQL_MAX_MESSAGE_LENGTH - 1; /* return length */
39 Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
42 rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
43 SQL_MAX_MESSAGE_LENGTH - 1, &len );
44 for ( ; BACKSQL_SUCCESS( rc ); ) {
45 Debug( LDAP_DEBUG_TRACE, "Native error code: %d\n",
46 (int)iSqlCode, 0, 0 );
47 Debug( LDAP_DEBUG_TRACE, "SQL engine state: %s\n",
49 Debug( LDAP_DEBUG_TRACE, "Message: %s\n", msg, 0, 0 );
50 rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
51 SQL_MAX_MESSAGE_LENGTH - 1, &len );
56 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
62 rc = SQLAllocStmt( dbh, sth );
63 if ( rc != SQL_SUCCESS ) {
68 Debug( LDAP_DEBUG_TRACE, "==>_SQLPrepare()\n", 0, 0, 0 );
69 #endif /* BACKSQL_TRACE */
71 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
74 Debug( LDAP_DEBUG_TRACE, "_SQLPrepare(): driver name='%s'\n",
76 #endif /* BACKSQL_TRACE */
78 ldap_pvt_str2upper( drv_name );
79 if ( !strncmp( drv_name, "SQLSRV32.DLL", sizeof( drv_name ) ) ) {
81 * stupid default result set in MS SQL Server
82 * does not support multiple active statements
83 * on the same connection -- so we are trying
84 * to make it not to use default result set...
86 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
87 "enabling MS SQL Server default result "
88 "set workaround\n", 0, 0, 0 );
89 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
91 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
92 Debug( LDAP_DEBUG_TRACE, "_SQLPrepare(): "
93 "SQLSetStmtOption(SQL_CONCURRENCY,"
94 "SQL_CONCUR_ROWVER) failed:\n",
96 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
101 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
102 "setting query timeout to %d sec.\n",
104 rc = SQLSetStmtOption( *sth, SQL_QUERY_TIMEOUT, timeout );
105 if ( rc != SQL_SUCCESS ) {
106 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
111 Debug( LDAP_DEBUG_TRACE, "<==_SQLPrepare() calling SQLPrepare()\n",
113 #endif /* BACKSQL_TRACE */
115 return SQLPrepare( *sth, query, SQL_NTS );
120 * Turned into macros --- see sql-wrap.h
123 backsql_BindParamStr( SQLHSTMT sth, int par_ind, char *str, int maxlen )
127 rc = SQLBindParameter( sth, (SQLUSMALLINT)par_ind, SQL_PARAM_INPUT,
128 SQL_C_CHAR, SQL_VARCHAR,
129 (SQLUINTEGER)maxlen, 0, (SQLPOINTER)str,
130 (SQLUINTEGER)maxlen, NULL );
135 backsql_BindParamID( SQLHSTMT sth, int par_ind, unsigned long *id )
137 return SQLBindParameter( sth, (SQLUSMALLINT)par_ind,
138 SQL_PARAM_INPUT, SQL_C_ULONG, SQL_INTEGER,
139 0, 0, (SQLPOINTER)id, 0, (SQLINTEGER*)NULL );
144 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
147 SQLCHAR colname[ 64 ];
148 SQLSMALLINT name_len, col_type, col_scale, col_null;
157 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
158 #endif /* BACKSQL_TRACE */
160 rc = SQLNumResultCols( sth, &row->ncols );
161 if ( rc != SQL_SUCCESS ) {
163 Debug( LDAP_DEBUG_TRACE, "_SQLBindRowAsStrings(): "
164 "SQLNumResultCols() failed:\n", 0, 0, 0 );
165 #endif /* BACKSQL_TRACE */
167 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
170 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
171 "ncols=%d\n", (int)row->ncols, 0, 0 );
172 #endif /* BACKSQL_TRACE */
174 row->col_names = (BerVarray)ch_calloc( row->ncols + 1,
175 sizeof( struct berval ) );
176 row->cols = (char **)ch_calloc( row->ncols + 1,
178 row->col_prec = (UDWORD *)ch_calloc( row->ncols,
180 row->is_null = (SQLINTEGER *)ch_calloc( row->ncols,
181 sizeof( SQLINTEGER ) );
182 for ( i = 1; i <= row->ncols; i++ ) {
183 rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
184 (SQLUINTEGER)( sizeof( colname ) - 1 ),
185 &name_len, &col_type,
186 &col_prec, &col_scale, &col_null );
187 ber_str2bv( colname, 0, 1, &row->col_names[ i - 1 ] );
189 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
190 "col_name=%s, col_prec[%d]=%d\n",
191 colname, (int)i, (int)col_prec );
192 #endif /* BACKSQL_TRACE */
193 if ( col_type == SQL_LONGVARCHAR
194 || col_type == SQL_LONGVARBINARY) {
196 row->cols[ i - 1 ] = NULL;
197 row->col_prec[ i - 1 ] = -1;
200 * such fields must be handled
201 * in some other way since they return 2G
202 * as their precision (at least it does so
203 * with MS SQL Server w/native driver)
204 * for now, we just set fixed precision
205 * for such fields - dirty hack, but...
206 * no time to deal with SQLGetData()
209 col_prec = MAX_ATTR_LEN;
210 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
211 row->col_prec[ i - 1 ] = col_prec;
212 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
214 (SQLPOINTER)row->cols[ i - 1 ],
216 &row->is_null[ i - 1 ] );
218 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
219 row->col_prec[ i - 1 ] = col_prec;
220 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
222 (SQLPOINTER)row->cols[ i - 1 ],
224 &row->is_null[ i - 1 ] );
228 row->col_names[ i - 1 ].bv_val = NULL;
229 row->col_names[ i - 1 ].bv_len = 0;
230 row->cols[ i - 1 ] = NULL;
234 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
235 #endif /* BACKSQL_TRACE */
241 backsql_FreeRow( BACKSQL_ROW_NTS *row )
243 if ( row->cols == NULL ) {
247 ber_bvarray_free( row->col_names );
248 charray_free( row->cols );
249 free( row->col_prec );
250 free( row->is_null );
256 backsql_cmp_connid( backsql_db_conn *c1, backsql_db_conn *c2 )
258 if ( c1->ldap_cid > c2->ldap_cid ) {
262 if ( c1->ldap_cid < c2->ldap_cid ) {
270 backsql_close_db_conn( backsql_db_conn *conn )
272 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn()\n", 0, 0, 0 );
275 * Default transact is SQL_ROLLBACK; commit is required only
276 * by write operations, and it is explicitly performed after
277 * each atomic operation succeeds.
281 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
282 SQLDisconnect( conn->dbh );
283 SQLFreeConnect( conn->dbh );
284 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn()\n", 0, 0, 0 );
289 backsql_init_db_env( backsql_info *si )
293 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
294 rc = SQLAllocEnv( &si->db_env );
295 if ( rc != SQL_SUCCESS ) {
296 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
298 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
301 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()\n", 0, 0, 0 );
306 backsql_free_db_env( backsql_info *si )
308 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
311 Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
313 #endif /* BACKSQL_TRACE */
316 * stop, if frontend waits for all threads to shutdown
317 * before calling this -- then what are we going to delete??
318 * everything is already deleted...
320 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
325 backsql_open_db_conn( backsql_info *si, int ldap_cid, backsql_db_conn **pdbc )
329 backsql_db_conn *dbc;
335 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
336 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
337 dbc->ldap_cid = ldap_cid;
338 rc = SQLAllocConnect( si->db_env, &dbc->dbh );
339 if ( !BACKSQL_SUCCESS( rc ) ) {
340 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
341 "SQLAllocConnect() failed:\n", 0, 0, 0 );
342 backsql_PrintErrors( si->db_env, SQL_NULL_HDBC,
344 return LDAP_UNAVAILABLE;
347 rc = SQLConnect( dbc->dbh, si->dbname, SQL_NTS, si->dbuser,
348 SQL_NTS, si->dbpasswd, SQL_NTS );
349 if ( rc != SQL_SUCCESS ) {
350 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
351 "SQLConnect() to database '%s' as user '%s' "
352 "%s:\n", si->dbname, si->dbuser,
353 rc == SQL_SUCCESS_WITH_INFO ?
354 "succeeded with info" : "failed" );
355 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
356 if ( rc != SQL_SUCCESS_WITH_INFO ) {
357 return LDAP_UNAVAILABLE;
362 * TimesTen : Turn off autocommit. We must explicitly
363 * commit any transactions.
365 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
368 * See if this connection is to TimesTen. If it is,
369 * remember that fact for later use.
371 /* Assume until proven otherwise */
372 si->bsql_flags &= ~BSQLF_USE_REVERSE_DN;
373 DBMSName[ 0 ] = '\0';
374 rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
375 sizeof( DBMSName ), NULL );
376 if ( rc == SQL_SUCCESS ) {
377 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
378 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
379 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
380 "TimesTen database!\n", 0, 0, 0 );
381 si->bsql_flags |= BSQLF_USE_REVERSE_DN;
384 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
385 "SQLGetInfo() failed:\n", 0, 0, 0 );
386 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
390 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
391 "connected, adding to tree\n", 0, 0, 0 );
392 ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
393 avl_insert( &si->db_conns, dbc, (AVL_CMP)backsql_cmp_connid, NULL );
394 ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
395 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
403 backsql_free_db_conn( Backend *be, Connection *ldapc )
405 backsql_info *si = (backsql_info *)be->be_private;
406 backsql_db_conn tmp, *conn;
408 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
409 tmp.ldap_cid = ldapc->c_connid;
410 ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
411 conn = (backsql_db_conn *)avl_delete( &si->db_conns, &tmp,
412 (AVL_CMP)backsql_cmp_connid );
413 ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
416 * we have one thread per connection, as I understand -- so we can
417 * get this out of critical section
419 if ( conn != NULL ) {
420 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
421 "closing db connection\n", 0, 0, 0 );
422 backsql_close_db_conn( conn );
424 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
429 backsql_get_db_conn( Backend *be, Connection *ldapc, SQLHDBC *dbh )
431 backsql_info *si = (backsql_info *)be->be_private;
432 backsql_db_conn *dbc;
434 int rc = LDAP_SUCCESS;
436 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
439 *dbh = SQL_NULL_HDBC;
441 tmp.ldap_cid = ldapc->c_connid;
444 * we have one thread per connection, as I understand --
445 * so we do not need locking here
447 dbc = (backsql_db_conn *)avl_find( si->db_conns, &tmp,
448 (AVL_CMP)backsql_cmp_connid );
450 rc = backsql_open_db_conn( si, ldapc->c_connid, &dbc );
451 if ( rc != LDAP_SUCCESS) {
452 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
453 "could not get connection handle "
454 "-- returning NULL\n", 0, 0, 0 );
459 ldap_pvt_thread_mutex_lock( &si->schema_mutex );
460 if ( !BACKSQL_SCHEMA_LOADED( si ) ) {
461 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
462 "first call -- reading schema map\n", 0, 0, 0 );
463 rc = backsql_load_schema_map( si, dbc->dbh );
464 if ( rc != LDAP_SUCCESS ) {
465 ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
466 backsql_free_db_conn( be, ldapc );
470 ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
474 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );
479 #endif /* SLAPD_SQL */