Add tests for the new code on this branch.
[sqlite.git] / src / loadext.c
blob7e0ae25437f27457f2d70e071fc4c93b7eab4d9d
1 /*
2 ** 2006 June 7
3 **
4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
6 **
7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give.
11 *************************************************************************
12 ** This file contains code used to dynamically load extensions into
13 ** the SQLite library.
16 #ifndef SQLITE_CORE
17 #define SQLITE_CORE 1 /* Disable the API redefinition in sqlite3ext.h */
18 #endif
19 #include "sqlite3ext.h"
20 #include "sqliteInt.h"
22 #ifndef SQLITE_OMIT_LOAD_EXTENSION
24 ** Some API routines are omitted when various features are
25 ** excluded from a build of SQLite. Substitute a NULL pointer
26 ** for any missing APIs.
28 #ifndef SQLITE_ENABLE_COLUMN_METADATA
29 # define sqlite3_column_database_name 0
30 # define sqlite3_column_database_name16 0
31 # define sqlite3_column_table_name 0
32 # define sqlite3_column_table_name16 0
33 # define sqlite3_column_origin_name 0
34 # define sqlite3_column_origin_name16 0
35 #endif
37 #ifdef SQLITE_OMIT_AUTHORIZATION
38 # define sqlite3_set_authorizer 0
39 #endif
41 #ifdef SQLITE_OMIT_UTF16
42 # define sqlite3_bind_text16 0
43 # define sqlite3_collation_needed16 0
44 # define sqlite3_column_decltype16 0
45 # define sqlite3_column_name16 0
46 # define sqlite3_column_text16 0
47 # define sqlite3_complete16 0
48 # define sqlite3_create_collation16 0
49 # define sqlite3_create_function16 0
50 # define sqlite3_errmsg16 0
51 # define sqlite3_open16 0
52 # define sqlite3_prepare16 0
53 # define sqlite3_prepare16_v2 0
54 # define sqlite3_prepare16_v3 0
55 # define sqlite3_result_error16 0
56 # define sqlite3_result_text16 0
57 # define sqlite3_result_text16be 0
58 # define sqlite3_result_text16le 0
59 # define sqlite3_value_text16 0
60 # define sqlite3_value_text16be 0
61 # define sqlite3_value_text16le 0
62 # define sqlite3_column_database_name16 0
63 # define sqlite3_column_table_name16 0
64 # define sqlite3_column_origin_name16 0
65 #endif
67 #ifdef SQLITE_OMIT_COMPLETE
68 # define sqlite3_complete 0
69 # define sqlite3_complete16 0
70 #endif
72 #ifdef SQLITE_OMIT_DECLTYPE
73 # define sqlite3_column_decltype16 0
74 # define sqlite3_column_decltype 0
75 #endif
77 #ifdef SQLITE_OMIT_PROGRESS_CALLBACK
78 # define sqlite3_progress_handler 0
79 #endif
81 #ifdef SQLITE_OMIT_VIRTUALTABLE
82 # define sqlite3_create_module 0
83 # define sqlite3_create_module_v2 0
84 # define sqlite3_declare_vtab 0
85 # define sqlite3_vtab_config 0
86 # define sqlite3_vtab_on_conflict 0
87 # define sqlite3_vtab_collation 0
88 #endif
90 #ifdef SQLITE_OMIT_SHARED_CACHE
91 # define sqlite3_enable_shared_cache 0
92 #endif
94 #if defined(SQLITE_OMIT_TRACE) || defined(SQLITE_OMIT_DEPRECATED)
95 # define sqlite3_profile 0
96 # define sqlite3_trace 0
97 #endif
99 #ifdef SQLITE_OMIT_GET_TABLE
100 # define sqlite3_free_table 0
101 # define sqlite3_get_table 0
102 #endif
104 #ifdef SQLITE_OMIT_INCRBLOB
105 #define sqlite3_bind_zeroblob 0
106 #define sqlite3_blob_bytes 0
107 #define sqlite3_blob_close 0
108 #define sqlite3_blob_open 0
109 #define sqlite3_blob_read 0
110 #define sqlite3_blob_write 0
111 #define sqlite3_blob_reopen 0
112 #endif
114 #if defined(SQLITE_OMIT_TRACE)
115 # define sqlite3_trace_v2 0
116 #endif
119 ** The following structure contains pointers to all SQLite API routines.
120 ** A pointer to this structure is passed into extensions when they are
121 ** loaded so that the extension can make calls back into the SQLite
122 ** library.
124 ** When adding new APIs, add them to the bottom of this structure
125 ** in order to preserve backwards compatibility.
127 ** Extensions that use newer APIs should first call the
128 ** sqlite3_libversion_number() to make sure that the API they
129 ** intend to use is supported by the library. Extensions should
130 ** also check to make sure that the pointer to the function is
131 ** not NULL before calling it.
133 static const sqlite3_api_routines sqlite3Apis = {
134 sqlite3_aggregate_context,
135 #ifndef SQLITE_OMIT_DEPRECATED
136 sqlite3_aggregate_count,
137 #else
139 #endif
140 sqlite3_bind_blob,
141 sqlite3_bind_double,
142 sqlite3_bind_int,
143 sqlite3_bind_int64,
144 sqlite3_bind_null,
145 sqlite3_bind_parameter_count,
146 sqlite3_bind_parameter_index,
147 sqlite3_bind_parameter_name,
148 sqlite3_bind_text,
149 sqlite3_bind_text16,
150 sqlite3_bind_value,
151 sqlite3_busy_handler,
152 sqlite3_busy_timeout,
153 sqlite3_changes,
154 sqlite3_close,
155 sqlite3_collation_needed,
156 sqlite3_collation_needed16,
157 sqlite3_column_blob,
158 sqlite3_column_bytes,
159 sqlite3_column_bytes16,
160 sqlite3_column_count,
161 sqlite3_column_database_name,
162 sqlite3_column_database_name16,
163 sqlite3_column_decltype,
164 sqlite3_column_decltype16,
165 sqlite3_column_double,
166 sqlite3_column_int,
167 sqlite3_column_int64,
168 sqlite3_column_name,
169 sqlite3_column_name16,
170 sqlite3_column_origin_name,
171 sqlite3_column_origin_name16,
172 sqlite3_column_table_name,
173 sqlite3_column_table_name16,
174 sqlite3_column_text,
175 sqlite3_column_text16,
176 sqlite3_column_type,
177 sqlite3_column_value,
178 sqlite3_commit_hook,
179 sqlite3_complete,
180 sqlite3_complete16,
181 sqlite3_create_collation,
182 sqlite3_create_collation16,
183 sqlite3_create_function,
184 sqlite3_create_function16,
185 sqlite3_create_module,
186 sqlite3_data_count,
187 sqlite3_db_handle,
188 sqlite3_declare_vtab,
189 sqlite3_enable_shared_cache,
190 sqlite3_errcode,
191 sqlite3_errmsg,
192 sqlite3_errmsg16,
193 sqlite3_exec,
194 #ifndef SQLITE_OMIT_DEPRECATED
195 sqlite3_expired,
196 #else
198 #endif
199 sqlite3_finalize,
200 sqlite3_free,
201 sqlite3_free_table,
202 sqlite3_get_autocommit,
203 sqlite3_get_auxdata,
204 sqlite3_get_table,
205 0, /* Was sqlite3_global_recover(), but that function is deprecated */
206 sqlite3_interrupt,
207 sqlite3_last_insert_rowid,
208 sqlite3_libversion,
209 sqlite3_libversion_number,
210 sqlite3_malloc,
211 sqlite3_mprintf,
212 sqlite3_open,
213 sqlite3_open16,
214 sqlite3_prepare,
215 sqlite3_prepare16,
216 sqlite3_profile,
217 sqlite3_progress_handler,
218 sqlite3_realloc,
219 sqlite3_reset,
220 sqlite3_result_blob,
221 sqlite3_result_double,
222 sqlite3_result_error,
223 sqlite3_result_error16,
224 sqlite3_result_int,
225 sqlite3_result_int64,
226 sqlite3_result_null,
227 sqlite3_result_text,
228 sqlite3_result_text16,
229 sqlite3_result_text16be,
230 sqlite3_result_text16le,
231 sqlite3_result_value,
232 sqlite3_rollback_hook,
233 sqlite3_set_authorizer,
234 sqlite3_set_auxdata,
235 sqlite3_snprintf,
236 sqlite3_step,
237 sqlite3_table_column_metadata,
238 #ifndef SQLITE_OMIT_DEPRECATED
239 sqlite3_thread_cleanup,
240 #else
242 #endif
243 sqlite3_total_changes,
244 sqlite3_trace,
245 #ifndef SQLITE_OMIT_DEPRECATED
246 sqlite3_transfer_bindings,
247 #else
249 #endif
250 sqlite3_update_hook,
251 sqlite3_user_data,
252 sqlite3_value_blob,
253 sqlite3_value_bytes,
254 sqlite3_value_bytes16,
255 sqlite3_value_double,
256 sqlite3_value_int,
257 sqlite3_value_int64,
258 sqlite3_value_numeric_type,
259 sqlite3_value_text,
260 sqlite3_value_text16,
261 sqlite3_value_text16be,
262 sqlite3_value_text16le,
263 sqlite3_value_type,
264 sqlite3_vmprintf,
266 ** The original API set ends here. All extensions can call any
267 ** of the APIs above provided that the pointer is not NULL. But
268 ** before calling APIs that follow, extension should check the
269 ** sqlite3_libversion_number() to make sure they are dealing with
270 ** a library that is new enough to support that API.
271 *************************************************************************
273 sqlite3_overload_function,
276 ** Added after 3.3.13
278 sqlite3_prepare_v2,
279 sqlite3_prepare16_v2,
280 sqlite3_clear_bindings,
283 ** Added for 3.4.1
285 sqlite3_create_module_v2,
288 ** Added for 3.5.0
290 sqlite3_bind_zeroblob,
291 sqlite3_blob_bytes,
292 sqlite3_blob_close,
293 sqlite3_blob_open,
294 sqlite3_blob_read,
295 sqlite3_blob_write,
296 sqlite3_create_collation_v2,
297 sqlite3_file_control,
298 sqlite3_memory_highwater,
299 sqlite3_memory_used,
300 #ifdef SQLITE_MUTEX_OMIT
306 #else
307 sqlite3_mutex_alloc,
308 sqlite3_mutex_enter,
309 sqlite3_mutex_free,
310 sqlite3_mutex_leave,
311 sqlite3_mutex_try,
312 #endif
313 sqlite3_open_v2,
314 sqlite3_release_memory,
315 sqlite3_result_error_nomem,
316 sqlite3_result_error_toobig,
317 sqlite3_sleep,
318 sqlite3_soft_heap_limit,
319 sqlite3_vfs_find,
320 sqlite3_vfs_register,
321 sqlite3_vfs_unregister,
324 ** Added for 3.5.8
326 sqlite3_threadsafe,
327 sqlite3_result_zeroblob,
328 sqlite3_result_error_code,
329 sqlite3_test_control,
330 sqlite3_randomness,
331 sqlite3_context_db_handle,
334 ** Added for 3.6.0
336 sqlite3_extended_result_codes,
337 sqlite3_limit,
338 sqlite3_next_stmt,
339 sqlite3_sql,
340 sqlite3_status,
343 ** Added for 3.7.4
345 sqlite3_backup_finish,
346 sqlite3_backup_init,
347 sqlite3_backup_pagecount,
348 sqlite3_backup_remaining,
349 sqlite3_backup_step,
350 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
351 sqlite3_compileoption_get,
352 sqlite3_compileoption_used,
353 #else
356 #endif
357 sqlite3_create_function_v2,
358 sqlite3_db_config,
359 sqlite3_db_mutex,
360 sqlite3_db_status,
361 sqlite3_extended_errcode,
362 sqlite3_log,
363 sqlite3_soft_heap_limit64,
364 sqlite3_sourceid,
365 sqlite3_stmt_status,
366 sqlite3_strnicmp,
367 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
368 sqlite3_unlock_notify,
369 #else
371 #endif
372 #ifndef SQLITE_OMIT_WAL
373 sqlite3_wal_autocheckpoint,
374 sqlite3_wal_checkpoint,
375 sqlite3_wal_hook,
376 #else
380 #endif
381 sqlite3_blob_reopen,
382 sqlite3_vtab_config,
383 sqlite3_vtab_on_conflict,
384 sqlite3_close_v2,
385 sqlite3_db_filename,
386 sqlite3_db_readonly,
387 sqlite3_db_release_memory,
388 sqlite3_errstr,
389 sqlite3_stmt_busy,
390 sqlite3_stmt_readonly,
391 sqlite3_stricmp,
392 sqlite3_uri_boolean,
393 sqlite3_uri_int64,
394 sqlite3_uri_parameter,
395 sqlite3_vsnprintf,
396 sqlite3_wal_checkpoint_v2,
397 /* Version 3.8.7 and later */
398 sqlite3_auto_extension,
399 sqlite3_bind_blob64,
400 sqlite3_bind_text64,
401 sqlite3_cancel_auto_extension,
402 sqlite3_load_extension,
403 sqlite3_malloc64,
404 sqlite3_msize,
405 sqlite3_realloc64,
406 sqlite3_reset_auto_extension,
407 sqlite3_result_blob64,
408 sqlite3_result_text64,
409 sqlite3_strglob,
410 /* Version 3.8.11 and later */
411 (sqlite3_value*(*)(const sqlite3_value*))sqlite3_value_dup,
412 sqlite3_value_free,
413 sqlite3_result_zeroblob64,
414 sqlite3_bind_zeroblob64,
415 /* Version 3.9.0 and later */
416 sqlite3_value_subtype,
417 sqlite3_result_subtype,
418 /* Version 3.10.0 and later */
419 sqlite3_status64,
420 sqlite3_strlike,
421 sqlite3_db_cacheflush,
422 /* Version 3.12.0 and later */
423 sqlite3_system_errno,
424 /* Version 3.14.0 and later */
425 sqlite3_trace_v2,
426 sqlite3_expanded_sql,
427 /* Version 3.18.0 and later */
428 sqlite3_set_last_insert_rowid,
429 /* Version 3.20.0 and later */
430 sqlite3_prepare_v3,
431 sqlite3_prepare16_v3,
432 sqlite3_bind_pointer,
433 sqlite3_result_pointer,
434 sqlite3_value_pointer,
435 /* Version 3.22.0 and later */
436 sqlite3_vtab_nochange,
437 sqlite3_value_nochange,
438 sqlite3_vtab_collation,
439 /* Version 3.24.0 and later */
440 sqlite3_keyword_count,
441 sqlite3_keyword_name,
442 sqlite3_keyword_check,
443 sqlite3_str_new,
444 sqlite3_str_finish,
445 sqlite3_str_appendf,
446 sqlite3_str_vappendf,
447 sqlite3_str_append,
448 sqlite3_str_appendall,
449 sqlite3_str_appendchar,
450 sqlite3_str_reset,
451 sqlite3_str_errcode,
452 sqlite3_str_length,
453 sqlite3_str_value,
454 /* Version 3.25.0 and later */
455 sqlite3_create_window_function,
456 /* Version 3.26.0 and later */
457 #ifdef SQLITE_ENABLE_NORMALIZE
458 sqlite3_normalized_sql,
459 #else
461 #endif
462 /* Version 3.28.0 and later */
463 sqlite3_stmt_isexplain,
464 sqlite3_value_frombind,
465 /* Version 3.30.0 and later */
466 #ifndef SQLITE_OMIT_VIRTUALTABLE
467 sqlite3_drop_modules,
468 #else
470 #endif
471 /* Version 3.31.0 and later */
472 sqlite3_hard_heap_limit64,
473 sqlite3_uri_key,
474 sqlite3_filename_database,
475 sqlite3_filename_journal,
476 sqlite3_filename_wal,
477 /* Version 3.32.0 and later */
478 sqlite3_create_filename,
479 sqlite3_free_filename,
480 sqlite3_database_file_object,
481 /* Version 3.34.0 and later */
482 sqlite3_txn_state,
483 /* Version 3.36.1 and later */
484 sqlite3_changes64,
485 sqlite3_total_changes64,
486 /* Version 3.37.0 and later */
487 sqlite3_autovacuum_pages,
488 /* Version 3.38.0 and later */
489 sqlite3_error_offset,
490 #ifndef SQLITE_OMIT_VIRTUALTABLE
491 sqlite3_vtab_rhs_value,
492 sqlite3_vtab_distinct,
493 sqlite3_vtab_in,
494 sqlite3_vtab_in_first,
495 sqlite3_vtab_in_next,
496 #else
502 #endif
503 /* Version 3.39.0 and later */
504 #ifndef SQLITE_OMIT_DESERIALIZE
505 sqlite3_deserialize,
506 sqlite3_serialize,
507 #else
510 #endif
511 sqlite3_db_name,
512 /* Version 3.40.0 and later */
513 sqlite3_value_encoding,
514 /* Version 3.41.0 and later */
515 sqlite3_is_interrupted,
516 /* Version 3.43.0 and later */
517 sqlite3_stmt_explain,
518 /* Version 3.44.0 and later */
519 sqlite3_get_clientdata,
520 sqlite3_set_clientdata
523 /* True if x is the directory separator character
525 #if SQLITE_OS_WIN
526 # define DirSep(X) ((X)=='/'||(X)=='\\')
527 #else
528 # define DirSep(X) ((X)=='/')
529 #endif
532 ** Attempt to load an SQLite extension library contained in the file
533 ** zFile. The entry point is zProc. zProc may be 0 in which case a
534 ** default entry point name (sqlite3_extension_init) is used. Use
535 ** of the default name is recommended.
537 ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
539 ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
540 ** error message text. The calling function should free this memory
541 ** by calling sqlite3DbFree(db, ).
543 static int sqlite3LoadExtension(
544 sqlite3 *db, /* Load the extension into this database connection */
545 const char *zFile, /* Name of the shared library containing extension */
546 const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
547 char **pzErrMsg /* Put error message here if not 0 */
549 sqlite3_vfs *pVfs = db->pVfs;
550 void *handle;
551 sqlite3_loadext_entry xInit;
552 char *zErrmsg = 0;
553 const char *zEntry;
554 char *zAltEntry = 0;
555 void **aHandle;
556 u64 nMsg = strlen(zFile);
557 int ii;
558 int rc;
560 /* Shared library endings to try if zFile cannot be loaded as written */
561 static const char *azEndings[] = {
562 #if SQLITE_OS_WIN
563 "dll"
564 #elif defined(__APPLE__)
565 "dylib"
566 #else
567 "so"
568 #endif
572 if( pzErrMsg ) *pzErrMsg = 0;
574 /* Ticket #1863. To avoid a creating security problems for older
575 ** applications that relink against newer versions of SQLite, the
576 ** ability to run load_extension is turned off by default. One
577 ** must call either sqlite3_enable_load_extension(db) or
578 ** sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, 0)
579 ** to turn on extension loading.
581 if( (db->flags & SQLITE_LoadExtension)==0 ){
582 if( pzErrMsg ){
583 *pzErrMsg = sqlite3_mprintf("not authorized");
585 return SQLITE_ERROR;
588 zEntry = zProc ? zProc : "sqlite3_extension_init";
590 /* tag-20210611-1. Some dlopen() implementations will segfault if given
591 ** an oversize filename. Most filesystems have a pathname limit of 4K,
592 ** so limit the extension filename length to about twice that.
593 ** https://sqlite.org/forum/forumpost/08a0d6d9bf
595 ** Later (2023-03-25): Save an extra 6 bytes for the filename suffix.
596 ** See https://sqlite.org/forum/forumpost/24083b579d.
598 if( nMsg>SQLITE_MAX_PATHLEN ) goto extension_not_found;
600 /* Do not allow sqlite3_load_extension() to link to a copy of the
601 ** running application, by passing in an empty filename. */
602 if( nMsg==0 ) goto extension_not_found;
604 handle = sqlite3OsDlOpen(pVfs, zFile);
605 #if SQLITE_OS_UNIX || SQLITE_OS_WIN
606 for(ii=0; ii<ArraySize(azEndings) && handle==0; ii++){
607 char *zAltFile = sqlite3_mprintf("%s.%s", zFile, azEndings[ii]);
608 if( zAltFile==0 ) return SQLITE_NOMEM_BKPT;
609 if( nMsg+strlen(azEndings[ii])+1<=SQLITE_MAX_PATHLEN ){
610 handle = sqlite3OsDlOpen(pVfs, zAltFile);
612 sqlite3_free(zAltFile);
614 #endif
615 if( handle==0 ) goto extension_not_found;
616 xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
618 /* If no entry point was specified and the default legacy
619 ** entry point name "sqlite3_extension_init" was not found, then
620 ** construct an entry point name "sqlite3_X_init" where the X is
621 ** replaced by the lowercase value of every ASCII alphabetic
622 ** character in the filename after the last "/" upto the first ".",
623 ** and eliding the first three characters if they are "lib".
624 ** Examples:
626 ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
627 ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
629 if( xInit==0 && zProc==0 ){
630 int iFile, iEntry, c;
631 int ncFile = sqlite3Strlen30(zFile);
632 zAltEntry = sqlite3_malloc64(ncFile+30);
633 if( zAltEntry==0 ){
634 sqlite3OsDlClose(pVfs, handle);
635 return SQLITE_NOMEM_BKPT;
637 memcpy(zAltEntry, "sqlite3_", 8);
638 for(iFile=ncFile-1; iFile>=0 && !DirSep(zFile[iFile]); iFile--){}
639 iFile++;
640 if( sqlite3_strnicmp(zFile+iFile, "lib", 3)==0 ) iFile += 3;
641 for(iEntry=8; (c = zFile[iFile])!=0 && c!='.'; iFile++){
642 if( sqlite3Isalpha(c) ){
643 zAltEntry[iEntry++] = (char)sqlite3UpperToLower[(unsigned)c];
646 memcpy(zAltEntry+iEntry, "_init", 6);
647 zEntry = zAltEntry;
648 xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
650 if( xInit==0 ){
651 if( pzErrMsg ){
652 nMsg += strlen(zEntry) + 300;
653 *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
654 if( zErrmsg ){
655 assert( nMsg<0x7fffffff ); /* zErrmsg would be NULL if not so */
656 sqlite3_snprintf((int)nMsg, zErrmsg,
657 "no entry point [%s] in shared library [%s]", zEntry, zFile);
658 sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
661 sqlite3OsDlClose(pVfs, handle);
662 sqlite3_free(zAltEntry);
663 return SQLITE_ERROR;
665 sqlite3_free(zAltEntry);
666 rc = xInit(db, &zErrmsg, &sqlite3Apis);
667 if( rc ){
668 if( rc==SQLITE_OK_LOAD_PERMANENTLY ) return SQLITE_OK;
669 if( pzErrMsg ){
670 *pzErrMsg = sqlite3_mprintf("error during initialization: %s", zErrmsg);
672 sqlite3_free(zErrmsg);
673 sqlite3OsDlClose(pVfs, handle);
674 return SQLITE_ERROR;
677 /* Append the new shared library handle to the db->aExtension array. */
678 aHandle = sqlite3DbMallocZero(db, sizeof(handle)*(db->nExtension+1));
679 if( aHandle==0 ){
680 return SQLITE_NOMEM_BKPT;
682 if( db->nExtension>0 ){
683 memcpy(aHandle, db->aExtension, sizeof(handle)*db->nExtension);
685 sqlite3DbFree(db, db->aExtension);
686 db->aExtension = aHandle;
688 db->aExtension[db->nExtension++] = handle;
689 return SQLITE_OK;
691 extension_not_found:
692 if( pzErrMsg ){
693 nMsg += 300;
694 *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
695 if( zErrmsg ){
696 assert( nMsg<0x7fffffff ); /* zErrmsg would be NULL if not so */
697 sqlite3_snprintf((int)nMsg, zErrmsg,
698 "unable to open shared library [%.*s]", SQLITE_MAX_PATHLEN, zFile);
699 sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
702 return SQLITE_ERROR;
704 int sqlite3_load_extension(
705 sqlite3 *db, /* Load the extension into this database connection */
706 const char *zFile, /* Name of the shared library containing extension */
707 const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
708 char **pzErrMsg /* Put error message here if not 0 */
710 int rc;
711 sqlite3_mutex_enter(db->mutex);
712 rc = sqlite3LoadExtension(db, zFile, zProc, pzErrMsg);
713 rc = sqlite3ApiExit(db, rc);
714 sqlite3_mutex_leave(db->mutex);
715 return rc;
719 ** Call this routine when the database connection is closing in order
720 ** to clean up loaded extensions
722 void sqlite3CloseExtensions(sqlite3 *db){
723 int i;
724 assert( sqlite3_mutex_held(db->mutex) );
725 for(i=0; i<db->nExtension; i++){
726 sqlite3OsDlClose(db->pVfs, db->aExtension[i]);
728 sqlite3DbFree(db, db->aExtension);
732 ** Enable or disable extension loading. Extension loading is disabled by
733 ** default so as not to open security holes in older applications.
735 int sqlite3_enable_load_extension(sqlite3 *db, int onoff){
736 #ifdef SQLITE_ENABLE_API_ARMOR
737 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
738 #endif
739 sqlite3_mutex_enter(db->mutex);
740 if( onoff ){
741 db->flags |= SQLITE_LoadExtension|SQLITE_LoadExtFunc;
742 }else{
743 db->flags &= ~(u64)(SQLITE_LoadExtension|SQLITE_LoadExtFunc);
745 sqlite3_mutex_leave(db->mutex);
746 return SQLITE_OK;
749 #endif /* !defined(SQLITE_OMIT_LOAD_EXTENSION) */
752 ** The following object holds the list of automatically loaded
753 ** extensions.
755 ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MAIN
756 ** mutex must be held while accessing this list.
758 typedef struct sqlite3AutoExtList sqlite3AutoExtList;
759 static SQLITE_WSD struct sqlite3AutoExtList {
760 u32 nExt; /* Number of entries in aExt[] */
761 void (**aExt)(void); /* Pointers to the extension init functions */
762 } sqlite3Autoext = { 0, 0 };
764 /* The "wsdAutoext" macro will resolve to the autoextension
765 ** state vector. If writable static data is unsupported on the target,
766 ** we have to locate the state vector at run-time. In the more common
767 ** case where writable static data is supported, wsdStat can refer directly
768 ** to the "sqlite3Autoext" state vector declared above.
770 #ifdef SQLITE_OMIT_WSD
771 # define wsdAutoextInit \
772 sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
773 # define wsdAutoext x[0]
774 #else
775 # define wsdAutoextInit
776 # define wsdAutoext sqlite3Autoext
777 #endif
781 ** Register a statically linked extension that is automatically
782 ** loaded by every new database connection.
784 int sqlite3_auto_extension(
785 void (*xInit)(void)
787 int rc = SQLITE_OK;
788 #ifdef SQLITE_ENABLE_API_ARMOR
789 if( xInit==0 ) return SQLITE_MISUSE_BKPT;
790 #endif
791 #ifndef SQLITE_OMIT_AUTOINIT
792 rc = sqlite3_initialize();
793 if( rc ){
794 return rc;
795 }else
796 #endif
798 u32 i;
799 #if SQLITE_THREADSAFE
800 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN);
801 #endif
802 wsdAutoextInit;
803 sqlite3_mutex_enter(mutex);
804 for(i=0; i<wsdAutoext.nExt; i++){
805 if( wsdAutoext.aExt[i]==xInit ) break;
807 if( i==wsdAutoext.nExt ){
808 u64 nByte = (wsdAutoext.nExt+1)*sizeof(wsdAutoext.aExt[0]);
809 void (**aNew)(void);
810 aNew = sqlite3_realloc64(wsdAutoext.aExt, nByte);
811 if( aNew==0 ){
812 rc = SQLITE_NOMEM_BKPT;
813 }else{
814 wsdAutoext.aExt = aNew;
815 wsdAutoext.aExt[wsdAutoext.nExt] = xInit;
816 wsdAutoext.nExt++;
819 sqlite3_mutex_leave(mutex);
820 assert( (rc&0xff)==rc );
821 return rc;
826 ** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
827 ** set of routines that is invoked for each new database connection, if it
828 ** is currently on the list. If xInit is not on the list, then this
829 ** routine is a no-op.
831 ** Return 1 if xInit was found on the list and removed. Return 0 if xInit
832 ** was not on the list.
834 int sqlite3_cancel_auto_extension(
835 void (*xInit)(void)
837 #if SQLITE_THREADSAFE
838 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN);
839 #endif
840 int i;
841 int n = 0;
842 wsdAutoextInit;
843 #ifdef SQLITE_ENABLE_API_ARMOR
844 if( xInit==0 ) return 0;
845 #endif
846 sqlite3_mutex_enter(mutex);
847 for(i=(int)wsdAutoext.nExt-1; i>=0; i--){
848 if( wsdAutoext.aExt[i]==xInit ){
849 wsdAutoext.nExt--;
850 wsdAutoext.aExt[i] = wsdAutoext.aExt[wsdAutoext.nExt];
851 n++;
852 break;
855 sqlite3_mutex_leave(mutex);
856 return n;
860 ** Reset the automatic extension loading mechanism.
862 void sqlite3_reset_auto_extension(void){
863 #ifndef SQLITE_OMIT_AUTOINIT
864 if( sqlite3_initialize()==SQLITE_OK )
865 #endif
867 #if SQLITE_THREADSAFE
868 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN);
869 #endif
870 wsdAutoextInit;
871 sqlite3_mutex_enter(mutex);
872 sqlite3_free(wsdAutoext.aExt);
873 wsdAutoext.aExt = 0;
874 wsdAutoext.nExt = 0;
875 sqlite3_mutex_leave(mutex);
880 ** Load all automatic extensions.
882 ** If anything goes wrong, set an error in the database connection.
884 void sqlite3AutoLoadExtensions(sqlite3 *db){
885 u32 i;
886 int go = 1;
887 int rc;
888 sqlite3_loadext_entry xInit;
890 wsdAutoextInit;
891 if( wsdAutoext.nExt==0 ){
892 /* Common case: early out without every having to acquire a mutex */
893 return;
895 for(i=0; go; i++){
896 char *zErrmsg;
897 #if SQLITE_THREADSAFE
898 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN);
899 #endif
900 #ifdef SQLITE_OMIT_LOAD_EXTENSION
901 const sqlite3_api_routines *pThunk = 0;
902 #else
903 const sqlite3_api_routines *pThunk = &sqlite3Apis;
904 #endif
905 sqlite3_mutex_enter(mutex);
906 if( i>=wsdAutoext.nExt ){
907 xInit = 0;
908 go = 0;
909 }else{
910 xInit = (sqlite3_loadext_entry)wsdAutoext.aExt[i];
912 sqlite3_mutex_leave(mutex);
913 zErrmsg = 0;
914 if( xInit && (rc = xInit(db, &zErrmsg, pThunk))!=0 ){
915 sqlite3ErrorWithMsg(db, rc,
916 "automatic extension loading failed: %s", zErrmsg);
917 go = 0;
919 sqlite3_free(zErrmsg);