samba-mirror/source4/script/build_smb_interfaces.pl

#!/usr/bin/perl
#
# Create ejs interfaces for structures in a C header file
#

use File::Basename;
use Data::Dumper;

#
# Generate parse tree for header file
#

my $file = shift;
require smb_interfaces;
my $parser = new smb_interfaces;
$header = $parser->parse($file);

#
# Make second pass over tree to make it easier to process.
#

sub flatten_structs($) {
  my $obj = shift;
  my $s = { %$obj };

  # Map NAME, STRUCT_NAME and UNION_NAME elements into a more likeable
  # property.

  if (defined($obj->{STRUCT_NAME}) or defined($obj->{UNION_NAME})) {

    $s->{TYPE_DEFINED} = defined($obj->{STRUCT_NAME}) ? $obj->{STRUCT_NAME} 
      : $obj->{UNION_NAME};

    delete $s->{STRUCT_NAME};
    delete $s->{UNION_NAME};
  }

  # Create a new list of structure fields with flattened names

  foreach my $elt (@{$obj->{DATA}}) {
    foreach my $name (@{$elt->{NAME}}) {
      my $new_elt = { %$elt };
      $new_elt->{NAME} = $name;
#      $new_elt->{PARENT} = $s;
      push(@{$s->{FIELDS}}, flatten_structs($new_elt));
    }
  }

  delete $s->{DATA};

  return $s;
}

@newheader = map { flatten_structs($_) } @{$header};

#
# Generate implementation
#

my $basename = basename($file, ".h");
stat "libcli/gen_raw" || mkdir("libcli/gen_raw") || die("mkdir");

open(FILE, ">libcli/gen_raw/ejs_${basename}.c");

print FILE "/* EJS wrapper functions auto-generated by build_smb_interfaces.pl */\n\n";

print FILE "#include \"includes.h\"\n";
print FILE "#include \"scripting/ejs/smbcalls.h\"\n";
print FILE "#include \"lib/appweb/ejs/ejs.h\"\n";
print FILE "#include \"scripting/ejs/ejsrpc.h\"\n"; # TODO: remove this
print FILE "\n";

sub transfer_element($$$) {
  my $dir = shift;
  my $prefix = shift;
  my $elt = shift;

  $type = $elt->{TYPE};
  $type =~ s/_t$//;

  print FILE "\tejs_${dir}_$type(ejs, v, \"$prefix.$elt->{NAME}\")\n";
}

sub transfer_struct($$) {
  my $dir = shift;
  my $struct = shift;

  foreach my $field (@{$struct->{FIELDS}}) {
    next if $dir eq "pull" and $field->{NAME} eq "out";
    next if $dir eq "push" and $field->{NAME} eq "in";

    if ($field->{TYPE} eq "struct") {
      foreach $subfield (@{$field->{FIELDS}}) {
	transfer_element($dir, $field->{NAME}, $subfield);
      }
    } else {
      transfer_element($dir, $struct->{NAME}, $field);
    }
  }
}

# Should a structure definition require a memory context to return
# data?

sub struct_need_mem_ctx($) {
  my $s = shift;

  for my $f (@{$s->{FIELDS}}) {
    if ($f->{NAME} eq "out") {

      # Look for pointers

      for my $e (@{$f->{FIELDS}}) {
	if (defined($e->{POINTERS})) {
	  return 1;
	}
      }
      return 0;
    }
  }

  # No 'out' structure found so we can't return anything

  return 0;
}

# Does the top-level structure definition require a memory context to
# return data?

sub need_mem_ctx($) {
  my $s = shift;

  # Check for presence of an 'out' nested structure that contains a
  # pointer.

  if ($s->{TYPE} eq "struct") {
    return struct_need_mem_ctx($s);
  } else {
    foreach my $ss (@{$s->{FIELDS}}) {
      return 1 if struct_need_mem_ctx($ss);
    }
    return 0;
  }

  return 1;
}

# Top level call functions

foreach my $s (@newheader) {

  if ($s->{TYPE} eq "struct") {

    # Push/pull top level struct

    print FILE "NTSTATUS ejs_pull_$s->{TYPE_DEFINED}(struct ejs_rpc *ejs, struct MprVar *v, struct $s->{TYPE_DEFINED} *r)\n";
    print FILE "{\n";
    print FILE "\treturn NT_STATUS_OK;\n";
    print FILE "}\n\n";

    print FILE "NTSTATUS ejs_push_$s->{TYPE_DEFINED}(struct ejs_rpc *ejs, struct MprVar *v, const struct $s->{TYPE_DEFINED} *r)\n";
    print FILE "{\n";
    print FILE "\treturn NT_STATUS_OK;\n";
    print FILE "}\n\n";

    # Top level ejs function

    print FILE "static int ejs_$s->{TYPE_DEFINED}(int eid, int argc, struct MprVar **argv)\n";
    print FILE "{\n";
    print FILE "\tstruct MprVar *io;\n";
    print FILE "\tstruct ejs_rpc *ejs;\n";
    print FILE "\tstruct $s->{TYPE_DEFINED} params;\n";
    print FILE "\tstruct smbcli_tree *tree;\n";
    print FILE "\tNTSTATUS status;\n";
    print FILE "\tvoid *ptr;\n\n";

    print FILE "\tif (argc != 1 || argv[0]->type != MPR_TYPE_OBJECT) {\n";
    print FILE "\t\tejsSetErrorMsg(eid, \"invalid arguments\");\n";
    print FILE "\t\treturn -1;\n";
    print FILE "\t}\n\n";

    print FILE "\tio = argv[0];\n\n";

    print FILE "\tejs = talloc(mprMemCtx(), struct ejs_rpc);\n";
    print FILE "\tif (ejs == NULL) {\n";
    print FILE "\t\tstatus = NT_STATUS_NO_MEMORY;\n";
    print FILE "\t\treturn -1;\n";
    print FILE "\t}\n\n";

    print FILE "\tptr = talloc_zero_size(ejs, sizeof(struct $s->{TYPE_DEFINED}));\n";
    print FILE "\tif (ptr == NULL) {\n";
    print FILE "\t\tstatus = NT_STATUS_NO_MEMORY;\n";
    print FILE "\t\treturn -1;\n";
    print FILE "\t}\n\n";

    print FILE "\tejs->eid = eid;\n\n";

    print FILE "\tstatus = ejs_pull_$s->{TYPE_DEFINED}(ejs, io, ptr);\n";
    print FILE "\tif (!NT_STATUS_IS_OK(status)) {\n";
    print FILE "\t\treturn -1;\n";
    print FILE "\t}\n\n";

    my $fn = $s->{TYPE_DEFINED};
    $fn =~ s/^smb_/smb_raw_/;

    if (need_mem_ctx($s)) {
      print FILE "\tstatus = $fn(tree, mprMemCtx(), &params);\n\n";
    } else {
      print FILE "\tstatus = $fn(tree, &params);\n\n";
    }

    print FILE "\tstatus = ejs_push_$s->{TYPE_DEFINED}(ejs, io, ptr);\n\n";

    print FILE "\tmpr_Return(eid, mprNTSTATUS(status));\n\n";
    print FILE "\tif (NT_STATUS_EQUAL(status, NT_STATUS_INTERNAL_ERROR)) {\n";
    print FILE "\t\treturn -1;\n";
    print FILE "\t}\n\n";
    print FILE "\treturn 0;\n";

    print FILE "}\n\n";

  } else {

    # Top level union

    foreach my $arm (@{$s->{FIELDS}}) {

      # Push/pull union arm

      print FILE "NTSTATUS ejs_pull_$s->{TYPE_DEFINED}_$arm->{NAME}(struct ejs_rpc *ejs, struct MprVar *v, union $s->{TYPE_DEFINED} *r)\n";
      print FILE "{\n";
      print FILE "\treturn NT_STATUS_OK;\n";
      print FILE "}\n\n";

      print FILE "NTSTATUS ejs_push_$s->{TYPE_DEFINED}_$arm->{NAME}(struct ejs_rpc *ejs, struct MprVar *v, const union $s->{TYPE_DEFINED} *r)\n";
      print FILE "{\n";
      print FILE "\treturn NT_STATUS_OK;\n";
      print FILE "}\n\n";

      print FILE "static int ejs_$s->{TYPE_DEFINED}_$arm->{NAME}(int eid, int argc, struct MprVar **argv)\n";
      print FILE "{\n";
      print FILE "\tstruct MprVar *io;\n";
      print FILE "\tstruct ejs_rpc *ejs;\n";
      print FILE "\tunion $s->{TYPE_DEFINED} params;\n";
      print FILE "\tstruct smbcli_tree *tree;\n";
      print FILE "\tNTSTATUS status;\n";
      print FILE "\tvoid *ptr;\n\n";

      print FILE "\tif (argc != 1 || argv[0]->type != MPR_TYPE_OBJECT) {\n";
      print FILE "\t\tejsSetErrorMsg(eid, \"invalid arguments\");\n";
      print FILE "\t\treturn -1;\n";
      print FILE "\t}\n\n";

      print FILE "\tio = argv[0];\n\n";

      print FILE "\tejs = talloc(mprMemCtx(), struct ejs_rpc);\n";
      print FILE "\tif (ejs == NULL) {\n";
      print FILE "\t\tstatus = NT_STATUS_NO_MEMORY;\n";
      print FILE "\t\treturn -1;\n";
      print FILE "\t}\n\n";

      print FILE "\tptr = talloc_zero_size(ejs, sizeof(union $s->{TYPE_DEFINED}));\n";
      print FILE "\tif (ptr == NULL) {\n";
      print FILE "\t\tstatus = NT_STATUS_NO_MEMORY;\n";
      print FILE "\t\treturn -1;\n";
      print FILE "\t}\n\n";

      print FILE "\tejs->eid = eid;\n\n";

      print FILE "\tstatus = ejs_pull_$s->{TYPE_DEFINED}_$arm->{NAME}(ejs, io, ptr);\n";
      print FILE "\tif (!NT_STATUS_IS_OK(status)) {\n";
      print FILE "\t\treturn -1;\n";
      print FILE "\t}\n\n";

      my $fn = $s->{TYPE_DEFINED};
      $fn =~ s/^smb_/smb_raw_/;

      if (need_mem_ctx($s)) {
	print FILE "\tstatus = $fn(tree, mprMemCtx(), &params);\n\n";
      } else {
	print FILE "\tstatus = $fn(tree, &params);\n\n";
      }

      print FILE "\tstatus = ejs_push_$s->{TYPE_DEFINED}_$arm->{NAME}(ejs, io, ptr);\n\n";

      print FILE "\tmpr_Return(eid, mprNTSTATUS(status));\n\n";
      print FILE "\tif (NT_STATUS_EQUAL(status, NT_STATUS_INTERNAL_ERROR)) {\n";
      print FILE "\t\treturn -1;\n";
      print FILE "\t}\n\n";
      print FILE "\treturn 0;\n";

      print FILE "}\n\n";
    }
  }
}

# Module initialisation

print FILE "static int ejs_${basename}_init(int eid, int argc, struct MprVar **argv)\n";
print FILE "{\n";
print FILE "\tstruct MprVar *obj = mprInitObject(eid, \"${basename}\", argc, argv);\n\n";

foreach my $s (@newheader) {
  if ($s->{TYPE} eq "struct") {
    print FILE "\tmprSetCFunction(obj, \"$s->{TYPE_DEFINED}\", ejs_$s->{TYPE_DEFINED});\n";
  } else {
    foreach my $arm (@{$s->{FIELDS}}) {
      print FILE "\tmprSetCFunction(obj, \"$s->{TYPE_DEFINED}_$arm->{NAME}\", ejs_$s->{TYPE_DEFINED});\n";
    }
  }
}

print FILE "}\n\n";

print FILE "NTSTATUS ejs_init_${basename}(void)\n";
print FILE "{\n";
print FILE "\treturn smbcalls_register_ejs(\"${basename}_init\", ejs_${basename}_init);\n";
print FILE "}\n";

close(FILE);

exit;