4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
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.
17 #define SQLITE_CORE 1 /* Disable the API redefinition in sqlite3ext.h */
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
37 #ifdef SQLITE_OMIT_AUTHORIZATION
38 # define sqlite3_set_authorizer 0
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
67 #ifdef SQLITE_OMIT_COMPLETE
68 # define sqlite3_complete 0
69 # define sqlite3_complete16 0
72 #ifdef SQLITE_OMIT_DECLTYPE
73 # define sqlite3_column_decltype16 0
74 # define sqlite3_column_decltype 0
77 #ifdef SQLITE_OMIT_PROGRESS_CALLBACK
78 # define sqlite3_progress_handler 0
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
89 #ifdef SQLITE_OMIT_SHARED_CACHE
90 # define sqlite3_enable_shared_cache 0
93 #if defined(SQLITE_OMIT_TRACE) || defined(SQLITE_OMIT_DEPRECATED)
94 # define sqlite3_profile 0
95 # define sqlite3_trace 0
98 #ifdef SQLITE_OMIT_GET_TABLE
99 # define sqlite3_free_table 0
100 # define sqlite3_get_table 0
103 #ifdef SQLITE_OMIT_INCRBLOB
104 #define sqlite3_bind_zeroblob 0
105 #define sqlite3_blob_bytes 0
106 #define sqlite3_blob_close 0
107 #define sqlite3_blob_open 0
108 #define sqlite3_blob_read 0
109 #define sqlite3_blob_write 0
110 #define sqlite3_blob_reopen 0
113 #if defined(SQLITE_OMIT_TRACE)
114 # define sqlite3_trace_v2 0
118 ** The following structure contains pointers to all SQLite API routines.
119 ** A pointer to this structure is passed into extensions when they are
120 ** loaded so that the extension can make calls back into the SQLite
123 ** When adding new APIs, add them to the bottom of this structure
124 ** in order to preserve backwards compatibility.
126 ** Extensions that use newer APIs should first call the
127 ** sqlite3_libversion_number() to make sure that the API they
128 ** intend to use is supported by the library. Extensions should
129 ** also check to make sure that the pointer to the function is
130 ** not NULL before calling it.
132 static const sqlite3_api_routines sqlite3Apis
= {
133 sqlite3_aggregate_context
,
134 #ifndef SQLITE_OMIT_DEPRECATED
135 sqlite3_aggregate_count
,
144 sqlite3_bind_parameter_count
,
145 sqlite3_bind_parameter_index
,
146 sqlite3_bind_parameter_name
,
150 sqlite3_busy_handler
,
151 sqlite3_busy_timeout
,
154 sqlite3_collation_needed
,
155 sqlite3_collation_needed16
,
157 sqlite3_column_bytes
,
158 sqlite3_column_bytes16
,
159 sqlite3_column_count
,
160 sqlite3_column_database_name
,
161 sqlite3_column_database_name16
,
162 sqlite3_column_decltype
,
163 sqlite3_column_decltype16
,
164 sqlite3_column_double
,
166 sqlite3_column_int64
,
168 sqlite3_column_name16
,
169 sqlite3_column_origin_name
,
170 sqlite3_column_origin_name16
,
171 sqlite3_column_table_name
,
172 sqlite3_column_table_name16
,
174 sqlite3_column_text16
,
176 sqlite3_column_value
,
180 sqlite3_create_collation
,
181 sqlite3_create_collation16
,
182 sqlite3_create_function
,
183 sqlite3_create_function16
,
184 sqlite3_create_module
,
187 sqlite3_declare_vtab
,
188 sqlite3_enable_shared_cache
,
193 #ifndef SQLITE_OMIT_DEPRECATED
201 sqlite3_get_autocommit
,
204 0, /* Was sqlite3_global_recover(), but that function is deprecated */
206 sqlite3_last_insert_rowid
,
208 sqlite3_libversion_number
,
216 sqlite3_progress_handler
,
220 sqlite3_result_double
,
221 sqlite3_result_error
,
222 sqlite3_result_error16
,
224 sqlite3_result_int64
,
227 sqlite3_result_text16
,
228 sqlite3_result_text16be
,
229 sqlite3_result_text16le
,
230 sqlite3_result_value
,
231 sqlite3_rollback_hook
,
232 sqlite3_set_authorizer
,
236 sqlite3_table_column_metadata
,
237 #ifndef SQLITE_OMIT_DEPRECATED
238 sqlite3_thread_cleanup
,
242 sqlite3_total_changes
,
244 #ifndef SQLITE_OMIT_DEPRECATED
245 sqlite3_transfer_bindings
,
253 sqlite3_value_bytes16
,
254 sqlite3_value_double
,
257 sqlite3_value_numeric_type
,
259 sqlite3_value_text16
,
260 sqlite3_value_text16be
,
261 sqlite3_value_text16le
,
265 ** The original API set ends here. All extensions can call any
266 ** of the APIs above provided that the pointer is not NULL. But
267 ** before calling APIs that follow, extension should check the
268 ** sqlite3_libversion_number() to make sure they are dealing with
269 ** a library that is new enough to support that API.
270 *************************************************************************
272 sqlite3_overload_function
,
275 ** Added after 3.3.13
278 sqlite3_prepare16_v2
,
279 sqlite3_clear_bindings
,
284 sqlite3_create_module_v2
,
289 sqlite3_bind_zeroblob
,
295 sqlite3_create_collation_v2
,
296 sqlite3_file_control
,
297 sqlite3_memory_highwater
,
299 #ifdef SQLITE_MUTEX_OMIT
313 sqlite3_release_memory
,
314 sqlite3_result_error_nomem
,
315 sqlite3_result_error_toobig
,
317 sqlite3_soft_heap_limit
,
319 sqlite3_vfs_register
,
320 sqlite3_vfs_unregister
,
326 sqlite3_result_zeroblob
,
327 sqlite3_result_error_code
,
328 sqlite3_test_control
,
330 sqlite3_context_db_handle
,
335 sqlite3_extended_result_codes
,
344 sqlite3_backup_finish
,
346 sqlite3_backup_pagecount
,
347 sqlite3_backup_remaining
,
349 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
350 sqlite3_compileoption_get
,
351 sqlite3_compileoption_used
,
356 sqlite3_create_function_v2
,
360 sqlite3_extended_errcode
,
362 sqlite3_soft_heap_limit64
,
366 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
367 sqlite3_unlock_notify
,
371 #ifndef SQLITE_OMIT_WAL
372 sqlite3_wal_autocheckpoint
,
373 sqlite3_wal_checkpoint
,
382 sqlite3_vtab_on_conflict
,
386 sqlite3_db_release_memory
,
389 sqlite3_stmt_readonly
,
393 sqlite3_uri_parameter
,
395 sqlite3_wal_checkpoint_v2
,
396 /* Version 3.8.7 and later */
397 sqlite3_auto_extension
,
400 sqlite3_cancel_auto_extension
,
401 sqlite3_load_extension
,
405 sqlite3_reset_auto_extension
,
406 sqlite3_result_blob64
,
407 sqlite3_result_text64
,
409 /* Version 3.8.11 and later */
410 (sqlite3_value
*(*)(const sqlite3_value
*))sqlite3_value_dup
,
412 sqlite3_result_zeroblob64
,
413 sqlite3_bind_zeroblob64
,
414 /* Version 3.9.0 and later */
415 sqlite3_value_subtype
,
416 sqlite3_result_subtype
,
417 /* Version 3.10.0 and later */
420 sqlite3_db_cacheflush
,
421 /* Version 3.12.0 and later */
422 sqlite3_system_errno
,
423 /* Version 3.14.0 and later */
425 sqlite3_expanded_sql
,
426 /* Version 3.18.0 and later */
427 sqlite3_set_last_insert_rowid
,
428 /* Version 3.20.0 and later */
430 sqlite3_prepare16_v3
,
431 sqlite3_bind_pointer
,
432 sqlite3_result_pointer
,
433 sqlite3_value_pointer
,
434 /* Version 3.22.0 and later */
435 sqlite3_vtab_nochange
,
436 sqlite3_value_nochange
,
437 sqlite3_vtab_collation
441 ** Attempt to load an SQLite extension library contained in the file
442 ** zFile. The entry point is zProc. zProc may be 0 in which case a
443 ** default entry point name (sqlite3_extension_init) is used. Use
444 ** of the default name is recommended.
446 ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
448 ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
449 ** error message text. The calling function should free this memory
450 ** by calling sqlite3DbFree(db, ).
452 static int sqlite3LoadExtension(
453 sqlite3
*db
, /* Load the extension into this database connection */
454 const char *zFile
, /* Name of the shared library containing extension */
455 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
456 char **pzErrMsg
/* Put error message here if not 0 */
458 sqlite3_vfs
*pVfs
= db
->pVfs
;
460 sqlite3_loadext_entry xInit
;
465 u64 nMsg
= 300 + sqlite3Strlen30(zFile
);
469 /* Shared library endings to try if zFile cannot be loaded as written */
470 static const char *azEndings
[] = {
473 #elif defined(__APPLE__)
481 if( pzErrMsg
) *pzErrMsg
= 0;
483 /* Ticket #1863. To avoid a creating security problems for older
484 ** applications that relink against newer versions of SQLite, the
485 ** ability to run load_extension is turned off by default. One
486 ** must call either sqlite3_enable_load_extension(db) or
487 ** sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, 0)
488 ** to turn on extension loading.
490 if( (db
->flags
& SQLITE_LoadExtension
)==0 ){
492 *pzErrMsg
= sqlite3_mprintf("not authorized");
497 zEntry
= zProc
? zProc
: "sqlite3_extension_init";
499 handle
= sqlite3OsDlOpen(pVfs
, zFile
);
500 #if SQLITE_OS_UNIX || SQLITE_OS_WIN
501 for(ii
=0; ii
<ArraySize(azEndings
) && handle
==0; ii
++){
502 char *zAltFile
= sqlite3_mprintf("%s.%s", zFile
, azEndings
[ii
]);
504 if( zAltFile
==0 ) return SQLITE_NOMEM_BKPT
;
505 sqlite3OsAccess(pVfs
, zAltFile
, SQLITE_ACCESS_EXISTS
, &bExists
);
506 if( bExists
) handle
= sqlite3OsDlOpen(pVfs
, zAltFile
);
507 sqlite3_free(zAltFile
);
512 *pzErrMsg
= zErrmsg
= sqlite3_malloc64(nMsg
);
514 sqlite3_snprintf(nMsg
, zErrmsg
,
515 "unable to open shared library [%s]", zFile
);
516 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
521 xInit
= (sqlite3_loadext_entry
)sqlite3OsDlSym(pVfs
, handle
, zEntry
);
523 /* If no entry point was specified and the default legacy
524 ** entry point name "sqlite3_extension_init" was not found, then
525 ** construct an entry point name "sqlite3_X_init" where the X is
526 ** replaced by the lowercase value of every ASCII alphabetic
527 ** character in the filename after the last "/" upto the first ".",
528 ** and eliding the first three characters if they are "lib".
531 ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
532 ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
534 if( xInit
==0 && zProc
==0 ){
535 int iFile
, iEntry
, c
;
536 int ncFile
= sqlite3Strlen30(zFile
);
537 zAltEntry
= sqlite3_malloc64(ncFile
+30);
539 sqlite3OsDlClose(pVfs
, handle
);
540 return SQLITE_NOMEM_BKPT
;
542 memcpy(zAltEntry
, "sqlite3_", 8);
543 for(iFile
=ncFile
-1; iFile
>=0 && zFile
[iFile
]!='/'; iFile
--){}
545 if( sqlite3_strnicmp(zFile
+iFile
, "lib", 3)==0 ) iFile
+= 3;
546 for(iEntry
=8; (c
= zFile
[iFile
])!=0 && c
!='.'; iFile
++){
547 if( sqlite3Isalpha(c
) ){
548 zAltEntry
[iEntry
++] = (char)sqlite3UpperToLower
[(unsigned)c
];
551 memcpy(zAltEntry
+iEntry
, "_init", 6);
553 xInit
= (sqlite3_loadext_entry
)sqlite3OsDlSym(pVfs
, handle
, zEntry
);
557 nMsg
+= sqlite3Strlen30(zEntry
);
558 *pzErrMsg
= zErrmsg
= sqlite3_malloc64(nMsg
);
560 sqlite3_snprintf(nMsg
, zErrmsg
,
561 "no entry point [%s] in shared library [%s]", zEntry
, zFile
);
562 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
565 sqlite3OsDlClose(pVfs
, handle
);
566 sqlite3_free(zAltEntry
);
569 sqlite3_free(zAltEntry
);
570 rc
= xInit(db
, &zErrmsg
, &sqlite3Apis
);
572 if( rc
==SQLITE_OK_LOAD_PERMANENTLY
) return SQLITE_OK
;
574 *pzErrMsg
= sqlite3_mprintf("error during initialization: %s", zErrmsg
);
576 sqlite3_free(zErrmsg
);
577 sqlite3OsDlClose(pVfs
, handle
);
581 /* Append the new shared library handle to the db->aExtension array. */
582 aHandle
= sqlite3DbMallocZero(db
, sizeof(handle
)*(db
->nExtension
+1));
584 return SQLITE_NOMEM_BKPT
;
586 if( db
->nExtension
>0 ){
587 memcpy(aHandle
, db
->aExtension
, sizeof(handle
)*db
->nExtension
);
589 sqlite3DbFree(db
, db
->aExtension
);
590 db
->aExtension
= aHandle
;
592 db
->aExtension
[db
->nExtension
++] = handle
;
595 int sqlite3_load_extension(
596 sqlite3
*db
, /* Load the extension into this database connection */
597 const char *zFile
, /* Name of the shared library containing extension */
598 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
599 char **pzErrMsg
/* Put error message here if not 0 */
602 sqlite3_mutex_enter(db
->mutex
);
603 rc
= sqlite3LoadExtension(db
, zFile
, zProc
, pzErrMsg
);
604 rc
= sqlite3ApiExit(db
, rc
);
605 sqlite3_mutex_leave(db
->mutex
);
610 ** Call this routine when the database connection is closing in order
611 ** to clean up loaded extensions
613 void sqlite3CloseExtensions(sqlite3
*db
){
615 assert( sqlite3_mutex_held(db
->mutex
) );
616 for(i
=0; i
<db
->nExtension
; i
++){
617 sqlite3OsDlClose(db
->pVfs
, db
->aExtension
[i
]);
619 sqlite3DbFree(db
, db
->aExtension
);
623 ** Enable or disable extension loading. Extension loading is disabled by
624 ** default so as not to open security holes in older applications.
626 int sqlite3_enable_load_extension(sqlite3
*db
, int onoff
){
627 sqlite3_mutex_enter(db
->mutex
);
629 db
->flags
|= SQLITE_LoadExtension
|SQLITE_LoadExtFunc
;
631 db
->flags
&= ~(SQLITE_LoadExtension
|SQLITE_LoadExtFunc
);
633 sqlite3_mutex_leave(db
->mutex
);
637 #endif /* !defined(SQLITE_OMIT_LOAD_EXTENSION) */
640 ** The following object holds the list of automatically loaded
643 ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MASTER
644 ** mutex must be held while accessing this list.
646 typedef struct sqlite3AutoExtList sqlite3AutoExtList
;
647 static SQLITE_WSD
struct sqlite3AutoExtList
{
648 u32 nExt
; /* Number of entries in aExt[] */
649 void (**aExt
)(void); /* Pointers to the extension init functions */
650 } sqlite3Autoext
= { 0, 0 };
652 /* The "wsdAutoext" macro will resolve to the autoextension
653 ** state vector. If writable static data is unsupported on the target,
654 ** we have to locate the state vector at run-time. In the more common
655 ** case where writable static data is supported, wsdStat can refer directly
656 ** to the "sqlite3Autoext" state vector declared above.
658 #ifdef SQLITE_OMIT_WSD
659 # define wsdAutoextInit \
660 sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
661 # define wsdAutoext x[0]
663 # define wsdAutoextInit
664 # define wsdAutoext sqlite3Autoext
669 ** Register a statically linked extension that is automatically
670 ** loaded by every new database connection.
672 int sqlite3_auto_extension(
676 #ifndef SQLITE_OMIT_AUTOINIT
677 rc
= sqlite3_initialize();
684 #if SQLITE_THREADSAFE
685 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
688 sqlite3_mutex_enter(mutex
);
689 for(i
=0; i
<wsdAutoext
.nExt
; i
++){
690 if( wsdAutoext
.aExt
[i
]==xInit
) break;
692 if( i
==wsdAutoext
.nExt
){
693 u64 nByte
= (wsdAutoext
.nExt
+1)*sizeof(wsdAutoext
.aExt
[0]);
695 aNew
= sqlite3_realloc64(wsdAutoext
.aExt
, nByte
);
697 rc
= SQLITE_NOMEM_BKPT
;
699 wsdAutoext
.aExt
= aNew
;
700 wsdAutoext
.aExt
[wsdAutoext
.nExt
] = xInit
;
704 sqlite3_mutex_leave(mutex
);
705 assert( (rc
&0xff)==rc
);
711 ** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
712 ** set of routines that is invoked for each new database connection, if it
713 ** is currently on the list. If xInit is not on the list, then this
714 ** routine is a no-op.
716 ** Return 1 if xInit was found on the list and removed. Return 0 if xInit
717 ** was not on the list.
719 int sqlite3_cancel_auto_extension(
722 #if SQLITE_THREADSAFE
723 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
728 sqlite3_mutex_enter(mutex
);
729 for(i
=(int)wsdAutoext
.nExt
-1; i
>=0; i
--){
730 if( wsdAutoext
.aExt
[i
]==xInit
){
732 wsdAutoext
.aExt
[i
] = wsdAutoext
.aExt
[wsdAutoext
.nExt
];
737 sqlite3_mutex_leave(mutex
);
742 ** Reset the automatic extension loading mechanism.
744 void sqlite3_reset_auto_extension(void){
745 #ifndef SQLITE_OMIT_AUTOINIT
746 if( sqlite3_initialize()==SQLITE_OK
)
749 #if SQLITE_THREADSAFE
750 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
753 sqlite3_mutex_enter(mutex
);
754 sqlite3_free(wsdAutoext
.aExt
);
757 sqlite3_mutex_leave(mutex
);
762 ** Load all automatic extensions.
764 ** If anything goes wrong, set an error in the database connection.
766 void sqlite3AutoLoadExtensions(sqlite3
*db
){
770 sqlite3_loadext_entry xInit
;
773 if( wsdAutoext
.nExt
==0 ){
774 /* Common case: early out without every having to acquire a mutex */
779 #if SQLITE_THREADSAFE
780 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
782 #ifdef SQLITE_OMIT_LOAD_EXTENSION
783 const sqlite3_api_routines
*pThunk
= 0;
785 const sqlite3_api_routines
*pThunk
= &sqlite3Apis
;
787 sqlite3_mutex_enter(mutex
);
788 if( i
>=wsdAutoext
.nExt
){
792 xInit
= (sqlite3_loadext_entry
)wsdAutoext
.aExt
[i
];
794 sqlite3_mutex_leave(mutex
);
796 if( xInit
&& (rc
= xInit(db
, &zErrmsg
, pThunk
))!=0 ){
797 sqlite3ErrorWithMsg(db
, rc
,
798 "automatic extension loading failed: %s", zErrmsg
);
801 sqlite3_free(zErrmsg
);