From: stephan Date: Sun, 3 Sep 2023 10:23:03 +0000 (+0000) Subject: Export the sqlite3_backup_...() APIs to JNI. X-Git-Tag: version-3.44.0~216^2~17 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=24a689cf01faf8b4079c9f5a47f894c838d04bf4;p=thirdparty%2Fsqlite.git Export the sqlite3_backup_...() APIs to JNI. FossilOrigin-Name: 865a3df5d550f6f4edbf95854750706e4e747d8f1825ae73d300b8e31934959b --- diff --git a/ext/jni/src/c/sqlite3-jni.c b/ext/jni/src/c/sqlite3-jni.c index 2832196e35..a587764408 100644 --- a/ext/jni/src/c/sqlite3-jni.c +++ b/ext/jni/src/c/sqlite3-jni.c @@ -335,8 +335,9 @@ struct S3JniNphOp { */ static const struct { const S3JniNphOp sqlite3; - const S3JniNphOp sqlite3_stmt; + const S3JniNphOp sqlite3_backup; const S3JniNphOp sqlite3_context; + const S3JniNphOp sqlite3_stmt; const S3JniNphOp sqlite3_value; const S3JniNphOp OutputPointer_Bool; const S3JniNphOp OutputPointer_Int32; @@ -361,26 +362,27 @@ static const struct { /* OutputPointer.T ref */ #define RefO(INDEX, KLAZZ, SIG) MkRef(INDEX, KLAZZ, "value", SIG) RefN(0, "sqlite3"), - RefN(1, "sqlite3_stmt"), + RefN(1, "sqlite3_backup"), RefN(2, "sqlite3_context"), - RefN(3, "sqlite3_value"), - RefO(4, "OutputPointer$Bool", "Z"), - RefO(5, "OutputPointer$Int32", "I"), - RefO(6, "OutputPointer$Int64", "J"), - RefO(7, "OutputPointer$sqlite3", + RefN(3, "sqlite3_stmt"), + RefN(4, "sqlite3_value"), + RefO(5, "OutputPointer$Bool", "Z"), + RefO(6, "OutputPointer$Int32", "I"), + RefO(7, "OutputPointer$Int64", "J"), + RefO(8, "OutputPointer$sqlite3", "Lorg/sqlite/jni/sqlite3;"), - RefO(8, "OutputPointer$sqlite3_stmt", + RefO(9, "OutputPointer$sqlite3_stmt", "Lorg/sqlite/jni/sqlite3_stmt;"), - RefO(9, "OutputPointer$sqlite3_value", + RefO(10, "OutputPointer$sqlite3_value", "Lorg/sqlite/jni/sqlite3_value;"), - RefO(10, "OutputPointer$String", "Ljava/lang/String;"), + RefO(11, "OutputPointer$String", "Ljava/lang/String;"), #ifdef SQLITE_ENABLE_FTS5 - RefO(11, "OutputPointer$ByteArray", "[B"), - RefN(12, "Fts5Context"), - RefN(13, "Fts5ExtensionApi"), - RefN(14, "fts5_api"), - RefN(15, "fts5_tokenizer"), - RefN(16, "Fts5Tokenizer") + RefO(12, "OutputPointer$ByteArray", "[B"), + RefN(13, "Fts5Context"), + RefN(14, "Fts5ExtensionApi"), + RefN(15, "fts5_api"), + RefN(16, "fts5_tokenizer"), + RefN(17, "Fts5Tokenizer") #endif #undef MkRef #undef RefN @@ -1376,30 +1378,30 @@ static jfieldID s3jni_nphop_field(JNIEnv * const env, S3JniNphOp const* pRef){ } /* -** Sets a native ptr value in NativePointerHolder object ppOut. -** zClassName must be a static string so we can use its address -** as a cache key. +** Sets a native ptr value in NativePointerHolder object jNph, +** which must be of the native type described by pRef. jNph +** may not be NULL. */ static void NativePointerHolder__set(JNIEnv * const env, S3JniNphOp const* pRef, - jobject ppOut, const void * p){ - assert( ppOut ); - (*env)->SetLongField(env, ppOut, s3jni_nphop_field(env, pRef), (jlong)p); + jobject jNph, const void * p){ + assert( jNph ); + (*env)->SetLongField(env, jNph, s3jni_nphop_field(env, pRef), (jlong)p); S3JniExceptionIsFatal("Could not set NativePointerHolder.nativePointer."); } -#define NativePointerHolder_set(PREF,PPOUT,P) \ - NativePointerHolder__set(env, PREF, PPOUT, P) +#define NativePointerHolder_set(PREF,JNPH,P) \ + NativePointerHolder__set(env, PREF, JNPH, P) /* -** Fetches a native ptr value from NativePointerHolder object pObj, +** Fetches a native ptr value from NativePointerHolder object jNph, ** which must be of the native type described by pRef. This is a -** no-op if pObj is NULL. +** no-op if jNph is NULL. */ -static void * NativePointerHolder__get(JNIEnv * env, jobject pObj, +static void * NativePointerHolder__get(JNIEnv * env, jobject jNph, S3JniNphOp const* pRef){ void * rv = 0; - if( pObj ){ - rv = (void*)(*env)->GetLongField(env, pObj, s3jni_nphop_field(env, pRef)); + if( jNph ){ + rv = (void*)(*env)->GetLongField(env, jNph, s3jni_nphop_field(env, pRef)); S3JniExceptionIsFatal("Cannot fetch NativePointerHolder.nativePointer."); } return rv; @@ -1424,9 +1426,10 @@ static void * NativePointerHolder__get(JNIEnv * env, jobject pObj, */ #define PtrGet_T(T,OBJ) NativePointerHolder_get(OBJ, S3JniNph(T)) #define PtrGet_sqlite3(OBJ) PtrGet_T(sqlite3, OBJ) +#define PtrGet_sqlite3_backup(OBJ) PtrGet_T(sqlite3_backup, OBJ) +#define PtrGet_sqlite3_context(OBJ) PtrGet_T(sqlite3_context, OBJ) #define PtrGet_sqlite3_stmt(OBJ) PtrGet_T(sqlite3_stmt, OBJ) #define PtrGet_sqlite3_value(OBJ) PtrGet_T(sqlite3_value, OBJ) -#define PtrGet_sqlite3_context(OBJ) PtrGet_T(sqlite3_context, OBJ) #if 0 /* @@ -1696,6 +1699,9 @@ static jobject NativePointerHolder_new(JNIEnv * const env, static inline jobject new_java_sqlite3(JNIEnv * const env, sqlite3 *sv){ return NativePointerHolder_new(env, S3JniNph(sqlite3), sv); } +static inline jobject new_java_sqlite3_backup(JNIEnv * const env, sqlite3_backup *sv){ + return NativePointerHolder_new(env, S3JniNph(sqlite3_backup), sv); +} static inline jobject new_java_sqlite3_context(JNIEnv * const env, sqlite3_context *sv){ return NativePointerHolder_new(env, S3JniNph(sqlite3_context), sv); } @@ -2239,6 +2245,59 @@ S3JniApi(sqlite3_auto_extension(),jint,1auto_1extension)( return rc; } +S3JniApi(sqlite3_backup_finish(),jint,1backup_1finish)( + JniArgsEnvClass, jobject jBack +){ + sqlite3_backup * const pB = PtrGet_sqlite3_backup(jBack); + NativePointerHolder_set(S3JniNph(sqlite3_backup), jBack, 0); + return sqlite3_backup_finish(pB); +} + +S3JniApi(sqlite3_backup_init(),jobject,1backup_1init)( + JniArgsEnvClass, jobject jDbDest, jstring jTDest, + jobject jDbSrc, jstring jTSrc +){ + sqlite3 * const pDest = PtrGet_sqlite3(jDbDest); + sqlite3 * const pSrc = PtrGet_sqlite3(jDbSrc); + char * const zDest = s3jni_jstring_to_utf8(jTDest, 0); + char * const zSrc = s3jni_jstring_to_utf8(jTSrc, 0); + jobject rv = 0; + + if( pDest && pSrc && zDest && zSrc ){ + sqlite3_backup * const pB = + sqlite3_backup_init(pDest, zDest, pSrc, zSrc); + if( pB ){ + rv = new_java_sqlite3_backup(env, pB); + if( rv ){ + NativePointerHolder_set(S3JniNph(sqlite3_backup), rv, pB); + }else{ + sqlite3_backup_finish( pB ); + } + } + } + sqlite3_free(zDest); + sqlite3_free(zSrc); + return rv; +} + +S3JniApi(sqlite3_backup_pagecount(),jint,1backup_1pagecount)( + JniArgsEnvClass, jobject jBack +){ + return sqlite3_backup_pagecount(PtrGet_sqlite3_backup(jBack)); +} + +S3JniApi(sqlite3_backup_remaining(),jint,1backup_1remaining)( + JniArgsEnvClass, jobject jBack +){ + return sqlite3_backup_remaining(PtrGet_sqlite3_backup(jBack)); +} + +S3JniApi(sqlite3_backup_step(),jint,1backup_1step)( + JniArgsEnvClass, jobject jBack, jint nPage +){ + return sqlite3_backup_step(PtrGet_sqlite3_backup(jBack), (int)nPage); +} + S3JniApi(sqlite3_bind_blob(),jint,1bind_1blob)( JniArgsEnvClass, jobject jpStmt, jint ndx, jbyteArray baData, jint nMax ){ diff --git a/ext/jni/src/c/sqlite3-jni.h b/ext/jni/src/c/sqlite3-jni.h index 7f8b351c58..f573eacc90 100644 --- a/ext/jni/src/c/sqlite3-jni.h +++ b/ext/jni/src/c/sqlite3-jni.h @@ -811,6 +811,46 @@ JNIEXPORT jlong JNICALL Java_org_sqlite_jni_SQLite3Jni_sqlite3_1aggregate_1conte JNIEXPORT jint JNICALL Java_org_sqlite_jni_SQLite3Jni_sqlite3_1auto_1extension (JNIEnv *, jclass, jobject); +/* + * Class: org_sqlite_jni_SQLite3Jni + * Method: sqlite3_backup_finish + * Signature: (Lorg/sqlite/jni/sqlite3_backup;)I + */ +JNIEXPORT jint JNICALL Java_org_sqlite_jni_SQLite3Jni_sqlite3_1backup_1finish + (JNIEnv *, jclass, jobject); + +/* + * Class: org_sqlite_jni_SQLite3Jni + * Method: sqlite3_backup_init + * Signature: (Lorg/sqlite/jni/sqlite3;Ljava/lang/String;Lorg/sqlite/jni/sqlite3;Ljava/lang/String;)Lorg/sqlite/jni/sqlite3_backup; + */ +JNIEXPORT jobject JNICALL Java_org_sqlite_jni_SQLite3Jni_sqlite3_1backup_1init + (JNIEnv *, jclass, jobject, jstring, jobject, jstring); + +/* + * Class: org_sqlite_jni_SQLite3Jni + * Method: sqlite3_backup_pagecount + * Signature: (Lorg/sqlite/jni/sqlite3_backup;)I + */ +JNIEXPORT jint JNICALL Java_org_sqlite_jni_SQLite3Jni_sqlite3_1backup_1pagecount + (JNIEnv *, jclass, jobject); + +/* + * Class: org_sqlite_jni_SQLite3Jni + * Method: sqlite3_backup_remaining + * Signature: (Lorg/sqlite/jni/sqlite3_backup;)I + */ +JNIEXPORT jint JNICALL Java_org_sqlite_jni_SQLite3Jni_sqlite3_1backup_1remaining + (JNIEnv *, jclass, jobject); + +/* + * Class: org_sqlite_jni_SQLite3Jni + * Method: sqlite3_backup_step + * Signature: (Lorg/sqlite/jni/sqlite3_backup;I)I + */ +JNIEXPORT jint JNICALL Java_org_sqlite_jni_SQLite3Jni_sqlite3_1backup_1step + (JNIEnv *, jclass, jobject, jint); + /* * Class: org_sqlite_jni_SQLite3Jni * Method: sqlite3_bind_blob diff --git a/ext/jni/src/org/sqlite/jni/SQLite3Jni.java b/ext/jni/src/org/sqlite/jni/SQLite3Jni.java index a287fc9941..feb6b7a92f 100644 --- a/ext/jni/src/org/sqlite/jni/SQLite3Jni.java +++ b/ext/jni/src/org/sqlite/jni/SQLite3Jni.java @@ -165,6 +165,26 @@ public final class SQLite3Jni { @Canonical public static native int sqlite3_auto_extension(@NotNull AutoExtensionCallback callback); + @Canonical + public static native int sqlite3_backup_finish(@NotNull sqlite3_backup b); + + @Canonical + public static native sqlite3_backup sqlite3_backup_init( + @NotNull sqlite3 dbDest, @NotNull String destTableName, + @NotNull sqlite3 dbSrc, @NotNull String srcTableName + ); + + @Canonical + public static native int sqlite3_backup_pagecount(@NotNull sqlite3_backup b); + + @Canonical + public static native int sqlite3_backup_remaining(@NotNull sqlite3_backup b); + + @Canonical + public static native int sqlite3_backup_step( + @NotNull sqlite3_backup b, int nPage + ); + /** Results are undefined if data is not null and n<0 || n>=data.length. */ diff --git a/ext/jni/src/org/sqlite/jni/Tester1.java b/ext/jni/src/org/sqlite/jni/Tester1.java index 3245821d19..b7b8907aa2 100644 --- a/ext/jni/src/org/sqlite/jni/Tester1.java +++ b/ext/jni/src/org/sqlite/jni/Tester1.java @@ -1488,6 +1488,35 @@ public class Tester1 implements Runnable { affirm( null==sqlite3_keyword_name(n) ); } + private void testBackup(){ + final sqlite3 db1 = createNewDb(); + final sqlite3 db2 = createNewDb(); + + execSql(db1, new String[]{ + "pragma page_size=512; VACUUM;", + "create table t(a);", + "insert into t(a) values(1),(2),(3);" + }); + affirm( null==sqlite3_backup_init(db1,"main",db1,"main") ); + final sqlite3_backup b = sqlite3_backup_init(db2,"main",db1,"main"); + affirm( null!=b ); + int rc; + while( SQLITE_DONE!=(rc = sqlite3_backup_step(b, 1)) ){ + affirm( 0==rc ); + } + affirm( sqlite3_backup_pagecount(b) > 0 ); + rc = sqlite3_backup_finish(b); + sqlite3_close_v2(db1); + affirm( 0==rc ); + + final sqlite3_stmt stmt = prepare(db2,"SELECT sum(a) from t"); + sqlite3_step(stmt); + affirm( sqlite3_column_int(stmt,0) == 6 ); + + sqlite3_finalize(stmt); + sqlite3_close_v2(db2); + } + /* Copy/paste/rename this to add new tests. */ private void _testTemplate(){ final sqlite3 db = createNewDb(); diff --git a/ext/jni/src/org/sqlite/jni/sqlite3_backup.java b/ext/jni/src/org/sqlite/jni/sqlite3_backup.java new file mode 100644 index 0000000000..d8ba78aec8 --- /dev/null +++ b/ext/jni/src/org/sqlite/jni/sqlite3_backup.java @@ -0,0 +1,25 @@ +/* +** 2023-09-03 +** +** The author disclaims copyright to this source code. In place of +** a legal notice, here is a blessing: +** +** May you do good and not evil. +** May you find forgiveness for yourself and forgive others. +** May you share freely, never taking more than you give. +** +************************************************************************* +** This file is part of the JNI bindings for the sqlite3 C API. +*/ +package org.sqlite.jni; + +/** + A wrapper for passing C-level (sqlite3_backup*) instances around in + Java. These wrappers do not own their associated pointer, they + simply provide a type-safe way to communicate it between Java and C + via JNI. +*/ +public final class sqlite3_backup extends NativePointerHolder { + // Only invoked from JNI. + private sqlite3_backup(){} +} diff --git a/manifest b/manifest index eccf284707..94302f6df8 100644 --- a/manifest +++ b/manifest @@ -1,5 +1,5 @@ -C Export\sthe\ssqlite3_keyword_...()\sfamily\sof\sfunctions\sto\sJNI. -D 2023-09-03T09:28:45.568 +C Export\sthe\ssqlite3_backup_...()\sAPIs\sto\sJNI. +D 2023-09-03T10:23:03.357 F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1 F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea F LICENSE.md df5091916dbb40e6e9686186587125e1b2ff51f022cc334e886c19a0e9982724 @@ -237,8 +237,8 @@ F ext/icu/sqliteicu.h fa373836ed5a1ee7478bdf8a1650689294e41d0c89c1daab26e9ae78a3 F ext/jni/GNUmakefile 7bd7f0c28d664b71b08f9d8ff507eb8329f1f3e7b5d88f774f90a1a5259a3fe8 F ext/jni/README.md 1332b1fa27918bd5d9ca2d0d4f3ac3a6ab86b9e3699dc5bfe32904a027f3d2a9 F ext/jni/jar-dist.make 030aaa4ae71dd86e4ec5e7c1e6cd86f9dfa47c4592c070d2e35157e42498e1fa -F ext/jni/src/c/sqlite3-jni.c a873c29cc80b14dd775a75359f7a3973642e8d9a84a8f37e3bcb85ab426aa820 -F ext/jni/src/c/sqlite3-jni.h ff6f69ffc2ace23ac7a7628405efe9846e33586a4399bfe48cec846be79e39df +F ext/jni/src/c/sqlite3-jni.c cd5be50471af97c0bb422aa7e3cfdaa19158f6a56b6b93af9602039b6bf56434 +F ext/jni/src/c/sqlite3-jni.h b00eab4f5412849a05ba3cb5e44f0583e4698176a41c63bc1d7d425e7e89865a F ext/jni/src/org/sqlite/jni/AbstractCollationCallback.java 95e88ba04f4aac51ffec65693e878e234088b2f21b387f4e4285c8b72b33e436 F ext/jni/src/org/sqlite/jni/AggregateFunction.java 7312486bc65fecdb91753c0a4515799194e031f45edbe16a6373cea18f404dc4 F ext/jni/src/org/sqlite/jni/AuthorizerCallback.java e6135be32f12bf140bffa39be7fd1a45ad83b2661ed49c08dbde04c8485feb38 @@ -262,10 +262,10 @@ F ext/jni/src/org/sqlite/jni/ProgressHandlerCallback.java 7b9ff2218129ece98ba60c F ext/jni/src/org/sqlite/jni/ResultCode.java ba701f20213a5f259e94cfbfdd36eb7ac7ce7797f2c6c7fca2004ff12ce20f86 F ext/jni/src/org/sqlite/jni/RollbackHookCallback.java d12352c0e22840de484ffa9b11ed5058bb0daca2e9f218055d3c54c947a273c4 F ext/jni/src/org/sqlite/jni/SQLFunction.java 544a875d33fd160467d82e2397ac33157b29971d715a821a4fad3c899113ee8c -F ext/jni/src/org/sqlite/jni/SQLite3Jni.java b9dd5ba6b538648a27ed9c61217a5ae56645d0494b205b814fd488d375857984 +F ext/jni/src/org/sqlite/jni/SQLite3Jni.java 38126c76219a61ec19c972e1162b4fb4311b99f201fd986b262275dbdadeac9d F ext/jni/src/org/sqlite/jni/ScalarFunction.java 6d387bb499fbe3bc13c53315335233dbf6a0c711e8fa7c521683219b041c614c F ext/jni/src/org/sqlite/jni/TableColumnMetadata.java 54511b4297fa28dcb3f49b24035e34ced10e3fd44fd0e458e784f4d6b0096dab -F ext/jni/src/org/sqlite/jni/Tester1.java 410fd7e126847456011372e38977d4331888f054e8ca509545aab65e3c0ed96a +F ext/jni/src/org/sqlite/jni/Tester1.java 48ffe327cae2d599059cf4ec026bd3bf11d743efd6a13dc61b9c21122efc39c8 F ext/jni/src/org/sqlite/jni/TesterFts5.java 1d127690daac4751300b277a14c09faa0cefd1efa365580cd8d95ea658e1ee59 F ext/jni/src/org/sqlite/jni/TraceV2Callback.java beb0b064c1a5f8bfe585a324ed39a4e33edbe379a3fc60f1401661620d3ca7c0 F ext/jni/src/org/sqlite/jni/UpdateHookCallback.java 8376f4a931f2d5612b295c003c9515ba933ee76d8f95610e89c339727376e36c @@ -281,6 +281,7 @@ F ext/jni/src/org/sqlite/jni/fts5_extension_function.java bec9f17a7e784d57eca99d F ext/jni/src/org/sqlite/jni/fts5_tokenizer.java a92c2e55bda492e4c76d48ddc73369bcc0d5e8727940840f9339e3292ea58fa7 F ext/jni/src/org/sqlite/jni/package-info.java a3946db2504de747a1993c4f6e8ce604bec5a8e5a134b292c3b07527bc321a99 F ext/jni/src/org/sqlite/jni/sqlite3.java 62b1b81935ccf3393472d17cb883dc5ff39c388ec3bc1de547f098a0217158fc +F ext/jni/src/org/sqlite/jni/sqlite3_backup.java d0bb06dd6225e76999ff6b7ab20f2643b1c4d4167431b3a93ea41943e41f094b F ext/jni/src/org/sqlite/jni/sqlite3_context.java 66ca95ce904044263a4aff684abe262d56f73e6b06bca6cf650761d79d7779ad F ext/jni/src/org/sqlite/jni/sqlite3_stmt.java 78e6d1b95ac600a9475e9db4623f69449322b0c93d1bd4e1616e76ed547ed9fc F ext/jni/src/org/sqlite/jni/sqlite3_value.java 3d1d4903e267bc0bc81d57d21f5e85978eff389a1a6ed46726dbe75f85e6914a @@ -2116,8 +2117,8 @@ F vsixtest/vsixtest.tcl 6a9a6ab600c25a91a7acc6293828957a386a8a93 F vsixtest/vsixtest.vcxproj.data 2ed517e100c66dc455b492e1a33350c1b20fbcdc F vsixtest/vsixtest.vcxproj.filters 37e51ffedcdb064aad6ff33b6148725226cd608e F vsixtest/vsixtest_TemporaryKey.pfx e5b1b036facdb453873e7084e1cae9102ccc67a0 -P 652e2e82100ac3d8238d15ef6d43de4162fd02d695db4936ad5706fe4f2d7dc3 -R 7fd736a7d08745015fcc69ede4fd14cc +P bd554db39159d8a538ce913d55285e3c417db8823c717a3e34bfa0678de42be7 +R cb965cc2f3508a211c89a61afe16623f U stephan -Z b7483f74605eb1221b65312bed3e2257 +Z b11611848e8e630b2ee28833698b37c5 # Remove this line to create a well-formed Fossil manifest. diff --git a/manifest.uuid b/manifest.uuid index 4787060430..508721251c 100644 --- a/manifest.uuid +++ b/manifest.uuid @@ -1 +1 @@ -bd554db39159d8a538ce913d55285e3c417db8823c717a3e34bfa0678de42be7 \ No newline at end of file +865a3df5d550f6f4edbf95854750706e4e747d8f1825ae73d300b8e31934959b \ No newline at end of file