1 /*
2 * Copyright (c) 2009-2021, Google LLC
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Google LLC nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 // upb_Encode: parsing from a upb_Message using a upb_MiniTable.
29
30 #ifndef UPB_WIRE_ENCODE_H_
31 #define UPB_WIRE_ENCODE_H_
32
33 #include "upb/message/message.h"
34
35 // Must be last.
36 #include "upb/port/def.inc"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 enum {
43 /* If set, the results of serializing will be deterministic across all
44 * instances of this binary. There are no guarantees across different
45 * binary builds.
46 *
47 * If your proto contains maps, the encoder will need to malloc()/free()
48 * memory during encode. */
49 kUpb_EncodeOption_Deterministic = 1,
50
51 // When set, unknown fields are not printed.
52 kUpb_EncodeOption_SkipUnknown = 2,
53
54 // When set, the encode will fail if any required fields are missing.
55 kUpb_EncodeOption_CheckRequired = 4,
56 };
57
58 typedef enum {
59 kUpb_EncodeStatus_Ok = 0,
60 kUpb_EncodeStatus_OutOfMemory = 1, // Arena alloc failed
61 kUpb_EncodeStatus_MaxDepthExceeded = 2,
62
63 // kUpb_EncodeOption_CheckRequired failed but the parse otherwise succeeded.
64 kUpb_EncodeStatus_MissingRequired = 3,
65 } upb_EncodeStatus;
66
upb_EncodeOptions_MaxDepth(uint16_t depth)67 UPB_INLINE uint32_t upb_EncodeOptions_MaxDepth(uint16_t depth) {
68 return (uint32_t)depth << 16;
69 }
70
upb_EncodeOptions_GetMaxDepth(uint32_t options)71 UPB_INLINE uint16_t upb_EncodeOptions_GetMaxDepth(uint32_t options) {
72 return options >> 16;
73 }
74
75 // Enforce an upper bound on recursion depth.
upb_Encode_LimitDepth(uint32_t encode_options,uint32_t limit)76 UPB_INLINE int upb_Encode_LimitDepth(uint32_t encode_options, uint32_t limit) {
77 uint32_t max_depth = upb_EncodeOptions_GetMaxDepth(encode_options);
78 if (max_depth > limit) max_depth = limit;
79 return upb_EncodeOptions_MaxDepth(max_depth) | (encode_options & 0xffff);
80 }
81
82 upb_EncodeStatus upb_Encode(const void* msg, const upb_MiniTable* l,
83 int options, upb_Arena* arena, char** buf,
84 size_t* size);
85
86 #ifdef __cplusplus
87 } /* extern "C" */
88 #endif
89
90 #include "upb/port/undef.inc"
91
92 #endif /* UPB_WIRE_ENCODE_H_ */
93