1 /* 2 * Template output. 3 * 4 * Copyright (C) 2019, 2020, 2021 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 compound_interface_type_filename "%s/%s_interface_type.h" 30 #define compound_interfaces_filename "%s/%s_interfaces.h" 31 #define interface_filename "%s/%s_interface.h" 32 #define server_filename_c "%s/%s_server.c" 33 #define server_filename_cpp "%s/%s_server.cc" 34 #define server_header_filename "%s/%s_server.h" 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 "\nprotected:\n" \ 66 " %s _endp;\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;" 75 76 #define client_interface_prologue_c \ 77 "\niface_%s client_iface_%s = {" 78 79 #define client_interface_member_c \ 80 "\n .%s = %s," 81 82 #define client_interface_epilogue_c \ 83 "\n};\n" 84 85 /* Compound interface dispatcher templates. */ 86 87 #define compound_dispatch_prologue \ 88 "#include \"%s_server.h\"\n" 89 90 #define compound_dispatch_function_prologue \ 91 " long err;\n\n" \ 92 " switch (l4_msgtag_label(msg->tag))\n" \ 93 " {\n" 94 95 #define compound_dispatch_epilogue \ 96 " default:\n" \ 97 " ipc_message_send_error(msg, -L4_EBADPROTO);\n" \ 98 " ipc_message_reply(msg);\n" \ 99 " break;\n" \ 100 " }\n" 101 102 #define compound_dispatch_header_prologue \ 103 "#pragma once\n\n" \ 104 "#include <ipc/message.h>\n" \ 105 "#include \"%s_interface.h\"\n" 106 107 /* Compound interface class definitions. */ 108 109 #define compound_interface_prologue_cpp \ 110 "#pragma once\n\n" \ 111 "#include \"%s_interfaces.h\"\n\n" \ 112 "#ifdef __cplusplus\n\n" \ 113 "class %s :" 114 115 #define compound_interface_prologue_c \ 116 "#pragma once\n\n" \ 117 "#include \"%s_interface_type.h\"\n\n" \ 118 "typedef struct\n" \ 119 "{\n" 120 121 #define compound_interface_epilogue_cpp \ 122 "\n{\n};\n\n" \ 123 "#endif /* __cplusplus */\n" 124 125 #define compound_interface_epilogue_c \ 126 "\n} iface_%s;\n" 127 128 #define compound_interfaces_prologue \ 129 "#pragma once\n\n" 130 131 #define compound_ref_type_definition_prologue_c \ 132 "#pragma once\n\n" \ 133 "#include <l4/sys/types.h>\n" \ 134 "#include \"%s_interfaces.h\"\n\n" \ 135 "typedef union {\n" \ 136 " %s cap;\n" \ 137 " void *ptr;\n" 138 139 #define compound_ref_type_definition_member_c \ 140 " ref_%s as_%s;\n" 141 142 #define compound_ref_type_definition_epilogue_c \ 143 "} ref_%s;\n" 144 145 #define compound_interface_conversion_c \ 146 "\n#define convert_to_%s(_self) (&((%s) {.iface=_self->iface->to_%s, .ref=_self->ref.as_%s}))\n" 147 148 #define compound_interface_conversion_cpp \ 149 "\n#define convert_to_%s(_self) (_self)\n" 150 151 /* Dispatch functions. */ 152 153 #define dispatch_function_signature \ 154 "\nvoid dispatch_%s(ipc_message_t *msg, %s *_self)" 155 156 /* Message handling functions. */ 157 158 #define handle_function_signature \ 159 "\nvoid handle_%s(ipc_message_t *msg, %s *_self)" 160 161 #define handle_function \ 162 " ipc_message_open(msg);\n" \ 163 " dispatch_%s(msg, _self);\n" \ 164 " ipc_message_discard(msg);\n" 165 166 /* General header template. */ 167 168 #define header_prologue \ 169 "#pragma once\n\n" \ 170 "#include <l4/sys/err.h>\n" \ 171 "#include <l4/sys/types.h>\n" 172 173 /* Server templates. */ 174 175 #define server_header_prologue \ 176 "#pragma once\n\n" \ 177 "#include <ipc/message.h>\n" 178 179 #define server_prologue \ 180 "#include \"%s_server.h\"\n" 181 182 /* Server wrapper function templates. */ 183 184 #define server_function_signature \ 185 "\nlong %s_%s(ipc_message_t *msg, %s *_self)" 186 187 #define server_function_body_prologue \ 188 " long err;\n" 189 190 #define server_function_body_unused_message \ 191 "\n (void) msg;\n" 192 193 #define server_function_body_call \ 194 " if (err)\n" \ 195 " return err;\n" 196 197 #define server_function_body_epilogue \ 198 "\n return L4_EOK;\n" 199 200 #define server_completion_function_signature_prologue \ 201 "\nlong complete_%s(l4_cap_idx_t _endp" 202 203 #define server_completion_optional_function_signature_prologue \ 204 "\nlong complete_%s(" 205 206 #define server_completion_function_body_prologue \ 207 " ipc_message_t msg;\n" 208 209 #define server_completion_function_body_epilogue \ 210 "\n ipc_message_send(&msg, %s, %s);\n\n" \ 211 " return l4_error(msg.tag);\n" 212 213 #define server_completion_optional_function_body_epilogue \ 214 "\n ipc_message_reply(&msg);\n\n" \ 215 " return l4_error(msg.tag);\n" 216 217 #define server_initiation_function_body_epilogue \ 218 "\n ipc_message_prepare(msg);\n\n" \ 219 " return L4_EOK;\n" 220 221 /* Server dispatch function templates. */ 222 223 #define server_function_dispatcher_body_epilogue \ 224 " default:\n" \ 225 " ipc_message_send_error(msg, -L4_EBADPROTO);\n" \ 226 " ipc_message_reply(msg);\n" \ 227 " break;\n" \ 228 " }\n" 229 230 /* Interface class definitions. */ 231 232 #define interface_prologue_cpp \ 233 "\n#ifdef __cplusplus\n" \ 234 "\nclass %s" 235 236 #define interface_prologue_c \ 237 "\ntypedef struct" \ 238 239 #define interface_body_begin \ 240 "\n{" 241 242 #define interface_signatures_prologue_cpp \ 243 "\npublic:" 244 245 #define interface_epilogue_cpp \ 246 "};\n\n" \ 247 "#endif /* __cplusplus */\n" 248 249 #define interface_epilogue_c \ 250 "\n} iface_%s;\n" 251 252 #define interface_function_signature_prologue \ 253 "\n%slong %s(" 254 255 #define interface_struct_member_function_signature_prologue \ 256 "\n long (*%s)(" 257 258 #define interface_unimplemented_method_prologue_cpp \ 259 "\n {" 260 261 #define interface_unimplemented_method_epilogue_cpp \ 262 " return -L4_EBADPROTO; }\n" 263 264 #define interface_unused_parameter \ 265 " (void) %s;" 266 267 /* Reference and object type definitions for interfaces. */ 268 269 #define ref_type_definition_c \ 270 "\ntypedef union { %s cap; void *ptr; } ref_%s;\n" 271 272 #define object_type_definition_c \ 273 "\ntypedef struct\n" \ 274 "{\n" \ 275 " ref_%s ref;\n" \ 276 " iface_%s *iface;\n" \ 277 "\n} %s;\n" 278 279 #define expected_items_definition \ 280 "\n#define %s_expected_items %d\n" 281 282 /* Opcode definitions. */ 283 284 #define opcode_enumeration_prologue \ 285 "\nenum opcodes_%s\n{\n" 286 287 #define opcode_identifier \ 288 " opcode_%s_%s" 289 290 #define opcode_enumeration_epilogue \ 291 "};\n" 292 293 /* Message structure definitions. */ 294 295 #define structure_prologue \ 296 "\nstruct %s_words_%s\n{\n" 297 298 #define structure_opcode_member \ 299 " %s _op;\n" 300 301 #define structure_epilogue \ 302 "};\n" 303 304 /* Message access templates. */ 305 306 #define message_accessor_declaration \ 307 " struct %s_words_%s *%s_words;\n" 308 309 #define message_accessor_initialisation \ 310 "\n %s_words = (struct %s_words_%s *)" 311 312 #define message_accessor_reading_initialiser \ 313 " ipc_message_get_word_address(%smsg, 0);\n" 314 315 #define message_accessor_writing_initialiser \ 316 " ipc_message_reserve_words(%smsg, sizeof(struct %s_words_%s));\n" 317 318 /* Dispatch templates. */ 319 320 #define dispatch_function_interface_case \ 321 " case %s:\n" \ 322 " dispatch_%s(msg, %s);\n" \ 323 " break;\n\n" 324 325 #define dispatch_function_wrapper_case \ 326 " case %s:\n" \ 327 " ipc_message_send_error(msg, %s_%s(msg, %s));\n" \ 328 " break;\n\n" 329 330 #define dispatch_function_reply_wrapper_case \ 331 " case %s:\n" \ 332 " err = %s_%s(msg, %s);\n" \ 333 " ipc_message_send_error(msg, err != IPC_MESSAGE_SENT ? err : (long) L4_EOK);\n" \ 334 " if (err != IPC_MESSAGE_SENT)\n" \ 335 " ipc_message_reply(msg);\n" \ 336 " break;\n\n" 337 338 /* Tokens. */ 339 340 #define BEGIN_FUNCTION "\n{\n" 341 #define END_FUNCTION "}\n" 342 343 #define COMPLETE_MEMBER ";\n" 344 #define INDENT_MEMBER " " 345 346 #define COMPLETE_SIGNATURE ";\n" 347 #define END_SIGNATURE "\n" 348 349 /* Texts. */ 350 351 #define help_text \ 352 "Usage: %s [ <options> ] <filename> ...\n\n" \ 353 "Generate source code for the interfaces in the supplied files.\n\n" \ 354 "The following options are supported:\n\n" \ 355 "--all or -a Produce all kinds of output for a given language.\n\n" \ 356 "--client or -c Generate client code.\n\n" \ 357 "--comp or -C Generate a compound/composite/component interface using\n" \ 358 " the given filename prefix.\n\n" \ 359 "--dir or -d Create output in the indicated directory.\n\n" \ 360 "--headers or -h Produce header files.\n\n" \ 361 "--help or -? Show this message.\n\n" \ 362 "--interfaces or -i Produce interface header files.\n\n" \ 363 "--language or -l Generate code in the indicated language.\n\n" \ 364 "--comp-name or -N Indicate the compound/composite/component interface name.\n\n" \ 365 "--routines or -r Produce program routines.\n\n" \ 366 "--server or -s Generate server code.\n\n" \ 367 "--verbose or -v Show verbose output reporting the processed interfaces.\n\n" \ 368 "--version or -V Show version information.\n\n"