protobuf/upbc/protoc-gen-upb.cc

// Copyright (c) 2009-2021, Google LLC
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Google LLC nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include <memory>

#include "absl/container/flat_hash_map.h"
#include "absl/container/flat_hash_set.h"
#include "absl/strings/ascii.h"
#include "absl/strings/substitute.h"
#include "google/protobuf/compiler/code_generator.h"
#include "google/protobuf/compiler/plugin.h"
#include "google/protobuf/descriptor.h"
#include "google/protobuf/descriptor.pb.h"
#include "google/protobuf/wire_format.h"
#include "upb/mini_table.hpp"
#include "upb/upb.hpp"
#include "upbc/common.h"

// Must be last.
#include "upb/port_def.inc"

namespace upbc {
namespace {

namespace protoc = ::google::protobuf::compiler;
namespace protobuf = ::google::protobuf;

// Returns fields in order of "hotness", eg. how frequently they appear in
// serialized payloads. Ideally this will use a profile. When we don't have
// that, we assume that fields with smaller numbers are used more frequently.
inline std::vector<const google::protobuf::FieldDescriptor*> FieldHotnessOrder(
    const google::protobuf::Descriptor* message) {
  std::vector<const google::protobuf::FieldDescriptor*> fields;
  for (int i = 0; i < message->field_count(); i++) {
    fields.push_back(message->field(i));
  }
  std::sort(fields.begin(), fields.end(),
            [](const google::protobuf::FieldDescriptor* a,
               const google::protobuf::FieldDescriptor* b) {
              return std::make_pair(!a->is_required(), a->number()) <
                     std::make_pair(!b->is_required(), b->number());
            });
  return fields;
}

std::string SourceFilename(const google::protobuf::FileDescriptor* file) {
  return StripExtension(file->name()) + ".upb.c";
}

std::string MessageInit(const protobuf::Descriptor* descriptor) {
  return MessageName(descriptor) + "_msginit";
}

std::string EnumInit(const protobuf::EnumDescriptor* descriptor) {
  return ToCIdent(descriptor->full_name()) + "_enuminit";
}

std::string ExtensionIdentBase(const protobuf::FieldDescriptor* ext) {
  assert(ext->is_extension());
  std::string ext_scope;
  if (ext->extension_scope()) {
    return MessageName(ext->extension_scope());
  } else {
    return ToCIdent(ext->file()->package());
  }
}

std::string ExtensionLayout(const google::protobuf::FieldDescriptor* ext) {
  return absl::StrCat(ExtensionIdentBase(ext), "_", ext->name(), "_ext");
}

const char* kEnumsInit = "enums_layout";
const char* kExtensionsInit = "extensions_layout";
const char* kMessagesInit = "messages_layout";

void AddEnums(const protobuf::Descriptor* message,
              std::vector<const protobuf::EnumDescriptor*>* enums) {
  enums->reserve(enums->size() + message->enum_type_count());
  for (int i = 0; i < message->enum_type_count(); i++) {
    enums->push_back(message->enum_type(i));
  }
  for (int i = 0; i < message->nested_type_count(); i++) {
    AddEnums(message->nested_type(i), enums);
  }
}

std::vector<const protobuf::EnumDescriptor*> SortedEnums(
    const protobuf::FileDescriptor* file) {
  std::vector<const protobuf::EnumDescriptor*> enums;
  enums.reserve(file->enum_type_count());
  for (int i = 0; i < file->enum_type_count(); i++) {
    enums.push_back(file->enum_type(i));
  }
  for (int i = 0; i < file->message_type_count(); i++) {
    AddEnums(file->message_type(i), &enums);
  }
  return enums;
}

std::vector<int32_t> SortedUniqueEnumNumbers(
    const protobuf::EnumDescriptor* e) {
  std::vector<int32_t> values;
  values.reserve(e->value_count());
  for (int i = 0; i < e->value_count(); i++) {
    values.push_back(e->value(i)->number());
  }
  std::sort(values.begin(), values.end());
  auto last = std::unique(values.begin(), values.end());
  values.erase(last, values.end());
  return values;
}

void AddMessages(const protobuf::Descriptor* message,
                 std::vector<const protobuf::Descriptor*>* messages) {
  messages->push_back(message);
  for (int i = 0; i < message->nested_type_count(); i++) {
    AddMessages(message->nested_type(i), messages);
  }
}

// Ordering must match upb/def.c!
//
// The ordering is significant because each upb_MessageDef* will point at the
// corresponding upb_MiniTable and we just iterate through the list without
// any search or lookup.
std::vector<const protobuf::Descriptor*> SortedMessages(
    const protobuf::FileDescriptor* file) {
  std::vector<const protobuf::Descriptor*> messages;
  for (int i = 0; i < file->message_type_count(); i++) {
    AddMessages(file->message_type(i), &messages);
  }
  return messages;
}

void AddExtensionsFromMessage(
    const protobuf::Descriptor* message,
    std::vector<const protobuf::FieldDescriptor*>* exts) {
  for (int i = 0; i < message->extension_count(); i++) {
    exts->push_back(message->extension(i));
  }
  for (int i = 0; i < message->nested_type_count(); i++) {
    AddExtensionsFromMessage(message->nested_type(i), exts);
  }
}

// Ordering must match upb/def.c!
//
// The ordering is significant because each upb_FieldDef* will point at the
// corresponding upb_MiniTable_Extension and we just iterate through the list
// without any search or lookup.
std::vector<const protobuf::FieldDescriptor*> SortedExtensions(
    const protobuf::FileDescriptor* file) {
  std::vector<const protobuf::FieldDescriptor*> ret;
  for (int i = 0; i < file->extension_count(); i++) {
    ret.push_back(file->extension(i));
  }
  for (int i = 0; i < file->message_type_count(); i++) {
    AddExtensionsFromMessage(file->message_type(i), &ret);
  }
  return ret;
}

std::vector<const protobuf::FieldDescriptor*> FieldNumberOrder(
    const protobuf::Descriptor* message) {
  std::vector<const protobuf::FieldDescriptor*> fields;
  for (int i = 0; i < message->field_count(); i++) {
    fields.push_back(message->field(i));
  }
  std::sort(fields.begin(), fields.end(),
            [](const protobuf::FieldDescriptor* a,
               const protobuf::FieldDescriptor* b) {
              return a->number() < b->number();
            });
  return fields;
}

std::string EnumValueSymbol(const protobuf::EnumValueDescriptor* value) {
  return ToCIdent(value->full_name());
}

std::string CTypeInternal(const protobuf::FieldDescriptor* field,
                          bool is_const) {
  std::string maybe_const = is_const ? "const " : "";
  switch (field->cpp_type()) {
    case protobuf::FieldDescriptor::CPPTYPE_MESSAGE: {
      std::string maybe_struct =
          field->file() != field->message_type()->file() ? "struct " : "";
      return maybe_const + maybe_struct + MessageName(field->message_type()) +
             "*";
    }
    case protobuf::FieldDescriptor::CPPTYPE_BOOL:
      return "bool";
    case protobuf::FieldDescriptor::CPPTYPE_FLOAT:
      return "float";
    case protobuf::FieldDescriptor::CPPTYPE_INT32:
    case protobuf::FieldDescriptor::CPPTYPE_ENUM:
      return "int32_t";
    case protobuf::FieldDescriptor::CPPTYPE_UINT32:
      return "uint32_t";
    case protobuf::FieldDescriptor::CPPTYPE_DOUBLE:
      return "double";
    case protobuf::FieldDescriptor::CPPTYPE_INT64:
      return "int64_t";
    case protobuf::FieldDescriptor::CPPTYPE_UINT64:
      return "uint64_t";
    case protobuf::FieldDescriptor::CPPTYPE_STRING:
      return "upb_StringView";
    default:
      fprintf(stderr, "Unexpected type");
      abort();
  }
}

std::string SizeLg2(const protobuf::FieldDescriptor* field) {
  switch (field->cpp_type()) {
    case protobuf::FieldDescriptor::CPPTYPE_MESSAGE:
      return "UPB_SIZE(2, 3)";
    case protobuf::FieldDescriptor::CPPTYPE_ENUM:
      return std::to_string(2);
    case protobuf::FieldDescriptor::CPPTYPE_BOOL:
      return std::to_string(1);
    case protobuf::FieldDescriptor::CPPTYPE_FLOAT:
      return std::to_string(2);
    case protobuf::FieldDescriptor::CPPTYPE_INT32:
      return std::to_string(2);
    case protobuf::FieldDescriptor::CPPTYPE_UINT32:
      return std::to_string(2);
    case protobuf::FieldDescriptor::CPPTYPE_DOUBLE:
      return std::to_string(3);
    case protobuf::FieldDescriptor::CPPTYPE_INT64:
      return std::to_string(3);
    case protobuf::FieldDescriptor::CPPTYPE_UINT64:
      return std::to_string(3);
    case protobuf::FieldDescriptor::CPPTYPE_STRING:
      return "UPB_SIZE(3, 4)";
    default:
      fprintf(stderr, "Unexpected type");
      abort();
  }
}

bool HasNonZeroDefault(const protobuf::FieldDescriptor* field) {
  switch (field->cpp_type()) {
    case protobuf::FieldDescriptor::CPPTYPE_MESSAGE:
      return false;
    case protobuf::FieldDescriptor::CPPTYPE_STRING:
      return !field->default_value_string().empty();
    case protobuf::FieldDescriptor::CPPTYPE_INT32:
      return field->default_value_int32() != 0;
    case protobuf::FieldDescriptor::CPPTYPE_INT64:
      return field->default_value_int64() != 0;
    case protobuf::FieldDescriptor::CPPTYPE_UINT32:
      return field->default_value_uint32() != 0;
    case protobuf::FieldDescriptor::CPPTYPE_UINT64:
      return field->default_value_uint64() != 0;
    case protobuf::FieldDescriptor::CPPTYPE_FLOAT:
      return field->default_value_float() != 0;
    case protobuf::FieldDescriptor::CPPTYPE_DOUBLE:
      return field->default_value_double() != 0;
    case protobuf::FieldDescriptor::CPPTYPE_BOOL:
      return field->default_value_bool() != false;
    case protobuf::FieldDescriptor::CPPTYPE_ENUM:
      // Use a number instead of a symbolic name so that we don't require
      // this enum's header to be included.
      return field->default_value_enum()->number() != 0;
  }
  ABSL_ASSERT(false);
  return false;
}

std::string FieldDefault(const protobuf::FieldDescriptor* field) {
  switch (field->cpp_type()) {
    case protobuf::FieldDescriptor::CPPTYPE_MESSAGE:
      return "NULL";
    case protobuf::FieldDescriptor::CPPTYPE_STRING:
      return absl::Substitute("upb_StringView_FromString(\"$0\")",
                              absl::CEscape(field->default_value_string()));
    case protobuf::FieldDescriptor::CPPTYPE_INT32:
      return absl::Substitute("_upb_Int32_FromI($0)",
                              field->default_value_int32());
    case protobuf::FieldDescriptor::CPPTYPE_INT64:
      return absl::Substitute("_upb_Int64_FromLL($0ll)",
                              field->default_value_int64());
    case protobuf::FieldDescriptor::CPPTYPE_UINT32:
      return absl::Substitute("_upb_UInt32_FromU($0u)",
                              field->default_value_uint32());
    case protobuf::FieldDescriptor::CPPTYPE_UINT64:
      return absl::Substitute("_upb_UInt64_FromULL($0ull)",
                              field->default_value_uint64());
    case protobuf::FieldDescriptor::CPPTYPE_FLOAT:
      return absl::StrCat(field->default_value_float());
    case protobuf::FieldDescriptor::CPPTYPE_DOUBLE:
      return absl::StrCat(field->default_value_double());
    case protobuf::FieldDescriptor::CPPTYPE_BOOL:
      return field->default_value_bool() ? "true" : "false";
    case protobuf::FieldDescriptor::CPPTYPE_ENUM:
      // Use a number instead of a symbolic name so that we don't require
      // this enum's header to be included.
      return absl::StrCat(field->default_value_enum()->number());
  }
  ABSL_ASSERT(false);
  return "XXX";
}

std::string CType(const protobuf::FieldDescriptor* field) {
  return CTypeInternal(field, false);
}

std::string CTypeConst(const protobuf::FieldDescriptor* field) {
  return CTypeInternal(field, true);
}

////////////////////////////////////////////////////////////////////////////////
// FilePlatformLayout
////////////////////////////////////////////////////////////////////////////////

// FilePlatformLayout builds and vends upb MiniTables for a given platform (32
// or 64 bit).
class FilePlatformLayout {
 public:
  FilePlatformLayout(const protobuf::FileDescriptor* fd,
                     upb_MiniTablePlatform platform)
      : platform_(platform) {
    BuildMiniTables(fd);
    BuildExtensions(fd);
  }

  // Retrieves a upb MiniTable or Extension given a protobuf descriptor.  The
  // descriptor must be from this layout's file.
  upb_MiniTable* GetMiniTable(const protobuf::Descriptor* m) const;
  const upb_MiniTable_Extension* GetExtension(
      const protobuf::FieldDescriptor* fd) const;

  // Get the initializer for the given sub-message/sub-enum link.
  static std::string GetSub(upb_MiniTable_Sub sub);

 private:
  // Functions to build mini-tables for this file's messages and extensions.
  void BuildMiniTables(const protobuf::FileDescriptor* fd);
  void BuildExtensions(const protobuf::FileDescriptor* fd);
  upb_MiniTable* MakeMiniTable(const protobuf::Descriptor* m);
  upb_MiniTable* MakeRegularMiniTable(const protobuf::Descriptor* m);
  uint64_t GetMessageModifiers(const protobuf::Descriptor* m);
  uint64_t GetFieldModifiers(const protobuf::FieldDescriptor* f);
  void ResolveIntraFileReferences();

  // When we are generating code, tables are linked to sub-tables via name (ie.
  // a string) rather than by pointer.  We need to emit an initializer like
  // `&foo_sub_table`.  To do this, we store `const char*` strings in all the
  // links that would normally be pointers:
  //    field -> sub-message
  //    field -> enum table (proto2 only)
  //    extension -> extendee
  //
  // This requires a bit of reinterpret_cast<>(), but it's confined to a few
  // functions.  We tag the pointer so we know which member of the union to
  // initialize.
  enum SubTag {
    kNull = 0,
    kMessage = 1,
    kEnum = 2,
    kMask = 3,
  };

  static upb_MiniTable_Sub PackSub(const char* data, SubTag tag);
  static bool IsNull(upb_MiniTable_Sub sub);
  void SetSubTableStrings();
  upb_MiniTable_Sub PackSubForField(const protobuf::FieldDescriptor* f,
                                    const upb_MiniTable_Field* mt_f);
  const char* AllocStr(absl::string_view str);

 private:
  using TableMap =
      absl::flat_hash_map<const protobuf::Descriptor*, upb_MiniTable*>;
  using ExtensionMap = absl::flat_hash_map<const protobuf::FieldDescriptor*,
                                           upb_MiniTable_Extension>;
  upb::Arena arena_;
  TableMap table_map_;
  ExtensionMap extension_map_;
  upb_MiniTablePlatform platform_;
};

upb_MiniTable* FilePlatformLayout::GetMiniTable(
    const protobuf::Descriptor* m) const {
  auto it = table_map_.find(m);
  assert(it != table_map_.end());
  return it->second;
}

const upb_MiniTable_Extension* FilePlatformLayout::GetExtension(
    const protobuf::FieldDescriptor* fd) const {
  auto it = extension_map_.find(fd);
  assert(it != extension_map_.end());
  return &it->second;
}

void FilePlatformLayout::ResolveIntraFileReferences() {
  // This properly resolves references within a file, in order to set any
  // necessary flags (eg. is a map).
  for (const auto& pair : table_map_) {
    upb_MiniTable* mt = pair.second;
    // First we properly resolve for defs within the file.
    for (const auto* f : FieldNumberOrder(pair.first)) {
      if (f->message_type() && f->message_type()->file() == f->file()) {
        // const_cast is safe because the mini-table is owned exclusively
        // by us, and was allocated from an arena (known-writable memory).
        upb_MiniTable_Field* mt_f = const_cast<upb_MiniTable_Field*>(
            upb_MiniTable_FindFieldByNumber(mt, f->number()));
        upb_MiniTable* sub_mt = GetMiniTable(f->message_type());
        upb_MiniTable_SetSubMessage(mt, mt_f, sub_mt);
      }
      // We don't worry about enums here, because resolving an enum will
      // never alter the mini-table.
    }
  }
}

upb_MiniTable_Sub FilePlatformLayout::PackSub(const char* data, SubTag tag) {
  uintptr_t val = reinterpret_cast<uintptr_t>(data);
  assert((val & kMask) == 0);
  upb_MiniTable_Sub sub;
  sub.submsg = reinterpret_cast<upb_MiniTable*>(val | tag);
  return sub;
}

bool FilePlatformLayout::IsNull(upb_MiniTable_Sub sub) {
  return reinterpret_cast<uintptr_t>(sub.subenum) == 0;
}

std::string FilePlatformLayout::GetSub(upb_MiniTable_Sub sub) {
  uintptr_t as_int = reinterpret_cast<uintptr_t>(sub.submsg);
  const char* str = reinterpret_cast<const char*>(as_int & ~SubTag::kMask);
  switch (as_int & SubTag::kMask) {
    case SubTag::kMessage:
      return absl::Substitute("{.submsg = &$0}", str);
    case SubTag::kEnum:
      return absl::Substitute("{.subenum = &$0}", str);
    default:
      return std::string("{.submsg = NULL}");
  }
  return std::string("ERROR in GetSub");
}

void FilePlatformLayout::SetSubTableStrings() {
  for (const auto& pair : table_map_) {
    upb_MiniTable* mt = pair.second;
    for (const auto* f : FieldNumberOrder(pair.first)) {
      upb_MiniTable_Field* mt_f = const_cast<upb_MiniTable_Field*>(
          upb_MiniTable_FindFieldByNumber(mt, f->number()));
      assert(mt_f);
      upb_MiniTable_Sub sub = PackSubForField(f, mt_f);
      if (IsNull(sub)) continue;
      // const_cast is safe because the mini-table is owned exclusively
      // by us, and was allocated from an arena (known-writable memory).
      *const_cast<upb_MiniTable_Sub*>(&mt->subs[mt_f->submsg_index]) = sub;
    }
  }
}

upb_MiniTable_Sub FilePlatformLayout::PackSubForField(
    const protobuf::FieldDescriptor* f, const upb_MiniTable_Field* mt_f) {
  if (mt_f->submsg_index == kUpb_NoSub) {
    return PackSub(nullptr, SubTag::kNull);
  } else if (f->message_type()) {
    return PackSub(AllocStr(MessageInit(f->message_type())), SubTag::kMessage);
  } else {
    ABSL_ASSERT(f->enum_type());
    return PackSub(AllocStr(EnumInit(f->enum_type())), SubTag::kEnum);
  }
}

const char* FilePlatformLayout::AllocStr(absl::string_view str) {
  char* ret =
      static_cast<char*>(upb_Arena_Malloc(arena_.ptr(), str.size() + 1));
  memcpy(ret, str.data(), str.size());
  ret[str.size()] = '\0';
  return ret;
}

void FilePlatformLayout::BuildMiniTables(const protobuf::FileDescriptor* fd) {
  for (const auto& m : SortedMessages(fd)) {
    table_map_[m] = MakeMiniTable(m);
  }
  ResolveIntraFileReferences();
  SetSubTableStrings();
}

void FilePlatformLayout::BuildExtensions(const protobuf::FileDescriptor* fd) {
  std::vector<const protobuf::FieldDescriptor*> sorted = SortedExtensions(fd);
  upb::Status status;
  for (const auto* f : sorted) {
    upb::MtDataEncoder e;
    e.StartMessage(0);
    e.PutField(static_cast<upb_FieldType>(f->type()), f->number(),
               GetFieldModifiers(f));
    upb_MiniTable_Extension& ext = extension_map_[f];
    upb_MiniTable_Sub sub;
    bool ok = upb_MiniTable_BuildExtension(e.data().data(), e.data().size(),
                                           &ext, sub, status.ptr());
    if (!ok) {
      // TODO(haberman): Use ABSL CHECK() when it is available.
      fprintf(stderr, "Error building mini-table: %s\n",
              status.error_message());
    }
    ABSL_ASSERT(ok);
    ext.extendee = reinterpret_cast<const upb_MiniTable*>(
        AllocStr(MessageInit(f->containing_type())));
    ext.sub = PackSubForField(f, &ext.field);
  }
}

upb_MiniTable* FilePlatformLayout::MakeMiniTable(
    const protobuf::Descriptor* m) {
  if (m->options().message_set_wire_format()) {
    return upb_MiniTable_BuildMessageSet(platform_, arena_.ptr());
  } else if (m->options().map_entry()) {
    return upb_MiniTable_BuildMapEntry(
        static_cast<upb_FieldType>(m->map_key()->type()),
        static_cast<upb_FieldType>(m->map_value()->type()),
        m->map_value()->enum_type() &&
            m->map_value()->enum_type()->file()->syntax() ==
                protobuf::FileDescriptor::SYNTAX_PROTO3,
        platform_, arena_.ptr());
  } else {
    return MakeRegularMiniTable(m);
  }
}

upb_MiniTable* FilePlatformLayout::MakeRegularMiniTable(
    const protobuf::Descriptor* m) {
  upb::MtDataEncoder e;
  e.StartMessage(GetMessageModifiers(m));
  for (const auto* f : FieldNumberOrder(m)) {
    e.PutField(static_cast<upb_FieldType>(f->type()), f->number(),
               GetFieldModifiers(f));
  }
  for (int i = 0; i < m->real_oneof_decl_count(); i++) {
    const protobuf::OneofDescriptor* oneof = m->oneof_decl(i);
    e.StartOneof();
    for (int j = 0; j < oneof->field_count(); j++) {
      const protobuf::FieldDescriptor* f = oneof->field(j);
      e.PutOneofField(f->number());
    }
  }
  const std::string& str = e.data();
  upb::Status status;
  upb_MiniTable* ret = upb_MiniTable_Build(str.data(), str.size(), platform_,
                                           arena_.ptr(), status.ptr());
  if (!ret) {
    fprintf(stderr, "Error building mini-table: %s\n", status.error_message());
  }
  assert(ret);
  return ret;
}

uint64_t FilePlatformLayout::GetMessageModifiers(
    const protobuf::Descriptor* m) {
  uint64_t ret = 0;

  if (m->file()->syntax() == protobuf::FileDescriptor::SYNTAX_PROTO3) {
    ret |= kUpb_MessageModifier_ValidateUtf8;
    ret |= kUpb_MessageModifier_DefaultIsPacked;
  }

  if (m->extension_range_count() > 0) {
    ret |= kUpb_MessageModifier_IsExtendable;
  }

  assert(!m->options().map_entry());
  return ret;
}

uint64_t FilePlatformLayout::GetFieldModifiers(
    const protobuf::FieldDescriptor* f) {
  uint64_t ret = 0;

  if (f->is_repeated()) ret |= kUpb_FieldModifier_IsRepeated;
  if (f->is_required()) ret |= kUpb_FieldModifier_IsRequired;
  if (f->is_packed()) ret |= kUpb_FieldModifier_IsPacked;
  if (f->enum_type() && f->enum_type()->file()->syntax() ==
                            protobuf::FileDescriptor::SYNTAX_PROTO2) {
    ret |= kUpb_FieldModifier_IsClosedEnum;
  }
  if (f->is_optional() && !f->has_presence()) {
    ret |= kUpb_FieldModifier_IsProto3Singular;
  }

  return ret;
}

////////////////////////////////////////////////////////////////////////////////
// FileLayout
////////////////////////////////////////////////////////////////////////////////

// FileLayout is a pair of platform layouts: one for 32-bit and one for 64-bit.
class FileLayout {
 public:
  FileLayout(const protobuf::FileDescriptor* fd)
      : descriptor_(fd),
        layout32_(fd, kUpb_MiniTablePlatform_32Bit),
        layout64_(fd, kUpb_MiniTablePlatform_64Bit) {}

  const protobuf::FileDescriptor* descriptor() const { return descriptor_; }

  const upb_MiniTable* GetMiniTable32(const protobuf::Descriptor* m) const {
    return layout32_.GetMiniTable(m);
  }

  const upb_MiniTable* GetMiniTable64(const protobuf::Descriptor* m) const {
    return layout64_.GetMiniTable(m);
  }

  std::string GetFieldOffset(const protobuf::FieldDescriptor* f) const {
    const upb_MiniTable_Field* f_32 = upb_MiniTable_FindFieldByNumber(
        GetMiniTable32(f->containing_type()), f->number());
    const upb_MiniTable_Field* f_64 = upb_MiniTable_FindFieldByNumber(
        GetMiniTable64(f->containing_type()), f->number());
    return absl::Substitute("UPB_SIZE($0, $1)", f_32->offset, f_64->offset);
  }

  std::string GetOneofCaseOffset(const protobuf::OneofDescriptor* o) const {
    const protobuf::FieldDescriptor* f = o->field(0);
    const upb_MiniTable_Field* f_32 = upb_MiniTable_FindFieldByNumber(
        GetMiniTable32(f->containing_type()), f->number());
    const upb_MiniTable_Field* f_64 = upb_MiniTable_FindFieldByNumber(
        GetMiniTable64(f->containing_type()), f->number());
    return absl::Substitute("UPB_SIZE($0, $1)", ~f_32->presence,
                            ~f_64->presence);
  }

  std::string GetMessageSize(const protobuf::Descriptor* d) const {
    return absl::Substitute("UPB_SIZE($0, $1)", GetMiniTable32(d)->size,
                            GetMiniTable64(d)->size);
  }

  int GetHasbitIndex(const protobuf::FieldDescriptor* f) const {
    const upb_MiniTable_Field* f_64 = upb_MiniTable_FindFieldByNumber(
        GetMiniTable64(f->containing_type()), f->number());
    return f_64->presence;
  }

  bool HasHasbit(const protobuf::FieldDescriptor* f) const {
    return GetHasbitIndex(f) > 0;
  }

  const upb_MiniTable_Extension* GetExtension(
      const protobuf::FieldDescriptor* f) const {
    return layout64_.GetExtension(f);
  }

 private:
  const protobuf::FileDescriptor* descriptor_;
  FilePlatformLayout layout32_;
  FilePlatformLayout layout64_;
};

void DumpEnumValues(const protobuf::EnumDescriptor* desc, Output& output) {
  std::vector<const protobuf::EnumValueDescriptor*> values;
  for (int i = 0; i < desc->value_count(); i++) {
    values.push_back(desc->value(i));
  }
  std::sort(values.begin(), values.end(),
            [](const protobuf::EnumValueDescriptor* a,
               const protobuf::EnumValueDescriptor* b) {
              return a->number() < b->number();
            });

  for (size_t i = 0; i < values.size(); i++) {
    auto value = values[i];
    output("  $0 = $1", EnumValueSymbol(value), value->number());
    if (i != values.size() - 1) {
      output(",");
    }
    output("\n");
  }
}

void GenerateExtensionInHeader(const protobuf::FieldDescriptor* ext,
                               Output& output) {
  output(
      R"cc(
        UPB_INLINE bool $0_has_$1(const struct $2* msg) {
          return _upb_Message_Getext(msg, &$3) != NULL;
        }
      )cc",
      ExtensionIdentBase(ext), ext->name(), MessageName(ext->containing_type()),
      ExtensionLayout(ext));

  output(
      R"cc(
        UPB_INLINE void $0_clear_$1(struct $2* msg) {
          _upb_Message_Clearext(msg, &$3);
        }
      )cc",
      ExtensionIdentBase(ext), ext->name(), MessageName(ext->containing_type()),
      ExtensionLayout(ext));

  if (ext->is_repeated()) {
  } else if (ext->message_type()) {
    output(
        R"cc(
          UPB_INLINE $0 $1_$2(const struct $3* msg) {
            const upb_Message_Extension* ext = _upb_Message_Getext(msg, &$4);
            UPB_ASSERT(ext);
            return *UPB_PTR_AT(&ext->data, 0, $0);
          }
        )cc",
        CTypeConst(ext), ExtensionIdentBase(ext), ext->name(),
        MessageName(ext->containing_type()), ExtensionLayout(ext),
        FieldDefault(ext));
    output(
        R"cc(
          UPB_INLINE void $1_set_$2(struct $3* msg, $0 ext, upb_Arena* arena) {
            const upb_Message_Extension* msg_ext =
                _upb_Message_GetOrCreateExtension(msg, &$4, arena);
            UPB_ASSERT(msg_ext);
            *UPB_PTR_AT(&msg_ext->data, 0, $0) = ext;
          }
        )cc",
        CTypeConst(ext), ExtensionIdentBase(ext), ext->name(),
        MessageName(ext->containing_type()), ExtensionLayout(ext),
        FieldDefault(ext));
  } else {
    // Returns default if extension field is not a message.
    output(
        R"cc(
          UPB_INLINE $0 $1_$2(const struct $3* msg) {
            const upb_Message_Extension* ext = _upb_Message_Getext(msg, &$4);
            return ext ? *UPB_PTR_AT(&ext->data, 0, $0) : $5;
          }
        )cc",
        CTypeConst(ext), ExtensionIdentBase(ext), ext->name(),
        MessageName(ext->containing_type()), ExtensionLayout(ext),
        FieldDefault(ext));
  }
}

void GenerateMessageFunctionsInHeader(const protobuf::Descriptor* message,
                                      Output& output) {
  output(
      R"cc(
        UPB_INLINE $0* $0_new(upb_Arena* arena) {
          return ($0*)_upb_Message_New(&$1, arena);
        }
        UPB_INLINE $0* $0_parse(const char* buf, size_t size, upb_Arena* arena) {
          $0* ret = $0_new(arena);
          if (!ret) return NULL;
          if (upb_Decode(buf, size, ret, &$1, NULL, 0, arena) != kUpb_DecodeStatus_Ok) {
            return NULL;
          }
          return ret;
        }
        UPB_INLINE $0* $0_parse_ex(const char* buf, size_t size,
                                   const upb_ExtensionRegistry* extreg,
                                   int options, upb_Arena* arena) {
          $0* ret = $0_new(arena);
          if (!ret) return NULL;
          if (upb_Decode(buf, size, ret, &$1, extreg, options, arena) !=
              kUpb_DecodeStatus_Ok) {
            return NULL;
          }
          return ret;
        }
        UPB_INLINE char* $0_serialize(const $0* msg, upb_Arena* arena, size_t* len) {
          return upb_Encode(msg, &$1, 0, arena, len);
        }
        UPB_INLINE char* $0_serialize_ex(const $0* msg, int options,
                                         upb_Arena* arena, size_t* len) {
          return upb_Encode(msg, &$1, options, arena, len);
        }
      )cc",
      MessageName(message), MessageInit(message));
}

void GenerateOneofInHeader(const protobuf::OneofDescriptor* oneof,
                           const FileLayout& layout, absl::string_view msg_name,
                           Output& output) {
  std::string fullname = ToCIdent(oneof->full_name());
  output("typedef enum {\n");
  for (int j = 0; j < oneof->field_count(); j++) {
    const protobuf::FieldDescriptor* field = oneof->field(j);
    output("  $0_$1 = $2,\n", fullname, field->name(), field->number());
  }
  output(
      "  $0_NOT_SET = 0\n"
      "} $0_oneofcases;\n",
      fullname);
  output(
      R"cc(
        UPB_INLINE $0_oneofcases $1_$2_case(const $1* msg) {
          return ($0_oneofcases)*UPB_PTR_AT(msg, $3, int32_t);
        }
      )cc",
      fullname, msg_name, oneof->name(), layout.GetOneofCaseOffset(oneof));
}

void GenerateHazzer(const protobuf::FieldDescriptor* field,
                    const FileLayout& layout, absl::string_view msg_name,
                    Output& output) {
  if (layout.HasHasbit(field)) {
    output(
        R"cc(
          UPB_INLINE bool $0_has_$1(const $0* msg) {
            return _upb_hasbit(msg, $2);
          }
        )cc",
        msg_name, field->name(), layout.GetHasbitIndex(field));
  } else if (field->real_containing_oneof()) {
    output(
        R"cc(
          UPB_INLINE bool $0_has_$1(const $0* msg) {
            return _upb_getoneofcase(msg, $2) == $3;
          }
        )cc",
        msg_name, field->name(),
        layout.GetOneofCaseOffset(field->real_containing_oneof()),
        field->number());
  } else if (field->message_type()) {
    output(
        R"cc(
          UPB_INLINE bool $0_has_$1(const $0* msg) {
            return _upb_has_submsg_nohasbit(msg, $2);
          }
        )cc",
        msg_name, field->name(), layout.GetFieldOffset(field));
  }
}

void GenerateClear(const protobuf::FieldDescriptor* field,
                   const FileLayout& layout, absl::string_view msg_name,
                   Output& output) {
  if (field == field->containing_type()->map_key() ||
      field == field->containing_type()->map_value()) {
    // Cannot be cleared.
    return;
  }

  if (field->real_containing_oneof()) {
    const protobuf::OneofDescriptor* oneof = field->real_containing_oneof();
    std::string oneof_fullname = ToCIdent(oneof->full_name());
    std::string default_value =
        field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
            ? "upb_StringView_FromDataAndSize(NULL, 0)"
            : "0";
    output(
        R"cc(
          UPB_INLINE void $0_clear_$1(const $0* msg) {
            UPB_WRITE_ONEOF(msg, $2, $3, $7, $4, $6_NOT_SET);
          }
        )cc",
        msg_name, field->name(), CType(field), layout.GetFieldOffset(field),
        layout.GetOneofCaseOffset(field->real_containing_oneof()),
        field->number(), oneof_fullname, default_value);
  } else {
    if (field->message_type()) {
      output(
          R"cc(
            UPB_INLINE void $0_clear_$1(const $0* msg) {
              *UPB_PTR_AT(msg, $2, const upb_Message*) = NULL;
            }
          )cc",
          msg_name, field->name(), layout.GetFieldOffset(field));
    } else if (layout.HasHasbit(field)) {
      if (field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING) {
        output(
            R"cc(
              UPB_INLINE void $0_clear_$1(const $0* msg) {
                *UPB_PTR_AT(msg, $3, $2) = upb_StringView_FromDataAndSize(NULL, 0);
                _upb_clearhas(msg, $4);
              }
            )cc",
            msg_name, field->name(), CType(field), layout.GetFieldOffset(field),
            layout.GetHasbitIndex(field));
      } else {
        output(
            R"cc(
              UPB_INLINE void $0_clear_$1(const $0* msg) {
                *UPB_PTR_AT(msg, $3, $2) = 0;
                _upb_clearhas(msg, $4);
              }
            )cc",
            msg_name, field->name(), CType(field), layout.GetFieldOffset(field),
            layout.GetHasbitIndex(field));
      }
    } else {
      if (field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING) {
        output(
            R"cc(
              UPB_INLINE void $0_clear_$1(const $0* msg) {
                *UPB_PTR_AT(msg, $3, $2) = upb_StringView_FromDataAndSize(NULL, 0);
              }
            )cc",
            msg_name, field->name(), CType(field),
            layout.GetFieldOffset(field));
      } else {
        output(
            R"cc(
              UPB_INLINE void $0_clear_$1(const $0* msg) {
                *UPB_PTR_AT(msg, $3, $2) = 0;
              }
            )cc",
            msg_name, field->name(), CType(field), layout.GetFieldOffset(field),
            layout.GetHasbitIndex(field));
      }
    }
  }
}

void GenerateRepeatedClear(const protobuf::FieldDescriptor* field,
                           const FileLayout& layout, absl::string_view msg_name,
                           Output& output) {
  output(
      R"cc(
        UPB_INLINE void $0_clear_$1(const $0* msg) {
          _upb_array_detach(msg, $2);
        }
      )cc",
      msg_name, field->name(), layout.GetFieldOffset(field));
}

void GenerateMapGetters(const protobuf::FieldDescriptor* field,
                        const FileLayout& layout, absl::string_view msg_name,
                        Output& output) {
  const protobuf::Descriptor* entry = field->message_type();
  const protobuf::FieldDescriptor* key = entry->FindFieldByNumber(1);
  const protobuf::FieldDescriptor* val = entry->FindFieldByNumber(2);
  output(
      R"cc(
        UPB_INLINE size_t $0_$1_size(const $0* msg) {
          return _upb_msg_map_size(msg, $2);
        }
      )cc",
      msg_name, field->name(), layout.GetFieldOffset(field));
  output(
      R"cc(
        UPB_INLINE bool $0_$1_get(const $0* msg, $2 key, $3* val) {
          return _upb_msg_map_get(msg, $4, &key, $5, val, $6);
        }
      )cc",
      msg_name, field->name(), CType(key), CType(val),
      layout.GetFieldOffset(field),
      key->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
          ? "0"
          : "sizeof(key)",
      val->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
          ? "0"
          : "sizeof(*val)");
  output(
      R"cc(
        UPB_INLINE $0 $1_$2_next(const $1* msg, size_t* iter) {
          return ($0)_upb_msg_map_next(msg, $3, iter);
        }
      )cc",
      CTypeConst(field), msg_name, field->name(), layout.GetFieldOffset(field));
}

void GenerateMapEntryGetters(const protobuf::FieldDescriptor* field,
                             absl::string_view msg_name, Output& output) {
  output(
      R"cc(
        UPB_INLINE $0 $1_$2(const $1* msg) {
          $3 ret;
          _upb_msg_map_$2(msg, &ret, $4);
          return ret;
        }
      )cc",
      CTypeConst(field), msg_name, field->name(), CType(field),
      field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
          ? "0"
          : "sizeof(ret)");
}

void GenerateRepeatedGetters(const protobuf::FieldDescriptor* field,
                             const FileLayout& layout,
                             absl::string_view msg_name, Output& output) {
  output(
      R"cc(
        UPB_INLINE $0 const* $1_$2(const $1* msg, size_t* len) {
          return ($0 const*)_upb_array_accessor(msg, $3, len);
        }
      )cc",
      CTypeConst(field), msg_name, field->name(), layout.GetFieldOffset(field));
}

void GenerateOneofGetters(const protobuf::FieldDescriptor* field,
                          const FileLayout& layout, absl::string_view msg_name,
                          Output& output) {
  output(
      R"cc(
        UPB_INLINE $0 $1_$2(const $1* msg) {
          return UPB_READ_ONEOF(msg, $0, $3, $4, $5, $6);
        }
      )cc",
      CTypeConst(field), msg_name, field->name(), layout.GetFieldOffset(field),
      layout.GetOneofCaseOffset(field->real_containing_oneof()),
      field->number(), FieldDefault(field));
}

void GenerateScalarGetters(const protobuf::FieldDescriptor* field,
                           const FileLayout& layout, absl::string_view msg_name,
                           Output& output) {
  if (HasNonZeroDefault(field)) {
    output(
        R"cc(
          UPB_INLINE $0 $1_$2(const $1* msg) {
            return $1_has_$2(msg) ? *UPB_PTR_AT(msg, $3, $0) : $4;
          }
        )cc",
        CTypeConst(field), msg_name, field->name(),
        layout.GetFieldOffset(field), FieldDefault(field));
  } else {
    output(
        R"cc(
          UPB_INLINE $0 $1_$2(const $1* msg) {
            return *UPB_PTR_AT(msg, $3, $0);
          }
        )cc",
        CTypeConst(field), msg_name, field->name(),
        layout.GetFieldOffset(field));
  }
}

void GenerateGetters(const protobuf::FieldDescriptor* field,
                     const FileLayout& layout, absl::string_view msg_name,
                     Output& output) {
  if (field->is_map()) {
    GenerateMapGetters(field, layout, msg_name, output);
  } else if (field->containing_type()->options().map_entry()) {
    GenerateMapEntryGetters(field, msg_name, output);
  } else if (field->is_repeated()) {
    GenerateRepeatedGetters(field, layout, msg_name, output);
  } else if (field->real_containing_oneof()) {
    GenerateOneofGetters(field, layout, msg_name, output);
  } else {
    GenerateScalarGetters(field, layout, msg_name, output);
  }
}

void GenerateMapSetters(const protobuf::FieldDescriptor* field,
                        const FileLayout& layout, absl::string_view msg_name,
                        Output& output) {
  const protobuf::Descriptor* entry = field->message_type();
  const protobuf::FieldDescriptor* key = entry->FindFieldByNumber(1);
  const protobuf::FieldDescriptor* val = entry->FindFieldByNumber(2);
  output(
      R"cc(
        UPB_INLINE void $0_$1_clear($0* msg) { _upb_msg_map_clear(msg, $2); }
      )cc",
      msg_name, field->name(), layout.GetFieldOffset(field));
  output(
      R"cc(
        UPB_INLINE bool $0_$1_set($0* msg, $2 key, $3 val, upb_Arena* a) {
          return _upb_msg_map_set(msg, $4, &key, $5, &val, $6, a);
        }
      )cc",
      msg_name, field->name(), CType(key), CType(val),
      layout.GetFieldOffset(field),
      key->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
          ? "0"
          : "sizeof(key)",
      val->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
          ? "0"
          : "sizeof(val)");
  output(
      R"cc(
        UPB_INLINE bool $0_$1_delete($0* msg, $2 key) {
          return _upb_msg_map_delete(msg, $3, &key, $4);
        }
      )cc",
      msg_name, field->name(), CType(key), layout.GetFieldOffset(field),
      key->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
          ? "0"
          : "sizeof(key)");
  output(
      R"cc(
        UPB_INLINE $0 $1_$2_nextmutable($1* msg, size_t* iter) {
          return ($0)_upb_msg_map_next(msg, $3, iter);
        }
      )cc",
      CType(field), msg_name, field->name(), layout.GetFieldOffset(field));
}

void GenerateRepeatedSetters(const protobuf::FieldDescriptor* field,
                             const FileLayout& layout,
                             absl::string_view msg_name, Output& output) {
  output(
      R"cc(
        UPB_INLINE $0* $1_mutable_$2($1* msg, size_t* len) {
          return ($0*)_upb_array_mutable_accessor(msg, $3, len);
        }
      )cc",
      CType(field), msg_name, field->name(), layout.GetFieldOffset(field));
  output(
      R"cc(
        UPB_INLINE $0* $1_resize_$2($1* msg, size_t len, upb_Arena* arena) {
          return ($0*)_upb_Array_Resize_accessor2(msg, $3, len, $4, arena);
        }
      )cc",
      CType(field), msg_name, field->name(), layout.GetFieldOffset(field),
      SizeLg2(field));
  if (field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_MESSAGE) {
    output(
        R"cc(
          UPB_INLINE struct $0* $1_add_$2($1* msg, upb_Arena* arena) {
            struct $0* sub = (struct $0*)_upb_Message_New(&$3, arena);
            bool ok = _upb_Array_Append_accessor2(msg, $4, $5, &sub, arena);
            if (!ok) return NULL;
            return sub;
          }
        )cc",
        MessageName(field->message_type()), msg_name, field->name(),
        MessageInit(field->message_type()), layout.GetFieldOffset(field),
        SizeLg2(field));
  } else {
    output(
        R"cc(
          UPB_INLINE bool $1_add_$2($1* msg, $0 val, upb_Arena* arena) {
            return _upb_Array_Append_accessor2(msg, $3, $4, &val, arena);
          }
        )cc",
        CType(field), msg_name, field->name(), layout.GetFieldOffset(field),
        SizeLg2(field));
  }
}

void GenerateNonRepeatedSetters(const protobuf::FieldDescriptor* field,
                                const FileLayout& layout,
                                absl::string_view msg_name, Output& output) {
  if (field == field->containing_type()->map_key()) {
    // Key cannot be mutated.
    return;
  }

  // The common function signature for all setters.  Varying
  // implementations follow.
  output("UPB_INLINE void $0_set_$1($0 *msg, $2 value) {\n", msg_name,
         field->name(), CType(field));

  if (field == field->containing_type()->map_value()) {
    output(
        "  _upb_msg_map_set_value(msg, &value, $0);\n"
        "}\n",
        field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_STRING
            ? "0"
            : "sizeof(" + CType(field) + ")");
  } else if (field->real_containing_oneof()) {
    output(
        "  UPB_WRITE_ONEOF(msg, $0, $1, value, $2, $3);\n"
        "}\n",
        CType(field), layout.GetFieldOffset(field),
        layout.GetOneofCaseOffset(field->real_containing_oneof()),
        field->number());
  } else {
    if (layout.HasHasbit(field)) {
      output("  _upb_sethas(msg, $0);\n", layout.GetHasbitIndex(field));
    }
    output(
        "  *UPB_PTR_AT(msg, $1, $0) = value;\n"
        "}\n",
        CType(field), layout.GetFieldOffset(field));
  }

  // Message fields also have a Msg_mutable_foo() accessor that will create
  // the sub-message if it doesn't already exist.
  if (field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_MESSAGE &&
      !field->containing_type()->options().map_entry()) {
    output(
        R"cc(
          UPB_INLINE struct $0* $1_mutable_$2($1* msg, upb_Arena* arena) {
            struct $0* sub = (struct $0*)$1_$2(msg);
            if (sub == NULL) {
              sub = (struct $0*)_upb_Message_New(&$3, arena);
              if (!sub) return NULL;
              $1_set_$2(msg, sub);
            }
            return sub;
          }
        )cc",
        MessageName(field->message_type()), msg_name, field->name(),
        MessageInit(field->message_type()));
  }
}

void GenerateSetters(const protobuf::FieldDescriptor* field,
                     const FileLayout& layout, absl::string_view msg_name,
                     Output& output) {
  if (field->is_map()) {
    GenerateMapSetters(field, layout, msg_name, output);
  } else if (field->is_repeated()) {
    GenerateRepeatedSetters(field, layout, msg_name, output);
  } else {
    GenerateNonRepeatedSetters(field, layout, msg_name, output);
  }
}

void GenerateMessageInHeader(const protobuf::Descriptor* message,
                             const FileLayout& layout, Output& output) {
  output("/* $0 */\n\n", message->full_name());
  std::string msg_name = ToCIdent(message->full_name());

  if (!message->options().map_entry()) {
    GenerateMessageFunctionsInHeader(message, output);
  }

  for (int i = 0; i < message->real_oneof_decl_count(); i++) {
    GenerateOneofInHeader(message->oneof_decl(i), layout, msg_name, output);
  }

  for (auto field : FieldNumberOrder(message)) {
    GenerateHazzer(field, layout, msg_name, output);
    if (field->is_repeated()) {
      GenerateRepeatedClear(field, layout, msg_name, output);
    } else {
      GenerateClear(field, layout, msg_name, output);
    }
    GenerateGetters(field, layout, msg_name, output);
  }

  output("\n");

  for (auto field : FieldNumberOrder(message)) {
    GenerateSetters(field, layout, msg_name, output);
  }

  output("\n");
}

void WriteHeader(const FileLayout& layout, Output& output) {
  const protobuf::FileDescriptor* file = layout.descriptor();
  EmitFileWarning(file, output);
  output(
      "#ifndef $0_UPB_H_\n"
      "#define $0_UPB_H_\n\n"
      "#include \"upb/msg_internal.h\"\n"
      "#include \"upb/decode.h\"\n"
      "#include \"upb/decode_fast.h\"\n"
      "#include \"upb/encode.h\"\n\n",
      ToPreproc(file->name()));

  for (int i = 0; i < file->public_dependency_count(); i++) {
    if (i == 0) {
      output("/* Public Imports. */\n");
    }
    output("#include \"$0\"\n", HeaderFilename(file));
    if (i == file->public_dependency_count() - 1) {
      output("\n");
    }
  }

  output(
      "#include \"upb/port_def.inc\"\n"
      "\n"
      "#ifdef __cplusplus\n"
      "extern \"C\" {\n"
      "#endif\n"
      "\n");

  const std::vector<const protobuf::Descriptor*> this_file_messages =
      SortedMessages(file);
  const std::vector<const protobuf::FieldDescriptor*> this_file_exts =
      SortedExtensions(file);

  // Forward-declare types defined in this file.
  for (auto message : this_file_messages) {
    output("struct $0;\n", ToCIdent(message->full_name()));
  }
  for (auto message : this_file_messages) {
    output("typedef struct $0 $0;\n", ToCIdent(message->full_name()));
  }
  for (auto message : this_file_messages) {
    output("extern const upb_MiniTable $0;\n", MessageInit(message));
  }
  for (auto ext : this_file_exts) {
    output("extern const upb_MiniTable_Extension $0;\n", ExtensionLayout(ext));
  }

  // Forward-declare types not in this file, but used as submessages.
  // Order by full name for consistent ordering.
  std::map<std::string, const protobuf::Descriptor*> forward_messages;

  for (auto* message : this_file_messages) {
    for (int i = 0; i < message->field_count(); i++) {
      const protobuf::FieldDescriptor* field = message->field(i);
      if (field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_MESSAGE &&
          field->file() != field->message_type()->file()) {
        forward_messages[field->message_type()->full_name()] =
            field->message_type();
      }
    }
  }
  for (auto ext : this_file_exts) {
    if (ext->file() != ext->containing_type()->file()) {
      forward_messages[ext->containing_type()->full_name()] =
          ext->containing_type();
    }
  }
  for (const auto& pair : forward_messages) {
    output("struct $0;\n", MessageName(pair.second));
  }
  for (const auto& pair : forward_messages) {
    output("extern const upb_MiniTable $0;\n", MessageInit(pair.second));
  }

  if (!this_file_messages.empty()) {
    output("\n");
  }

  std::vector<const protobuf::EnumDescriptor*> this_file_enums =
      SortedEnums(file);
  std::sort(
      this_file_enums.begin(), this_file_enums.end(),
      [](const protobuf::EnumDescriptor* a, const protobuf::EnumDescriptor* b) {
        return a->full_name() < b->full_name();
      });

  for (auto enumdesc : this_file_enums) {
    output("typedef enum {\n");
    DumpEnumValues(enumdesc, output);
    output("} $0;\n\n", ToCIdent(enumdesc->full_name()));
  }

  output("\n");

  if (file->syntax() == protobuf::FileDescriptor::SYNTAX_PROTO2) {
    for (const auto* enumdesc : this_file_enums) {
      output("extern const upb_MiniTable_Enum $0;\n", EnumInit(enumdesc));
    }
  }

  output("\n");

  for (auto message : this_file_messages) {
    GenerateMessageInHeader(message, layout, output);
  }

  for (auto ext : this_file_exts) {
    GenerateExtensionInHeader(ext, output);
  }

  output("extern const upb_MiniTable_File $0;\n\n", FileLayoutName(file));

  if (file->name() ==
      protobuf::FileDescriptorProto::descriptor()->file()->name()) {
    // This is gratuitously inefficient with how many times it rebuilds
    // MessageLayout objects for the same message. But we only do this for one
    // proto (descriptor.proto) so we don't worry about it.
    const protobuf::Descriptor* max32_message = nullptr;
    const protobuf::Descriptor* max64_message = nullptr;
    size_t max32 = 0;
    size_t max64 = 0;
    for (const auto* message : this_file_messages) {
      if (absl::EndsWith(message->name(), "Options")) {
        size_t size32 = layout.GetMiniTable32(message)->size;
        size_t size64 = layout.GetMiniTable64(message)->size;
        if (size32 > max32) {
          max32 = size32;
          max32_message = message;
        }
        if (size64 > max64) {
          max64 = size64;
          max64_message = message;
        }
      }
    }

    output("/* Max size 32 is $0 */\n", max32_message->full_name());
    output("/* Max size 64 is $0 */\n", max64_message->full_name());
    output("#define _UPB_MAXOPT_SIZE UPB_SIZE($0, $1)\n\n", max32, max64);
  }

  output(
      "#ifdef __cplusplus\n"
      "}  /* extern \"C\" */\n"
      "#endif\n"
      "\n"
      "#include \"upb/port_undef.inc\"\n"
      "\n"
      "#endif  /* $0_UPB_H_ */\n",
      ToPreproc(file->name()));
}

typedef std::pair<std::string, uint64_t> TableEntry;

uint64_t GetEncodedTag(const protobuf::FieldDescriptor* field) {
  protobuf::internal::WireFormatLite::WireType wire_type =
      protobuf::internal::WireFormat::WireTypeForField(field);
  uint32_t unencoded_tag =
      protobuf::internal::WireFormatLite::MakeTag(field->number(), wire_type);
  uint8_t tag_bytes[10] = {0};
  protobuf::io::CodedOutputStream::WriteVarint32ToArray(unencoded_tag,
                                                        tag_bytes);
  uint64_t encoded_tag = 0;
  memcpy(&encoded_tag, tag_bytes, sizeof(encoded_tag));
  // TODO: byte-swap for big endian.
  return encoded_tag;
}

int GetTableSlot(const protobuf::FieldDescriptor* field) {
  uint64_t tag = GetEncodedTag(field);
  if (tag > 0x7fff) {
    // Tag must fit within a two-byte varint.
    return -1;
  }
  return (tag & 0xf8) >> 3;
}

bool TryFillTableEntry(const FileLayout& layout,
                       const protobuf::FieldDescriptor* field,
                       TableEntry& ent) {
  const upb_MiniTable* mt = layout.GetMiniTable64(field->containing_type());
  const upb_MiniTable_Field* mt_f =
      upb_MiniTable_FindFieldByNumber(mt, field->number());
  std::string type = "";
  std::string cardinality = "";
  switch (mt_f->descriptortype) {
    case kUpb_FieldType_Bool:
      type = "b1";
      break;
    case kUpb_FieldType_Enum:
      // We don't have the means to test proto2 enum fields for valid values.
      return false;
    case kUpb_FieldType_Int32:
    case kUpb_FieldType_UInt32:
      type = "v4";
      break;
    case kUpb_FieldType_Int64:
    case kUpb_FieldType_UInt64:
      type = "v8";
      break;
    case kUpb_FieldType_Fixed32:
    case kUpb_FieldType_SFixed32:
    case kUpb_FieldType_Float:
      type = "f4";
      break;
    case kUpb_FieldType_Fixed64:
    case kUpb_FieldType_SFixed64:
    case kUpb_FieldType_Double:
      type = "f8";
      break;
    case kUpb_FieldType_SInt32:
      type = "z4";
      break;
    case kUpb_FieldType_SInt64:
      type = "z8";
      break;
    case kUpb_FieldType_String:
      type = "s";
      break;
    case kUpb_FieldType_Bytes:
      type = "b";
      break;
    case kUpb_FieldType_Message:
      type = "m";
      break;
    default:
      return false;  // Not supported yet.
  }

  switch (upb_FieldMode_Get(mt_f)) {
    case kUpb_FieldMode_Map:
      return false;  // Not supported yet (ever?).
    case kUpb_FieldMode_Array:
      if (mt_f->mode & kUpb_LabelFlags_IsPacked) {
        cardinality = "p";
      } else {
        cardinality = "r";
      }
      break;
    case kUpb_FieldMode_Scalar:
      if (mt_f->presence < 0) {
        cardinality = "o";
      } else {
        cardinality = "s";
      }
      break;
  }

  uint64_t expected_tag = GetEncodedTag(field);

  // Data is:
  //
  //                  48                32                16                 0
  // |--------|--------|--------|--------|--------|--------|--------|--------|
  // |   offset (16)   |case offset (16) |presence| submsg |  exp. tag (16)  |
  // |--------|--------|--------|--------|--------|--------|--------|--------|
  //
  // - |presence| is either hasbit index or field number for oneofs.

  uint64_t data = static_cast<uint64_t>(mt_f->offset) << 48 | expected_tag;

  if (field->is_repeated()) {
    // No hasbit/oneof-related fields.
  }
  if (field->real_containing_oneof()) {
    size_t case_offset = ~mt_f->presence;
    if (case_offset > 0xffff) return false;
    assert(field->number() < 256);
    data |= field->number() << 24;
    data |= case_offset << 32;
  } else {
    uint64_t hasbit_index = 63;  // No hasbit (set a high, unused bit).
    if (mt_f->presence) {
      hasbit_index = mt_f->presence;
      if (hasbit_index > 31) return false;
    }
    data |= hasbit_index << 24;
  }

  if (field->cpp_type() == protobuf::FieldDescriptor::CPPTYPE_MESSAGE) {
    uint64_t idx = mt_f->submsg_index;
    if (idx > 255) return false;
    data |= idx << 16;

    std::string size_ceil = "max";
    size_t size = SIZE_MAX;
    if (field->message_type()->file() == field->file()) {
      // We can only be guaranteed the size of the sub-message if it is in the
      // same file as us.  We could relax this to increase the speed of
      // cross-file sub-message parsing if we are comfortable requiring that
      // users compile all messages at the same time.
      const upb_MiniTable* sub_mt =
          layout.GetMiniTable64(field->message_type());
      size = sub_mt->size + 8;
    }
    std::vector<size_t> breaks = {64, 128, 192, 256};
    for (auto brk : breaks) {
      if (size <= brk) {
        size_ceil = std::to_string(brk);
        break;
      }
    }
    ent.first = absl::Substitute("upb_p$0$1_$2bt_max$3b", cardinality, type,
                                 expected_tag > 0xff ? "2" : "1", size_ceil);

  } else {
    ent.first = absl::Substitute("upb_p$0$1_$2bt", cardinality, type,
                                 expected_tag > 0xff ? "2" : "1");
  }
  ent.second = data;
  return true;
}

std::vector<TableEntry> FastDecodeTable(const protobuf::Descriptor* message,
                                        const FileLayout& layout) {
  std::vector<TableEntry> table;
  for (const auto field : FieldHotnessOrder(message)) {
    TableEntry ent;
    int slot = GetTableSlot(field);
    // std::cerr << "table slot: " << field->number() << ": " << slot << "\n";
    if (slot < 0) {
      // Tag can't fit in the table.
      continue;
    }
    if (!TryFillTableEntry(layout, field, ent)) {
      // Unsupported field type or offset, hasbit index, etc. doesn't fit.
      continue;
    }
    while ((size_t)slot >= table.size()) {
      size_t size = std::max(static_cast<size_t>(1), table.size() * 2);
      table.resize(size, TableEntry{"fastdecode_generic", 0});
    }
    if (table[slot].first != "fastdecode_generic") {
      // A hotter field already filled this slot.
      continue;
    }
    table[slot] = ent;
  }
  return table;
}

// Returns the field mode as a string initializer.
//
// We could just emit this as a number (and we may yet go in that direction) but
// for now emitting symbolic constants gives this better readability and
// debuggability.
std::string GetModeInit(uint8_t mode) {
  std::string ret;
  switch (mode & kUpb_FieldMode_Mask) {
    case kUpb_FieldMode_Map:
      ret = "kUpb_FieldMode_Map";
      break;
    case kUpb_FieldMode_Array:
      ret = "kUpb_FieldMode_Array";
      break;
    case kUpb_FieldMode_Scalar:
      ret = "kUpb_FieldMode_Scalar";
      break;
    default:
      break;
  }

  if (mode & kUpb_LabelFlags_IsPacked) {
    absl::StrAppend(&ret, " | kUpb_LabelFlags_IsPacked");
  }

  if (mode & kUpb_LabelFlags_IsExtension) {
    absl::StrAppend(&ret, " | kUpb_LabelFlags_IsExtension");
  }

  std::string rep;
  switch (mode >> kUpb_FieldRep_Shift) {
    case kUpb_FieldRep_1Byte:
      rep = "kUpb_FieldRep_1Byte";
      break;
    case kUpb_FieldRep_4Byte:
      rep = "kUpb_FieldRep_4Byte";
      break;
    case kUpb_FieldRep_Pointer:
      rep = "kUpb_FieldRep_Pointer";
      break;
    case kUpb_FieldRep_StringView:
      rep = "kUpb_FieldRep_StringView";
      break;
    case kUpb_FieldRep_8Byte:
      rep = "kUpb_FieldRep_8Byte";
      break;
  }

  absl::StrAppend(&ret, " | (", rep, " << kUpb_FieldRep_Shift)");
  return ret;
}

void WriteField(const upb_MiniTable_Field* field64,
                const upb_MiniTable_Field* field32, Output& output) {
  output("{$0, UPB_SIZE($1, $2), UPB_SIZE($3, $4), $5, $6, $7}",
         field64->number, field32->offset, field64->offset, field32->presence,
         field64->presence,
         field64->submsg_index == kUpb_NoSub
             ? "kUpb_NoSub"
             : absl::StrCat(field64->submsg_index).c_str(),
         field64->descriptortype, GetModeInit(field64->mode));
}

// Writes a single field into a .upb.c source file.
void WriteMessageField(const upb_MiniTable_Field* field64,
                       const upb_MiniTable_Field* field32, Output& output) {
  output("  ");
  WriteField(field64, field32, output);
  output(",\n");
}

// Writes a single message into a .upb.c source file.
void WriteMessage(const protobuf::Descriptor* message, const FileLayout& layout,
                  Output& output, bool fasttable_enabled) {
  std::string msg_name = ToCIdent(message->full_name());
  std::string fields_array_ref = "NULL";
  std::string submsgs_array_ref = "NULL";
  std::string subenums_array_ref = "NULL";
  const upb_MiniTable* mt_32 = layout.GetMiniTable32(message);
  const upb_MiniTable* mt_64 = layout.GetMiniTable64(message);
  std::vector<std::string> subs;

  for (int i = 0; i < mt_64->field_count; i++) {
    const upb_MiniTable_Field* f = &mt_64->fields[i];
    if (f->submsg_index != kUpb_NoSub) {
      subs.push_back(FilePlatformLayout::GetSub(mt_64->subs[f->submsg_index]));
    }
  }

  if (!subs.empty()) {
    std::string submsgs_array_name = msg_name + "_submsgs";
    submsgs_array_ref = "&" + submsgs_array_name + "[0]";
    output("static const upb_MiniTable_Sub $0[$1] = {\n", submsgs_array_name,
           subs.size());

    for (const auto& sub : subs) {
      output("  $0,\n", sub);
    }

    output("};\n\n");
  }

  if (mt_64->field_count > 0) {
    std::string fields_array_name = msg_name + "__fields";
    fields_array_ref = "&" + fields_array_name + "[0]";
    output("static const upb_MiniTable_Field $0[$1] = {\n", fields_array_name,
           mt_64->field_count);
    for (int i = 0; i < mt_64->field_count; i++) {
      WriteMessageField(&mt_64->fields[i], &mt_32->fields[i], output);
    }
    output("};\n\n");
  }

  std::vector<TableEntry> table;
  uint8_t table_mask = -1;

  if (fasttable_enabled) {
    table = FastDecodeTable(message, layout);
  }

  if (table.size() > 1) {
    assert((table.size() & (table.size() - 1)) == 0);
    table_mask = (table.size() - 1) << 3;
  }

  std::string msgext = "kUpb_ExtMode_NonExtendable";

  if (message->extension_range_count()) {
    if (message->options().message_set_wire_format()) {
      msgext = "kUpb_ExtMode_IsMessageSet";
    } else {
      msgext = "kUpb_ExtMode_Extendable";
    }
  }

  output("const upb_MiniTable $0 = {\n", MessageInit(message));
  output("  $0,\n", submsgs_array_ref);
  output("  $0,\n", fields_array_ref);
  output("  $0, $1, $2, $3, $4, $5,\n", layout.GetMessageSize(message),
         mt_64->field_count, msgext, mt_64->dense_below, table_mask,
         mt_64->required_count);
  if (!table.empty()) {
    output("  UPB_FASTTABLE_INIT({\n");
    for (const auto& ent : table) {
      output("    {0x$1, &$0},\n", ent.first,
             absl::StrCat(absl::Hex(ent.second, absl::kZeroPad16)));
    }
    output("  }),\n");
  }
  output("};\n\n");
}

int WriteEnums(const protobuf::FileDescriptor* file, Output& output) {
  if (file->syntax() != protobuf::FileDescriptor::SYNTAX_PROTO2) {
    return 0;
  }

  std::vector<const protobuf::EnumDescriptor*> this_file_enums =
      SortedEnums(file);

  std::string values_init = "NULL";

  for (const auto* e : this_file_enums) {
    uint64_t mask = 0;
    std::vector<int32_t> values;
    for (auto number : SortedUniqueEnumNumbers(e)) {
      if (static_cast<uint32_t>(number) < 64) {
        mask |= 1ULL << number;
      } else {
        values.push_back(number);
      }
    }

    if (!values.empty()) {
      values_init = EnumInit(e) + "_values";
      output("static const int32_t $0[$1] = {\n", values_init, values.size());
      for (int32_t value : values) {
        output("  $0,\n", value);
      }
      output("};\n\n");
    }

    output("const upb_MiniTable_Enum $0 = {\n", EnumInit(e));
    output("  $0,\n", values_init);
    output("  0x$0ULL,\n", absl::Hex(mask));
    output("  $0,\n", values.size());

    output("};\n\n");
  }

  if (!this_file_enums.empty()) {
    output("static const upb_MiniTable_Enum *$0[$1] = {\n", kEnumsInit,
           this_file_enums.size());
    for (const auto* e : this_file_enums) {
      output("  &$0,\n", EnumInit(e));
    }
    output("};\n");
    output("\n");
  }

  return this_file_enums.size();
}

int WriteMessages(const FileLayout& layout, Output& output,
                  bool fasttable_enabled) {
  const protobuf::FileDescriptor* file = layout.descriptor();
  std::vector<const protobuf::Descriptor*> file_messages = SortedMessages(file);

  if (file_messages.empty()) return 0;

  for (auto message : file_messages) {
    WriteMessage(message, layout, output, fasttable_enabled);
  }

  output("static const upb_MiniTable *$0[$1] = {\n", kMessagesInit,
         file_messages.size());
  for (auto message : file_messages) {
    output("  &$0,\n", MessageInit(message));
  }
  output("};\n");
  output("\n");
  return file_messages.size();
}

void WriteExtension(const upb_MiniTable_Extension* ext, Output& output) {
  WriteField(&ext->field, &ext->field, output);
  output(",\n");
  output("  &$0,\n", reinterpret_cast<const char*>(ext->extendee));
  output("  $0,\n", FilePlatformLayout::GetSub(ext->sub));
}

int WriteExtensions(const FileLayout& layout, Output& output) {
  auto exts = SortedExtensions(layout.descriptor());
  absl::flat_hash_set<const protobuf::Descriptor*> forward_decls;

  if (exts.empty()) return 0;

  // Order by full name for consistent ordering.
  std::map<std::string, const protobuf::Descriptor*> forward_messages;

  for (auto ext : exts) {
    forward_messages[ext->containing_type()->full_name()] =
        ext->containing_type();
    if (ext->message_type()) {
      forward_messages[ext->message_type()->full_name()] = ext->message_type();
    }
  }

  for (const auto& decl : forward_messages) {
    output("extern const upb_MiniTable $0;\n", MessageInit(decl.second));
  }

  for (auto ext : exts) {
    output("const upb_MiniTable_Extension $0 = {\n  ", ExtensionLayout(ext));
    WriteExtension(layout.GetExtension(ext), output);
    output("\n};\n");
  }

  output(
      "\n"
      "static const upb_MiniTable_Extension *$0[$1] = {\n",
      kExtensionsInit, exts.size());

  for (auto ext : exts) {
    output("  &$0,\n", ExtensionLayout(ext));
  }

  output(
      "};\n"
      "\n");
  return exts.size();
}

// Writes a .upb.c source file.
void WriteSource(const FileLayout& layout, Output& output,
                 bool fasttable_enabled) {
  const protobuf::FileDescriptor* file = layout.descriptor();
  EmitFileWarning(file, output);

  output(
      "#include <stddef.h>\n"
      "#include \"upb/msg_internal.h\"\n"
      "#include \"$0\"\n",
      HeaderFilename(file));

  for (int i = 0; i < file->dependency_count(); i++) {
    output("#include \"$0\"\n", HeaderFilename(file->dependency(i)));
  }

  output(
      "\n"
      "#include \"upb/port_def.inc\"\n"
      "\n");

  int msg_count = WriteMessages(file, output, fasttable_enabled);
  int ext_count = WriteExtensions(layout, output);
  int enum_count = WriteEnums(file, output);

  output("const upb_MiniTable_File $0 = {\n", FileLayoutName(file));
  output("  $0,\n", msg_count ? kMessagesInit : "NULL");
  output("  $0,\n", enum_count ? kEnumsInit : "NULL");
  output("  $0,\n", ext_count ? kExtensionsInit : "NULL");
  output("  $0,\n", msg_count);
  output("  $0,\n", enum_count);
  output("  $0,\n", ext_count);
  output("};\n\n");

  output("#include \"upb/port_undef.inc\"\n");
  output("\n");
}

class Generator : public protoc::CodeGenerator {
  ~Generator() override {}
  bool Generate(const protobuf::FileDescriptor* file,
                const std::string& parameter, protoc::GeneratorContext* context,
                std::string* error) const override;
  uint64_t GetSupportedFeatures() const override {
    return FEATURE_PROTO3_OPTIONAL;
  }
};

bool Generator::Generate(const protobuf::FileDescriptor* file,
                         const std::string& parameter,
                         protoc::GeneratorContext* context,
                         std::string* error) const {
  bool fasttable_enabled = false;
  std::vector<std::pair<std::string, std::string>> params;
  google::protobuf::compiler::ParseGeneratorParameter(parameter, &params);

  for (const auto& pair : params) {
    if (pair.first == "fasttable") {
      fasttable_enabled = true;
    } else {
      *error = "Unknown parameter: " + pair.first;
      return false;
    }
  }

  FileLayout layout(file);

  std::unique_ptr<protobuf::io::ZeroCopyOutputStream> h_output_stream(
      context->Open(HeaderFilename(file)));
  Output h_output(h_output_stream.get());
  WriteHeader(layout, h_output);

  std::unique_ptr<protobuf::io::ZeroCopyOutputStream> c_output_stream(
      context->Open(SourceFilename(file)));
  Output c_output(c_output_stream.get());
  WriteSource(layout, c_output, fasttable_enabled);

  return true;
}

}  // namespace
}  // namespace upbc

int main(int argc, char** argv) {
  std::unique_ptr<google::protobuf::compiler::CodeGenerator> generator(
      new upbc::Generator());
  return google::protobuf::compiler::PluginMain(argc, argv, generator.get());
}