// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd

#include <cstdint>
#include <string>
#include <type_traits>

#include <gtest/gtest.h>
#include "absl/log/absl_check.h"
#include "google/protobuf/descriptor.h"
#include "google/protobuf/generated_message_bases.h"
#include "google/protobuf/internal_metadata_locator.h"
#include "google/protobuf/port.h"
#include "google/protobuf/repeated_ptr_field.h"
#include "google/protobuf/unittest.pb.h"

// Must be included last.
#include "google/protobuf/port_def.inc"

namespace google {
namespace protobuf {
namespace compiler {
namespace cpp {

// Can't use an anonymous namespace here due to brokenness of Tru64 compiler.
namespace cpp_unittest {


#if !defined(ABSL_CHECK_MESSAGE_SIZE)
#define ABSL_CHECK_MESSAGE_SIZE(t, expected)
#endif

// Mock structures to lock down the size of messages in a platform-independent
// way.  The commented sizes only apply when build with clang x86_64.
struct MockMessageBase {
  virtual ~MockMessageBase() = default;  // 8 bytes vtable
  void* internal_metadata;               // 8 bytes
};
ABSL_CHECK_MESSAGE_SIZE(MockMessageBase, 16);

struct MockZeroFieldsBase : public MockMessageBase {
  int cached_size;  // 4 bytes
  // + 4 bytes padding
};
ABSL_CHECK_MESSAGE_SIZE(MockZeroFieldsBase, 24);

struct MockExtensionSet {
  void* data;        // 8 bytes
};
ABSL_CHECK_MESSAGE_SIZE(MockExtensionSet, 8);

struct MockRepeatedPtrField {
  int current_size;  // 4 bytes
  int total_size;    // 4 bytes
  void* data;        // 8 bytes
};
ABSL_CHECK_MESSAGE_SIZE(MockRepeatedPtrField, 16);

struct MockRepeatedField {
  internal::InternalMetadataResolver resolver;  // 4 bytes
  int size;                                     // 4 bytes
  union {                                       // 8 bytes
    void* heap_rep;
    uint8_t soo_capacity[internal::kSooCapacityBytes];
  };
};
ABSL_CHECK_MESSAGE_SIZE(MockRepeatedField, 16);

TEST(GeneratedMessageTest, MockSizes) {
  // Consistency checks -- if these fail, the tests below will definitely fail.
  ABSL_CHECK_EQ(sizeof(MessageLite), sizeof(MockMessageBase));
  ABSL_CHECK_EQ(sizeof(Message), sizeof(MockMessageBase));
  ABSL_CHECK_EQ(sizeof(internal::ZeroFieldsBase), sizeof(MockZeroFieldsBase));
  ABSL_CHECK_EQ(sizeof(internal::ExtensionSet), sizeof(MockExtensionSet));
  ABSL_CHECK_EQ(sizeof(RepeatedPtrField<std::string>),
                sizeof(MockRepeatedPtrField));
  ABSL_CHECK_EQ(sizeof(RepeatedField<int>), sizeof(MockRepeatedField));
}

TEST(GeneratedMessageTest, EmptyMessageSize) {
  EXPECT_EQ(sizeof(proto2_unittest::TestEmptyMessage),
            sizeof(MockZeroFieldsBase));
}

TEST(GeneratedMessageTest, ReservedSize) {
  EXPECT_EQ(sizeof(proto2_unittest::TestReservedFields),
            sizeof(MockZeroFieldsBase));
}

TEST(GeneratedMessageTest, EmptyMessageWithExtensionsSize) {
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    MockExtensionSet extensions;                   // 8 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
    // + 0-4 bytes of padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 32);
  EXPECT_EQ(sizeof(proto2_unittest::TestEmptyMessageWithExtensions),
            sizeof(MockGenerated));
}

struct MockLazy {
#if defined(PROTOBUF_INTERNAL_LAZY_FIELD_REFACTOR)
  void* ptr;
#else
  void* ptr[2];
#endif
};

TEST(GeneratedMessageTest, RecursiveMessageSize) {
  // TODO: remove once synthetic_pdproto lands.
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    void* a;                                       // 8 bytes
    int32_t i;                                     // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
    // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 40);

  struct MockGeneratedLazy : public MockMessageBase {  // 16 bytes
    int has_bits[1];                                   // 4 bytes
    int cached_size;                                   // 4 bytes
    MockLazy a;                                        // lazy, see above.
    int32_t i;                                         // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                      // 0-4 bytes
    // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGeneratedLazy, 32 + sizeof(MockLazy));

  struct MockGeneratedSplit : public MockMessageBase {  // 16 bytes
    int has_bits[1];                                    // 4 bytes
    int cached_size;                                    // 4 bytes
    void* split;                                        // 8 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                       // 0-4 bytes
    // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGeneratedSplit, 32);

#ifndef PROTOBUF_FORCE_SPLIT
  using Type = std::conditional_t<internal::ForceEagerlyVerifiedLazyInProtoc(),
                                  MockGeneratedLazy, MockGenerated>;
#else   // !PROTOBUF_FORCE_SPLIT
  using Type = MockGeneratedSplit;
#endif  // PROTOBUF_FORCE_SPLIT

  EXPECT_EQ(sizeof(proto2_unittest::TestRecursiveMessage), sizeof(Type));
}

TEST(GeneratedMessageTest, OneStringSize) {
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    void* data;                                    // 8 bytes
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 32);

  struct MockGeneratedInlinedString : public MockMessageBase {  // 16 bytes
    int has_bits[1];                                            // 4 bytes
    int cached_size;                                            // 4 bytes
    std::string data;              // sizeof(std::string)
    PROTOBUF_TSAN_DECLARE_MEMBER;  // 0-4 bytes
                                   // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGeneratedInlinedString, 48);

  using Type = std::conditional_t<internal::ForceInlineStringInProtoc(),
                                  MockGeneratedInlinedString, MockGenerated>;
  EXPECT_EQ(sizeof(proto2_unittest::OneString), sizeof(Type));
}

TEST(GeneratedMessageTest, MoreStringSize) {
  // TODO: remove once synthetic_pdproto lands.
#ifndef PROTOBUF_FORCE_SPLIT
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    MockRepeatedPtrField data;                     // 24 bytes
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 40);
  EXPECT_EQ(sizeof(proto2_unittest::MoreString), sizeof(MockGenerated));
#else   // !PROTOBUF_FORCE_SPLIT
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int cached_size;                               // 4 bytes
    void* split;                                   // 8 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 32);
  EXPECT_EQ(sizeof(proto2_unittest::MoreString), sizeof(MockGenerated));
#endif  // PROTOBUF_FORCE_SPLIT
}

TEST(GeneratedMessageTest, Int32MessageSize) {
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    int32_t data;                                  // 4 bytes
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 32);
  EXPECT_EQ(sizeof(proto2_unittest::Int32Message), sizeof(MockGenerated));
}

TEST(GeneratedMessageTest, Int64MessageSize) {
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    int64_t data;                                  // 8 bytes
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 32);
  EXPECT_EQ(sizeof(proto2_unittest::Int64Message), sizeof(MockGenerated));
}

TEST(GeneratedMessageTest, BoolMessageSize) {
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    bool data;                                     // 1 byte
    // + 3 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 32);
  EXPECT_EQ(sizeof(proto2_unittest::BoolMessage), sizeof(MockGenerated));
}

TEST(GeneratedMessageTest, OneofSize) {
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    void* foo;                                     // 8 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    uint32_t oneof_case[1];                        // 4 bytes
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 32);
  EXPECT_EQ(sizeof(proto2_unittest::TestOneof), sizeof(MockGenerated));
}

TEST(GeneratedMessageTest, Oneof2Size) {
  // TODO: remove once synthetic_pdproto lands.
#ifndef PROTOBUF_FORCE_SPLIT
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    void* baz_string;                              // 8 bytes
    int32_t baz_int;                               // 4 bytes
                                                   // + 4 bytes padding
    void* foo;                                     // 8 bytes
    void* bar;                                     // 8 bytes
    uint32_t oneof_case[2];                        // 8 bytes
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 64);
#else   // !PROTOBUF_FORCE_SPLIT
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
    void* split;                                   // 8 bytes
    void* foo;                                     // 8 bytes
    void* bar;                                     // 8 bytes
    uint32_t oneof_case[2];                        // 8 bytes
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 56);
#endif  // PROTOBUF_FORCE_SPLIT
  EXPECT_EQ(sizeof(proto2_unittest::TestOneof2), sizeof(MockGenerated));
}

TEST(GeneratedMessageTest, FieldOrderingsSize) {
  // TODO: remove once synthetic_pdproto lands.
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    MockExtensionSet extensions;                   // 8 bytes
    void* my_string;                               // 8 bytes
    void* optional_nested_message;                 // 8 bytes
    int64_t my_int;                                // 8 bytes
    float my_float;                                // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
    // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 64);

  struct MockGeneratedExperiments : public MockMessageBase {  // 16 bytes
    int has_bits[1];                                          // 4 bytes
    int cached_size;                                          // 4 bytes
    MockExtensionSet extensions;                              // 8 bytes
    std::string my_string;             // sizeof(std::string)
    MockLazy optional_nested_message;  // lazy, see above.
    int64_t my_int;                    // 8 bytes
    float my_float;                    // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;      // 0-4 bytes
    // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGeneratedExperiments, 72 + sizeof(MockLazy));

  struct MockGeneratedSplit : public MockMessageBase {  // 16 bytes
    int has_bits[1];                                    // 4 bytes
    int cached_size;                                    // 4 bytes
    MockExtensionSet extensions;                        // 8 bytes
    void* split;                                        // 8 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                       // 0-4 bytes
    // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGeneratedSplit, 40);

#ifndef PROTOBUF_FORCE_SPLIT
  // Make sure both or none are on for this test.
  ASSERT_EQ(internal::ForceEagerlyVerifiedLazyInProtoc(),
            internal::ForceInlineStringInProtoc());
  using Type = std::conditional_t<internal::ForceInlineStringInProtoc(),
                                  MockGeneratedExperiments, MockGenerated>;
#else   // !PROTOBUF_FORCE_SPLIT
  using Type = MockGeneratedSplit;
#endif  // PROTOBUF_FORCE_SPLIT
  EXPECT_EQ(sizeof(proto2_unittest::TestFieldOrderings), sizeof(Type));
}

TEST(GeneratedMessageTest, TestMessageSize) {
  // We expect the message to contain (not in this order):
  // TODO: remove once synthetic_pdproto lands.
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    void* m4;                                      // 8 bytes
    int64_t m2;                                    // 8 bytes
    bool m1;                                       // 1 bytes
    bool m3;                                       // 1 bytes
                                                   // + 2 bytes padding
    int m5;                                        // 4 bytes
    int64_t m6;                                    // 8 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
                                                   // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 56);

  struct MockGeneratedInlinedString : public MockMessageBase {  // 16 bytes
    int has_bits[1];                                            // 4 bytes
    int cached_size;                                            // 4 bytes
    std::string m4;                // sizeof(std::string)
    int64_t m2;                    // 8 bytes
    bool m1;                       // 1 bytes
    bool m3;                       // 1 bytes
                                   // + 2 bytes padding
    int m5;                        // 4 bytes
    int64_t m6;                    // 8 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;  // 0-4 bytes
                                   // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGeneratedInlinedString, 72);

  struct MockGeneratedSplit : public MockMessageBase {  // 16 bytes
    int has_bits[1];                                    // 4 bytes
    int cached_size;                                    // 4 bytes
    void* split;                                        // 8 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                       // 0-4 bytes
                                                        // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGeneratedSplit, 32);
#ifndef PROTOBUF_FORCE_SPLIT
  using Type = std::conditional_t<internal::ForceInlineStringInProtoc(),
                                  MockGeneratedInlinedString, MockGenerated>;
#else   // !PROTOBUF_FORCE_SPLIT
  using Type = MockGeneratedSplit;
#endif  // PROTOBUF_FORCE_SPLIT
  EXPECT_EQ(sizeof(proto2_unittest::TestMessageSize), sizeof(Type));
}

TEST(GeneratedMessageTest, PackedTypesSize) {
  // TODO: remove once synthetic_pdproto lands.
  struct MockGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes
    MockRepeatedField packed_int32;                // 16 bytes
    MockRepeatedField packed_int64;                // 16 bytes
    MockRepeatedField packed_uint32;               // 16 bytes
    MockRepeatedField packed_uint64;               // 16 bytes
    MockRepeatedField packed_sint32;               // 16 bytes
    MockRepeatedField packed_sint64;               // 16 bytes
    MockRepeatedField packed_fixed32;              // 16 bytes
    MockRepeatedField packed_fixed64;              // 16 bytes
    MockRepeatedField packed_sfixed32;             // 16 bytes
    MockRepeatedField packed_sfixed64;             // 16 bytes
    MockRepeatedField packed_float;                // 16 bytes
    MockRepeatedField packed_double;               // 16 bytes
    MockRepeatedField packed_bool;                 // 16 bytes
    MockRepeatedField packed_enum;                 // 16 bytes
    int packed_int32_cached_byte_size;             // 4 bytes
    int packed_int64_cached_byte_size;             // 4 bytes
    int packed_uint32_cached_byte_size;            // 4 bytes
    int packed_uint64_cached_byte_size;            // 4 bytes
    int packed_sint32_cached_byte_size;            // 4 bytes
    int packed_sint64_cached_byte_size;            // 4 bytes
    int packed_enum_cached_byte_size;              // 4 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
    // + 4-0 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockGenerated, 8 + 16 * 15 + 4 * 8);
  struct MockSplitGenerated : public MockMessageBase {  // 16 bytes
    int has_bits[1];                               // 4 bytes
    int cached_size;                               // 4 bytes + 4 bytes padding
    void* split;                                   // 8 bytes
    PROTOBUF_TSAN_DECLARE_MEMBER;                  // 0-4 bytes
    // + 0-4 bytes padding
  };
  ABSL_CHECK_MESSAGE_SIZE(MockSplitGenerated, 32);
  using T = std::conditional_t<internal::ForceSplitFieldsInProtoc(),
                               MockSplitGenerated, MockGenerated>;

  EXPECT_EQ(sizeof(proto2_unittest::TestPackedTypes), sizeof(T));
}

}  // namespace cpp_unittest
}  // namespace cpp
}  // namespace compiler
}  // namespace protobuf
}  // namespace google

#include "google/protobuf/port_undef.inc"
