1 /* 2 * Template output. 3 * 4 * Copyright (C) 2019, 2020, 2021, 2022 Paul Boddie <paul@boddie.org.uk> 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation; either version 2 of 9 * the License, or (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 * Boston, MA 02110-1301, USA 20 */ 21 22 #pragma once 23 24 /* Filename definitions. */ 25 26 #define client_filename_c "%s/%s_client.c" 27 #define client_filename_cpp "%s/%s_client.cc" 28 #define client_header_filename "%s/%s_client.h" 29 #define interface_filename "%s/%s_interface.h" 30 #define server_filename_c "%s/%s_server.c" 31 #define server_filename_cpp "%s/%s_server.cc" 32 #define server_header_filename "%s/%s_server.h" 33 34 35 36 /* Client templates. */ 37 38 #define client_prologue \ 39 "#include \"%s_client.h\"\n" \ 40 "#include <ipc/message.h>\n" 41 42 #define client_function_body_prologue \ 43 " ipc_message_t msg;\n" \ 44 " long err;\n" 45 46 #define client_function_body_endpoint_conversion_c \ 47 " %s _endp = _self.cap;\n" 48 49 #define client_function_body_call \ 50 "\n ipc_message_request(&msg, %s, %s);\n\n" \ 51 " err = l4_error(msg.tag);\n" \ 52 " if (err)\n" \ 53 " return err;\n" 54 55 #define client_function_body_epilogue \ 56 "\n ipc_message_free(&msg);\n" \ 57 " return L4_EOK;\n" 58 59 /* Client interface definitions for C++. */ 60 61 #define client_interface_prologue_cpp \ 62 " : public %s" 63 64 #define client_interface_endpoint_declaration_cpp \ 65 "protected:\n" \ 66 " %s _endp;\n\n" 67 68 #define client_interface_constructor_cpp \ 69 "\n %s(%s endp) : _endp(endp) { }\n" 70 71 /* Client interface definitions for C. */ 72 73 #define client_interface_declaration_c \ 74 "\nextern iface_%s client_iface_%s;\n" 75 76 #define client_interface_prologue_empty_c \ 77 "\niface_%s client_iface_%s;" 78 79 #define client_interface_prologue_c \ 80 "\niface_%s client_iface_%s = {" 81 82 #define client_interface_member_c \ 83 "\n .%s = %s," 84 85 #define client_interface_epilogue_c \ 86 "\n};\n" 87 88 89 90 /* Compound interface definitions. */ 91 92 #define compound_interface_include \ 93 "#include \"%s_interface.h\"\n" 94 95 #define compound_ref_type_definition_prologue_c \ 96 "\ntypedef struct {\n" \ 97 " union {\n" \ 98 " %s cap;\n" \ 99 " void *ptr;\n" \ 100 " };\n" 101 102 #define compound_ref_type_definition_member_c \ 103 " ref_%s as_%s;\n" 104 105 #define compound_ref_type_definition_epilogue_c \ 106 "} ref_%s;\n" 107 108 #define compound_interface_conversion_c \ 109 "\n#define convert_to_%s(_self) (&((%s) {.iface=_self->iface->to_%s, .ref=_self->ref.as_%s}))\n" 110 111 #define compound_interface_conversion_cpp \ 112 "\n#define convert_to_%s(_self) (_self)\n" 113 114 115 116 /* Dispatch functions. */ 117 118 #define dispatch_function_signature \ 119 "\nvoid dispatch_%s(ipc_message_t *msg, %s *_self)" 120 121 #define dispatch_function_prologue \ 122 " long err;\n\n" 123 124 #define dispatch_function_test_protocol \ 125 " if (l4_msgtag_label(msg->tag) != %s)\n" \ 126 " {\n" \ 127 " ipc_message_send_error(msg, -L4_EBADPROTO);\n" \ 128 " return;\n" \ 129 " }\n" 130 131 #define dispatch_function_label_dispatcher \ 132 " switch (l4_msgtag_label(msg->tag))\n" \ 133 " {\n" 134 135 #define dispatch_function_word_dispatcher \ 136 " switch (ipc_message_get_word(msg, 0))\n" \ 137 " {\n" 138 139 /* Dispatch templates. */ 140 141 #define dispatch_function_case_prologue \ 142 " case %s:\n" 143 144 #define dispatch_function_case_epilogue \ 145 " break;\n\n" 146 147 #define dispatch_function_interface_case \ 148 " case %s:\n" \ 149 " dispatch_%s(msg, %s);\n" \ 150 " break;\n\n" 151 152 #define dispatch_function_wrapper_case \ 153 " case %s:\n" \ 154 " ipc_message_send_error(msg, %s_%s(msg, %s));\n" \ 155 " break;\n\n" 156 157 #define dispatch_function_reply_wrapper_case \ 158 " case %s:\n" \ 159 " err = %s_%s(msg, %s);\n" \ 160 " ipc_message_send_error(msg, err != IPC_MESSAGE_SENT ? err : (long) L4_EOK);\n" \ 161 " if (err != IPC_MESSAGE_SENT)\n" \ 162 " ipc_message_reply(msg);\n" \ 163 " break;\n\n" 164 165 #define dispatch_function_default_case \ 166 " default:\n" \ 167 " ipc_message_send_error(msg, -L4_EBADPROTO);\n" \ 168 " ipc_message_reply(msg);\n" \ 169 " break;\n" 170 171 #define dispatch_function_dispatcher_epilogue \ 172 " }\n" 173 174 175 176 /* Message handling functions. */ 177 178 #define handle_function_signature \ 179 "\nvoid handle_%s(ipc_message_t *msg, %s *_self)" 180 181 #define handle_function \ 182 " ipc_message_open(msg);\n" \ 183 " dispatch_%s(msg, _self);\n" \ 184 " ipc_message_discard(msg);\n" 185 186 187 188 /* General header template. */ 189 190 #define header_prologue \ 191 "#pragma once\n\n" \ 192 "#include <l4/sys/err.h>\n" \ 193 "#include <l4/sys/types.h>\n" 194 195 196 197 /* Server templates. */ 198 199 #define server_header_prologue \ 200 "#pragma once\n\n" \ 201 "#include <ipc/message.h>\n" \ 202 "#include <ipc/server.h>\n" 203 204 #define server_prologue \ 205 "#include \"%s_server.h\"\n" 206 207 #define server_config_instance_declaration \ 208 "\nextern ipc_server_default_config_type config_%s;\n" 209 210 #define server_config_instance \ 211 "\nipc_server_default_config_type config_%s = {\n" \ 212 " %s_expected_items, (ipc_server_handler_type) handle_%s};\n" 213 214 /* Server wrapper function templates. */ 215 216 #define server_function_signature \ 217 "\nlong %s_%s(ipc_message_t *msg, %s *_self)" 218 219 #define server_function_body_prologue \ 220 " long err;\n" 221 222 #define server_function_body_unused_message \ 223 "\n (void) msg;\n" 224 225 #define server_function_body_call \ 226 " if (err)\n" \ 227 " return err;\n" 228 229 #define server_function_body_epilogue \ 230 "\n return L4_EOK;\n" 231 232 #define server_completion_function_signature_prologue \ 233 "\nlong complete_%s(l4_cap_idx_t _endp" 234 235 #define server_completion_optional_function_signature_prologue \ 236 "\nlong complete_%s(" 237 238 #define server_completion_function_body_prologue \ 239 " ipc_message_t msg;\n" 240 241 #define server_completion_function_body_epilogue \ 242 "\n ipc_message_send(&msg, %s, %s);\n\n" \ 243 " return l4_error(msg.tag);\n" 244 245 #define server_completion_optional_function_body_epilogue \ 246 "\n ipc_message_reply(&msg);\n\n" \ 247 " return l4_error(msg.tag);\n" 248 249 #define server_initiation_function_body_epilogue \ 250 "\n ipc_message_prepare(msg);\n\n" \ 251 " return L4_EOK;\n" 252 253 254 255 /* Interface class definitions. */ 256 257 #define interface_prologue_cpp \ 258 "\n#ifdef __cplusplus\n" \ 259 "\nclass %s" 260 261 #define interface_prologue_base_cpp \ 262 "%spublic %s" 263 264 #define interface_prologue_c \ 265 "\ntypedef struct" \ 266 267 #define interface_body_begin \ 268 "\n{\n" 269 270 #define interface_body_base_c \ 271 " iface_%s *to_%s;\n" 272 273 #define interface_signatures_prologue_cpp \ 274 "public:" 275 276 #define interface_epilogue_cpp \ 277 "};\n\n" \ 278 "#endif /* __cplusplus */\n" 279 280 #define interface_epilogue_c \ 281 "\n} iface_%s;\n" 282 283 #define interface_function_signature_prologue \ 284 "\n%slong %s(" 285 286 #define interface_struct_member_function_signature_prologue \ 287 " long (*%s)(" 288 289 #define interface_unimplemented_method_prologue_cpp \ 290 "\n {" 291 292 #define interface_unimplemented_method_epilogue_cpp \ 293 " return -L4_EBADPROTO; }\n" 294 295 #define interface_unused_parameter \ 296 " (void) %s;" 297 298 /* Reference and object type definitions for interfaces. */ 299 300 #define ref_type_definition_c \ 301 "\ntypedef union { %s cap; void *ptr; } ref_%s;\n" 302 303 #define object_type_definition_c \ 304 "\ntypedef struct\n" \ 305 "{\n" \ 306 " ref_%s ref;\n" \ 307 " iface_%s *iface;\n" \ 308 "\n} %s;\n" 309 310 #define expected_items_definition \ 311 "\n#define %s_expected_items %d\n" 312 313 314 315 /* Opcode definitions. */ 316 317 #define opcode_enumeration_prologue \ 318 "\nenum opcodes_%s\n{\n" 319 320 #define opcode_identifier \ 321 " opcode_%s_%s" 322 323 #define opcode_enumeration_epilogue \ 324 "};\n" 325 326 /* Message structure definitions. */ 327 328 #define structure_prologue \ 329 "\nstruct %s_words_%s\n{\n" 330 331 #define structure_opcode_member \ 332 " %s _op;\n" 333 334 #define structure_epilogue \ 335 "};\n" 336 337 /* Message access templates. */ 338 339 #define message_accessor_declaration \ 340 " struct %s_words_%s *%s_words;\n" 341 342 #define message_accessor_initialisation \ 343 "\n %s_words = (struct %s_words_%s *)" 344 345 #define message_accessor_reading_initialiser \ 346 " ipc_message_get_word_address(%smsg, 0);\n" 347 348 #define message_accessor_writing_initialiser \ 349 " ipc_message_reserve_words(%smsg, sizeof(struct %s_words_%s));\n" 350 351 352 353 /* Tokens. */ 354 355 #define BEGIN_FUNCTION "\n{\n" 356 #define END_FUNCTION "}\n" 357 358 #define COMPLETE_MEMBER ";\n" 359 #define INDENT_MEMBER " " 360 361 #define COMPLETE_SIGNATURE ";\n" 362 #define END_SIGNATURE "\n" 363 364 365 366 /* Texts. */ 367 368 #define help_text \ 369 "Usage: %s [ <options> ] <filename> ...\n\n" \ 370 "Generate source code for the interfaces in the supplied files.\n\n" \ 371 "The following options are supported:\n\n" \ 372 "--all or -a Produce all kinds of output for a given language.\n\n" \ 373 "--client or -c Generate client code.\n\n" \ 374 "--dir or -d Create output in the indicated directory.\n\n" \ 375 "--files or -f Only show processed filenames, produce no files.\n\n" \ 376 "--headers or -h Produce header files.\n\n" \ 377 "--help or -? Show this message.\n\n" \ 378 "--interfaces or -i Produce interface header files.\n\n" \ 379 "--language or -l Generate code in the indicated language.\n\n" \ 380 "--recursive or -R Also generate code for any base interfaces.\n\n" \ 381 "--routines or -r Produce program routines.\n\n" \ 382 "--server or -s Generate server code.\n\n" \ 383 "--verbose or -v Show verbose output reporting the processed interfaces.\n\n" \ 384 "--version or -V Show version information.\n\n"