ctf visitor generate I/O struct: visit typedef/typealias
[babeltrace.git] / formats / ctf / metadata / ctf-visitor-generate-io-struct.c
index 260fc31ce3f7e0870d7ec758a765833445b3acdd..7e2dc07268d4a7917c3b78b226d4846a560c70b9 100644 (file)
@@ -25,6 +25,7 @@
 #include <inttypes.h>
 #include <errno.h>
 #include <babeltrace/list.h>
+#include <uuid/uuid.h>
 #include "ctf-scanner.h"
 #include "ctf-parser.h"
 #include "ctf-ast.h"
 #define _cds_list_first_entry(ptr, type, member)       \
        cds_list_entry((ptr)->next, type, member)
 
+static
+struct declaration *ctf_declaration_specifier_visit(FILE *fd,
+               int depth, struct list_head *head,
+               struct declaration_scope *declaration_scope);
+
 static
 int ctf_visitor_print_type_specifier(FILE *fd, int depth, struct ctf_node *node)
 {
@@ -178,24 +184,76 @@ int ctf_visitor_print_type_declarator(FILE *fd, int depth, struct ctf_node *node
 }
 
 /*
- * String returned must be freed by the caller.
+ * String returned must be freed by the caller using g_free.
  */
 static
 char *concatenate_unary_strings(struct list_head *head)
 {
-
+       struct ctf_node *node;
+       GString *str;
+       int i = 0;
+
+       str = g_string_new();
+       cds_list_for_each_entry(node, head, siblings) {
+               char *src_string;
+
+               assert(node->type == NODE_UNARY_EXPRESSION);
+               assert(node->u.unary_expression.type == UNARY_STRING);
+               assert((node->u.unary_expression.link == UNARY_LINK_UNKNOWN)
+                       ^ (i != 0))
+               switch (node->u.unary_expression.link) {
+               case UNARY_DOTLINK:
+                       g_string_append(str, ".")
+                       break;
+               case UNARY_ARROWLINK:
+                       g_string_append(str, "->")
+                       break;
+               case UNARY_DOTDOTDOT:
+                       g_string_append(str, "...")
+                       break;
+               }
+               src_string = u.unary_expression.u.string;
+               g_string_append(str, src_string);
+               i++;
+       }
+       return g_string_free(str, FALSE);
 }
 
 static
 int get_unary_unsigned(struct list_head *head, uint64_t *value)
 {
-
+       struct ctf_node *node;
+       int i = 0;
+
+       cds_list_for_each_entry(node, head, siblings) {
+               assert(node->type == NODE_UNARY_EXPRESSION);
+               assert(node->u.unary_expression.type == UNARY_UNSIGNED_CONSTANT);
+               assert(node->u.unary_expression.link == UNARY_LINK_UNKNOWN);
+               assert(i == 0);
+               *value = node->u.unary_expression.unsigned_constant
+               i++;
+       }
+       return 0;
 }
 
 static
 int get_unary_uuid(struct list_head *head, uuid_t *uuid)
 {
-
+       struct ctf_node *node;
+       int i = 0;
+       int ret = -1;
+
+       cds_list_for_each_entry(node, head, siblings) {
+               const char *src_string;
+
+               assert(node->type == NODE_UNARY_EXPRESSION);
+               assert(node->u.unary_expression.type == UNARY_STRING);
+               assert(node->u.unary_expression.link == UNARY_LINK_UNKNOWN);
+               assert(i == 0);
+               src_string = u.unary_expression.u.string;
+               ret = uuid_parse(u.unary_expression.u.string, *uuid);
+       }
+       return ret;
 }
 
 static
@@ -206,27 +264,396 @@ struct ctf_stream *trace_stream_lookup(struct ctf_trace *trace, uint64_t stream_
        return g_ptr_array_index(trace->streams, stream_id);
 }
 
+static
+struct declaration *ctf_type_declarator_visit(int fd, int depth,
+       struct cds_list_head *declaration_specifier,
+       GQuark *field_name,
+       struct ctf_node *node_type_declarator,
+       struct declaration_scope *declaration_scope
+       struct declaration *nested_declaration)
+{
+       /*
+        * Visit type declarator by first taking care of sequence/array
+        * (recursively). Then, when we get to the identifier, take care
+        * of pointers.
+        */
+
+       assert(node_type_declarator->u.type_declarator.type != TYPEDEC_UNKNOWN);
+       /* TODO: gcc bitfields not supported yet. */
+       assert(node_type_declarator->u.type_declarator.bitfield_len == NULL);
+
+       if (!nested_declaration) {
+               if (!cds_list_empty(&node_type_declarator->u.type_declarator.pointers)) {
+                       /*
+                        * If we have a pointer declarator, it _has_ to be present in
+                        * the typealiases (else fail).
+                        */
+                       nested_declaration = ... ;
+               } else {
+                       nested_declaration = /* parse declaration_specifier */;
+               }
+
+       }
+
+       if (node_type_declarator->u.type_declarator.type == TYPEDEC_ID) {
+               if (node_type_declarator->u.type_declarator.u.id)
+                       *field_name = g_quark_from_string(node_type_declarator->u.type_declarator.u.id);
+               else
+                       *field_name = 0;
+               return nested_declaration;
+       } else {
+               struct declaration *declaration;
+               struct node *length;
+
+               /* TYPEDEC_NESTED */
+
+               /* create array/sequence, pass nested_declaration as child. */
+               length = node_type_declarator->u.type_declarator.u.nested.length;
+               if (length) {
+                       switch (length->type) {
+                       case NODE_UNARY_EXPRESSION:
+                               /* Array */
+                               declaration = /* create array */;
+                               break;
+                       case NODE_TYPE_SPECIFIER:
+                               /* Sequence */
+                               declaration = /* create sequence */;
+                               break;
+                       default:
+                               assert(0);
+                       }
+               }
+
+               /* Pass it as content of outer container */
+               declaration = ctf_type_declarator_visit(fd, depth,
+                               declaration_specifier, field_name,
+                               node_type_declarator->u.type_declarator.u.nested.type_declarator,
+                               declaration_scope, declaration);
+               return declaration;
+       }
+}
+
+static
+int ctf_struct_type_declarators_visit(int fd, int depth,
+       struct declaration_struct *struct_declaration,
+       struct cds_list_head *declaration_specifier,
+       struct cds_list_head *type_declarators,
+       struct declaration_scope *declaration_scope)
+{
+       struct ctf_node *iter;
+       GQuark field_name;
+
+       cds_list_for_each_entry(iter, type_declarators, siblings) {
+               struct declaration *field_declaration;
+
+               field_declaration = ctf_type_declarator_visit(fd, depth,
+                                               declaration_specifier,
+                                               &field_name, iter,
+                                               struct_declaration->scope,
+                                               NULL);
+               struct_declaration_add_field(struct_declaration,
+                                            g_quark_to_string(field_name),
+                                            field_declaration);
+       }
+
+       return 0;
+}
+
+static
+int ctf_typedef_visit(int fd, int depth, struct declaration_scope *scope,
+               struct cds_list_head *declaration_specifier,
+               struct cds_list_head *type_declarators)
+{
+       struct ctf_node *iter;
+       GQuark identifier;
+
+       cds_list_for_each_entry(iter, type_declarators, siblings) {
+               struct declaration *type_declaration;
+               int ret;
+       
+               type_declaration = ctf_type_declarator_visit(fd, depth,
+                                       declaration_specifier,
+                                       &identifier, iter,
+                                       scope, NULL);
+               ret = register_declaration(identifier, type_declaration, scope);
+               if (ret) {
+                       type_declaration->declaration_free(type_declaration);
+                       return ret;
+               }
+       }
+       return 0;
+}
+
+static
+int ctf_typealias_visit(int fd, int depth, struct declaration_scope *scope,
+               struct ctf_node *target, struct ctf_node *alias)
+{
+       struct declaration *type_declaration;
+       struct ctf_node *iter, *node;
+       GQuark identifier, dummy_id;
+       GString *str;
+       const char *str_c;
+       GQuark alias_q;
+       int alias_item_nr = 0;
+
+       /* See ctf_visitor_type_declarator() in the semantic validator. */
+
+       /*
+        * Create target type declaration.
+        */
+
+       type_declaration = ctf_type_declarator_visit(fd, depth,
+               &target->u.typealias_target.declaration_specifier,
+               &dummy_id, &target->u.typealias_target.type_declarators,
+               scope, NULL);
+       if (!type_declaration) {
+               fprintf(stderr, "[error] %s: problem creating type declaration\n", __func__);
+               err = -EINVAL;
+               goto error;
+       }
+       /*
+        * The semantic validator does not check whether the target is
+        * abstract or not (if it has an identifier). Check it here.
+        */
+       if (dummy_id != 0) {
+               fprintf(stderr, "[error] %s: expecting empty identifier\n", __func__);
+               err = -EINVAL;
+               goto error;
+       }
+       /*
+        * Create alias identifier.
+        */
+       str = g_string_new();
+       cds_list_for_each_entry(iter, &alias->u.typealias_alias.declaration_specifier, siblings) {
+               if (alias_item_nr != 0)
+                       g_string_append(str, " ");
+               alias_item_nr++;
+
+               switch (iter->type) {
+               case NODE_TYPE_SPECIFIER:
+                       switch (iter->u.type_specifier.type) {
+                       case TYPESPEC_VOID:
+                               g_string_append(str, "void");
+                               break;
+                       case TYPESPEC_CHAR:
+                               g_string_append(str, "char");
+                               break;
+                       case TYPESPEC_SHORT:
+                               g_string_append(str, "short");
+                               break;
+                       case TYPESPEC_INT:
+                               g_string_append(str, "int");
+                               break;
+                       case TYPESPEC_LONG:
+                               g_string_append(str, "long");
+                               break;
+                       case TYPESPEC_FLOAT:
+                               g_string_append(str, "float");
+                               break;
+                       case TYPESPEC_DOUBLE:
+                               g_string_append(str, "double");
+                               break;
+                       case TYPESPEC_SIGNED:
+                               g_string_append(str, "signed");
+                               break;
+                       case TYPESPEC_UNSIGNED:
+                               g_string_append(str, "unsigned");
+                               break;
+                       case TYPESPEC_BOOL:
+                               g_string_append(str, "bool");
+                               break;
+                       case TYPESPEC_COMPLEX:
+                               g_string_append(str, "_Complex");
+                               break;
+                       case TYPESPEC_IMAGINARY:
+                               g_string_append(str, "_Imaginary");
+                               break;
+                       case TYPESPEC_CONST:
+                               g_string_append(str, "const");
+                               break;
+                       case TYPESPEC_ID_TYPE:
+                               if (!iter->u.type_specifier.id_type) {
+                                       fprintf(stderr, "[error] %s: unexpected empty ID\n", __func__);
+                                       err = -EINVAL;
+                                       goto error;
+                               }
+                               g_string_append(str, iter->u.type_specifier.id_type);
+                               break;
+                       default:
+                               fprintf(stderr, "[error] %s: unknown specifier\n", __func__);
+                               err = -EINVAL;
+                               goto error;
+                       }
+                       break;
+               case NODE_ENUM:
+                       if (!iter->u._enum.enum_id) {
+                               fprintf(stderr, "[error] %s: unexpected empty enum ID\n", __func__);
+                               err = -EINVAL;
+                               goto error;
+                       }
+                       g_string_append(str, "enum ");
+                       g_string_append(str, iter->u._enum.enum_id);
+                       break;
+               case NODE_VARIANT:
+                       if (!iter->u.variant.name) {
+                               fprintf(stderr, "[error] %s: unexpected empty variant name\n", __func__);
+                               err = -EINVAL;
+                               goto error;
+                       }
+                       g_string_append(str, "variant ");
+                       g_string_append(str, iter->u.variant.name);
+                       break;
+               case NODE_STRUCT:
+                       if (!iter->u._struct.name) {
+                               fprintf(stderr, "[error] %s: unexpected empty variant name\n", __func__);
+                               err = -EINVAL;
+                               goto error;
+                       }
+                       g_string_append(str, "struct ");
+                       g_string_append(str, iter->u._struct.name);
+                       break;
+               default:
+                       fprintf(stderr, "[error] %s: unexpected node type %d\n", __func__, (int) iter->type);
+                       err = -EINVAL;
+                       goto error;
+               }
+       }
+
+       node = _cds_list_first_entry(&alias->u.typealias_alias.type_declarators,
+                               struct node, siblings) {
+               cds_list_for_each_entry(iter, &node->u.type_declarator.pointers, siblings) {
+                       g_string_append(str, " *");
+                       if (iter->u.pointer.const_qualifier)
+                               g_string_append(str, " const");
+               }
+
+       }
+       str_c = g_string_free(str, FALSE);
+       alias_q = g_quark_from_string(str_c);
+       g_free(str_c);
+       ret = register_declaration(alias_q, type_declaration, scope);
+       if (ret)
+               goto error;
+       return 0;
+
+error:
+       type_declaration->declaration_free(type_declaration);
+       return ret;
+}
+
+static
+int ctf_struct_declaration_list_visit(int fd, int depth,
+       struct ctf_node *iter, struct declaration_struct *struct_declaration)
+{
+       struct declaration *declaration;
+       int ret;
+
+       switch (iter->type) {
+       case NODE_TYPEDEF:
+               /* For each declarator, declare type and add type to struct declaration scope */
+               ret = ctf_typedef_visit(fd, depth,
+                       struct_declaration->scope,
+                       &iter->u._typedef.declaration_specifier,
+                       &iter->u._typedef.type_declarators);
+               if (ret)
+                       return ret;
+               break;
+       case NODE_TYPEALIAS:
+               /* Declare type with declarator and add type to struct declaration scope */
+               ret = ctf_typealias_visit(fd, depth,
+                       struct_declaration->scope,
+                       iter->u.typealias.target,
+                       iter->u.typealias.alias);
+               if (ret)
+                       return ret;
+               break;
+       case NODE_STRUCT_OR_VARIANT_DECLARATION:
+               /* Add field to structure declaration */
+               ret = ctf_struct_type_declarators_visit(fd, depth,
+                               struct_declaration,
+                               &iter->u.struct_or_variant_declaration.declaration_specifier,
+                               &iter->u.struct_or_variant_declaration.type_declarators);
+               if (ret)
+                       return ret;
+               break;
+       default:
+               fprintf(stderr, "[error] %s: unexpected node type %d\n", __func__, (int) iter->type);
+               assert(0);
+       }
+       return 0;
+}
+
+static
+struct declaration_struct *ctf_declaration_struct_visit(FILE *fd,
+       int depth, const char *name, struct cds_list_head *declaration_list,
+       int has_body, struct declaration_scope *declaration_scope)
+{
+       struct declaration *declaration;
+       struct declaration_struct *struct_declaration;
+       struct ctf_node *iter;
+
+       /*
+        * For named struct (without body), lookup in
+        * declaration scope. Don't take reference on struct
+        * declaration: ref is only taken upon definition.
+        */
+       if (!has_body) {
+               assert(name);
+               struct_declaration =
+                       lookup_struct_declaration(g_quark_from_string(name),
+                                                 declaration_scope);
+               return struct_declaration;
+       } else {
+               /* For unnamed struct, create type */
+               /* For named struct (with body), create type and add to declaration scope */
+               if (name) {
+                       if (lookup_struct_declaration(g_quark_from_string(name),
+                                                     declaration_scope)) {
+                               
+                               fprintf(stderr, "[error] %s: struct %s already declared in scope\n", name);
+                               return NULL;
+                       }
+               }
+               struct_declaration = struct_declaration_new(name, declaration_scope);
+               cds_list_for_each_entry(iter, declaration_list, siblings) {
+                       ret = ctf_struct_declaration_list_visit(fd,
+depth + 1, iter, struct_declaration);
+                       if (ret)
+                               goto error;
+               }
+               if (name) {
+                       ret = register_struct_declaration(g_quark_from_string(name),
+                                       struct_declaration,
+                                       declaration_scope);
+                       assert(!ret);
+               }
+               return struct_declaration;
+       }
+error:
+       struct_declaration->p.declaration_free(&struct_declaration->p);
+       return NULL;
+}
+
 /*
  * Also add named variant, struct or enum to the current declaration scope.
  */
 static
-struct ctf_declaration *ctf_declaration_specifier_visit(FILE *fd,
+struct declaration *ctf_declaration_specifier_visit(FILE *fd,
                int depth, struct list_head *head,
                struct declaration_scope *declaration_scope)
 {
-       struct ctf_declaration *declaration;
+       struct declaration *declaration;
        struct node *first;
 
        first = _cds_list_first_entry(head, struct node, siblings);
 
        switch (first->type) {
        case NODE_STRUCT:
-               /*
-                * For named struct (without body), lookup in
-                * declaration scope and create declaration copy.
-                */
-               /* For named struct (with body), create type and add to declaration scope */
-               /* For unnamed struct, create type */
+               return ctf_declaration_struct_visit(fd, depth,
+                       first->u._struct.name,
+                       &first->u._struct.declaration_list,
+                       first->u._struct.has_body,
+                       declaration_scope);
                break;
        case NODE_VARIANT:
                /*
@@ -360,7 +787,7 @@ int ctf_event_declaration_visit(FILE *fd, int depth, struct ctf_node *node, stru
                                return -EINVAL;
                        }
                        event->name = g_quark_from_string(right);
-                       free(right);
+                       g_free(right);
                        CTF_EVENT_SET_FIELD(event, name);
                } else if (!strcmp(left, "id")) {
                        if (CTF_EVENT_FIELD_IS_SET(event, id))
@@ -384,11 +811,6 @@ int ctf_event_declaration_visit(FILE *fd, int depth, struct ctf_node *node, stru
                                fprintf(stderr, "[error] %s: stream id %" PRIu64 " cannot be found\n", __func__, event->stream_id);
                                return -EINVAL;
                        }
-                       event->definition_scope = new_dynamic_definition_scope(stream->definition_scope);
-                       if (!event->definition_scope) {
-                               fprintf(stderr, "[error] %s: Error allocating declaration scope\n", __func__);
-                               return -EPERM;
-                       }
                        CTF_EVENT_SET_FIELD(event, stream_id);
                } else if (!strcmp(left, "context")) {
                        struct declaration *declaration;
@@ -417,7 +839,7 @@ int ctf_event_declaration_visit(FILE *fd, int depth, struct ctf_node *node, stru
                                return -EPERM;
                        event->fields_decl = container_of(declaration, struct declaration_struct, p);
                }
-               free(left);
+               g_free(left);
                break;
        }
        default:
@@ -462,22 +884,24 @@ int ctf_event_visit(FILE *fd, int depth, struct ctf_node *node,
        g_hash_table_insert(event->stream->event_quark_to_id,
                            (gpointer)(unsigned long) event->name,
                            &event->id);
-       parent_def_scope = event->definition_scope;
+       parent_def_scope = stream->definition_scope;
        if (event->context_decl) {
                event->context =
                        event->context_decl->definition_new(event->context_decl,
-                               parent_def_scope,
-                               g_quark_from_string("event.context"),
-                               MAX_INT);
+                               parent_def_scope, 0, 0);
+               set_dynamic_definition_scope(&event->context->p,
+                                            event->context->scope,
+                                            "event.context");
                parent_def_scope = event->context->scope;
                declaration_unref(event->context_decl);
        }
        if (event->fields_decl) {
                event->fields =
                        event->fields_decl->definition_new(event->fields_decl,
-                               parent_def_scope,
-                               g_quark_from_string("event.fields"),
-                               MAX_INT);
+                               parent_def_scope, 0, 0);
+               set_dynamic_definition_scope(&event->fields->p,
+                                            event->fields->scope,
+                                            "event.fields");
                parent_def_scope = event->fields->scope;
                declaration_unref(event->fields_decl);
        }
@@ -562,7 +986,7 @@ int ctf_stream_declaration_visit(FILE *fd, int depth, struct ctf_node *node, str
                                return -EPERM;
                        stream->packet_context_decl = container_of(declaration, struct declaration_struct, p);
                }
-               free(left);
+               g_free(left);
                break;
        }
        default:
@@ -584,7 +1008,6 @@ int ctf_stream_visit(FILE *fd, int depth, struct ctf_node *node,
 
        stream = g_new0(struct ctf_stream, 1);
        stream->declaration_scope = new_declaration_scope(parent_declaration_scope);
-       stream->definition_scope = new_dynamic_definition_scope(trace->definition_scope);
        stream->events_by_id = g_ptr_array_new();
        stream->event_quark_to_id = g_hash_table_new(g_int_hash, g_int_equal);
        cds_list_for_each_entry(iter, &node->u.stream.declaration_list, siblings) {
@@ -600,34 +1023,38 @@ int ctf_stream_visit(FILE *fd, int depth, struct ctf_node *node,
                g_ptr_array_set_size(trace->streams, stream->stream_id + 1);
        g_ptr_array_index(trace->streams, stream->stream_id) = stream;
 
-       parent_def_scope = stream->definition_scope;
+       parent_def_scope = NULL;
        if (stream->packet_context_decl) {
                stream->packet_context =
                        stream->packet_context_decl->definition_new(stream->packet_context_decl,
-                               parent_def_scope,
-                               g_quark_from_string("stream.packet.context"),
-                               MAX_INT);
+                               parent_def_scope, 0, 0);
+               set_dynamic_definition_scope(&stream->packet_context->p,
+                                            stream->packet_context->scope,
+                                            "stream.packet.context");
                parent_def_scope = stream->packet_context->scope;
                declaration_unref(stream->packet_context_decl);
        }
        if (stream->event_header_decl) {
                stream->event_header =
                        stream->event_header_decl->definition_new(stream->event_header_decl,
-                               parent_def_scope,
-                               g_quark_from_string("stream.event.header"),
-                               MAX_INT);
+                               parent_def_scope, 0, 0);
+               set_dynamic_definition_scope(&stream->event_header->p,
+                                            stream->event_header->scope,
+                                            "stream.event.header");
                parent_def_scope = stream->event_header->scope;
                declaration_unref(stream->event_header_decl);
        }
        if (stream->event_context_decl) {
                stream->event_context =
                        stream->event_context_decl->definition_new(stream->event_context_decl,
-                               parent_def_scope,
-                               g_quark_from_string("stream.event.context"),
-                               MAX_INT);
+                               parent_def_scope, 0, 0);
+               set_dynamic_definition_scope(&stream->event_context->p,
+                                            stream->event_context->scope,
+                                            "stream.event.context");
                parent_def_scope = stream->event_context->scope;
                declaration_unref(stream->event_context_decl);
        }
+       stream->definition_scope = parent_def_scope;
 
        return 0;
 
@@ -706,7 +1133,7 @@ int ctf_trace_declaration_visit(FILE *fd, int depth, struct ctf_node *node, stru
                        }
                        CTF_EVENT_SET_FIELD(trace, uuid);
                }
-               free(left);
+               g_free(left);
                break;
        }
        default:
@@ -771,7 +1198,7 @@ int _ctf_visitor(FILE *fd, int depth, struct ctf_node *node, struct ctf_trace *t
                        ret = ctf_typedef_visit(fd, depth + 1,
                                                &iter->u._typedef.declaration_specifier,
                                                &iter->u._typedef.type_declarators,
-                                               trace->declaration_scope);
+                                               trace->root_declaration_scope);
                        if (ret)
                                return ret;
                }
@@ -779,7 +1206,7 @@ int _ctf_visitor(FILE *fd, int depth, struct ctf_node *node, struct ctf_trace *t
                                        siblings) {
                        ret = ctf_typealias_visit(fd, depth + 1,
                                        &iter->u.typealias.target, &iter->u.typealias.alias
-                                       trace->declaration_scope);
+                                       trace->root_declaration_scope);
                        if (ret)
                                return ret;
                }
@@ -796,13 +1223,13 @@ int _ctf_visitor(FILE *fd, int depth, struct ctf_node *node, struct ctf_trace *t
                }
                cds_list_for_each_entry(iter, &node->u.root.stream, siblings) {
                        ret = ctf_stream_visit(fd, depth + 1, iter,
-                                              trace->declaration_scope, trace);
+                                              trace->root_declaration_scope, trace);
                        if (ret)
                                return ret;
                }
                cds_list_for_each_entry(iter, &node->u.root.event, siblings) {
                        ret = ctf_event_visit(fd, depth + 1, iter,
-                                             trace->declaration_scope, trace);
+                                             trace->root_declaration_scope, trace);
                        if (ret)
                                return ret;
                }
This page took 0.034735 seconds and 4 git commands to generate.