capi: Import inspection functions #683

gumb0 · 2021-01-07T12:04:57Z

Split from #675

codecov · 2021-01-07T12:38:38Z

Codecov Report

Merging #683 (87a195d) into master (3c1c6ce) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           master     #683    +/-   ##
========================================
  Coverage   99.30%   99.30%            
========================================
  Files          72       72            
  Lines       10312    10420   +108     
========================================
+ Hits        10240    10348   +108     
  Misses         72       72

Flag	Coverage Δ
spectests	`91.50% <ø> (ø)`
unittests	`99.30% <100.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
lib/fizzy/capi.cpp	`98.84% <100.00%> (+0.12%)`	⬆️
test/unittests/capi_test.cpp	`100.00% <100.00%> (ø)`

chfast · 2021-01-14T10:21:44Z

include/fizzy/fizzy.h

@@ -133,6 +133,33 @@ typedef struct FizzyExternalGlobal
    FizzyGlobalType type;
 } FizzyExternalGlobal;

+/// External kind.
+typedef enum FizzyExternalKind


Please compare with https://github.com/WebAssembly/wasm-c-api/blob/master/include/wasm.h#L254-L260.

What do you mean? They're quite similar except that I use full word for "function" and list them in the order of the spec.

They use uint8_t storage type. So it could be used in C++ directly. Or wrap it in C++ for better control.

typedef uint8_t wasm_externkind_t; enum wasm_externkind_enum { WASM_EXTERN_FUNC, WASM_EXTERN_GLOBAL, WASM_EXTERN_TABLE, WASM_EXTERN_MEMORY, }; // C++ enum class ExternalKind : wasm_externkind_t { func = WASM_EXTERN_FUNC, global = WASM_EXTERN_GLOBAL, table = WASM_EXTERN_TABLE, memory = WASM_EXTERN_MEMORY, };

This may be done other day, but I'm suggesting exploring the design where some declarations are imported from C to C++ instead of only declaring C equivalents of C++ ones.

Hmm, this could have been done for FizzyValueType, too 🤔

True. We may go old-school in this PR and then consider conversion. This probably requires off-site discussion.

I use full word for "function"

I like this better.

list them in the order of the spec.

So is the wasm-c-api not in order with the spec?

list them in the order of the spec.

So is the wasm-c-api not in order with the spec?

Yeah, there it's func-global-table-memory.

axic · 2021-01-26T18:38:04Z

include/fizzy/fizzy.h

+///
+/// @note Only one member of FizzyImportDescription::desc union corresponding to
+/// FizzyImportDescription::kind is defined for each import.
+typedef struct FizzyImportDescription


Do we need to mention the lifetime of module/name here? It is explained in fizzy_get_import_description.

Perhaps what we could note here is that the user should refer to the documentation from the function returning this value about lifetimes:

Suggested change

typedef struct FizzyImportDescription

//// For the lifetime of the #module and #kind fields, please refer to the description provided by the function used to obtain this structure.

typedef struct FizzyImportDescription

Is #module the correct way?

Yes, #module and #name worked, but I needed to add individual documentation to the members.

axic · 2021-01-26T18:44:04Z

test/unittests/capi_test.cpp

+    fizzy_free_module(module);
+}
+
+TEST(capi, import_name_after_instantiate)


Is this testing the lifetime of the name/namespace pointers?

Yes, checks that it's alive after instantiation, as the documentation claims.

axic · 2021-01-26T18:44:45Z

test/unittests/capi_test.cpp

+{
+    /* wat2wasm
+      (func (import "m" "f1") (result i32))
+      (func (import "m" "f2") (param i64))


Would it make any difference in coverage having a case with multiple params and a result at the same time? Don't want to overcomplicate tests either.

I'll add it for completeness.

axic

Looks good in general, but please squash the renaming commit. Added some smaller remarks.

axic · 2021-01-26T18:48:15Z

include/fizzy/fizzy.h

+/// FizzyImportDescription::kind is defined for each import.
+typedef struct FizzyImportDescription
+{
+    const char* module;


These fields are documented in #686. It should be consistent, either document here too, or not in #686.

axic · 2021-01-26T19:05:43Z

lib/fizzy/capi.cpp

+        c_import_description.desc.memory_limits = wrap(import.desc.memory.limits);
+        break;
+    case FizzyExternalKindGlobal:
+        c_import_description.desc.global_type = wrap(import.desc.global);


~~Hmm, shouldn't this be wrap(import.desc.global.type)?~~

Never mind I see it includes both type and mutability.

gumb0 mentioned this pull request Jan 7, 2021

capi: Type and global inspection functions #675

Merged

gumb0 changed the title ~~capi: Add functions to access import definitions in module~~ capi: Import inspection functions Jan 7, 2021

gumb0 mentioned this pull request Jan 7, 2021

Public C API #558

Open

49 tasks

gumb0 force-pushed the capi-import-inspection branch 2 times, most recently from 4c1101c to f8e37a7 Compare January 12, 2021 15:35

chfast reviewed Jan 14, 2021

View reviewed changes

axic reviewed Jan 26, 2021

View reviewed changes

axic approved these changes Jan 26, 2021

View reviewed changes

axic mentioned this pull request Jan 26, 2021

capi: Export inspection functions #686

Merged

axic reviewed Jan 26, 2021

View reviewed changes

gumb0 force-pushed the capi-import-inspection branch 2 times, most recently from 993c5a7 to b4aa0e9 Compare January 26, 2021 18:59

axic reviewed Jan 26, 2021

View reviewed changes

capi: Add functions to access import definitions in module

87a195d

gumb0 force-pushed the capi-import-inspection branch from b4aa0e9 to 87a195d Compare January 26, 2021 19:20

axic approved these changes Jan 26, 2021

View reviewed changes

gumb0 merged commit 43dcc2b into master Jan 26, 2021

gumb0 deleted the capi-import-inspection branch January 26, 2021 19:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

capi: Import inspection functions #683

capi: Import inspection functions #683

gumb0 commented Jan 7, 2021

codecov bot commented Jan 7, 2021 •

edited

Loading

chfast Jan 14, 2021

gumb0 Jan 18, 2021

chfast Jan 19, 2021

gumb0 Jan 20, 2021

chfast Jan 21, 2021

axic Jan 26, 2021

gumb0 Jan 26, 2021

axic Jan 26, 2021 •

edited

Loading

gumb0 Jan 26, 2021

axic Jan 26, 2021

gumb0 Jan 26, 2021

axic Jan 26, 2021

gumb0 Jan 26, 2021

axic left a comment

axic Jan 26, 2021

axic Jan 26, 2021 •

edited

Loading

	typedef struct FizzyImportDescription
	//// For the lifetime of the #module and #kind fields, please refer to the description provided by the function used to obtain this structure.
	typedef struct FizzyImportDescription

capi: Import inspection functions #683

capi: Import inspection functions #683

Conversation

gumb0 commented Jan 7, 2021

codecov bot commented Jan 7, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

axic Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

axic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

axic Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 7, 2021 •

edited

Loading

axic Jan 26, 2021 •

edited

Loading

axic Jan 26, 2021 •

edited

Loading