logging: adds memory scope (#1076)

This allows you to specify the memory scope amongst existing logging scopes, both in API and the CLI.

e.g for the CLI.
```bash
$ wazero run --hostlogging=memory,filesystem --mount=.:/:ro cat.wasm
```

e.g. for Go
```go
loggingCtx := context.WithValue(testCtx, experimental.FunctionListenerFactoryKey{},
	logging.NewHostLoggingListenerFactory(&log, logging.LogScopeMemory|logging.LogScopeFilesystem))
```

This is helpful for emscripten and gojs which have memory reset
callbacks. This will be much more interesting once #1075 is implemented.

Signed-off-by: Adrian Cole <adrian@tetrate.io>

internal/gojs/logging/logging.go

@@ -39,6 +39,13 @@ func IsInLogScope(fnd api.FunctionDefinition, scopes logging.LogScopes) bool {
 		}
 	}
 
+	if scopes.IsEnabled(logging.LogScopeMemory) {
+		switch fnd.Name() {
+		case custom.NameRuntimeResetMemoryDataView:
+			return true
+		}
+	}
+
 	if scopes.IsEnabled(logging.LogScopePoll) {
 		switch fnd.Name() {
 		case custom.NameRuntimeScheduleTimeoutEvent, custom.NameRuntimeClearTimeoutEvent:
@@ -60,9 +67,13 @@ func IsInLogScope(fnd api.FunctionDefinition, scopes logging.LogScopes) bool {
 
 func Config(fnd api.FunctionDefinition, scopes logging.LogScopes) (pSampler logging.ParamSampler, pLoggers []logging.ParamLogger, rLoggers []logging.ResultLogger) {
 	switch fnd.Name() {
-	case custom.NameRuntimeGetRandomData:
-		pLoggers = []logging.ParamLogger{runtimeGetRandomDataParamLogger}
+	case custom.NameRuntimeWasmExit:
+		pLoggers = []logging.ParamLogger{runtimeWasmExitParamLogger}
 		// no results
+	case custom.NameRuntimeWasmWrite:
+		return // Don't log NameRuntimeWasmWrite as it is used in panics
+	case custom.NameRuntimeResetMemoryDataView:
+		// no params or results
 	case custom.NameRuntimeNanotime1:
 		// no params
 		rLoggers = []logging.ResultLogger{runtimeNanotime1ResultLogger}
@@ -75,11 +86,9 @@ func Config(fnd api.FunctionDefinition, scopes logging.LogScopes) (pSampler logg
 	case custom.NameRuntimeClearTimeoutEvent:
 		pLoggers = []logging.ParamLogger{runtimeClearTimeoutEventParamLogger}
 		// no results
-	case custom.NameRuntimeWasmExit:
-		pLoggers = []logging.ParamLogger{runtimeWasmExitParamLogger}
+	case custom.NameRuntimeGetRandomData:
+		pLoggers = []logging.ParamLogger{runtimeGetRandomDataParamLogger}
 		// no results
-	case custom.NameRuntimeWasmWrite:
-		return // Don't log NameRuntimeWasmWrite as it is used in panics
 	case custom.NameSyscallValueCall:
 		pSampler = (&syscallValueCallParamSampler{scopes: scopes}).isSampled
 		pLoggers = []logging.ParamLogger{syscallValueCallParamLogger}

internal/gojs/logging/logging_test.go

@@ -22,6 +22,7 @@ func (f *testFunctionDefinition) Name() string {
 
 func TestIsInLogScope(t *testing.T) {
 	runtimeGetRandomData := &testFunctionDefinition{name: custom.NameRuntimeGetRandomData}
+	runtimeResetMemoryDataView := &testFunctionDefinition{name: custom.NameRuntimeResetMemoryDataView}
 	runtimeWasmExit := &testFunctionDefinition{name: custom.NameRuntimeWasmExit}
 	syscallValueCall := &testFunctionDefinition{name: custom.NameSyscallValueCall}
 	tests := []struct {
@@ -61,9 +62,33 @@ func TestIsInLogScope(t *testing.T) {
 			expected: true,
 		},
 		{
-			name:     "runtimeGetRandomData in LogScopeRandom",
-			fnd:      runtimeGetRandomData,
-			scopes:   logging.LogScopeRandom,
+			name:     "runtimeResetMemoryDataView in LogScopeMemory",
+			fnd:      runtimeResetMemoryDataView,
+			scopes:   logging.LogScopeMemory,
+			expected: true,
+		},
+		{
+			name:     "runtimeResetMemoryDataView not in LogScopeFilesystem",
+			fnd:      runtimeResetMemoryDataView,
+			scopes:   logging.LogScopeFilesystem,
+			expected: false,
+		},
+		{
+			name:     "runtimeResetMemoryDataView in LogScopeMemory|LogScopeFilesystem",
+			fnd:      runtimeResetMemoryDataView,
+			scopes:   logging.LogScopeMemory | logging.LogScopeFilesystem,
+			expected: true,
+		},
+		{
+			name:     "runtimeResetMemoryDataView not in LogScopeNone",
+			fnd:      runtimeResetMemoryDataView,
+			scopes:   logging.LogScopeNone,
+			expected: false,
+		},
+		{
+			name:     "runtimeResetMemoryDataView in LogScopeAll",
+			fnd:      runtimeResetMemoryDataView,
+			scopes:   logging.LogScopeAll,
 			expected: true,
 		},
 		{

internal/gojs/misc_test.go

@@ -45,11 +45,20 @@ consumer
 func Test_mem(t *testing.T) {
 	t.Parallel()
 
-	stdout, stderr, err := compileAndRun(testCtx, "mem", wazero.NewModuleConfig())
+	var log bytes.Buffer
+	loggingCtx := context.WithValue(testCtx, experimental.FunctionListenerFactoryKey{},
+		logging.NewHostLoggingListenerFactory(&log, logging.LogScopeMemory))
+
+	stdout, stderr, err := compileAndRun(loggingCtx, "mem", wazero.NewModuleConfig())
 
 	require.EqualError(t, err, `module "" closed with exit_code(0)`)
 	require.Zero(t, stderr)
 	require.Zero(t, stdout)
+
+	// The memory view is reset at least once.
+	require.Contains(t, log.String(), `==> go.runtime.resetMemoryDataView()
+<==
+`)
 }
 
 func Test_stdio(t *testing.T) {

internal/gojs/runtime.go

@@ -17,6 +17,8 @@ import (
 // See https://github.com/golang/go/blob/go1.19/src/cmd/link/internal/wasm/asm.go#L133-L138
 var Debug = goarch.StubFunction(custom.NameDebug)
 
+// TODO: should this call runtime.Breakpoint()?
+
 // WasmExit implements runtime.wasmExit which supports runtime.exit.
 //
 // See https://github.com/golang/go/blob/go1.19/src/runtime/sys_wasm.go#L28