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"
23 #ifndef SQLITE_OMIT_LOAD_EXTENSION
26 ** Some API routines are omitted when various features are
27 ** excluded from a build of SQLite. Substitute a NULL pointer
28 ** for any missing APIs.
30 #ifndef SQLITE_ENABLE_COLUMN_METADATA
31 # define sqlite3_column_database_name 0
32 # define sqlite3_column_database_name16 0
33 # define sqlite3_column_table_name 0
34 # define sqlite3_column_table_name16 0
35 # define sqlite3_column_origin_name 0
36 # define sqlite3_column_origin_name16 0
37 # define sqlite3_table_column_metadata 0
40 #ifdef SQLITE_OMIT_AUTHORIZATION
41 # define sqlite3_set_authorizer 0
44 #ifdef SQLITE_OMIT_UTF16
45 # define sqlite3_bind_text16 0
46 # define sqlite3_collation_needed16 0
47 # define sqlite3_column_decltype16 0
48 # define sqlite3_column_name16 0
49 # define sqlite3_column_text16 0
50 # define sqlite3_complete16 0
51 # define sqlite3_create_collation16 0
52 # define sqlite3_create_function16 0
53 # define sqlite3_errmsg16 0
54 # define sqlite3_open16 0
55 # define sqlite3_prepare16 0
56 # define sqlite3_prepare16_v2 0
57 # define sqlite3_result_error16 0
58 # define sqlite3_result_text16 0
59 # define sqlite3_result_text16be 0
60 # define sqlite3_result_text16le 0
61 # define sqlite3_value_text16 0
62 # define sqlite3_value_text16be 0
63 # define sqlite3_value_text16le 0
64 # define sqlite3_column_database_name16 0
65 # define sqlite3_column_table_name16 0
66 # define sqlite3_column_origin_name16 0
69 #ifdef SQLITE_OMIT_COMPLETE
70 # define sqlite3_complete 0
71 # define sqlite3_complete16 0
74 #ifdef SQLITE_OMIT_DECLTYPE
75 # define sqlite3_column_decltype16 0
76 # define sqlite3_column_decltype 0
79 #ifdef SQLITE_OMIT_PROGRESS_CALLBACK
80 # define sqlite3_progress_handler 0
83 #ifdef SQLITE_OMIT_VIRTUALTABLE
84 # define sqlite3_create_module 0
85 # define sqlite3_create_module_v2 0
86 # define sqlite3_declare_vtab 0
87 # define sqlite3_vtab_config 0
88 # define sqlite3_vtab_on_conflict 0
91 #ifdef SQLITE_OMIT_SHARED_CACHE
92 # define sqlite3_enable_shared_cache 0
95 #ifdef SQLITE_OMIT_TRACE
96 # define sqlite3_profile 0
97 # define sqlite3_trace 0
100 #ifdef SQLITE_OMIT_GET_TABLE
101 # define sqlite3_free_table 0
102 # define sqlite3_get_table 0
105 #ifdef SQLITE_OMIT_INCRBLOB
106 #define sqlite3_bind_zeroblob 0
107 #define sqlite3_blob_bytes 0
108 #define sqlite3_blob_close 0
109 #define sqlite3_blob_open 0
110 #define sqlite3_blob_read 0
111 #define sqlite3_blob_write 0
112 #define sqlite3_blob_reopen 0
116 ** The following structure contains pointers to all SQLite API routines.
117 ** A pointer to this structure is passed into extensions when they are
118 ** loaded so that the extension can make calls back into the SQLite
121 ** When adding new APIs, add them to the bottom of this structure
122 ** in order to preserve backwards compatibility.
124 ** Extensions that use newer APIs should first call the
125 ** sqlite3_libversion_number() to make sure that the API they
126 ** intend to use is supported by the library. Extensions should
127 ** also check to make sure that the pointer to the function is
128 ** not NULL before calling it.
130 static const sqlite3_api_routines sqlite3Apis
= {
131 sqlite3_aggregate_context
,
132 #ifndef SQLITE_OMIT_DEPRECATED
133 sqlite3_aggregate_count
,
142 sqlite3_bind_parameter_count
,
143 sqlite3_bind_parameter_index
,
144 sqlite3_bind_parameter_name
,
148 sqlite3_busy_handler
,
149 sqlite3_busy_timeout
,
152 sqlite3_collation_needed
,
153 sqlite3_collation_needed16
,
155 sqlite3_column_bytes
,
156 sqlite3_column_bytes16
,
157 sqlite3_column_count
,
158 sqlite3_column_database_name
,
159 sqlite3_column_database_name16
,
160 sqlite3_column_decltype
,
161 sqlite3_column_decltype16
,
162 sqlite3_column_double
,
164 sqlite3_column_int64
,
166 sqlite3_column_name16
,
167 sqlite3_column_origin_name
,
168 sqlite3_column_origin_name16
,
169 sqlite3_column_table_name
,
170 sqlite3_column_table_name16
,
172 sqlite3_column_text16
,
174 sqlite3_column_value
,
178 sqlite3_create_collation
,
179 sqlite3_create_collation16
,
180 sqlite3_create_function
,
181 sqlite3_create_function16
,
182 sqlite3_create_module
,
185 sqlite3_declare_vtab
,
186 sqlite3_enable_shared_cache
,
191 #ifndef SQLITE_OMIT_DEPRECATED
199 sqlite3_get_autocommit
,
202 0, /* Was sqlite3_global_recover(), but that function is deprecated */
204 sqlite3_last_insert_rowid
,
206 sqlite3_libversion_number
,
214 sqlite3_progress_handler
,
218 sqlite3_result_double
,
219 sqlite3_result_error
,
220 sqlite3_result_error16
,
222 sqlite3_result_int64
,
225 sqlite3_result_text16
,
226 sqlite3_result_text16be
,
227 sqlite3_result_text16le
,
228 sqlite3_result_value
,
229 sqlite3_rollback_hook
,
230 sqlite3_set_authorizer
,
234 sqlite3_table_column_metadata
,
235 #ifndef SQLITE_OMIT_DEPRECATED
236 sqlite3_thread_cleanup
,
240 sqlite3_total_changes
,
242 #ifndef SQLITE_OMIT_DEPRECATED
243 sqlite3_transfer_bindings
,
251 sqlite3_value_bytes16
,
252 sqlite3_value_double
,
255 sqlite3_value_numeric_type
,
257 sqlite3_value_text16
,
258 sqlite3_value_text16be
,
259 sqlite3_value_text16le
,
263 ** The original API set ends here. All extensions can call any
264 ** of the APIs above provided that the pointer is not NULL. But
265 ** before calling APIs that follow, extension should check the
266 ** sqlite3_libversion_number() to make sure they are dealing with
267 ** a library that is new enough to support that API.
268 *************************************************************************
270 sqlite3_overload_function
,
273 ** Added after 3.3.13
276 sqlite3_prepare16_v2
,
277 sqlite3_clear_bindings
,
282 sqlite3_create_module_v2
,
287 sqlite3_bind_zeroblob
,
293 sqlite3_create_collation_v2
,
294 sqlite3_file_control
,
295 sqlite3_memory_highwater
,
297 #ifdef SQLITE_MUTEX_OMIT
311 sqlite3_release_memory
,
312 sqlite3_result_error_nomem
,
313 sqlite3_result_error_toobig
,
315 sqlite3_soft_heap_limit
,
317 sqlite3_vfs_register
,
318 sqlite3_vfs_unregister
,
324 sqlite3_result_zeroblob
,
325 sqlite3_result_error_code
,
326 sqlite3_test_control
,
328 sqlite3_context_db_handle
,
333 sqlite3_extended_result_codes
,
342 sqlite3_backup_finish
,
344 sqlite3_backup_pagecount
,
345 sqlite3_backup_remaining
,
347 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
348 sqlite3_compileoption_get
,
349 sqlite3_compileoption_used
,
354 sqlite3_create_function_v2
,
358 sqlite3_extended_errcode
,
360 sqlite3_soft_heap_limit64
,
364 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
365 sqlite3_unlock_notify
,
369 #ifndef SQLITE_OMIT_WAL
370 sqlite3_wal_autocheckpoint
,
371 sqlite3_wal_checkpoint
,
380 sqlite3_vtab_on_conflict
,
384 sqlite3_db_release_memory
,
387 sqlite3_stmt_readonly
,
391 sqlite3_uri_parameter
,
393 sqlite3_wal_checkpoint_v2
,
394 /* Version 3.8.7 and later */
395 sqlite3_auto_extension
,
398 sqlite3_cancel_auto_extension
,
399 sqlite3_load_extension
,
403 sqlite3_reset_auto_extension
,
404 sqlite3_result_blob64
,
405 sqlite3_result_text64
,
410 ** Attempt to load an SQLite extension library contained in the file
411 ** zFile. The entry point is zProc. zProc may be 0 in which case a
412 ** default entry point name (sqlite3_extension_init) is used. Use
413 ** of the default name is recommended.
415 ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
417 ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
418 ** error message text. The calling function should free this memory
419 ** by calling sqlite3DbFree(db, ).
421 static int sqlite3LoadExtension(
422 sqlite3
*db
, /* Load the extension into this database connection */
423 const char *zFile
, /* Name of the shared library containing extension */
424 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
425 char **pzErrMsg
/* Put error message here if not 0 */
427 sqlite3_vfs
*pVfs
= db
->pVfs
;
429 int (*xInit
)(sqlite3
*,char**,const sqlite3_api_routines
*);
434 int nMsg
= 300 + sqlite3Strlen30(zFile
);
437 /* Shared library endings to try if zFile cannot be loaded as written */
438 static const char *azEndings
[] = {
441 #elif defined(__APPLE__)
449 if( pzErrMsg
) *pzErrMsg
= 0;
451 /* Ticket #1863. To avoid a creating security problems for older
452 ** applications that relink against newer versions of SQLite, the
453 ** ability to run load_extension is turned off by default. One
454 ** must call sqlite3_enable_load_extension() to turn on extension
455 ** loading. Otherwise you get the following error.
457 if( (db
->flags
& SQLITE_LoadExtension
)==0 ){
459 *pzErrMsg
= sqlite3_mprintf("not authorized");
464 zEntry
= zProc
? zProc
: "sqlite3_extension_init";
466 handle
= sqlite3OsDlOpen(pVfs
, zFile
);
467 #if SQLITE_OS_UNIX || SQLITE_OS_WIN
468 for(ii
=0; ii
<ArraySize(azEndings
) && handle
==0; ii
++){
469 char *zAltFile
= sqlite3_mprintf("%s.%s", zFile
, azEndings
[ii
]);
470 if( zAltFile
==0 ) return SQLITE_NOMEM
;
471 handle
= sqlite3OsDlOpen(pVfs
, zAltFile
);
472 sqlite3_free(zAltFile
);
477 *pzErrMsg
= zErrmsg
= sqlite3_malloc(nMsg
);
479 sqlite3_snprintf(nMsg
, zErrmsg
,
480 "unable to open shared library [%s]", zFile
);
481 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
486 xInit
= (int(*)(sqlite3
*,char**,const sqlite3_api_routines
*))
487 sqlite3OsDlSym(pVfs
, handle
, zEntry
);
489 /* If no entry point was specified and the default legacy
490 ** entry point name "sqlite3_extension_init" was not found, then
491 ** construct an entry point name "sqlite3_X_init" where the X is
492 ** replaced by the lowercase value of every ASCII alphabetic
493 ** character in the filename after the last "/" upto the first ".",
494 ** and eliding the first three characters if they are "lib".
497 ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
498 ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
500 if( xInit
==0 && zProc
==0 ){
501 int iFile
, iEntry
, c
;
502 int ncFile
= sqlite3Strlen30(zFile
);
503 zAltEntry
= sqlite3_malloc(ncFile
+30);
505 sqlite3OsDlClose(pVfs
, handle
);
508 memcpy(zAltEntry
, "sqlite3_", 8);
509 for(iFile
=ncFile
-1; iFile
>=0 && zFile
[iFile
]!='/'; iFile
--){}
511 if( sqlite3_strnicmp(zFile
+iFile
, "lib", 3)==0 ) iFile
+= 3;
512 for(iEntry
=8; (c
= zFile
[iFile
])!=0 && c
!='.'; iFile
++){
513 if( sqlite3Isalpha(c
) ){
514 zAltEntry
[iEntry
++] = (char)sqlite3UpperToLower
[(unsigned)c
];
517 memcpy(zAltEntry
+iEntry
, "_init", 6);
519 xInit
= (int(*)(sqlite3
*,char**,const sqlite3_api_routines
*))
520 sqlite3OsDlSym(pVfs
, handle
, zEntry
);
524 nMsg
+= sqlite3Strlen30(zEntry
);
525 *pzErrMsg
= zErrmsg
= sqlite3_malloc(nMsg
);
527 sqlite3_snprintf(nMsg
, zErrmsg
,
528 "no entry point [%s] in shared library [%s]", zEntry
, zFile
);
529 sqlite3OsDlError(pVfs
, nMsg
-1, zErrmsg
);
532 sqlite3OsDlClose(pVfs
, handle
);
533 sqlite3_free(zAltEntry
);
536 sqlite3_free(zAltEntry
);
537 if( xInit(db
, &zErrmsg
, &sqlite3Apis
) ){
539 *pzErrMsg
= sqlite3_mprintf("error during initialization: %s", zErrmsg
);
541 sqlite3_free(zErrmsg
);
542 sqlite3OsDlClose(pVfs
, handle
);
546 /* Append the new shared library handle to the db->aExtension array. */
547 aHandle
= sqlite3DbMallocZero(db
, sizeof(handle
)*(db
->nExtension
+1));
551 if( db
->nExtension
>0 ){
552 memcpy(aHandle
, db
->aExtension
, sizeof(handle
)*db
->nExtension
);
554 sqlite3DbFree(db
, db
->aExtension
);
555 db
->aExtension
= aHandle
;
557 db
->aExtension
[db
->nExtension
++] = handle
;
560 int sqlite3_load_extension(
561 sqlite3
*db
, /* Load the extension into this database connection */
562 const char *zFile
, /* Name of the shared library containing extension */
563 const char *zProc
, /* Entry point. Use "sqlite3_extension_init" if 0 */
564 char **pzErrMsg
/* Put error message here if not 0 */
567 sqlite3_mutex_enter(db
->mutex
);
568 rc
= sqlite3LoadExtension(db
, zFile
, zProc
, pzErrMsg
);
569 rc
= sqlite3ApiExit(db
, rc
);
570 sqlite3_mutex_leave(db
->mutex
);
575 ** Call this routine when the database connection is closing in order
576 ** to clean up loaded extensions
578 void sqlite3CloseExtensions(sqlite3
*db
){
580 assert( sqlite3_mutex_held(db
->mutex
) );
581 for(i
=0; i
<db
->nExtension
; i
++){
582 sqlite3OsDlClose(db
->pVfs
, db
->aExtension
[i
]);
584 sqlite3DbFree(db
, db
->aExtension
);
588 ** Enable or disable extension loading. Extension loading is disabled by
589 ** default so as not to open security holes in older applications.
591 int sqlite3_enable_load_extension(sqlite3
*db
, int onoff
){
592 sqlite3_mutex_enter(db
->mutex
);
594 db
->flags
|= SQLITE_LoadExtension
;
596 db
->flags
&= ~SQLITE_LoadExtension
;
598 sqlite3_mutex_leave(db
->mutex
);
602 #endif /* SQLITE_OMIT_LOAD_EXTENSION */
605 ** The auto-extension code added regardless of whether or not extension
606 ** loading is supported. We need a dummy sqlite3Apis pointer for that
607 ** code if regular extension loading is not available. This is that
610 #ifdef SQLITE_OMIT_LOAD_EXTENSION
611 static const sqlite3_api_routines sqlite3Apis
= { 0 };
616 ** The following object holds the list of automatically loaded
619 ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MASTER
620 ** mutex must be held while accessing this list.
622 typedef struct sqlite3AutoExtList sqlite3AutoExtList
;
623 static SQLITE_WSD
struct sqlite3AutoExtList
{
624 int nExt
; /* Number of entries in aExt[] */
625 void (**aExt
)(void); /* Pointers to the extension init functions */
626 } sqlite3Autoext
= { 0, 0 };
628 /* The "wsdAutoext" macro will resolve to the autoextension
629 ** state vector. If writable static data is unsupported on the target,
630 ** we have to locate the state vector at run-time. In the more common
631 ** case where writable static data is supported, wsdStat can refer directly
632 ** to the "sqlite3Autoext" state vector declared above.
634 #ifdef SQLITE_OMIT_WSD
635 # define wsdAutoextInit \
636 sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
637 # define wsdAutoext x[0]
639 # define wsdAutoextInit
640 # define wsdAutoext sqlite3Autoext
645 ** Register a statically linked extension that is automatically
646 ** loaded by every new database connection.
648 int sqlite3_auto_extension(void (*xInit
)(void)){
650 #ifndef SQLITE_OMIT_AUTOINIT
651 rc
= sqlite3_initialize();
658 #if SQLITE_THREADSAFE
659 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
662 sqlite3_mutex_enter(mutex
);
663 for(i
=0; i
<wsdAutoext
.nExt
; i
++){
664 if( wsdAutoext
.aExt
[i
]==xInit
) break;
666 if( i
==wsdAutoext
.nExt
){
667 int nByte
= (wsdAutoext
.nExt
+1)*sizeof(wsdAutoext
.aExt
[0]);
669 aNew
= sqlite3_realloc(wsdAutoext
.aExt
, nByte
);
673 wsdAutoext
.aExt
= aNew
;
674 wsdAutoext
.aExt
[wsdAutoext
.nExt
] = xInit
;
678 sqlite3_mutex_leave(mutex
);
679 assert( (rc
&0xff)==rc
);
685 ** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
686 ** set of routines that is invoked for each new database connection, if it
687 ** is currently on the list. If xInit is not on the list, then this
688 ** routine is a no-op.
690 ** Return 1 if xInit was found on the list and removed. Return 0 if xInit
691 ** was not on the list.
693 int sqlite3_cancel_auto_extension(void (*xInit
)(void)){
694 #if SQLITE_THREADSAFE
695 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
700 sqlite3_mutex_enter(mutex
);
701 for(i
=wsdAutoext
.nExt
-1; i
>=0; i
--){
702 if( wsdAutoext
.aExt
[i
]==xInit
){
704 wsdAutoext
.aExt
[i
] = wsdAutoext
.aExt
[wsdAutoext
.nExt
];
709 sqlite3_mutex_leave(mutex
);
714 ** Reset the automatic extension loading mechanism.
716 void sqlite3_reset_auto_extension(void){
717 #ifndef SQLITE_OMIT_AUTOINIT
718 if( sqlite3_initialize()==SQLITE_OK
)
721 #if SQLITE_THREADSAFE
722 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
725 sqlite3_mutex_enter(mutex
);
726 sqlite3_free(wsdAutoext
.aExt
);
729 sqlite3_mutex_leave(mutex
);
734 ** Load all automatic extensions.
736 ** If anything goes wrong, set an error in the database connection.
738 void sqlite3AutoLoadExtensions(sqlite3
*db
){
742 int (*xInit
)(sqlite3
*,char**,const sqlite3_api_routines
*);
745 if( wsdAutoext
.nExt
==0 ){
746 /* Common case: early out without every having to acquire a mutex */
751 #if SQLITE_THREADSAFE
752 sqlite3_mutex
*mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
);
754 sqlite3_mutex_enter(mutex
);
755 if( i
>=wsdAutoext
.nExt
){
759 xInit
= (int(*)(sqlite3
*,char**,const sqlite3_api_routines
*))
762 sqlite3_mutex_leave(mutex
);
764 if( xInit
&& (rc
= xInit(db
, &zErrmsg
, &sqlite3Apis
))!=0 ){
765 sqlite3ErrorWithMsg(db
, rc
,
766 "automatic extension loading failed: %s", zErrmsg
);
769 sqlite3_free(zErrmsg
);