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