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
,
438 /* Version 3.24.0 and later */
439 sqlite3_keyword_count
,
440 sqlite3_keyword_name
,
441 sqlite3_keyword_check
,
445 sqlite3_str_vappendf
,
447 sqlite3_str_appendall
,
448 sqlite3_str_appendchar
,
456 ** Attempt to load an SQLite extension library contained in the file
457 ** zFile. The entry point is zProc. zProc may be 0 in which case a
458 ** default entry point name (sqlite3_extension_init) is used. Use
459 ** of the default name is recommended.
461 ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
463 ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
464 ** error message text. The calling function should free this memory
465 ** by calling sqlite3DbFree(db, ).
467 static int sqlite3LoadExtension(
468 sqlite3
*db
, /* Load the extension into this database connection */
469 const char *zFile
, /* Name of the shared library containing extension */
470 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
471 char **pzErrMsg
/* Put error message here if not 0 */
473 sqlite3_vfs
*pVfs
= db
->pVfs
;
475 sqlite3_loadext_entry xInit
;
480 u64 nMsg
= 300 + sqlite3Strlen30(zFile
);
484 /* Shared library endings to try if zFile cannot be loaded as written */
485 static const char *azEndings
[] = {
488 #elif defined(__APPLE__)
496 if( pzErrMsg
) *pzErrMsg
= 0;
498 /* Ticket #1863. To avoid a creating security problems for older
499 ** applications that relink against newer versions of SQLite, the
500 ** ability to run load_extension is turned off by default. One
501 ** must call either sqlite3_enable_load_extension(db) or
502 ** sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, 0)
503 ** to turn on extension loading.
505 if( (db
->flags
& SQLITE_LoadExtension
)==0 ){
507 *pzErrMsg
= sqlite3_mprintf("not authorized");
512 zEntry
= zProc
? zProc
: "sqlite3_extension_init";
514 handle
= sqlite3OsDlOpen(pVfs
, zFile
);
515 #if SQLITE_OS_UNIX || SQLITE_OS_WIN
516 for(ii
=0; ii
<ArraySize(azEndings
) && handle
==0; ii
++){
517 char *zAltFile
= sqlite3_mprintf("%s.%s", zFile
, azEndings
[ii
]);
518 if( zAltFile
==0 ) return SQLITE_NOMEM_BKPT
;
519 handle
= sqlite3OsDlOpen(pVfs
, zAltFile
);
520 sqlite3_free(zAltFile
);
525 *pzErrMsg
= zErrmsg
= sqlite3_malloc64(nMsg
);
527 sqlite3_snprintf(nMsg
, zErrmsg
,
528 "unable to open shared library [%s]", zFile
);
529 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
534 xInit
= (sqlite3_loadext_entry
)sqlite3OsDlSym(pVfs
, handle
, zEntry
);
536 /* If no entry point was specified and the default legacy
537 ** entry point name "sqlite3_extension_init" was not found, then
538 ** construct an entry point name "sqlite3_X_init" where the X is
539 ** replaced by the lowercase value of every ASCII alphabetic
540 ** character in the filename after the last "/" upto the first ".",
541 ** and eliding the first three characters if they are "lib".
544 ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
545 ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
547 if( xInit
==0 && zProc
==0 ){
548 int iFile
, iEntry
, c
;
549 int ncFile
= sqlite3Strlen30(zFile
);
550 zAltEntry
= sqlite3_malloc64(ncFile
+30);
552 sqlite3OsDlClose(pVfs
, handle
);
553 return SQLITE_NOMEM_BKPT
;
555 memcpy(zAltEntry
, "sqlite3_", 8);
556 for(iFile
=ncFile
-1; iFile
>=0 && zFile
[iFile
]!='/'; iFile
--){}
558 if( sqlite3_strnicmp(zFile
+iFile
, "lib", 3)==0 ) iFile
+= 3;
559 for(iEntry
=8; (c
= zFile
[iFile
])!=0 && c
!='.'; iFile
++){
560 if( sqlite3Isalpha(c
) ){
561 zAltEntry
[iEntry
++] = (char)sqlite3UpperToLower
[(unsigned)c
];
564 memcpy(zAltEntry
+iEntry
, "_init", 6);
566 xInit
= (sqlite3_loadext_entry
)sqlite3OsDlSym(pVfs
, handle
, zEntry
);
570 nMsg
+= sqlite3Strlen30(zEntry
);
571 *pzErrMsg
= zErrmsg
= sqlite3_malloc64(nMsg
);
573 sqlite3_snprintf(nMsg
, zErrmsg
,
574 "no entry point [%s] in shared library [%s]", zEntry
, zFile
);
575 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
578 sqlite3OsDlClose(pVfs
, handle
);
579 sqlite3_free(zAltEntry
);
582 sqlite3_free(zAltEntry
);
583 rc
= xInit(db
, &zErrmsg
, &sqlite3Apis
);
585 if( rc
==SQLITE_OK_LOAD_PERMANENTLY
) return SQLITE_OK
;
587 *pzErrMsg
= sqlite3_mprintf("error during initialization: %s", zErrmsg
);
589 sqlite3_free(zErrmsg
);
590 sqlite3OsDlClose(pVfs
, handle
);
594 /* Append the new shared library handle to the db->aExtension array. */
595 aHandle
= sqlite3DbMallocZero(db
, sizeof(handle
)*(db
->nExtension
+1));
597 return SQLITE_NOMEM_BKPT
;
599 if( db
->nExtension
>0 ){
600 memcpy(aHandle
, db
->aExtension
, sizeof(handle
)*db
->nExtension
);
602 sqlite3DbFree(db
, db
->aExtension
);
603 db
->aExtension
= aHandle
;
605 db
->aExtension
[db
->nExtension
++] = handle
;
608 int sqlite3_load_extension(
609 sqlite3
*db
, /* Load the extension into this database connection */
610 const char *zFile
, /* Name of the shared library containing extension */
611 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
612 char **pzErrMsg
/* Put error message here if not 0 */
615 sqlite3_mutex_enter(db
->mutex
);
616 rc
= sqlite3LoadExtension(db
, zFile
, zProc
, pzErrMsg
);
617 rc
= sqlite3ApiExit(db
, rc
);
618 sqlite3_mutex_leave(db
->mutex
);
623 ** Call this routine when the database connection is closing in order
624 ** to clean up loaded extensions
626 void sqlite3CloseExtensions(sqlite3
*db
){
628 assert( sqlite3_mutex_held(db
->mutex
) );
629 for(i
=0; i
<db
->nExtension
; i
++){
630 sqlite3OsDlClose(db
->pVfs
, db
->aExtension
[i
]);
632 sqlite3DbFree(db
, db
->aExtension
);
636 ** Enable or disable extension loading. Extension loading is disabled by
637 ** default so as not to open security holes in older applications.
639 int sqlite3_enable_load_extension(sqlite3
*db
, int onoff
){
640 sqlite3_mutex_enter(db
->mutex
);
642 db
->flags
|= SQLITE_LoadExtension
|SQLITE_LoadExtFunc
;
644 db
->flags
&= ~(SQLITE_LoadExtension
|SQLITE_LoadExtFunc
);
646 sqlite3_mutex_leave(db
->mutex
);
650 #endif /* !defined(SQLITE_OMIT_LOAD_EXTENSION) */
653 ** The following object holds the list of automatically loaded
656 ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MASTER
657 ** mutex must be held while accessing this list.
659 typedef struct sqlite3AutoExtList sqlite3AutoExtList
;
660 static SQLITE_WSD
struct sqlite3AutoExtList
{
661 u32 nExt
; /* Number of entries in aExt[] */
662 void (**aExt
)(void); /* Pointers to the extension init functions */
663 } sqlite3Autoext
= { 0, 0 };
665 /* The "wsdAutoext" macro will resolve to the autoextension
666 ** state vector. If writable static data is unsupported on the target,
667 ** we have to locate the state vector at run-time. In the more common
668 ** case where writable static data is supported, wsdStat can refer directly
669 ** to the "sqlite3Autoext" state vector declared above.
671 #ifdef SQLITE_OMIT_WSD
672 # define wsdAutoextInit \
673 sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
674 # define wsdAutoext x[0]
676 # define wsdAutoextInit
677 # define wsdAutoext sqlite3Autoext
682 ** Register a statically linked extension that is automatically
683 ** loaded by every new database connection.
685 int sqlite3_auto_extension(
689 #ifndef SQLITE_OMIT_AUTOINIT
690 rc
= sqlite3_initialize();
697 #if SQLITE_THREADSAFE
698 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
701 sqlite3_mutex_enter(mutex
);
702 for(i
=0; i
<wsdAutoext
.nExt
; i
++){
703 if( wsdAutoext
.aExt
[i
]==xInit
) break;
705 if( i
==wsdAutoext
.nExt
){
706 u64 nByte
= (wsdAutoext
.nExt
+1)*sizeof(wsdAutoext
.aExt
[0]);
708 aNew
= sqlite3_realloc64(wsdAutoext
.aExt
, nByte
);
710 rc
= SQLITE_NOMEM_BKPT
;
712 wsdAutoext
.aExt
= aNew
;
713 wsdAutoext
.aExt
[wsdAutoext
.nExt
] = xInit
;
717 sqlite3_mutex_leave(mutex
);
718 assert( (rc
&0xff)==rc
);
724 ** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
725 ** set of routines that is invoked for each new database connection, if it
726 ** is currently on the list. If xInit is not on the list, then this
727 ** routine is a no-op.
729 ** Return 1 if xInit was found on the list and removed. Return 0 if xInit
730 ** was not on the list.
732 int sqlite3_cancel_auto_extension(
735 #if SQLITE_THREADSAFE
736 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
741 sqlite3_mutex_enter(mutex
);
742 for(i
=(int)wsdAutoext
.nExt
-1; i
>=0; i
--){
743 if( wsdAutoext
.aExt
[i
]==xInit
){
745 wsdAutoext
.aExt
[i
] = wsdAutoext
.aExt
[wsdAutoext
.nExt
];
750 sqlite3_mutex_leave(mutex
);
755 ** Reset the automatic extension loading mechanism.
757 void sqlite3_reset_auto_extension(void){
758 #ifndef SQLITE_OMIT_AUTOINIT
759 if( sqlite3_initialize()==SQLITE_OK
)
762 #if SQLITE_THREADSAFE
763 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
766 sqlite3_mutex_enter(mutex
);
767 sqlite3_free(wsdAutoext
.aExt
);
770 sqlite3_mutex_leave(mutex
);
775 ** Load all automatic extensions.
777 ** If anything goes wrong, set an error in the database connection.
779 void sqlite3AutoLoadExtensions(sqlite3
*db
){
783 sqlite3_loadext_entry xInit
;
786 if( wsdAutoext
.nExt
==0 ){
787 /* Common case: early out without every having to acquire a mutex */
792 #if SQLITE_THREADSAFE
793 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
795 #ifdef SQLITE_OMIT_LOAD_EXTENSION
796 const sqlite3_api_routines
*pThunk
= 0;
798 const sqlite3_api_routines
*pThunk
= &sqlite3Apis
;
800 sqlite3_mutex_enter(mutex
);
801 if( i
>=wsdAutoext
.nExt
){
805 xInit
= (sqlite3_loadext_entry
)wsdAutoext
.aExt
[i
];
807 sqlite3_mutex_leave(mutex
);
809 if( xInit
&& (rc
= xInit(db
, &zErrmsg
, pThunk
))!=0 ){
810 sqlite3ErrorWithMsg(db
, rc
,
811 "automatic extension loading failed: %s", zErrmsg
);
814 sqlite3_free(zErrmsg
);