Add validation caching interface.

src/trusted/validator/validation_cache_test.cc

+/*
+ * Copyright (c) 2012 The Native Client Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#include "gtest/gtest.h"
+
+#include "native_client/src/include/nacl_compiler_annotations.h"
+#include "native_client/src/shared/platform/nacl_log.h"
+#include "native_client/src/trusted/validator/ncvalidate.h"
+#include "native_client/src/trusted/validator/validation_cache.h"
+
+#define CODE_SIZE 32
+
+const char nop[CODE_SIZE+1] =

[Mark Seaborn, 2012/03/01 19:23:12]

space around '+'

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+    "\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90"
+    "\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90";
+
+// ret
+const char ret[CODE_SIZE+1] =
+    "\xc3\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90"
+    "\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90";
+
+// pblendw $0xc0,%xmm0,%xmm2
+const char sse41[CODE_SIZE+1] =
+    "\x66\x0f\x3a\x0e\xd0\xc0\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90"
+    "\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90\x90";
+
+struct MockContext {
+  /* Sanity check that we're getting the right object. */

[Mark Seaborn, 2012/03/01 19:23:12]

Putting the comment on the same line as 'int marker' would make it clearer what
it's referring to.

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  int marker;
+  int query_result;
+  int set_validates_expected;

[Mark Seaborn, 2012/03/01 19:23:12]

"expect_set_code_validates_call"?  This is C++, so you can use the "bool" type.

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  int query_destroyed;

[Mark Seaborn, 2012/03/01 19:23:12]

"bool"

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+};
+
+enum MockQueryState {
+  QUERY_CREATED,
+  QUERY_GET,

[Mark Seaborn, 2012/03/01 19:23:12]

QUERY_GET_CALLED, QUERY_SET_CALLED?

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  QUERY_SET,
+  QUERY_DESTROYED
+};
+
+struct MockQuery {
+  /* Sanity check that we're getting the right object. */
+  int marker;
+  MockQueryState state;
+  int add_count;
+  MockContext *context;
+};
+
+void *MockCreateQuery(void *handle) {
+  MockContext *mcontext = (MockContext *) handle;
+  MockQuery *mquery = (MockQuery *) malloc(sizeof(MockQuery));
+  EXPECT_EQ(31, mcontext->marker);

[Mark Seaborn, 2012/03/01 19:23:12]

Magic number, move to enum/const

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  mquery->marker = 37;

[Mark Seaborn, 2012/03/01 19:23:12]

Ditto - magic number

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  mquery->state = QUERY_CREATED;
+  mquery->add_count = 0;
+  mquery->context = mcontext;
+  return mquery;
+}
+
+void MockAddData(void *query, const unsigned char *data, size_t length) {
+  MockQuery *mquery = (MockQuery *) query;
+  ASSERT_EQ(37, mquery->marker);
+  UNREFERENCED_PARAMETER(data);

[Mark Seaborn, 2012/03/01 19:23:12]

These should go as close to the function start as possible.

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  EXPECT_EQ(QUERY_CREATED, mquery->state);
+  /* Small data is supicious. */

[Mark Seaborn, 2012/03/01 19:23:12]

'suspicious'

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  EXPECT_LE((size_t) 2, length);
+  mquery->add_count += 1;
+}
+
+int MockQueryCodeValidates(void *query) {
+  MockQuery *mquery = (MockQuery *) query;
+  EXPECT_EQ(37, mquery->marker);
+  EXPECT_EQ(QUERY_CREATED, mquery->state);
+  /* Less than two pieces of data is suspicious. */
+  EXPECT_LE(2, mquery->add_count);
+  mquery->state = QUERY_GET;
+  return mquery->context->query_result;
+}
+
+void MockSetCodeValidates(void *query) {
+  MockQuery *mquery = (MockQuery *) query;
+  ASSERT_EQ(37, mquery->marker);
+  EXPECT_EQ(QUERY_GET, mquery->state);
+  EXPECT_EQ(1, mquery->context->set_validates_expected);
+  mquery->state = QUERY_SET;
+}
+
+void MockDestroyQuery(void *query) {
+  MockQuery *mquery = (MockQuery *) query;
+  ASSERT_EQ(37, mquery->marker);
+  if (mquery->context->set_validates_expected) {
+    EXPECT_EQ(QUERY_SET, mquery->state);
+  } else {
+    EXPECT_EQ(QUERY_GET, mquery->state);
+  }
+  mquery->state = QUERY_DESTROYED;
+  mquery->context->query_destroyed = 1;
+  free(mquery);
+}
+
+class ValidationCachingInterfaceTests : public ::testing::Test {
+ protected:
+  MockContext context;
+  NaClValidationCache cache;
+  NaClCPUFeatures cpu_features;
+  int bundle_size;
+
+  unsigned char code_buffer[32];

[Mark Seaborn, 2012/03/01 19:23:12]

32 -> CODE_SIZE

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+
+  void SetUp() {
+    context.marker = 31;
+    context.query_result = 1;
+    context.set_validates_expected = 0;
+    context.query_destroyed = 0;
+
+    cache.handle = &context;
+    cache.CreateQuery = MockCreateQuery;
+    cache.AddData = MockAddData;
+    cache.QueryCodeValidates = MockQueryCodeValidates;
+    cache.SetCodeValidates = MockSetCodeValidates;
+    cache.DestroyQuery = MockDestroyQuery;
+
+    NaClSetAllCPUFeatures(&cpu_features);
+
+    bundle_size = 32;
+
+    memset(code_buffer, 0x90, 32);

[Mark Seaborn, 2012/03/01 19:23:12]

32 -> sizeof(code_buffer) or CODE_SIZE

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  }
+
+  NaClValidationStatus Validate() {
+    return NACL_SUBARCH_NAME(ApplyValidator,
+                             NACL_TARGET_ARCH,
+                             NACL_TARGET_SUBARCH)(
+                                 NACL_SB_DEFAULT,
+                                 NaClApplyCodeValidation,
+                                 0, code_buffer, 32,
+                                 bundle_size, &cpu_features,
+                                 &cache);
+  }
+};
+
+TEST_F(ValidationCachingInterfaceTests, Sanity) {
+  void *query = cache.CreateQuery(cache.handle);
+  cache.AddData(query, 0, 6);

[Mark Seaborn, 2012/03/01 19:23:12]

0 -> NULL

[Nick Bray (chromium), 2012/03/01 21:16:58]

Done.

+  cache.AddData(query, 0, 128);
+  EXPECT_EQ(1, cache.QueryCodeValidates(query));
+  cache.DestroyQuery(query);
+  EXPECT_EQ(1, context.query_destroyed);
+}
+
+TEST_F(ValidationCachingInterfaceTests, NoCache) {
+  NaClValidationStatus status =
+      NACL_SUBARCH_NAME(ApplyValidator,
+                        NACL_TARGET_ARCH,
+                        NACL_TARGET_SUBARCH)(
+                            NACL_SB_DEFAULT,
+                            NaClApplyCodeValidation,
+                            0, code_buffer, CODE_SIZE,
+                            bundle_size, &cpu_features,
+                            NULL);
+  EXPECT_EQ(NaClValidationSucceeded, status);
+}
+
+TEST_F(ValidationCachingInterfaceTests, CacheHit) {
+  NaClValidationStatus status = Validate();
+  EXPECT_EQ(NaClValidationSucceeded, status);
+  EXPECT_EQ(1, context.query_destroyed);
+}
+
+TEST_F(ValidationCachingInterfaceTests, CacheMiss) {
+  context.query_result = 0;
+  context.set_validates_expected = 1;
+  NaClValidationStatus status = Validate();
+  EXPECT_EQ(NaClValidationSucceeded, status);
+  EXPECT_EQ(1, context.query_destroyed);
+}
+
+TEST_F(ValidationCachingInterfaceTests, SSE4Allowed) {
+  memcpy(code_buffer, sse41, CODE_SIZE);
+  context.query_result = 0;
+  context.set_validates_expected = 1;
+  NaClValidationStatus status = Validate();
+  EXPECT_EQ(NaClValidationSucceeded, status);
+  EXPECT_EQ(1, context.query_destroyed);
+}
+
+TEST_F(ValidationCachingInterfaceTests, SSE4Stubout) {
+  memcpy(code_buffer, sse41, CODE_SIZE);
+  context.query_result = 0;
+  NaClSetCPUFeature(&cpu_features, NaClCPUFeature_SSE41, 0);
+  NaClValidationStatus status = Validate();
+  EXPECT_EQ(NaClValidationSucceeded, status);
+  EXPECT_EQ(1, context.query_destroyed);
+}
+
+TEST_F(ValidationCachingInterfaceTests, IllegalInst) {
+  memcpy(code_buffer, ret, CODE_SIZE);
+  context.query_result = 0;
+  NaClValidationStatus status = Validate();
+  EXPECT_EQ(NaClValidationFailed, status);
+  EXPECT_EQ(1, context.query_destroyed);
+}
+
+TEST_F(ValidationCachingInterfaceTests, IllegalCacheHit) {
+  memcpy(code_buffer, ret, CODE_SIZE);
+  NaClValidationStatus status = Validate();
+  // Success proves the cache shortcircuted validation.
+  EXPECT_EQ(NaClValidationSucceeded, status);
+  EXPECT_EQ(1, context.query_destroyed);
+}
+
+// Test driver function.
+int main(int argc, char *argv[]) {
+  // The IllegalInst test touches the log mutex deep inside the validator.
+  // This causes an SEH exception to be thrown on Windows if the mutex is not
+  // initialized.
+  // http://code.google.com/p/nativeclient/issues/detail?id=1696
+  NaClLogModuleInit();
+  testing::InitGoogleTest(&argc, argv);
+  return RUN_ALL_TESTS();
+}