Problem with sqlite3_create_function_v2

[gwenn]

Hello,
I am getting the following error when calling sqlite3_create_function_v2:

21: misuse at line 134792 of [e9bb4cf40f]

https://www.sqlite.org/2016/sqlite-autoconf-3120000.tar.gz

  if( zFunctionName==0 ||
      (xSFunc && (xFinal || xStep)) || 
      (!xSFunc && (xFinal && !xStep)) ||
      (!xSFunc && (!xFinal && xStep)) ||
      (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
      (255<(nName = sqlite3Strlen30( zFunctionName))) ){
    return SQLITE_MISUSE_BKPT; // line 134792
  }

https://github.com/gwenn/sqlite-jna/blob/jnr/src/main/java/org/sqlite/SQLite.java#L769

@IgnoreError
int sqlite3_create_function_v2(@In Pointer pDb, @In @Encoding("UTF-8")String functionName, int nArg, int eTextRep, @In Pointer pApp, @In ScalarCallback xFunc, @In AggregateStepCallback xStep, @In AggregateFinalCallback xFinal, @In Pointer xDestroy);

https://github.com/gwenn/sqlite-jna/blob/jnr/src/main/java/org/sqlite/SQLite.java#L379

static int sqlite3_create_function_v2(Pointer pDb, String functionName, int nArg, int eTextRep, Pointer pApp, ScalarCallback xFunc, AggregateStepCallback xStep, AggregateFinalCallback xFinal, Pointer xDestroy) {
    return library.sqlite3_create_function_v2(pDb, functionName, nArg, eTextRep, pApp, xFunc, xStep, xFinal, xDestroy);
}

If I manually change the signature and force callback(s) to be null, it works:

static int sqlite3_create_function_v2(Pointer pDb, String functionName, int nArg, int eTextRep, Pointer pApp, ScalarCallback xFunc, AggregateStepCallback xStep, AggregateFinalCallback xFinal, Pointer xDestroy) {
    return library.sqlite3_create_function_v2(pDb, functionName, nArg, eTextRep, pApp, null, xStep, xFinal, xDestroy);
}
// ...
@IgnoreError
int sqlite3_create_function_v2(@In Pointer pDb, @In @Encoding("UTF-8")String functionName, int nArg, int eTextRep, @In Pointer pApp, @In Pointer xFunc, @In AggregateStepCallback xStep, @In AggregateFinalCallback xFinal, @In Pointer xDestroy);

or

static int sqlite3_create_function_v2(Pointer pDb, String functionName, int nArg, int eTextRep, Pointer pApp, ScalarCallback xFunc, AggregateStepCallback xStep, AggregateFinalCallback xFinal, Pointer xDestroy) {
    return library.sqlite3_create_function_v2(pDb, functionName, nArg, eTextRep, pApp, xFunc, null, null, xDestroy);
}
// ...
@IgnoreError
int sqlite3_create_function_v2(@In Pointer pDb, @In @Encoding("UTF-8")String functionName, int nArg, int eTextRep, @In Pointer pApp, @In ScalarCallback xFunc, @In Pointer xStep, @In Pointer xFinal, @In Pointer xDestroy);

It seems that JNR is passing a non-null function pointer to C even when the Java callback/delegate is null.
Regards.

[pepijnve]

@gwenn I ran into the same problem while trying to convert your sqlite-jna library to jnr. It seems that JNR instantiates a native trampoline and passes a pointer to it on the native function even if the Java callback object is null.
At https://github.com/jnr/jnr-ffi/blob/master/src/main/java/jnr/ffi/provider/jffi/NativeClosureManager.java#L95 I added

if (value == null) {
  return null;
}

at the beginning of ClosureSite#toNative and that seems to resolve the issue.

I haven't found a way to intercept this via the public API so this will have to get fixed in JNR itself. Would be good to get confirmation from one of the JNR maintainers that passing null for callback parameters is indeed not working correctly yet.

[gwenn]

@pepijnve On my side, I fixed the issue with this commit gwenn/sqlite-jna@1593a96
Regards.

[headius]

#77 has been merged, so I believe the next jnr-ffi release will work properly here.

Hoping to wrap up this and other PRs by end of week, so we can put out a 2.0.10 (or 2.1).