1 ###################################################
2 # Samba3 server generator for IDL structures
3 # on top of Samba4 style NDR functions
4 # Copyright jelmer@samba.org 2005-2006
5 # released under the GNU GPL
7 package Parse::Pidl::Samba3::ServerNDR;
11 @EXPORT_OK = qw(DeclLevel);
14 use Parse::Pidl qw(warning error fatal);
15 use Parse::Pidl::Typelist qw(mapTypeName scalar_is_reference);
16 use Parse::Pidl::Util qw(ParseExpr has_property is_constant);
17 use Parse::Pidl::NDR qw(GetNextLevel);
18 use Parse::Pidl::Samba4 qw(ElementStars DeclLong);
19 use Parse::Pidl::Samba4::Header qw(GenerateFunctionOutEnv);
21 use vars qw($VERSION);
27 sub indent() { $tabs.="\t"; }
28 sub deindent() { $tabs = substr($tabs, 1); }
29 sub pidl($) { my ($txt) = @_; $res .= $txt?$tabs.(shift)."\n":"\n"; }
30 sub pidl_hdr($) { $res_hdr .= (shift)."\n"; }
31 sub fn_declare($) { my ($n) = @_; pidl $n; pidl_hdr "$n;"; }
38 if (has_property($e, "charset")) {
41 $res .= mapTypeName($e->{TYPE});
44 my $stars = ElementStars($e, $l);
46 $res .= " ".$stars unless ($stars eq "");
51 sub AllocOutVar($$$$$)
53 my ($e, $mem_ctx, $name, $env, $fail) = @_;
55 my $l = $e->{LEVELS}[0];
57 # we skip pointer to arrays
58 if ($l->{TYPE} eq "POINTER") {
59 my $nl = GetNextLevel($e, $l);
60 $l = $nl if ($nl->{TYPE} eq "ARRAY");
63 # we don't support multi-dimentional arrays yet
64 ($l->{TYPE} eq "ARRAY") {
65 my $nl = GetNextLevel($e, $l);
66 if ($nl->{TYPE} eq "ARRAY") {
67 fatal($e->{ORIGINAL},"multi-dimentional [out] arrays are not supported!");
70 # neither pointer nor array, no need to alloc something.
74 if ($l->{TYPE} eq "ARRAY") {
75 unless(defined($l->{SIZE_IS})) {
76 error($e->{ORIGINAL}, "No size known for array `$e->{NAME}'");
77 pidl "#error No size known for array `$e->{NAME}'";
79 my $size = ParseExpr($l->{SIZE_IS}, $env, $e);
80 pidl "$name = talloc_zero_array($mem_ctx, " . DeclLevel($e, 1) . ", $size);";
83 pidl "$name = talloc_zero($mem_ctx, " . DeclLevel($e, 1) . ");";
86 pidl "if ($name == NULL) {";
92 sub CallWithStruct($$$$)
94 my ($pipes_struct, $mem_ctx, $fn, $fail) = @_;
95 my $env = GenerateFunctionOutEnv($fn);
97 foreach (@{$fn->{ELEMENTS}}) {
98 if (grep(/out/, @{$_->{DIRECTION}})) { $hasout = 1; }
101 pidl "ZERO_STRUCT(r->out);" if ($hasout);
103 my $proto = "_$fn->{NAME}(struct pipes_struct *p, struct $fn->{NAME} *r";
104 my $ret = "_$fn->{NAME}($pipes_struct, r";
105 foreach (@{$fn->{ELEMENTS}}) {
106 my @dir = @{$_->{DIRECTION}};
107 if (grep(/in/, @dir) and grep(/out/, @dir)) {
108 pidl "r->out.$_->{NAME} = r->in.$_->{NAME};";
112 foreach (@{$fn->{ELEMENTS}}) {
113 my @dir = @{$_->{DIRECTION}};
114 if (grep(/in/, @dir) and grep(/out/, @dir)) {
116 } elsif (grep(/out/, @dir) and not
117 has_property($_, "represent_as")) {
118 AllocOutVar($_, $mem_ctx, "r->out.$_->{NAME}", $env, $fail);
124 if ($fn->{RETURN_TYPE}) {
125 $ret = "r->out.result = $ret";
126 $proto = "$fn->{RETURN_TYPE} $proto";
128 $proto = "void $proto";
135 sub ParseFunction($$)
139 my $op = "NDR_".uc($fn->{NAME});
141 pidl "static bool api_$fn->{NAME}(struct pipes_struct *p)";
144 pidl "const struct ndr_interface_call *call;";
145 pidl "struct ndr_pull *pull;";
146 pidl "struct ndr_push *push;";
147 pidl "enum ndr_err_code ndr_err;";
148 pidl "struct $fn->{NAME} *r;";
150 pidl "call = &ndr_table_$if->{NAME}.calls[$op];";
152 pidl "r = talloc(talloc_tos(), struct $fn->{NAME});";
153 pidl "if (r == NULL) {";
154 pidl "\treturn false;";
157 pidl "pull = ndr_pull_init_blob(&p->in_data.data, r);";
158 pidl "if (pull == NULL) {";
159 pidl "\ttalloc_free(r);";
160 pidl "\treturn false;";
163 pidl "pull->flags |= LIBNDR_FLAG_REF_ALLOC;";
164 pidl "if (p->endian) {";
165 pidl "\tpull->flags |= LIBNDR_FLAG_BIGENDIAN;";
167 pidl "ndr_err = call->ndr_pull(pull, NDR_IN, r);";
168 pidl "if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {";
169 pidl "\ttalloc_free(r);";
170 pidl "\treturn false;";
173 pidl "if (DEBUGLEVEL >= 10) {";
174 pidl "\tNDR_PRINT_FUNCTION_DEBUG($fn->{NAME}, NDR_IN, r);";
178 CallWithStruct("p", "r", $fn,
180 pidl "\ttalloc_free(r);";
181 pidl "\treturn false;";
186 pidl "if (p->fault_state) {";
187 pidl "\ttalloc_free(r);";
188 pidl "\t/* Return true here, srv_pipe_hnd.c will take care */";
189 pidl "\treturn true;";
192 pidl "if (DEBUGLEVEL >= 10) {";
193 pidl "\tNDR_PRINT_FUNCTION_DEBUG($fn->{NAME}, NDR_OUT | NDR_SET_VALUES, r);";
196 pidl "push = ndr_push_init_ctx(r);";
197 pidl "if (push == NULL) {";
198 pidl "\ttalloc_free(r);";
199 pidl "\treturn false;";
203 pidl " * carry over the pointer count to the reply in case we are";
204 pidl " * using full pointer. See NDR specification for full pointers";
206 pidl "push->ptr_count = pull->ptr_count;";
208 pidl "ndr_err = call->ndr_push(push, NDR_OUT, r);";
209 pidl "if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {";
210 pidl "\ttalloc_free(r);";
211 pidl "\treturn false;";
214 pidl "p->out_data.rdata = ndr_push_blob(push);";
215 pidl "talloc_steal(p->mem_ctx, p->out_data.rdata.data);";
217 pidl "talloc_free(r);";
225 sub ParseInterface($)
229 my $uif = uc($if->{NAME});
231 pidl_hdr "#ifndef __SRV_$uif\__";
232 pidl_hdr "#define __SRV_$uif\__";
234 foreach (@{$if->{FUNCTIONS}}) {
235 next if ($_->{PROPERTIES}{noopnum});
236 ParseFunction($if, $_);
241 pidl "static struct api_struct api_$if->{NAME}_cmds[] = ";
245 foreach (@{$if->{FUNCTIONS}}) {
246 next if ($_->{PROPERTIES}{noopnum});
247 pidl "{\"" . uc($_->{NAME}) . "\", NDR_" . uc($_->{NAME}) . ", api_$_->{NAME}},";
255 pidl_hdr "void $if->{NAME}_get_pipe_fns(struct api_struct **fns, int *n_fns);";
256 pidl "void $if->{NAME}_get_pipe_fns(struct api_struct **fns, int *n_fns)";
259 pidl "*fns = api_$if->{NAME}_cmds;";
260 pidl "*n_fns = sizeof(api_$if->{NAME}_cmds) / sizeof(struct api_struct);";
265 if (not has_property($if, "no_srv_register")) {
266 pidl_hdr "struct rpc_srv_callbacks;";
267 pidl_hdr "NTSTATUS rpc_$if->{NAME}_init(const struct rpc_srv_callbacks *rpc_srv_cb);";
268 pidl "NTSTATUS rpc_$if->{NAME}_init(const struct rpc_srv_callbacks *rpc_srv_cb)";
270 pidl "\treturn rpc_srv_register(SMB_RPC_INTERFACE_VERSION, \"$if->{NAME}\", \"$if->{NAME}\", \&ndr_table_$if->{NAME}, api_$if->{NAME}_cmds, sizeof(api_$if->{NAME}_cmds) / sizeof(struct api_struct), rpc_srv_cb);";
275 pidl_hdr "NTSTATUS rpc_$if->{NAME}_shutdown(void);";
276 pidl "NTSTATUS rpc_$if->{NAME}_shutdown(void)";
278 pidl "\treturn rpc_srv_unregister(\&ndr_table_$if->{NAME});";
281 pidl_hdr "#endif /* __SRV_$uif\__ */";
286 my($ndr,$header,$ndr_header) = @_;
292 pidl " * Unix SMB/CIFS implementation.";
293 pidl " * server auto-generated by pidl. DO NOT MODIFY!";
296 pidl "#include \"includes.h\"";
297 pidl "#include \"ntdomain.h\"";
298 pidl "#include \"$header\"";
299 pidl_hdr "#include \"$ndr_header\"";
303 ParseInterface($_) if ($_->{TYPE} eq "INTERFACE");
306 return ($res, $res_hdr);