|
|
|
|
/*
|
|
|
|
|
* Copyright (c) 2009-2022, 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.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef UPB_MINI_TABLE_COMMON_H_
|
|
|
|
|
#define UPB_MINI_TABLE_COMMON_H_
|
|
|
|
|
|
|
|
|
|
#include "upb/mini_table/field_internal.h"
|
|
|
|
|
#include "upb/mini_table/message_internal.h"
|
|
|
|
|
#include "upb/mini_table/sub_internal.h"
|
|
|
|
|
|
|
|
|
|
// Must be last.
|
|
|
|
|
#include "upb/port/def.inc"
|
|
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
|
kUpb_FieldModifier_IsRepeated = 1 << 0,
|
|
|
|
|
kUpb_FieldModifier_IsPacked = 1 << 1,
|
|
|
|
|
kUpb_FieldModifier_IsClosedEnum = 1 << 2,
|
|
|
|
|
kUpb_FieldModifier_IsProto3Singular = 1 << 3,
|
|
|
|
|
kUpb_FieldModifier_IsRequired = 1 << 4,
|
|
|
|
|
} kUpb_FieldModifier;
|
|
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
|
kUpb_MessageModifier_ValidateUtf8 = 1 << 0,
|
|
|
|
|
kUpb_MessageModifier_DefaultIsPacked = 1 << 1,
|
|
|
|
|
kUpb_MessageModifier_IsExtendable = 1 << 2,
|
|
|
|
|
} kUpb_MessageModifier;
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C" {
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
const upb_MiniTableField* upb_MiniTable_FindFieldByNumber(
|
|
|
|
|
const upb_MiniTable* table, uint32_t number);
|
|
|
|
|
|
|
|
|
|
upb_FieldType upb_MiniTableField_Type(const upb_MiniTableField* field);
|
|
|
|
|
|
Refactored message accessors to share a common set of functions instead of duplicating logic.
Prior to this CL, there were several different code paths for reading/writing message data. Generated code, MiniTable accessors, and reflection all performed direct manipulation of the bits and bytes in a message, but they all had distinct implementations that did not share much of any code. This divergence meant that they could easily have different behavior, bugs could creep into one but not another, and we would need three different sets of tests to get full test coverage. This also made it very difficult to change the internal representation in any way, since it would require updating many places in the code.
With this CL, the three different APIs for accessing message data now all share a common set of functions. The common functions all take a `upb_MiniTableField` as the canonical description of a field's type and layout. The lowest-level functions are very branchy, as they must test for every possible variation in the field type (field vs oneof, hasbit vs no-hasbit, different field sizes, whether a nonzero default value exists, extension vs. regular field), however these functions are declared inline and designed to be very optimizable when values are known at compile time.
In generated accessors, for example, we can declare constant `upb_MiniTableField` instances so that all values can constant-propagate, and we can get fully specialized code even though we are calling a generic function. On the other hand, when we use the generic functions from reflection, we get runtime branches since values are not known at compile time. But even the function is written to still be as efficient as possible even when used from reflection. For example, we use memcpy() calls with constant length so that the compiler can optimize these into inline loads/stores without having to make an out-of-line call to memcpy().
In this way, this CL should be a benefit to both correctness and performance. It will also make it easier to change the message representation, for example to optimize the encoder by giving hasbits to all fields.
Note that we have not completely consolidated all access in this CL:
1. Some functions outside of get/set such as clear and hazzers are not yet unified.
2. The encoder and decoder still touch the message without going through the common functions. The encoder and decoder require a bit more specialized code to get good performance when reading/writing fields en masse.
PiperOrigin-RevId: 490016095
2 years ago
|
|
|
UPB_INLINE bool upb_MiniTableField_IsExtension(
|
|
|
|
|
const upb_MiniTableField* field) {
|
|
|
|
|
return field->mode & kUpb_LabelFlags_IsExtension;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
UPB_INLINE bool upb_MiniTableField_HasPresence(
|
|
|
|
|
const upb_MiniTableField* field) {
|
|
|
|
|
if (upb_MiniTableField_IsExtension(field)) {
|
|
|
|
|
return !upb_IsRepeatedOrMap(field);
|
|
|
|
|
} else {
|
|
|
|
|
return field->presence != 0;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
UPB_INLINE const upb_MiniTable* upb_MiniTable_GetSubMessageTable(
|
|
|
|
|
const upb_MiniTable* mini_table, const upb_MiniTableField* field) {
|
|
|
|
|
return mini_table->subs[field->submsg_index].submsg;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
UPB_INLINE const upb_MiniTableEnum* upb_MiniTable_GetSubEnumTable(
|
|
|
|
|
const upb_MiniTable* mini_table, const upb_MiniTableField* field) {
|
|
|
|
|
return mini_table->subs[field->submsg_index].subenum;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
} /* extern "C" */
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#include "upb/port/undef.inc"
|
|
|
|
|
|
|
|
|
|
#endif /* UPB_MINI_TABLE_COMMON_H_ */
|
