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
87 # define sqlite3_vtab_collation 0
90 #ifdef SQLITE_OMIT_SHARED_CACHE
91 # define sqlite3_enable_shared_cache 0
94 #if defined(SQLITE_OMIT_TRACE) || defined(SQLITE_OMIT_DEPRECATED)
95 # define sqlite3_profile 0
96 # define sqlite3_trace 0
99 #ifdef SQLITE_OMIT_GET_TABLE
100 # define sqlite3_free_table 0
101 # define sqlite3_get_table 0
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
114 #if defined(SQLITE_OMIT_TRACE)
115 # define sqlite3_trace_v2 0
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
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
,
145 sqlite3_bind_parameter_count
,
146 sqlite3_bind_parameter_index
,
147 sqlite3_bind_parameter_name
,
151 sqlite3_busy_handler
,
152 sqlite3_busy_timeout
,
155 sqlite3_collation_needed
,
156 sqlite3_collation_needed16
,
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
,
167 sqlite3_column_int64
,
169 sqlite3_column_name16
,
170 sqlite3_column_origin_name
,
171 sqlite3_column_origin_name16
,
172 sqlite3_column_table_name
,
173 sqlite3_column_table_name16
,
175 sqlite3_column_text16
,
177 sqlite3_column_value
,
181 sqlite3_create_collation
,
182 sqlite3_create_collation16
,
183 sqlite3_create_function
,
184 sqlite3_create_function16
,
185 sqlite3_create_module
,
188 sqlite3_declare_vtab
,
189 sqlite3_enable_shared_cache
,
194 #ifndef SQLITE_OMIT_DEPRECATED
202 sqlite3_get_autocommit
,
205 0, /* Was sqlite3_global_recover(), but that function is deprecated */
207 sqlite3_last_insert_rowid
,
209 sqlite3_libversion_number
,
217 sqlite3_progress_handler
,
221 sqlite3_result_double
,
222 sqlite3_result_error
,
223 sqlite3_result_error16
,
225 sqlite3_result_int64
,
228 sqlite3_result_text16
,
229 sqlite3_result_text16be
,
230 sqlite3_result_text16le
,
231 sqlite3_result_value
,
232 sqlite3_rollback_hook
,
233 sqlite3_set_authorizer
,
237 sqlite3_table_column_metadata
,
238 #ifndef SQLITE_OMIT_DEPRECATED
239 sqlite3_thread_cleanup
,
243 sqlite3_total_changes
,
245 #ifndef SQLITE_OMIT_DEPRECATED
246 sqlite3_transfer_bindings
,
254 sqlite3_value_bytes16
,
255 sqlite3_value_double
,
258 sqlite3_value_numeric_type
,
260 sqlite3_value_text16
,
261 sqlite3_value_text16be
,
262 sqlite3_value_text16le
,
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
279 sqlite3_prepare16_v2
,
280 sqlite3_clear_bindings
,
285 sqlite3_create_module_v2
,
290 sqlite3_bind_zeroblob
,
296 sqlite3_create_collation_v2
,
297 sqlite3_file_control
,
298 sqlite3_memory_highwater
,
300 #ifdef SQLITE_MUTEX_OMIT
314 sqlite3_release_memory
,
315 sqlite3_result_error_nomem
,
316 sqlite3_result_error_toobig
,
318 sqlite3_soft_heap_limit
,
320 sqlite3_vfs_register
,
321 sqlite3_vfs_unregister
,
327 sqlite3_result_zeroblob
,
328 sqlite3_result_error_code
,
329 sqlite3_test_control
,
331 sqlite3_context_db_handle
,
336 sqlite3_extended_result_codes
,
345 sqlite3_backup_finish
,
347 sqlite3_backup_pagecount
,
348 sqlite3_backup_remaining
,
350 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
351 sqlite3_compileoption_get
,
352 sqlite3_compileoption_used
,
357 sqlite3_create_function_v2
,
361 sqlite3_extended_errcode
,
363 sqlite3_soft_heap_limit64
,
367 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
368 sqlite3_unlock_notify
,
372 #ifndef SQLITE_OMIT_WAL
373 sqlite3_wal_autocheckpoint
,
374 sqlite3_wal_checkpoint
,
383 sqlite3_vtab_on_conflict
,
387 sqlite3_db_release_memory
,
390 sqlite3_stmt_readonly
,
394 sqlite3_uri_parameter
,
396 sqlite3_wal_checkpoint_v2
,
397 /* Version 3.8.7 and later */
398 sqlite3_auto_extension
,
401 sqlite3_cancel_auto_extension
,
402 sqlite3_load_extension
,
406 sqlite3_reset_auto_extension
,
407 sqlite3_result_blob64
,
408 sqlite3_result_text64
,
410 /* Version 3.8.11 and later */
411 (sqlite3_value
*(*)(const sqlite3_value
*))sqlite3_value_dup
,
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 */
421 sqlite3_db_cacheflush
,
422 /* Version 3.12.0 and later */
423 sqlite3_system_errno
,
424 /* Version 3.14.0 and later */
426 sqlite3_expanded_sql
,
427 /* Version 3.18.0 and later */
428 sqlite3_set_last_insert_rowid
,
429 /* Version 3.20.0 and later */
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
,
446 sqlite3_str_vappendf
,
448 sqlite3_str_appendall
,
449 sqlite3_str_appendchar
,
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
,
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
,
471 /* Version 3.31.0 and later */
472 sqlite3_hard_heap_limit64
,
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
,
483 /* True if x is the directory separator character
486 # define DirSep(X) ((X)=='/'||(X)=='\\')
488 # define DirSep(X) ((X)=='/')
492 ** Attempt to load an SQLite extension library contained in the file
493 ** zFile. The entry point is zProc. zProc may be 0 in which case a
494 ** default entry point name (sqlite3_extension_init) is used. Use
495 ** of the default name is recommended.
497 ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
499 ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
500 ** error message text. The calling function should free this memory
501 ** by calling sqlite3DbFree(db, ).
503 static int sqlite3LoadExtension(
504 sqlite3
*db
, /* Load the extension into this database connection */
505 const char *zFile
, /* Name of the shared library containing extension */
506 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
507 char **pzErrMsg
/* Put error message here if not 0 */
509 sqlite3_vfs
*pVfs
= db
->pVfs
;
511 sqlite3_loadext_entry xInit
;
516 u64 nMsg
= 300 + sqlite3Strlen30(zFile
);
520 /* Shared library endings to try if zFile cannot be loaded as written */
521 static const char *azEndings
[] = {
524 #elif defined(__APPLE__)
532 if( pzErrMsg
) *pzErrMsg
= 0;
534 /* Ticket #1863. To avoid a creating security problems for older
535 ** applications that relink against newer versions of SQLite, the
536 ** ability to run load_extension is turned off by default. One
537 ** must call either sqlite3_enable_load_extension(db) or
538 ** sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, 0)
539 ** to turn on extension loading.
541 if( (db
->flags
& SQLITE_LoadExtension
)==0 ){
543 *pzErrMsg
= sqlite3_mprintf("not authorized");
548 zEntry
= zProc
? zProc
: "sqlite3_extension_init";
550 handle
= sqlite3OsDlOpen(pVfs
, zFile
);
551 #if SQLITE_OS_UNIX || SQLITE_OS_WIN
552 for(ii
=0; ii
<ArraySize(azEndings
) && handle
==0; ii
++){
553 char *zAltFile
= sqlite3_mprintf("%s.%s", zFile
, azEndings
[ii
]);
554 if( zAltFile
==0 ) return SQLITE_NOMEM_BKPT
;
555 handle
= sqlite3OsDlOpen(pVfs
, zAltFile
);
556 sqlite3_free(zAltFile
);
561 *pzErrMsg
= zErrmsg
= sqlite3_malloc64(nMsg
);
563 sqlite3_snprintf(nMsg
, zErrmsg
,
564 "unable to open shared library [%s]", zFile
);
565 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
570 xInit
= (sqlite3_loadext_entry
)sqlite3OsDlSym(pVfs
, handle
, zEntry
);
572 /* If no entry point was specified and the default legacy
573 ** entry point name "sqlite3_extension_init" was not found, then
574 ** construct an entry point name "sqlite3_X_init" where the X is
575 ** replaced by the lowercase value of every ASCII alphabetic
576 ** character in the filename after the last "/" upto the first ".",
577 ** and eliding the first three characters if they are "lib".
580 ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
581 ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
583 if( xInit
==0 && zProc
==0 ){
584 int iFile
, iEntry
, c
;
585 int ncFile
= sqlite3Strlen30(zFile
);
586 zAltEntry
= sqlite3_malloc64(ncFile
+30);
588 sqlite3OsDlClose(pVfs
, handle
);
589 return SQLITE_NOMEM_BKPT
;
591 memcpy(zAltEntry
, "sqlite3_", 8);
592 for(iFile
=ncFile
-1; iFile
>=0 && !DirSep(zFile
[iFile
]); iFile
--){}
594 if( sqlite3_strnicmp(zFile
+iFile
, "lib", 3)==0 ) iFile
+= 3;
595 for(iEntry
=8; (c
= zFile
[iFile
])!=0 && c
!='.'; iFile
++){
596 if( sqlite3Isalpha(c
) ){
597 zAltEntry
[iEntry
++] = (char)sqlite3UpperToLower
[(unsigned)c
];
600 memcpy(zAltEntry
+iEntry
, "_init", 6);
602 xInit
= (sqlite3_loadext_entry
)sqlite3OsDlSym(pVfs
, handle
, zEntry
);
606 nMsg
+= sqlite3Strlen30(zEntry
);
607 *pzErrMsg
= zErrmsg
= sqlite3_malloc64(nMsg
);
609 sqlite3_snprintf(nMsg
, zErrmsg
,
610 "no entry point [%s] in shared library [%s]", zEntry
, zFile
);
611 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
614 sqlite3OsDlClose(pVfs
, handle
);
615 sqlite3_free(zAltEntry
);
618 sqlite3_free(zAltEntry
);
619 rc
= xInit(db
, &zErrmsg
, &sqlite3Apis
);
621 if( rc
==SQLITE_OK_LOAD_PERMANENTLY
) return SQLITE_OK
;
623 *pzErrMsg
= sqlite3_mprintf("error during initialization: %s", zErrmsg
);
625 sqlite3_free(zErrmsg
);
626 sqlite3OsDlClose(pVfs
, handle
);
630 /* Append the new shared library handle to the db->aExtension array. */
631 aHandle
= sqlite3DbMallocZero(db
, sizeof(handle
)*(db
->nExtension
+1));
633 return SQLITE_NOMEM_BKPT
;
635 if( db
->nExtension
>0 ){
636 memcpy(aHandle
, db
->aExtension
, sizeof(handle
)*db
->nExtension
);
638 sqlite3DbFree(db
, db
->aExtension
);
639 db
->aExtension
= aHandle
;
641 db
->aExtension
[db
->nExtension
++] = handle
;
644 int sqlite3_load_extension(
645 sqlite3
*db
, /* Load the extension into this database connection */
646 const char *zFile
, /* Name of the shared library containing extension */
647 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
648 char **pzErrMsg
/* Put error message here if not 0 */
651 sqlite3_mutex_enter(db
->mutex
);
652 rc
= sqlite3LoadExtension(db
, zFile
, zProc
, pzErrMsg
);
653 rc
= sqlite3ApiExit(db
, rc
);
654 sqlite3_mutex_leave(db
->mutex
);
659 ** Call this routine when the database connection is closing in order
660 ** to clean up loaded extensions
662 void sqlite3CloseExtensions(sqlite3
*db
){
664 assert( sqlite3_mutex_held(db
->mutex
) );
665 for(i
=0; i
<db
->nExtension
; i
++){
666 sqlite3OsDlClose(db
->pVfs
, db
->aExtension
[i
]);
668 sqlite3DbFree(db
, db
->aExtension
);
672 ** Enable or disable extension loading. Extension loading is disabled by
673 ** default so as not to open security holes in older applications.
675 int sqlite3_enable_load_extension(sqlite3
*db
, int onoff
){
676 sqlite3_mutex_enter(db
->mutex
);
678 db
->flags
|= SQLITE_LoadExtension
|SQLITE_LoadExtFunc
;
680 db
->flags
&= ~(u64
)(SQLITE_LoadExtension
|SQLITE_LoadExtFunc
);
682 sqlite3_mutex_leave(db
->mutex
);
686 #endif /* !defined(SQLITE_OMIT_LOAD_EXTENSION) */
689 ** The following object holds the list of automatically loaded
692 ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MAIN
693 ** mutex must be held while accessing this list.
695 typedef struct sqlite3AutoExtList sqlite3AutoExtList
;
696 static SQLITE_WSD
struct sqlite3AutoExtList
{
697 u32 nExt
; /* Number of entries in aExt[] */
698 void (**aExt
)(void); /* Pointers to the extension init functions */
699 } sqlite3Autoext
= { 0, 0 };
701 /* The "wsdAutoext" macro will resolve to the autoextension
702 ** state vector. If writable static data is unsupported on the target,
703 ** we have to locate the state vector at run-time. In the more common
704 ** case where writable static data is supported, wsdStat can refer directly
705 ** to the "sqlite3Autoext" state vector declared above.
707 #ifdef SQLITE_OMIT_WSD
708 # define wsdAutoextInit \
709 sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
710 # define wsdAutoext x[0]
712 # define wsdAutoextInit
713 # define wsdAutoext sqlite3Autoext
718 ** Register a statically linked extension that is automatically
719 ** loaded by every new database connection.
721 int sqlite3_auto_extension(
725 #ifndef SQLITE_OMIT_AUTOINIT
726 rc
= sqlite3_initialize();
733 #if SQLITE_THREADSAFE
734 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN
);
737 sqlite3_mutex_enter(mutex
);
738 for(i
=0; i
<wsdAutoext
.nExt
; i
++){
739 if( wsdAutoext
.aExt
[i
]==xInit
) break;
741 if( i
==wsdAutoext
.nExt
){
742 u64 nByte
= (wsdAutoext
.nExt
+1)*sizeof(wsdAutoext
.aExt
[0]);
744 aNew
= sqlite3_realloc64(wsdAutoext
.aExt
, nByte
);
746 rc
= SQLITE_NOMEM_BKPT
;
748 wsdAutoext
.aExt
= aNew
;
749 wsdAutoext
.aExt
[wsdAutoext
.nExt
] = xInit
;
753 sqlite3_mutex_leave(mutex
);
754 assert( (rc
&0xff)==rc
);
760 ** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
761 ** set of routines that is invoked for each new database connection, if it
762 ** is currently on the list. If xInit is not on the list, then this
763 ** routine is a no-op.
765 ** Return 1 if xInit was found on the list and removed. Return 0 if xInit
766 ** was not on the list.
768 int sqlite3_cancel_auto_extension(
771 #if SQLITE_THREADSAFE
772 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN
);
777 sqlite3_mutex_enter(mutex
);
778 for(i
=(int)wsdAutoext
.nExt
-1; i
>=0; i
--){
779 if( wsdAutoext
.aExt
[i
]==xInit
){
781 wsdAutoext
.aExt
[i
] = wsdAutoext
.aExt
[wsdAutoext
.nExt
];
786 sqlite3_mutex_leave(mutex
);
791 ** Reset the automatic extension loading mechanism.
793 void sqlite3_reset_auto_extension(void){
794 #ifndef SQLITE_OMIT_AUTOINIT
795 if( sqlite3_initialize()==SQLITE_OK
)
798 #if SQLITE_THREADSAFE
799 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN
);
802 sqlite3_mutex_enter(mutex
);
803 sqlite3_free(wsdAutoext
.aExt
);
806 sqlite3_mutex_leave(mutex
);
811 ** Load all automatic extensions.
813 ** If anything goes wrong, set an error in the database connection.
815 void sqlite3AutoLoadExtensions(sqlite3
*db
){
819 sqlite3_loadext_entry xInit
;
822 if( wsdAutoext
.nExt
==0 ){
823 /* Common case: early out without every having to acquire a mutex */
828 #if SQLITE_THREADSAFE
829 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN
);
831 #ifdef SQLITE_OMIT_LOAD_EXTENSION
832 const sqlite3_api_routines
*pThunk
= 0;
834 const sqlite3_api_routines
*pThunk
= &sqlite3Apis
;
836 sqlite3_mutex_enter(mutex
);
837 if( i
>=wsdAutoext
.nExt
){
841 xInit
= (sqlite3_loadext_entry
)wsdAutoext
.aExt
[i
];
843 sqlite3_mutex_leave(mutex
);
845 if( xInit
&& (rc
= xInit(db
, &zErrmsg
, pThunk
))!=0 ){
846 sqlite3ErrorWithMsg(db
, rc
,
847 "automatic extension loading failed: %s", zErrmsg
);
850 sqlite3_free(zErrmsg
);