1 /*
2  * Copyright (c) 2009-2022, 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 #include "upbc/code_generator_request.h"
29 
30 #include <inttypes.h>
31 
32 #include "google/protobuf/compiler/plugin.upb.h"
33 #include "upb/mini_table/decode.h"
34 #include "upb/reflection/def.h"
35 
36 // Must be last.
37 #include "upb/port/def.inc"
38 
39 /******************************************************************************/
40 
41 // Kitchen sink storage for all of our state as we build the mini descriptors.
42 
43 typedef struct {
44   upb_Arena* arena;
45   upb_Status* status;
46   upb_DefPool* symtab;
47 
48   upbc_CodeGeneratorRequest* out;
49 
50   jmp_buf jmp;
51 } upbc_State;
52 
upbc_State_Fini(upbc_State * s)53 static void upbc_State_Fini(upbc_State* s) {
54   if (s->symtab) upb_DefPool_Free(s->symtab);
55 }
56 
upbc_Error(upbc_State * s,const char * fn,const char * msg)57 UPB_NORETURN static void upbc_Error(upbc_State* s, const char* fn,
58                                     const char* msg) {
59   upb_Status_SetErrorFormat(s->status, "%s(): %s", fn, msg);
60   upbc_State_Fini(s);
61   UPB_LONGJMP(s->jmp, -1);
62 }
63 
upbc_State_Init(upbc_State * s)64 static void upbc_State_Init(upbc_State* s) {
65   s->symtab = upb_DefPool_New();
66   if (!s->symtab) upbc_Error(s, __func__, "could not allocate def pool");
67 
68   s->out = upbc_CodeGeneratorRequest_new(s->arena);
69   if (!s->out) upbc_Error(s, __func__, "could not allocate request");
70 }
71 
upbc_State_StrDup(upbc_State * s,const char * str)72 static upb_StringView upbc_State_StrDup(upbc_State* s, const char* str) {
73   upb_StringView from = upb_StringView_FromString(str);
74   char* to = upb_Arena_Malloc(s->arena, from.size);
75   if (!to) upbc_Error(s, __func__, "Out of memory");
76   memcpy(to, from.data, from.size);
77   return upb_StringView_FromDataAndSize(to, from.size);
78 }
79 
upbc_State_AddMiniDescriptor(upbc_State * s,const char * name,upb_StringView encoding)80 static void upbc_State_AddMiniDescriptor(upbc_State* s, const char* name,
81                                          upb_StringView encoding) {
82   const upb_StringView key = upb_StringView_FromString(name);
83   upbc_CodeGeneratorRequest_UpbInfo* info =
84       upbc_CodeGeneratorRequest_UpbInfo_new(s->arena);
85   if (!info) upbc_Error(s, __func__, "Out of memory");
86   upbc_CodeGeneratorRequest_UpbInfo_set_mini_descriptor(info, encoding);
87   bool ok = upbc_CodeGeneratorRequest_upb_info_set(s->out, key, info, s->arena);
88   if (!ok) upbc_Error(s, __func__, "could not set mini descriptor in map");
89 }
90 
91 /******************************************************************************/
92 
93 // Forward declaration.
94 static void upbc_Scrape_Message(upbc_State*, const upb_MessageDef*);
95 
upbc_Scrape_Enum(upbc_State * s,const upb_EnumDef * e)96 static void upbc_Scrape_Enum(upbc_State* s, const upb_EnumDef* e) {
97   upb_StringView desc;
98   bool ok = upb_EnumDef_MiniDescriptorEncode(e, s->arena, &desc);
99   if (!ok) upbc_Error(s, __func__, "could not encode enum");
100 
101   upbc_State_AddMiniDescriptor(s, upb_EnumDef_FullName(e), desc);
102 }
103 
upbc_Scrape_Extension(upbc_State * s,const upb_FieldDef * f)104 static void upbc_Scrape_Extension(upbc_State* s, const upb_FieldDef* f) {
105   upb_StringView desc;
106   bool ok = upb_FieldDef_MiniDescriptorEncode(f, s->arena, &desc);
107   if (!ok) upbc_Error(s, __func__, "could not encode extension");
108 
109   upbc_State_AddMiniDescriptor(s, upb_FieldDef_FullName(f), desc);
110 }
111 
upbc_Scrape_FileEnums(upbc_State * s,const upb_FileDef * f)112 static void upbc_Scrape_FileEnums(upbc_State* s, const upb_FileDef* f) {
113   const size_t len = upb_FileDef_TopLevelEnumCount(f);
114 
115   for (size_t i = 0; i < len; i++) {
116     upbc_Scrape_Enum(s, upb_FileDef_TopLevelEnum(f, i));
117   }
118 }
119 
upbc_Scrape_FileExtensions(upbc_State * s,const upb_FileDef * f)120 static void upbc_Scrape_FileExtensions(upbc_State* s, const upb_FileDef* f) {
121   const size_t len = upb_FileDef_TopLevelExtensionCount(f);
122 
123   for (size_t i = 0; i < len; i++) {
124     upbc_Scrape_Extension(s, upb_FileDef_TopLevelExtension(f, i));
125   }
126 }
127 
upbc_Scrape_FileMessages(upbc_State * s,const upb_FileDef * f)128 static void upbc_Scrape_FileMessages(upbc_State* s, const upb_FileDef* f) {
129   const size_t len = upb_FileDef_TopLevelMessageCount(f);
130 
131   for (size_t i = 0; i < len; i++) {
132     upbc_Scrape_Message(s, upb_FileDef_TopLevelMessage(f, i));
133   }
134 }
135 
upbc_Scrape_File(upbc_State * s,const upb_FileDef * f)136 static void upbc_Scrape_File(upbc_State* s, const upb_FileDef* f) {
137   upbc_Scrape_FileEnums(s, f);
138   upbc_Scrape_FileExtensions(s, f);
139   upbc_Scrape_FileMessages(s, f);
140 }
141 
upbc_Scrape_Files(upbc_State * s)142 static void upbc_Scrape_Files(upbc_State* s) {
143   const google_protobuf_compiler_CodeGeneratorRequest* request =
144       upbc_CodeGeneratorRequest_request(s->out);
145 
146   size_t len = 0;
147   const google_protobuf_FileDescriptorProto* const* files =
148       google_protobuf_compiler_CodeGeneratorRequest_proto_file(request, &len);
149 
150   for (size_t i = 0; i < len; i++) {
151     const upb_FileDef* f = upb_DefPool_AddFile(s->symtab, files[i], s->status);
152     if (!f) upbc_Error(s, __func__, "could not add file to def pool");
153 
154     upbc_Scrape_File(s, f);
155   }
156 }
157 
upbc_Scrape_NestedEnums(upbc_State * s,const upb_MessageDef * m)158 static void upbc_Scrape_NestedEnums(upbc_State* s, const upb_MessageDef* m) {
159   const size_t len = upb_MessageDef_NestedEnumCount(m);
160 
161   for (size_t i = 0; i < len; i++) {
162     upbc_Scrape_Enum(s, upb_MessageDef_NestedEnum(m, i));
163   }
164 }
165 
upbc_Scrape_NestedExtensions(upbc_State * s,const upb_MessageDef * m)166 static void upbc_Scrape_NestedExtensions(upbc_State* s,
167                                          const upb_MessageDef* m) {
168   const size_t len = upb_MessageDef_NestedExtensionCount(m);
169 
170   for (size_t i = 0; i < len; i++) {
171     upbc_Scrape_Extension(s, upb_MessageDef_NestedExtension(m, i));
172   }
173 }
174 
upbc_Scrape_NestedMessages(upbc_State * s,const upb_MessageDef * m)175 static void upbc_Scrape_NestedMessages(upbc_State* s, const upb_MessageDef* m) {
176   const size_t len = upb_MessageDef_NestedMessageCount(m);
177 
178   for (size_t i = 0; i < len; i++) {
179     upbc_Scrape_Message(s, upb_MessageDef_NestedMessage(m, i));
180   }
181 }
182 
upbc_Scrape_MessageSubs(upbc_State * s,upbc_CodeGeneratorRequest_UpbInfo * info,const upb_MessageDef * m)183 static void upbc_Scrape_MessageSubs(upbc_State* s,
184                                     upbc_CodeGeneratorRequest_UpbInfo* info,
185                                     const upb_MessageDef* m) {
186   const upb_MiniTableField** fields =
187       malloc(upb_MessageDef_FieldCount(m) * sizeof(*fields));
188   const upb_MiniTable* mt = upb_MessageDef_MiniTable(m);
189   uint32_t counts = upb_MiniTable_GetSubList(mt, fields);
190   uint32_t msg_count = counts >> 16;
191   uint32_t enum_count = counts & 0xffff;
192 
193   for (uint32_t i = 0; i < msg_count; i++) {
194     const upb_FieldDef* f =
195         upb_MessageDef_FindFieldByNumber(m, fields[i]->number);
196     if (!f) upbc_Error(s, __func__, "Missing f");
197     const upb_MessageDef* sub = upb_FieldDef_MessageSubDef(f);
198     if (!sub) upbc_Error(s, __func__, "Missing sub");
199     upb_StringView name = upbc_State_StrDup(s, upb_MessageDef_FullName(sub));
200     upbc_CodeGeneratorRequest_UpbInfo_add_sub_message(info, name, s->arena);
201   }
202 
203   for (uint32_t i = 0; i < enum_count; i++) {
204     const upb_FieldDef* f =
205         upb_MessageDef_FindFieldByNumber(m, fields[msg_count + i]->number);
206     if (!f) upbc_Error(s, __func__, "Missing f (2)");
207     const upb_EnumDef* sub = upb_FieldDef_EnumSubDef(f);
208     if (!sub) upbc_Error(s, __func__, "Missing sub (2)");
209     upb_StringView name = upbc_State_StrDup(s, upb_EnumDef_FullName(sub));
210     upbc_CodeGeneratorRequest_UpbInfo_add_sub_enum(info, name, s->arena);
211   }
212 
213   free(fields);
214 }
215 
upbc_Scrape_Message(upbc_State * s,const upb_MessageDef * m)216 static void upbc_Scrape_Message(upbc_State* s, const upb_MessageDef* m) {
217   upb_StringView desc;
218   bool ok = upb_MessageDef_MiniDescriptorEncode(m, s->arena, &desc);
219   if (!ok) upbc_Error(s, __func__, "could not encode message");
220 
221   upbc_CodeGeneratorRequest_UpbInfo* info =
222       upbc_CodeGeneratorRequest_UpbInfo_new(s->arena);
223   if (!info) upbc_Error(s, __func__, "Out of memory");
224   upbc_CodeGeneratorRequest_UpbInfo_set_mini_descriptor(info, desc);
225 
226   upbc_Scrape_MessageSubs(s, info, m);
227 
228   const upb_StringView key = upbc_State_StrDup(s, upb_MessageDef_FullName(m));
229   ok = upbc_CodeGeneratorRequest_upb_info_set(s->out, key, info, s->arena);
230   if (!ok) upbc_Error(s, __func__, "could not set mini descriptor in map");
231 
232   upbc_Scrape_NestedEnums(s, m);
233   upbc_Scrape_NestedExtensions(s, m);
234   upbc_Scrape_NestedMessages(s, m);
235 }
236 
upbc_State_MakeCodeGeneratorRequest(upbc_State * const s,google_protobuf_compiler_CodeGeneratorRequest * const request)237 static upbc_CodeGeneratorRequest* upbc_State_MakeCodeGeneratorRequest(
238     upbc_State* const s, google_protobuf_compiler_CodeGeneratorRequest* const request) {
239   if (UPB_SETJMP(s->jmp)) return NULL;
240   upbc_State_Init(s);
241 
242   upbc_CodeGeneratorRequest_set_request(s->out, request);
243   upbc_Scrape_Files(s);
244   upbc_State_Fini(s);
245   return s->out;
246 }
247 
upbc_MakeCodeGeneratorRequest(google_protobuf_compiler_CodeGeneratorRequest * request,upb_Arena * arena,upb_Status * status)248 upbc_CodeGeneratorRequest* upbc_MakeCodeGeneratorRequest(
249     google_protobuf_compiler_CodeGeneratorRequest* request, upb_Arena* arena,
250     upb_Status* status) {
251   upbc_State s = {
252       .arena = arena,
253       .status = status,
254       .symtab = NULL,
255       .out = NULL,
256   };
257 
258   return upbc_State_MakeCodeGeneratorRequest(&s, request);
259 }
260