blob: 2622a81711f1a9c5a94bbef90d32ec01e6289e18 [file] [log] [blame]
drh1e397f82006-06-08 15:28:43 +00001/*
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.
10**
11*************************************************************************
12** This file contains code used to dynamically load extensions into
13** the SQLite library.
14*/
drh1e397f82006-06-08 15:28:43 +000015
danielk19777c9aaa72008-01-01 05:49:07 +000016#ifndef SQLITE_CORE
17 #define SQLITE_CORE 1 /* Disable the API redefinition in sqlite3ext.h */
18#endif
drh1e397f82006-06-08 15:28:43 +000019#include "sqlite3ext.h"
drhf1952c52006-06-08 15:48:00 +000020#include "sqliteInt.h"
drh1e397f82006-06-08 15:28:43 +000021
mlcreech9323f762008-03-19 23:52:34 +000022#ifndef SQLITE_OMIT_LOAD_EXTENSION
mistachkin44e95d42016-07-28 22:23:26 +000023/*
drh70df4fe2006-06-13 15:12:21 +000024** 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.
27*/
drh1e397f82006-06-08 15:28:43 +000028#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
drh1e397f82006-06-08 15:28:43 +000035#endif
36
danielk19774b2688a2006-06-20 11:01:07 +000037#ifdef SQLITE_OMIT_AUTHORIZATION
drhaf304692007-04-23 23:56:31 +000038# define sqlite3_set_authorizer 0
danielk19774b2688a2006-06-20 11:01:07 +000039#endif
40
41#ifdef SQLITE_OMIT_UTF16
drhaf304692007-04-23 23:56:31 +000042# 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
drhf0f44b72017-07-12 12:19:33 +000054# define sqlite3_prepare16_v3 0
drhaf304692007-04-23 23:56:31 +000055# 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
danielk19774b2688a2006-06-20 11:01:07 +000065#endif
66
67#ifdef SQLITE_OMIT_COMPLETE
68# define sqlite3_complete 0
69# define sqlite3_complete16 0
70#endif
71
danbb2b4412011-04-06 17:54:31 +000072#ifdef SQLITE_OMIT_DECLTYPE
73# define sqlite3_column_decltype16 0
74# define sqlite3_column_decltype 0
75#endif
76
danielk19774b2688a2006-06-20 11:01:07 +000077#ifdef SQLITE_OMIT_PROGRESS_CALLBACK
78# define sqlite3_progress_handler 0
79#endif
80
81#ifdef SQLITE_OMIT_VIRTUALTABLE
82# define sqlite3_create_module 0
danielk1977b7865fb2007-06-27 11:10:03 +000083# define sqlite3_create_module_v2 0
danielk19774b2688a2006-06-20 11:01:07 +000084# define sqlite3_declare_vtab 0
dan0ea25172011-06-28 07:15:43 +000085# define sqlite3_vtab_config 0
86# define sqlite3_vtab_on_conflict 0
danf6e015f2018-11-28 08:02:28 +000087# define sqlite3_vtab_collation 0
danielk19774b2688a2006-06-20 11:01:07 +000088#endif
89
drhe31a1fb2007-01-26 13:08:24 +000090#ifdef SQLITE_OMIT_SHARED_CACHE
91# define sqlite3_enable_shared_cache 0
92#endif
93
drh087ec072016-07-25 00:05:56 +000094#if defined(SQLITE_OMIT_TRACE) || defined(SQLITE_OMIT_DEPRECATED)
drhe31a1fb2007-01-26 13:08:24 +000095# define sqlite3_profile 0
96# define sqlite3_trace 0
97#endif
98
99#ifdef SQLITE_OMIT_GET_TABLE
100# define sqlite3_free_table 0
101# define sqlite3_get_table 0
102#endif
103
danielk1977a15db352007-09-14 16:20:00 +0000104#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
dan0ea25172011-06-28 07:15:43 +0000111#define sqlite3_blob_reopen 0
danielk1977a15db352007-09-14 16:20:00 +0000112#endif
113
mistachkin44e95d42016-07-28 22:23:26 +0000114#if defined(SQLITE_OMIT_TRACE)
115# define sqlite3_trace_v2 0
116#endif
117
drh70df4fe2006-06-13 15:12:21 +0000118/*
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.
123**
124** When adding new APIs, add them to the bottom of this structure
125** in order to preserve backwards compatibility.
126**
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.
132*/
drhde244782008-04-10 16:01:10 +0000133static const sqlite3_api_routines sqlite3Apis = {
drh1e397f82006-06-08 15:28:43 +0000134 sqlite3_aggregate_context,
shaneeec556d2008-10-12 00:27:53 +0000135#ifndef SQLITE_OMIT_DEPRECATED
drh1e397f82006-06-08 15:28:43 +0000136 sqlite3_aggregate_count,
shaneeec556d2008-10-12 00:27:53 +0000137#else
138 0,
139#endif
drh1e397f82006-06-08 15:28:43 +0000140 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,
drhc1be6322006-06-27 00:14:27 +0000150 sqlite3_bind_value,
drh1e397f82006-06-08 15:28:43 +0000151 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,
danielk1977d6e8dd02006-06-15 15:38:41 +0000177 sqlite3_column_value,
drh1e397f82006-06-08 15:28:43 +0000178 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,
danielk1977d6e8dd02006-06-15 15:38:41 +0000185 sqlite3_create_module,
drh1e397f82006-06-08 15:28:43 +0000186 sqlite3_data_count,
187 sqlite3_db_handle,
danielk1977d6e8dd02006-06-15 15:38:41 +0000188 sqlite3_declare_vtab,
drh1e397f82006-06-08 15:28:43 +0000189 sqlite3_enable_shared_cache,
190 sqlite3_errcode,
191 sqlite3_errmsg,
192 sqlite3_errmsg16,
193 sqlite3_exec,
shaneeec556d2008-10-12 00:27:53 +0000194#ifndef SQLITE_OMIT_DEPRECATED
drh1e397f82006-06-08 15:28:43 +0000195 sqlite3_expired,
shaneeec556d2008-10-12 00:27:53 +0000196#else
197 0,
198#endif
drh1e397f82006-06-08 15:28:43 +0000199 sqlite3_finalize,
200 sqlite3_free,
201 sqlite3_free_table,
202 sqlite3_get_autocommit,
203 sqlite3_get_auxdata,
204 sqlite3_get_table,
drhe31a1fb2007-01-26 13:08:24 +0000205 0, /* Was sqlite3_global_recover(), but that function is deprecated */
drh1e397f82006-06-08 15:28:43 +0000206 sqlite3_interrupt,
207 sqlite3_last_insert_rowid,
208 sqlite3_libversion,
209 sqlite3_libversion_number,
drh28dd4792006-06-26 21:35:44 +0000210 sqlite3_malloc,
drh1e397f82006-06-08 15:28:43 +0000211 sqlite3_mprintf,
212 sqlite3_open,
213 sqlite3_open16,
214 sqlite3_prepare,
215 sqlite3_prepare16,
216 sqlite3_profile,
217 sqlite3_progress_handler,
drh28dd4792006-06-26 21:35:44 +0000218 sqlite3_realloc,
drh1e397f82006-06-08 15:28:43 +0000219 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,
shaneeec556d2008-10-12 00:27:53 +0000238#ifndef SQLITE_OMIT_DEPRECATED
drh1e397f82006-06-08 15:28:43 +0000239 sqlite3_thread_cleanup,
shaneeec556d2008-10-12 00:27:53 +0000240#else
241 0,
242#endif
drh1e397f82006-06-08 15:28:43 +0000243 sqlite3_total_changes,
244 sqlite3_trace,
shaneeec556d2008-10-12 00:27:53 +0000245#ifndef SQLITE_OMIT_DEPRECATED
drh1e397f82006-06-08 15:28:43 +0000246 sqlite3_transfer_bindings,
shaneeec556d2008-10-12 00:27:53 +0000247#else
248 0,
249#endif
drh1e397f82006-06-08 15:28:43 +0000250 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,
drh70df4fe2006-06-13 15:12:21 +0000265 /*
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 *************************************************************************
272 */
shess74093102006-09-22 23:38:21 +0000273 sqlite3_overload_function,
drh6d54da02007-03-25 19:08:46 +0000274
275 /*
276 ** Added after 3.3.13
277 */
278 sqlite3_prepare_v2,
279 sqlite3_prepare16_v2,
drha92993c2007-03-29 18:46:00 +0000280 sqlite3_clear_bindings,
drh6bf0ae72007-07-20 10:33:58 +0000281
282 /*
283 ** Added for 3.4.1
284 */
285 sqlite3_create_module_v2,
286
drh428e2822007-08-30 16:23:19 +0000287 /*
288 ** Added for 3.5.0
289 */
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,
drhcc6bb3e2007-08-31 16:11:35 +0000297 sqlite3_file_control,
drh428e2822007-08-30 16:23:19 +0000298 sqlite3_memory_highwater,
299 sqlite3_memory_used,
drh18472fa2008-10-07 15:25:48 +0000300#ifdef SQLITE_MUTEX_OMIT
drhad3e78b2007-08-30 20:09:27 +0000301 0,
302 0,
303 0,
304 0,
305 0,
306#else
drh61f6dc62007-08-30 17:15:37 +0000307 sqlite3_mutex_alloc,
308 sqlite3_mutex_enter,
309 sqlite3_mutex_free,
310 sqlite3_mutex_leave,
311 sqlite3_mutex_try,
drhad3e78b2007-08-30 20:09:27 +0000312#endif
drh428e2822007-08-30 16:23:19 +0000313 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,
drh2fa18682008-03-19 14:15:34 +0000322
323 /*
324 ** Added for 3.5.8
325 */
drhe5dd20a2008-03-19 19:55:55 +0000326 sqlite3_threadsafe,
327 sqlite3_result_zeroblob,
328 sqlite3_result_error_code,
329 sqlite3_test_control,
drh2fa18682008-03-19 14:15:34 +0000330 sqlite3_randomness,
drhfa4a4b92008-03-19 21:45:51 +0000331 sqlite3_context_db_handle,
drh8b6abed2008-06-19 15:06:24 +0000332
333 /*
334 ** Added for 3.6.0
335 */
336 sqlite3_extended_result_codes,
337 sqlite3_limit,
338 sqlite3_next_stmt,
339 sqlite3_sql,
340 sqlite3_status,
drhfd7ebbf2010-10-11 13:12:04 +0000341
342 /*
343 ** Added for 3.7.4
344 */
345 sqlite3_backup_finish,
346 sqlite3_backup_init,
347 sqlite3_backup_pagecount,
348 sqlite3_backup_remaining,
349 sqlite3_backup_step,
drh4e49c772010-10-11 17:57:41 +0000350#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
drhfd7ebbf2010-10-11 13:12:04 +0000351 sqlite3_compileoption_get,
352 sqlite3_compileoption_used,
drh4e49c772010-10-11 17:57:41 +0000353#else
354 0,
355 0,
356#endif
drhfd7ebbf2010-10-11 13:12:04 +0000357 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,
drh4e49c772010-10-11 17:57:41 +0000367#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
drhfd7ebbf2010-10-11 13:12:04 +0000368 sqlite3_unlock_notify,
drh4e49c772010-10-11 17:57:41 +0000369#else
370 0,
371#endif
372#ifndef SQLITE_OMIT_WAL
drhfd7ebbf2010-10-11 13:12:04 +0000373 sqlite3_wal_autocheckpoint,
374 sqlite3_wal_checkpoint,
375 sqlite3_wal_hook,
drh4e49c772010-10-11 17:57:41 +0000376#else
377 0,
378 0,
379 0,
380#endif
dan0ea25172011-06-28 07:15:43 +0000381 sqlite3_blob_reopen,
382 sqlite3_vtab_config,
383 sqlite3_vtab_on_conflict,
drh1d59d032013-03-01 23:40:26 +0000384 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,
drh0807cc22014-09-09 18:41:32 +0000396 sqlite3_wal_checkpoint_v2,
397 /* Version 3.8.7 and later */
398 sqlite3_auto_extension,
399 sqlite3_bind_blob64,
drhbbf483f2014-09-09 20:30:24 +0000400 sqlite3_bind_text64,
drh0807cc22014-09-09 18:41:32 +0000401 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,
drhbbf483f2014-09-09 20:30:24 +0000408 sqlite3_result_text64,
drhf5ed7ad2015-06-15 14:43:25 +0000409 sqlite3_strglob,
410 /* Version 3.8.11 and later */
411 (sqlite3_value*(*)(const sqlite3_value*))sqlite3_value_dup,
drh6bacdc22015-07-24 17:14:03 +0000412 sqlite3_value_free,
dan80c03022015-07-24 17:36:34 +0000413 sqlite3_result_zeroblob64,
drhcf94f172015-09-10 20:40:21 +0000414 sqlite3_bind_zeroblob64,
drh58a8a922015-10-12 04:56:12 +0000415 /* Version 3.9.0 and later */
drhcf94f172015-09-10 20:40:21 +0000416 sqlite3_value_subtype,
drh7be53fe2015-12-03 13:43:07 +0000417 sqlite3_result_subtype,
418 /* Version 3.10.0 and later */
419 sqlite3_status64,
420 sqlite3_strlike,
drh1b9f2142016-03-17 16:01:23 +0000421 sqlite3_db_cacheflush,
422 /* Version 3.12.0 and later */
mistachkin44e95d42016-07-28 22:23:26 +0000423 sqlite3_system_errno,
424 /* Version 3.14.0 and later */
425 sqlite3_trace_v2,
drh0d8d9c92017-03-25 19:16:41 +0000426 sqlite3_expanded_sql,
427 /* Version 3.18.0 and later */
drhdb3e0452017-07-11 17:28:27 +0000428 sqlite3_set_last_insert_rowid,
429 /* Version 3.20.0 and later */
430 sqlite3_prepare_v3,
drh5587d862017-07-13 17:54:12 +0000431 sqlite3_prepare16_v3,
432 sqlite3_bind_pointer,
433 sqlite3_result_pointer,
drh76506cd2018-01-13 01:53:09 +0000434 sqlite3_value_pointer,
435 /* Version 3.22.0 and later */
436 sqlite3_vtab_nochange,
drh4a4532b2018-01-16 20:50:37 +0000437 sqlite3_value_nochange,
drhf0f9dbd2018-05-09 15:17:02 +0000438 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,
drh173e7822018-09-10 17:21:17 +0000453 sqlite3_str_value,
454 /* Version 3.25.0 and later */
mistachkin8bee11a2018-10-29 17:53:23 +0000455 sqlite3_create_window_function,
456 /* Version 3.26.0 and later */
457#ifdef SQLITE_ENABLE_NORMALIZE
drh80ac9cb2019-04-04 17:39:54 +0000458 sqlite3_normalized_sql,
mistachkin8bee11a2018-10-29 17:53:23 +0000459#else
drh80ac9cb2019-04-04 17:39:54 +0000460 0,
mistachkin8bee11a2018-10-29 17:53:23 +0000461#endif
drh80ac9cb2019-04-04 17:39:54 +0000462 /* Version 3.28.0 and later */
463 sqlite3_stmt_isexplain,
drh10c0e712019-04-25 18:15:38 +0000464 sqlite3_value_frombind,
drh95da9d52019-08-20 13:49:12 +0000465 /* Version 3.30.0 and later */
danb008e4d2019-10-03 14:36:36 +0000466#ifndef SQLITE_OMIT_VIRTUALTABLE
drh95da9d52019-08-20 13:49:12 +0000467 sqlite3_drop_modules,
danb008e4d2019-10-03 14:36:36 +0000468#else
469 0,
470#endif
drh803f06b2019-11-14 15:21:15 +0000471 /* Version 3.31.0 and later */
472 sqlite3_hard_heap_limit64,
drh1e397f82006-06-08 15:28:43 +0000473};
474
drh70df4fe2006-06-13 15:12:21 +0000475/*
drh1e397f82006-06-08 15:28:43 +0000476** Attempt to load an SQLite extension library contained in the file
drh428397c2006-06-17 13:21:32 +0000477** zFile. The entry point is zProc. zProc may be 0 in which case a
478** default entry point name (sqlite3_extension_init) is used. Use
479** of the default name is recommended.
drh1e397f82006-06-08 15:28:43 +0000480**
481** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
482**
483** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
484** error message text. The calling function should free this memory
drh633e6d52008-07-28 19:34:53 +0000485** by calling sqlite3DbFree(db, ).
drh1e397f82006-06-08 15:28:43 +0000486*/
drhb21c8cd2007-08-21 19:33:56 +0000487static int sqlite3LoadExtension(
drh1e397f82006-06-08 15:28:43 +0000488 sqlite3 *db, /* Load the extension into this database connection */
489 const char *zFile, /* Name of the shared library containing extension */
drh428397c2006-06-17 13:21:32 +0000490 const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
drh1e397f82006-06-08 15:28:43 +0000491 char **pzErrMsg /* Put error message here if not 0 */
492){
danielk1977b4b47412007-08-17 15:53:36 +0000493 sqlite3_vfs *pVfs = db->pVfs;
drh761df872006-12-21 01:29:22 +0000494 void *handle;
mistachkin44e95d42016-07-28 22:23:26 +0000495 sqlite3_loadext_entry xInit;
drh1e397f82006-06-08 15:28:43 +0000496 char *zErrmsg = 0;
drhc288e442013-04-18 22:56:42 +0000497 const char *zEntry;
498 char *zAltEntry = 0;
drh761df872006-12-21 01:29:22 +0000499 void **aHandle;
drhf3cdcdc2015-04-29 16:50:28 +0000500 u64 nMsg = 300 + sqlite3Strlen30(zFile);
drhc288e442013-04-18 22:56:42 +0000501 int ii;
drhc1502e22016-05-28 17:23:08 +0000502 int rc;
drhc288e442013-04-18 22:56:42 +0000503
504 /* Shared library endings to try if zFile cannot be loaded as written */
505 static const char *azEndings[] = {
506#if SQLITE_OS_WIN
507 "dll"
508#elif defined(__APPLE__)
509 "dylib"
510#else
511 "so"
512#endif
513 };
514
drh1e397f82006-06-08 15:28:43 +0000515
drh7aaa8782009-05-20 02:40:45 +0000516 if( pzErrMsg ) *pzErrMsg = 0;
drh191dd062016-04-21 01:30:09 +0000517
518 /* Ticket #1863. To avoid a creating security problems for older
519 ** applications that relink against newer versions of SQLite, the
520 ** ability to run load_extension is turned off by default. One
521 ** must call either sqlite3_enable_load_extension(db) or
522 ** sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, 0)
523 ** to turn on extension loading.
524 */
525 if( (db->flags & SQLITE_LoadExtension)==0 ){
526 if( pzErrMsg ){
527 *pzErrMsg = sqlite3_mprintf("not authorized");
528 }
529 return SQLITE_ERROR;
530 }
531
drhc288e442013-04-18 22:56:42 +0000532 zEntry = zProc ? zProc : "sqlite3_extension_init";
drh191dd062016-04-21 01:30:09 +0000533
danielk1977b4b47412007-08-17 15:53:36 +0000534 handle = sqlite3OsDlOpen(pVfs, zFile);
drhc288e442013-04-18 22:56:42 +0000535#if SQLITE_OS_UNIX || SQLITE_OS_WIN
536 for(ii=0; ii<ArraySize(azEndings) && handle==0; ii++){
537 char *zAltFile = sqlite3_mprintf("%s.%s", zFile, azEndings[ii]);
mistachkinfad30392016-02-13 23:43:46 +0000538 if( zAltFile==0 ) return SQLITE_NOMEM_BKPT;
drh60208c32018-05-07 02:50:38 +0000539 handle = sqlite3OsDlOpen(pVfs, zAltFile);
drhc288e442013-04-18 22:56:42 +0000540 sqlite3_free(zAltFile);
541 }
542#endif
drh1e397f82006-06-08 15:28:43 +0000543 if( handle==0 ){
544 if( pzErrMsg ){
drhf3cdcdc2015-04-29 16:50:28 +0000545 *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
drh50d654d2009-06-03 01:24:54 +0000546 if( zErrmsg ){
547 sqlite3_snprintf(nMsg, zErrmsg,
548 "unable to open shared library [%s]", zFile);
549 sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
drh50d654d2009-06-03 01:24:54 +0000550 }
drh1e397f82006-06-08 15:28:43 +0000551 }
552 return SQLITE_ERROR;
553 }
mistachkin44e95d42016-07-28 22:23:26 +0000554 xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
drhc288e442013-04-18 22:56:42 +0000555
556 /* If no entry point was specified and the default legacy
557 ** entry point name "sqlite3_extension_init" was not found, then
558 ** construct an entry point name "sqlite3_X_init" where the X is
559 ** replaced by the lowercase value of every ASCII alphabetic
560 ** character in the filename after the last "/" upto the first ".",
561 ** and eliding the first three characters if they are "lib".
562 ** Examples:
563 **
564 ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
565 ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
566 */
567 if( xInit==0 && zProc==0 ){
568 int iFile, iEntry, c;
569 int ncFile = sqlite3Strlen30(zFile);
drhf3cdcdc2015-04-29 16:50:28 +0000570 zAltEntry = sqlite3_malloc64(ncFile+30);
drhc288e442013-04-18 22:56:42 +0000571 if( zAltEntry==0 ){
572 sqlite3OsDlClose(pVfs, handle);
mistachkinfad30392016-02-13 23:43:46 +0000573 return SQLITE_NOMEM_BKPT;
drhc288e442013-04-18 22:56:42 +0000574 }
575 memcpy(zAltEntry, "sqlite3_", 8);
576 for(iFile=ncFile-1; iFile>=0 && zFile[iFile]!='/'; iFile--){}
577 iFile++;
578 if( sqlite3_strnicmp(zFile+iFile, "lib", 3)==0 ) iFile += 3;
579 for(iEntry=8; (c = zFile[iFile])!=0 && c!='.'; iFile++){
580 if( sqlite3Isalpha(c) ){
581 zAltEntry[iEntry++] = (char)sqlite3UpperToLower[(unsigned)c];
582 }
583 }
584 memcpy(zAltEntry+iEntry, "_init", 6);
585 zEntry = zAltEntry;
mistachkin44e95d42016-07-28 22:23:26 +0000586 xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
drhc288e442013-04-18 22:56:42 +0000587 }
drh1e397f82006-06-08 15:28:43 +0000588 if( xInit==0 ){
589 if( pzErrMsg ){
drhc288e442013-04-18 22:56:42 +0000590 nMsg += sqlite3Strlen30(zEntry);
drhf3cdcdc2015-04-29 16:50:28 +0000591 *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
drh50d654d2009-06-03 01:24:54 +0000592 if( zErrmsg ){
593 sqlite3_snprintf(nMsg, zErrmsg,
drhc288e442013-04-18 22:56:42 +0000594 "no entry point [%s] in shared library [%s]", zEntry, zFile);
drh50d654d2009-06-03 01:24:54 +0000595 sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
drh50d654d2009-06-03 01:24:54 +0000596 }
drh1e397f82006-06-08 15:28:43 +0000597 }
drhc288e442013-04-18 22:56:42 +0000598 sqlite3OsDlClose(pVfs, handle);
599 sqlite3_free(zAltEntry);
drh1e397f82006-06-08 15:28:43 +0000600 return SQLITE_ERROR;
drhc288e442013-04-18 22:56:42 +0000601 }
602 sqlite3_free(zAltEntry);
drhc1502e22016-05-28 17:23:08 +0000603 rc = xInit(db, &zErrmsg, &sqlite3Apis);
604 if( rc ){
605 if( rc==SQLITE_OK_LOAD_PERMANENTLY ) return SQLITE_OK;
drh1e397f82006-06-08 15:28:43 +0000606 if( pzErrMsg ){
607 *pzErrMsg = sqlite3_mprintf("error during initialization: %s", zErrmsg);
608 }
609 sqlite3_free(zErrmsg);
danielk1977b4b47412007-08-17 15:53:36 +0000610 sqlite3OsDlClose(pVfs, handle);
drh1e397f82006-06-08 15:28:43 +0000611 return SQLITE_ERROR;
612 }
danielk197769e777f2006-06-14 10:38:02 +0000613
614 /* Append the new shared library handle to the db->aExtension array. */
drh701bb3b2008-08-02 03:50:39 +0000615 aHandle = sqlite3DbMallocZero(db, sizeof(handle)*(db->nExtension+1));
danielk197769e777f2006-06-14 10:38:02 +0000616 if( aHandle==0 ){
mistachkinfad30392016-02-13 23:43:46 +0000617 return SQLITE_NOMEM_BKPT;
danielk197769e777f2006-06-14 10:38:02 +0000618 }
619 if( db->nExtension>0 ){
drh701bb3b2008-08-02 03:50:39 +0000620 memcpy(aHandle, db->aExtension, sizeof(handle)*db->nExtension);
danielk197769e777f2006-06-14 10:38:02 +0000621 }
drh633e6d52008-07-28 19:34:53 +0000622 sqlite3DbFree(db, db->aExtension);
danielk197769e777f2006-06-14 10:38:02 +0000623 db->aExtension = aHandle;
624
drh701bb3b2008-08-02 03:50:39 +0000625 db->aExtension[db->nExtension++] = handle;
drh1e397f82006-06-08 15:28:43 +0000626 return SQLITE_OK;
drh1e397f82006-06-08 15:28:43 +0000627}
drhb21c8cd2007-08-21 19:33:56 +0000628int sqlite3_load_extension(
629 sqlite3 *db, /* Load the extension into this database connection */
630 const char *zFile, /* Name of the shared library containing extension */
631 const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
632 char **pzErrMsg /* Put error message here if not 0 */
633){
634 int rc;
635 sqlite3_mutex_enter(db->mutex);
636 rc = sqlite3LoadExtension(db, zFile, zProc, pzErrMsg);
drh7aaa8782009-05-20 02:40:45 +0000637 rc = sqlite3ApiExit(db, rc);
drhb21c8cd2007-08-21 19:33:56 +0000638 sqlite3_mutex_leave(db->mutex);
639 return rc;
640}
drhf1952c52006-06-08 15:48:00 +0000641
642/*
643** Call this routine when the database connection is closing in order
644** to clean up loaded extensions
645*/
646void sqlite3CloseExtensions(sqlite3 *db){
647 int i;
drhb21c8cd2007-08-21 19:33:56 +0000648 assert( sqlite3_mutex_held(db->mutex) );
drhf1952c52006-06-08 15:48:00 +0000649 for(i=0; i<db->nExtension; i++){
danielk1977b4b47412007-08-17 15:53:36 +0000650 sqlite3OsDlClose(db->pVfs, db->aExtension[i]);
drhf1952c52006-06-08 15:48:00 +0000651 }
drh633e6d52008-07-28 19:34:53 +0000652 sqlite3DbFree(db, db->aExtension);
drhf1952c52006-06-08 15:48:00 +0000653}
654
drhc2e87a32006-06-27 15:16:14 +0000655/*
656** Enable or disable extension loading. Extension loading is disabled by
657** default so as not to open security holes in older applications.
658*/
659int sqlite3_enable_load_extension(sqlite3 *db, int onoff){
drhb21c8cd2007-08-21 19:33:56 +0000660 sqlite3_mutex_enter(db->mutex);
drhc2e87a32006-06-27 15:16:14 +0000661 if( onoff ){
drh191dd062016-04-21 01:30:09 +0000662 db->flags |= SQLITE_LoadExtension|SQLITE_LoadExtFunc;
drhc2e87a32006-06-27 15:16:14 +0000663 }else{
drhd5b44d62018-12-06 17:06:02 +0000664 db->flags &= ~(u64)(SQLITE_LoadExtension|SQLITE_LoadExtFunc);
drhc2e87a32006-06-27 15:16:14 +0000665 }
drhb21c8cd2007-08-21 19:33:56 +0000666 sqlite3_mutex_leave(db->mutex);
drhc2e87a32006-06-27 15:16:14 +0000667 return SQLITE_OK;
668}
669
drh98365be2016-09-15 19:15:19 +0000670#endif /* !defined(SQLITE_OMIT_LOAD_EXTENSION) */
drh984bfaa2008-03-19 16:08:53 +0000671
drh1409be62006-08-23 20:07:20 +0000672/*
drh605264d2007-08-21 15:13:19 +0000673** The following object holds the list of automatically loaded
674** extensions.
drh1409be62006-08-23 20:07:20 +0000675**
drh605264d2007-08-21 15:13:19 +0000676** This list is shared across threads. The SQLITE_MUTEX_STATIC_MASTER
677** mutex must be held while accessing this list.
drh1409be62006-08-23 20:07:20 +0000678*/
drh1875f7a2008-12-08 18:19:17 +0000679typedef struct sqlite3AutoExtList sqlite3AutoExtList;
680static SQLITE_WSD struct sqlite3AutoExtList {
drhf3cdcdc2015-04-29 16:50:28 +0000681 u32 nExt; /* Number of entries in aExt[] */
drh1875f7a2008-12-08 18:19:17 +0000682 void (**aExt)(void); /* Pointers to the extension init functions */
drh78f82d12008-09-02 00:52:52 +0000683} sqlite3Autoext = { 0, 0 };
684
685/* The "wsdAutoext" macro will resolve to the autoextension
686** state vector. If writable static data is unsupported on the target,
687** we have to locate the state vector at run-time. In the more common
688** case where writable static data is supported, wsdStat can refer directly
689** to the "sqlite3Autoext" state vector declared above.
690*/
691#ifdef SQLITE_OMIT_WSD
692# define wsdAutoextInit \
drh1875f7a2008-12-08 18:19:17 +0000693 sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
drh78f82d12008-09-02 00:52:52 +0000694# define wsdAutoext x[0]
695#else
696# define wsdAutoextInit
697# define wsdAutoext sqlite3Autoext
698#endif
drh1409be62006-08-23 20:07:20 +0000699
700
701/*
702** Register a statically linked extension that is automatically
703** loaded by every new database connection.
704*/
mistachkin44e95d42016-07-28 22:23:26 +0000705int sqlite3_auto_extension(
drh32c83c82016-08-01 14:35:48 +0000706 void (*xInit)(void)
mistachkin44e95d42016-07-28 22:23:26 +0000707){
danielk197700f0faf2008-07-08 14:17:35 +0000708 int rc = SQLITE_OK;
drh40257ff2008-06-13 18:24:27 +0000709#ifndef SQLITE_OMIT_AUTOINIT
danielk197700f0faf2008-07-08 14:17:35 +0000710 rc = sqlite3_initialize();
drh40257ff2008-06-13 18:24:27 +0000711 if( rc ){
712 return rc;
713 }else
drhe265b082008-05-01 17:03:49 +0000714#endif
drh40257ff2008-06-13 18:24:27 +0000715 {
drh6a412b82015-04-30 12:31:49 +0000716 u32 i;
drh18472fa2008-10-07 15:25:48 +0000717#if SQLITE_THREADSAFE
danielk197759f8c082008-06-18 17:09:10 +0000718 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drh40257ff2008-06-13 18:24:27 +0000719#endif
drh78f82d12008-09-02 00:52:52 +0000720 wsdAutoextInit;
drh40257ff2008-06-13 18:24:27 +0000721 sqlite3_mutex_enter(mutex);
drh78f82d12008-09-02 00:52:52 +0000722 for(i=0; i<wsdAutoext.nExt; i++){
drhb0df5402016-08-01 17:06:44 +0000723 if( wsdAutoext.aExt[i]==xInit ) break;
drh1409be62006-08-23 20:07:20 +0000724 }
drh78f82d12008-09-02 00:52:52 +0000725 if( i==wsdAutoext.nExt ){
drhf3cdcdc2015-04-29 16:50:28 +0000726 u64 nByte = (wsdAutoext.nExt+1)*sizeof(wsdAutoext.aExt[0]);
drh1875f7a2008-12-08 18:19:17 +0000727 void (**aNew)(void);
drhf3cdcdc2015-04-29 16:50:28 +0000728 aNew = sqlite3_realloc64(wsdAutoext.aExt, nByte);
drh40257ff2008-06-13 18:24:27 +0000729 if( aNew==0 ){
mistachkinfad30392016-02-13 23:43:46 +0000730 rc = SQLITE_NOMEM_BKPT;
drh40257ff2008-06-13 18:24:27 +0000731 }else{
drh78f82d12008-09-02 00:52:52 +0000732 wsdAutoext.aExt = aNew;
drhb0df5402016-08-01 17:06:44 +0000733 wsdAutoext.aExt[wsdAutoext.nExt] = xInit;
drh78f82d12008-09-02 00:52:52 +0000734 wsdAutoext.nExt++;
drh40257ff2008-06-13 18:24:27 +0000735 }
736 }
737 sqlite3_mutex_leave(mutex);
738 assert( (rc&0xff)==rc );
739 return rc;
drh1409be62006-08-23 20:07:20 +0000740 }
drh1409be62006-08-23 20:07:20 +0000741}
742
743/*
drh425e27d2013-07-15 17:02:28 +0000744** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
745** set of routines that is invoked for each new database connection, if it
746** is currently on the list. If xInit is not on the list, then this
747** routine is a no-op.
748**
749** Return 1 if xInit was found on the list and removed. Return 0 if xInit
750** was not on the list.
751*/
mistachkin44e95d42016-07-28 22:23:26 +0000752int sqlite3_cancel_auto_extension(
drh32c83c82016-08-01 14:35:48 +0000753 void (*xInit)(void)
mistachkin44e95d42016-07-28 22:23:26 +0000754){
drh425e27d2013-07-15 17:02:28 +0000755#if SQLITE_THREADSAFE
756 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
757#endif
758 int i;
759 int n = 0;
760 wsdAutoextInit;
761 sqlite3_mutex_enter(mutex);
drh6a412b82015-04-30 12:31:49 +0000762 for(i=(int)wsdAutoext.nExt-1; i>=0; i--){
drhb0df5402016-08-01 17:06:44 +0000763 if( wsdAutoext.aExt[i]==xInit ){
drh425e27d2013-07-15 17:02:28 +0000764 wsdAutoext.nExt--;
765 wsdAutoext.aExt[i] = wsdAutoext.aExt[wsdAutoext.nExt];
766 n++;
767 break;
768 }
769 }
770 sqlite3_mutex_leave(mutex);
771 return n;
772}
773
774/*
drh1409be62006-08-23 20:07:20 +0000775** Reset the automatic extension loading mechanism.
776*/
777void sqlite3_reset_auto_extension(void){
drh40257ff2008-06-13 18:24:27 +0000778#ifndef SQLITE_OMIT_AUTOINIT
779 if( sqlite3_initialize()==SQLITE_OK )
drhe265b082008-05-01 17:03:49 +0000780#endif
drh40257ff2008-06-13 18:24:27 +0000781 {
drh18472fa2008-10-07 15:25:48 +0000782#if SQLITE_THREADSAFE
danielk197759f8c082008-06-18 17:09:10 +0000783 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drh40257ff2008-06-13 18:24:27 +0000784#endif
drh78f82d12008-09-02 00:52:52 +0000785 wsdAutoextInit;
drh40257ff2008-06-13 18:24:27 +0000786 sqlite3_mutex_enter(mutex);
drh78f82d12008-09-02 00:52:52 +0000787 sqlite3_free(wsdAutoext.aExt);
788 wsdAutoext.aExt = 0;
789 wsdAutoext.nExt = 0;
drh40257ff2008-06-13 18:24:27 +0000790 sqlite3_mutex_leave(mutex);
791 }
drh1409be62006-08-23 20:07:20 +0000792}
793
794/*
795** Load all automatic extensions.
drh7aaa8782009-05-20 02:40:45 +0000796**
797** If anything goes wrong, set an error in the database connection.
drh1409be62006-08-23 20:07:20 +0000798*/
drh7aaa8782009-05-20 02:40:45 +0000799void sqlite3AutoLoadExtensions(sqlite3 *db){
drh6a412b82015-04-30 12:31:49 +0000800 u32 i;
drh1409be62006-08-23 20:07:20 +0000801 int go = 1;
drhe5077c12011-12-13 04:08:36 +0000802 int rc;
mistachkin44e95d42016-07-28 22:23:26 +0000803 sqlite3_loadext_entry xInit;
drh1409be62006-08-23 20:07:20 +0000804
drh78f82d12008-09-02 00:52:52 +0000805 wsdAutoextInit;
806 if( wsdAutoext.nExt==0 ){
drh1409be62006-08-23 20:07:20 +0000807 /* Common case: early out without every having to acquire a mutex */
drh7aaa8782009-05-20 02:40:45 +0000808 return;
drh1409be62006-08-23 20:07:20 +0000809 }
810 for(i=0; go; i++){
drh7aaa8782009-05-20 02:40:45 +0000811 char *zErrmsg;
drh18472fa2008-10-07 15:25:48 +0000812#if SQLITE_THREADSAFE
danielk197759f8c082008-06-18 17:09:10 +0000813 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhe265b082008-05-01 17:03:49 +0000814#endif
drh98365be2016-09-15 19:15:19 +0000815#ifdef SQLITE_OMIT_LOAD_EXTENSION
816 const sqlite3_api_routines *pThunk = 0;
817#else
818 const sqlite3_api_routines *pThunk = &sqlite3Apis;
819#endif
danielk1977b4b47412007-08-17 15:53:36 +0000820 sqlite3_mutex_enter(mutex);
drh78f82d12008-09-02 00:52:52 +0000821 if( i>=wsdAutoext.nExt ){
drh1409be62006-08-23 20:07:20 +0000822 xInit = 0;
823 go = 0;
824 }else{
mistachkin44e95d42016-07-28 22:23:26 +0000825 xInit = (sqlite3_loadext_entry)wsdAutoext.aExt[i];
drh1409be62006-08-23 20:07:20 +0000826 }
danielk1977b4b47412007-08-17 15:53:36 +0000827 sqlite3_mutex_leave(mutex);
drh7aaa8782009-05-20 02:40:45 +0000828 zErrmsg = 0;
drh98365be2016-09-15 19:15:19 +0000829 if( xInit && (rc = xInit(db, &zErrmsg, pThunk))!=0 ){
drh13f40da2014-08-22 18:00:11 +0000830 sqlite3ErrorWithMsg(db, rc,
drh1409be62006-08-23 20:07:20 +0000831 "automatic extension loading failed: %s", zErrmsg);
832 go = 0;
drh1409be62006-08-23 20:07:20 +0000833 }
drh7aaa8782009-05-20 02:40:45 +0000834 sqlite3_free(zErrmsg);
drh1409be62006-08-23 20:07:20 +0000835 }
drh1409be62006-08-23 20:07:20 +0000836}