r9516: Try a full-on matrix test of all the combinations in DRSUAPI
[samba.git] / prog_guide.txt
1
2
3 THIS IS INCOMPLETE! I'M ONLY COMMITING IT IN ORDER TO SOLICIT COMMENTS
4 FROM A FEW PEOPLE. DON'T TAKE THIS AS THE FINAL VERSION YET.
5
6
7 Samba4 Programming Guide
8 ------------------------
9
10 The internals of Samba4 are quite different from previous versions of
11 Samba, so even if you are an experienced Samba developer please take
12 the time to read through this document.
13
14 This document will explain both the broad structure of Samba4, and
15 some of the common coding elements such as memory management and
16 dealing with macros.
17
18
19 Coding Style
20 ------------
21
22 In past versions of Samba we have basically let each programmer choose
23 their own programming style. Unfortunately the result has often been
24 that code that other members of the team find difficult to read. For
25 Samba version 4 I would like to standardise on a common coding style
26 to make the whole tree more readable. For those of you who are
27 horrified at the idea of having to learn a new style, I can assure you
28 that it isn't as painful as you might think. I was forced to adopt a
29 new style when I started working on the Linux kernel, and after some
30 initial pain found it quite easy.
31
32 That said, I don't want to invent a new style, instead I would like to
33 adopt the style used by the Linux kernel. It is a widely used style
34 with plenty of support tools available. See Documentation/CodingStyle
35 in the Linux source tree. This is the style that I have used to write
36 all of the core infrastructure for Samba4 and I think that we should
37 continue with that style.
38
39 I also think that we should most definately *not* adopt an automatic
40 reformatting system in cvs (or whatever other source code system we
41 end up using in the future). Such automatic formatters are, in my
42 experience, incredibly error prone and don't understand the necessary
43 exceptions. I don't mind if people use automated tools to reformat
44 their own code before they commit it, but please do not run such
45 automated tools on large slabs of existing code without being willing
46 to spend a *lot* of time hand checking the results.
47
48 Finally, I think that for code that is parsing or formatting protocol
49 packets the code layout should strongly reflect the packet
50 format. That means ordring the code so that it parses in the same
51 order as the packet is stored on the wire (where possible) and using
52 white space to align packet offsets so that a reader can immediately
53 map any line of the code to the corresponding place in the packet.
54
55
56 Static and Global Data
57 ----------------------
58
59 The basic rule is "avoid static and global data like the plague". What
60 do I mean by static data? The way to tell if you have static data in a
61 file is to use the "size" utility in Linux. For example if we run:
62
63   size libcli/raw/*.o
64
65 in Samba4 then you get the following:
66
67    text    data     bss     dec     hex filename
68    2015       0       0    2015     7df libcli/raw/clikrb5.o
69     202       0       0     202      ca libcli/raw/clioplock.o
70      35       0       0      35      23 libcli/raw/clirewrite.o
71    3891       0       0    3891     f33 libcli/raw/clisession.o
72     869       0       0     869     365 libcli/raw/clisocket.o
73    4962       0       0    4962    1362 libcli/raw/clispnego.o
74    1223       0       0    1223     4c7 libcli/raw/clitransport.o
75    2294       0       0    2294     8f6 libcli/raw/clitree.o
76    1081       0       0    1081     439 libcli/raw/raweas.o
77    6765       0       0    6765    1a6d libcli/raw/rawfile.o
78    6824       0       0    6824    1aa8 libcli/raw/rawfileinfo.o
79    2944       0       0    2944     b80 libcli/raw/rawfsinfo.o
80     541       0       0     541     21d libcli/raw/rawioctl.o
81    1728       0       0    1728     6c0 libcli/raw/rawnegotiate.o
82     723       0       0     723     2d3 libcli/raw/rawnotify.o
83    3779       0       0    3779     ec3 libcli/raw/rawreadwrite.o
84    6597       0       0    6597    19c5 libcli/raw/rawrequest.o
85    5580       0       0    5580    15cc libcli/raw/rawsearch.o
86    3034       0       0    3034     bda libcli/raw/rawsetfileinfo.o
87    5187       0       0    5187    1443 libcli/raw/rawtrans.o
88    2033       0       0    2033     7f1 libcli/raw/smb_signing.o
89
90 notice that the "data" and "bss" columns are all zero? That is
91 good. If there are any non-zero values in data or bss then that
92 indicates static data and is bad (as a rule of thumb).
93
94 Lets compare that result to the equivalent in Samba3:
95
96    text    data     bss     dec     hex filename
97    3978       0       0    3978     f8a libsmb/asn1.o
98   18963       0     288   19251    4b33 libsmb/cliconnect.o
99    2815       0    1024    3839     eff libsmb/clidgram.o
100    4038       0       0    4038     fc6 libsmb/clientgen.o
101    3337     664     256    4257    10a1 libsmb/clierror.o
102   10043       0       0   10043    273b libsmb/clifile.o
103     332       0       0     332     14c libsmb/clifsinfo.o
104     166       0       0     166      a6 libsmb/clikrb5.o
105    5212       0       0    5212    145c libsmb/clilist.o
106    1367       0       0    1367     557 libsmb/climessage.o
107     259       0       0     259     103 libsmb/clioplock.o
108    1584       0       0    1584     630 libsmb/cliprint.o
109    7565       0     256    7821    1e8d libsmb/cliquota.o
110    7694       0       0    7694    1e0e libsmb/clirap.o
111   27440       0       0   27440    6b30 libsmb/clirap2.o
112    2905       0       0    2905     b59 libsmb/clireadwrite.o
113    1698       0       0    1698     6a2 libsmb/clisecdesc.o
114    5517       0       0    5517    158d libsmb/clispnego.o
115     485       0       0     485     1e5 libsmb/clistr.o
116    8449       0       0    8449    2101 libsmb/clitrans.o
117    2053       0       4    2057     809 libsmb/conncache.o
118    3041       0     256    3297     ce1 libsmb/credentials.o
119    1261       0    1024    2285     8ed libsmb/doserr.o
120   14560       0       0   14560    38e0 libsmb/errormap.o
121    3645       0       0    3645     e3d libsmb/namecache.o
122   16815       0       8   16823    41b7 libsmb/namequery.o
123    1626       0       0    1626     65a libsmb/namequery_dc.o
124   14301       0    1076   15377    3c11 libsmb/nmblib.o
125   24516       0    2048   26564    67c4 libsmb/nterr.o
126    8661       0       8    8669    21dd libsmb/ntlmssp.o
127    3188       0       0    3188     c74 libsmb/ntlmssp_parse.o
128    4945       0       0    4945    1351 libsmb/ntlmssp_sign.o
129    1303       0       0    1303     517 libsmb/passchange.o
130    1221       0       0    1221     4c5 libsmb/pwd_cache.o
131    2475       0       4    2479     9af libsmb/samlogon_cache.o
132   10768      32       0   10800    2a30 libsmb/smb_signing.o
133    4524       0      16    4540    11bc libsmb/smbdes.o
134    5708       0       0    5708    164c libsmb/smbencrypt.o
135    7049       0    3072   10121    2789 libsmb/smberr.o
136    2995       0       0    2995     bb3 libsmb/spnego.o
137    3186       0       0    3186     c72 libsmb/trustdom_cache.o
138    1742       0       0    1742     6ce libsmb/trusts_util.o
139     918       0      28     946     3b2 libsmb/unexpected.o
140
141 notice all of the non-zero data and bss elements? Every bit of that
142 data is a bug waiting to happen.
143
144 Static data is evil as it has the following consequences:
145  - it makes code much less likely to be thread-safe
146  - it makes code much less likely to be recursion-safe
147  - it leads to subtle side effects when the same code is called from
148    multiple places
149
150 Static data is particularly evil in library code (such as our internal
151 smb and rpc libraries). If you can get rid of all static data in
152 libraries then you can make some fairly strong guarantees about the
153 behaviour of functions in that library, which really helps.
154
155 Of course, it is possible to write code that uses static data and is
156 safe, it's just much harder to do that than just avoid static data in
157 the first place. We have been tripped up countless times by subtle
158 bugs in Samba due to the use of static data, so I think it is time to
159 start avoiding it in new code. Much of the core infrastructure of
160 Samba4 was specifically written to avoid static data, so I'm going to
161 be really annoyed if everyone starts adding lots of static data back
162 in.
163
164 So, how do we avoid static data? The basic method is to use context
165 pointers. When reading the Samba4 code you will notice that just about
166 every function takes a pointer to a context structure as its first
167 argument. Any data that the function needs that isn't an explicit
168 argument to the function can be found by traversing that context. 
169
170 Note that this includes all of the little caches that we have lying
171 all over the code in Samba3. I'm referring to the ones that generally
172 have a "static int initialised" and then some static string or integer
173 that remembers the last return value of the function. Get rid of them!
174 If you are *REALLY* absolutely completely certain that your personal
175 favourite mini-cache is needed then you should do it properly by
176 putting it into the appropriate context rather than doing it the lazy
177 way by putting it inside the target function. I would suggest however
178 that the vast majority of those little caches are useless - don't
179 stick it in unless you have really firm benchmarking results that show
180 that it is needed and helps by a significant amount.
181
182 Note that Samba4 is not yet completely clean of static data like
183 this. I've gotten the smbd/ directory down to 24 bytes of static data,
184 and libcli/raw/ down to zero. I've also gotten the ntvfs layer and all
185 backends down to just 8 bytes in ntvfs_base.c. The rest still needs
186 some more work.
187
188 Also note that truly constant data is OK, and will not in fact show up
189 in the data and bss columns in "size" anyway (it will be included in
190 "text"). So you can have constant tables of protocol data.
191
192
193 How to use talloc
194 -----------------
195
196 Please see the separate document, source/lib/talloc/talloc_guide.txt
197 You _must_ read this if you want to program in Samba4.
198
199
200 Interface Structures
201 --------------------
202
203 One of the biggest changes in Samba4 is the universal use of interface
204 structures. Go take a look through include/smb_interfaces.h now to get
205 an idea of what I am talking about.
206
207 In Samba3 many of the core wire structures in the SMB protocol were
208 never explicitly defined in Samba. Instead, our parse and generation
209 functions just worked directly with wire buffers. The biggest problem
210 with this is that is tied our parse code with our "business logic"
211 much too closely, which meant the code got extremely confusing to
212 read.
213
214 In Samba4 we have explicitly defined interface structures for
215 everything in the protocol. When we receive a buffer we always parse
216 it completely into one of these structures, then we pass a pointer to
217 that structure to a backend handler. What we must *not* do is make any
218 decisions about the data inside the parse functions. That is critical
219 as different backends will need different portions of the data. This
220 leads to a golden rule for Samba4:
221
222   "don't design interfaces that lose information"
223
224 In Samba3 our backends often received "condensed" versions of the
225 information sent from clients, but this inevitably meant that some
226 backends could not get at the data they needed to do what they wanted,
227 so from now on we should expose the backends to all of the available
228 information and let them choose which bits they want.
229
230 Ok, so now some of you will be thinking "this sounds just like our
231 msrpc code from Samba3", and while to some extent this is true there
232 are extremely important differences in the approach that are worth
233 pointing out.
234
235 In the Samba3 msrpc code we used explicit parse structures for all
236 msrpc functions. The problem is that we didn't just put all of the
237 real variables in these structures, we also put in all the artifacts
238 as well. A good example is the security descriptor strucrure that
239 looks like this in Samba3:
240
241 typedef struct security_descriptor_info
242 {
243         uint16 revision; 
244         uint16 type;    
245
246         uint32 off_owner_sid;
247         uint32 off_grp_sid;
248         uint32 off_sacl;
249         uint32 off_dacl;
250
251         SEC_ACL *dacl;
252         SEC_ACL *sacl;
253         DOM_SID *owner_sid; 
254         DOM_SID *grp_sid;
255 } SEC_DESC;
256
257 The problem with this structure is all the off_* variables. Those are
258 not part of the interface, and do not appear in any real descriptions
259 of Microsoft security descriptors. They are parsing artifacts
260 generated by the IDL compiler that Microsoft use. That doesn't mean
261 they aren't needed on the wire - indeed they are as they tell the
262 parser where to find the following four variables, but they should
263 *NOT* be in the interface structure.
264
265 In Samba3 there were unwritten rules about which variables in a
266 structure a high level caller has to fill in and which ones are filled
267 in by the marshalling code. In Samba4 those rules are gone, because
268 the redundent artifact variables are gone. The high level caller just
269 sets up the real variables and the marshalling code worries about
270 generating the right offsets.
271
272 The same rule applies to strings. In many places in the SMB and MSRPC
273 protocols complex strings are used on the wire, with complex rules
274 about padding, format, alighment, termination etc. None of that
275 information is useful to a high level calling routine or to a backend
276 - its all just so much wire fluff. So, in Samba4 these strings are
277 just "char *" and are always in our internal multi-byte format (which
278 is usually UTF8). It is up to the parse functions to worry about
279 translating the format and getting the padding right.
280
281 The one exception to this is the use of the WIRE_STRING type, but that
282 has a very good justification in terms of regression testing. Go and
283 read the comment in smb_interfaces.h about that now.
284
285 So, here is another rule to code by. When writing an interface
286 structure think carefully about what variables in the structure can be
287 left out as they are redundent. If some length is effectively defined
288 twice on the wire then only put it once in the packet. If a length can
289 be inferred from a null termination then do that and leave the length
290 out of the structure completely. Don't put redundent stuff in
291 structures!
292
293
294 Async Design
295 ------------
296
297 Samba4 has an asynchronous design. That affects *lots* of the code,
298 and the implications of the asynchronous design needs to be considered
299 just about everywhere.
300
301 The first aspect of the async design to look at is the SMB client
302 library. Lets take a look at the following three functions in
303 libcli/raw/rawfile.c:
304
305 struct cli_request *smb_raw_seek_send(struct cli_tree *tree, struct smb_seek *parms);
306 NTSTATUS smb_raw_seek_recv(struct cli_request *req, struct smb_seek *parms);
307 NTSTATUS smb_raw_seek(struct cli_tree *tree, struct smb_seek *parms);
308
309 Go and read them now then come back.
310
311 Ok, first notice there there are 3 separate functions, whereas the
312 equivalent code in Samba3 had just one. Also note that the 3rd
313 function is extremely simple - its just a wrapper around calling the
314 first two in order.
315
316 The three separate functions are needed because we need to be able to
317 generate SMB calls asynchronously. The first call, which for smb calls
318 is always called smb_raw_XXXX_send(), constructs and sends a SMB
319 request and returns a "struct cli_request" which acts as a handle for
320 the request. The caller is then free to do lots of other calls if it
321 wants to, then when it is ready it can call the smb_raw_XXX_recv()
322 function to receive the reply. 
323
324 If all you want is a synchronous call then call the 3rd interface, the
325 one called smb_raw_XXXX(). That just calls the first two in order, and
326 blocks waiting for the reply. 
327
328 But what if you want to be called when the reply comes in? Yes, thats
329 possible. You can do things like this:
330
331     struct cli_request *req;
332
333     req = smb_raw_XXX_send(tree, params);
334
335     req->async.fn = my_callback;
336     req->async.private = my_private_data;
337
338 then in your callback function you can call the smb_raw_XXXX_recv()
339 function to receive the reply. Your callback will receive the "req"
340 pointer, which you can use to retrieve your private data from
341 req->async.private.
342
343 Then all you need to do is ensure that the main loop in the client
344 library gets called. You can either do that by polling the connection
345 using cli_transport_pending() and cli_request_receive_next() or you
346 can use transport->idle.func to setup an idle function handler to call
347 back to your main code. Either way, you can build a fully async
348 application.
349
350 In order to support all of this we have to make sure that when we
351 write a piece of library code (SMB, MSRPC etc) that we build the
352 separate _send() and _recv() functions. It really is worth the effort.
353
354 Now about async in smbd, a much more complex topic.
355
356 The SMB protocol is inherently async. Some functions (such as change
357 notify) often don't return for hours, while hundreds of other
358 functions pass through the socket. Take a look at the RAW-MUX test in
359 the Samba4 smbtorture to see some really extreme examples of the sort
360 of async operations that Windows supports. I particularly like the
361 open/open/close sequence where the 2nd open (which conflicts with the
362 first) succeeds because the subsequent close is answered out of order.
363
364 In Samba3 we handled this stuff very badly. We had awful "pending
365 request" queues that allocated full 128k packet buffers, and even with
366 all that crap we got the semantics wrong. In Samba4 I intend to make
367 sure we get this stuff right.
368
369 So, how do we do this? We now have an async interface between smbd and
370 the NTVFS backends. Whenever smbd calls into a backend the backend has
371 an option of answer the request in a synchronous fashion if it wants
372 to just like in Samba3, but it also has the option of answering the
373 request asynchronously. The only backend that currently does this is
374 the CIFS backend, but I hope the other backends will soon do this to.
375
376 To make this work you need to do things like this in the backend:
377
378   req->control_flags |= REQ_CONTROL_ASYNC;
379
380 that tells smbd that the backend has elected to reply later rather
381 than replying immediately. The backend must *only* do this if
382 req->async.send_fn is not NULL. If send_fn is NULL then it means that
383 the smbd front end cannot handle this function being replied to in an
384 async fashion.
385
386 If the backend does this then it is up to the backend to call
387 req->async.send_fn() when it is ready to reply. It the meantime smbd
388 puts the call on hold and goes back to answering other requests on the
389 socket.
390
391 Inside smbd you will find that there is code to support this. The most
392 obvious change is that smbd splits each SMB reply function into two
393 parts - just like the client library has a _send() and _recv()
394 function, so smbd has a _send() function and the parse function for
395 each SMB.
396
397 As an example go and have a look at reply_getatr_send() and
398 reply_getatr() in smb_server/reply.c. Read them? Good.
399
400 Notice that reply_getatr() sets up the req->async structure to contain
401 the send function. Thats how the backend gets to do an async reply, it
402 calls this function when it is ready. Also notice that reply_getatr()
403 only does the parsing of the request, and does not do the reply
404 generation. That is done by the _send() function. 
405
406 The only missing piece in the Samba4 right now that prevents it being
407 fully async is that it currently does the low level socket calls (read
408 and write on sockets) in a blocking fashion. It does use select() to
409 make it somewhat async, but if a client were to send a partial packet
410 then delay before sending the rest then smbd would be stuck waiting
411 for the second half of the packet. 
412
413 To fix this I plan on making the socket calls async as well, which
414 luckily will not involve any API changes in the core of smbd or the
415 library. It just involves a little bit of extra code in clitransport.c
416 and smbd/request.c. As a side effect I hope that this will also reduce
417 the average number of system calls required to answer a request, so we
418 may see a performance improvement.
419
420
421 NTVFS
422 -----
423
424 One of the most noticeable changes in Samba4 is the introduction of
425 the NTVFS layer. This provided the initial motivation for the design
426 of Samba4 and in many ways lies at the heart of the design.
427
428 In Samba3 the main file serving process (smbd) combined the handling
429 of the SMB protocol with the mapping to POSIX semantics in the same
430 code. If you look in smbd/reply.c in Samba3 you see numerous places
431 where POSIX assumptions are mixed tightly with SMB parsing code. We
432 did have a VFS layer in Samba3, but it was a POSIX-like VFS layer, so
433 no matter how you wrote a plugin you could not bypass the POSIX
434 mapping decisions that had already been made before the VFS layer was
435 called.
436
437 In Samba4 things are quite different. All SMB parsing is performed in
438 the smbd front end, then fully parsed requests are passed to the NTVFS
439 backend. That backend makes any semantic mapping decisions and fills
440 in the 'out' portion of the request. The front end is then responsible
441 for putting those results into wire format and sending them to the
442 client.
443
444 Lets have a look at one of those request structures. Go and read the
445 definition of "union smb_write" and "enum write_level" in
446 include/smb_interfaces.h. (no, don't just skip reading it, really go
447 and read it. Yes, that means you!).
448
449 Notice the union? That's how Samba4 allows a single NTVFS backend
450 interface to handle the several different ways of doing a write
451 operation in the SMB protocol. Now lets look at one section of that
452 union:
453
454         /* SMBwriteX interface */
455         struct {
456                 enum write_level level;
457
458                 struct {
459                         uint16 fnum;
460                         SMB_BIG_UINT offset;
461                         uint16 wmode;
462                         uint16 remaining;
463                         uint32 count;
464                         const char *data;
465                 } in;
466                 struct {
467                         uint32 nwritten;
468                         uint16 remaining;
469                 } out;
470         } writex;
471
472 see the "in" and "out" sections? The "in" section is for parameters
473 that the SMB client sends on the wire as part of the request. The smbd
474 front end parse code parses the wire request and fills in all those
475 parameters. It then calls the NTVFS interface which looks like this:
476
477   NTSTATUS (*write)(struct request_context *req, union smb_write *io);
478
479 and the NTVFS backend does the write request. The backend then fills
480 in the "out" section of the writex structure and gives the union back
481 to the front end (either by returning, or if done in an async fashion
482 then by calling the async send function. See the async discussion
483 elsewhere in this document).
484
485 The NTVFS backend knows which particular function is being requested
486 by looking at io->generic.level. Notice that this enum is also
487 repeated inside each of the sub-structures in the union, so the
488 backend could just as easily look at io->writex.level and would get
489 the same variable.
490
491 Notice also that some levels (such as splwrite) don't have an "out"
492 section. This happens because there is no return value apart from a
493 status code from those SMB calls. 
494
495 So what about status codes? The status code is returned directly by
496 the backend NTVFS interface when the call is performed
497 synchronously. When performed asynchronously then the status code is
498 put into req->async.status before the req->async.send_fn() callback is
499 called.
500
501 Currently the most complete NTVFS backend is the CIFS backend. I don't
502 expect this backend will be used much in production, but it does
503 provide the ideal test case for our NTVFS design. As it offers the
504 full capabilities that are possible with a CIFS server we can be sure
505 that we don't have any gaping holes in our APIs, and that the front
506 end code is flexible enough to handle any advances in the NT style
507 feature sets of Unix filesystems that make come along.
508
509
510 Process Models
511 --------------
512
513 In Samba3 we supported just one process model. It just so happens that
514 the process model that Samba3 supported is the "right" one for most
515 users, but there are situations where this model wasn't ideal.
516
517 In Samba4 you can choose the smbd process model on the smbd command
518 line. 
519
520
521 DCERPC binding strings
522 ----------------------
523
524 When connecting to a dcerpc service you need to specify a binding
525 string. 
526
527 The format is:
528
529   TRANSPORT:host[flags]
530
531 where TRANSPORT is either ncacn_np for SMB or ncacn_ip_tcp for RPC/TCP
532
533 "host" is an IP or hostname or netbios name. If the binding string 
534 identifies the server side of an endpoint, "host" may be an empty 
535 string.
536
537 "flags" can include a SMB pipe name if using the ncacn_np transport or
538 a TCP port number if using the ncacn_ip_tcp transport, otherwise they
539 will be auto-determined.
540
541 other recognised flags are:
542
543   sign      : enable ntlmssp signing
544   seal      : enable ntlmssp sealing
545   spnego    : use SPNEGO instead of NTLMSSP authentication
546   krb5      : use KRB5 instead of NTLMSSP authentication
547   connect   : enable rpc connect level auth (auth, but no sign or seal)
548   validate  : enable the NDR validator
549   print     : enable debugging of the packets
550   bigendian : use bigendian RPC
551   padcheck  : check reply data for non-zero pad bytes
552
553
554 Here are some examples:
555
556    ncacn_np:myserver
557    ncacn_np:myserver[samr]
558    ncacn_np:myserver[\pipe\samr]
559    ncacn_np:myserver[/pipe/samr]
560    ncacn_np:myserver[samr,sign,print]
561    ncacn_np:myserver[sign,spnego]
562    ncacn_np:myserver[\pipe\samr,sign,seal,bigendian]
563    ncacn_np:myserver[/pipe/samr,seal,validate]
564    ncacn_np:
565    ncacn_np:[/pipe/samr]
566    ncacn_ip_tcp:myserver
567    ncacn_ip_tcp:myserver[1024]
568    ncacn_ip_tcp:myserver[sign,seal]
569    ncacn_ip_tcp:myserver[spnego,seal]
570
571
572 IDEA: Maybe extend UNC names like this?
573
574  smbclient //server/share
575  smbclient //server/share[sign,seal,spnego]
576
577 DCERPC Handles
578 --------------
579 The various handles that are used in the RPC servers should be created and 
580 fetch using the dcesrv_handle_* functions.
581
582 Use dcesrv_handle_new(struct dcesrv_connection *, uint8 handle_type) to obtain 
583 a new handle of the specified type. Handle types are unique within each 
584 pipe.
585
586 The handle can later be fetched again using
587 struct dcesrv_handle *dcesrv_handle_fetch(struct dcesrv_connection *dce_conn, struct policy_handle *p, uint8 handle_type)
588 and destroyed by dcesrv_handle_destroy(struct dcesrv_handle *).
589
590 User data should be stored in the 'data' member of the dcesrv_handle struct.
591
592
593 MSRPC
594 -----
595
596
597
598  - ntvfs
599  - testing
600  - command line handling
601  - libcli structure
602  - posix reliance
603  - uid/gid handling
604  - process models
605  - static data
606  - msrpc
607
608
609 don't zero structures! avoid ZERO_STRUCT() and talloc_zero()
610
611
612 GMT vs TZ in printout of QFILEINFO timezones
613
614 put in full UNC path in tconx
615
616 test timezone handling by using a server in different zone from client
617
618 do {} while (0) system
619
620 NT_STATUS_IS_OK() is NOT the opposite of NT_STATUS_IS_ERR()
621
622 need to implement secondary parts of trans2 and nttrans in server and
623 client
624
625 document access_mask in openx reply
626
627 check all capabilities and flag1, flag2 fields (eg. EAs)
628
629 large files -> pass thru levels
630
631 setpathinfo is very fussy about null termination of the file name
632
633 the overwrite flag doesn't seem to work on setpathinfo RENAME_INFORMATION
634
635 END_OF_FILE_INFORMATION and ALLOCATION_INFORMATION don't seem to work
636 via setpathinfo
637
638 on w2k3 setpathinfo DISPOSITION_INFORMATION fails, but does have an
639 effect. It leaves the file with SHARING_VIOLATION.
640
641 on w2k3 trans2 setpathinfo with any invalid low numbered level causes
642 the file to get into a state where DELETE_PENDING is reported, and the
643 file cannot be deleted until you reboot
644
645 trans2 qpathinfo doesn't see the delete_pending flag correctly, but
646 qfileinfo does!
647
648 get rid of pstring, fstring, strtok
649
650 add programming documentation note about lp_set_cmdline()
651
652 need to add a wct checking function in all client parsing code,
653 similar to REQ_CHECK_WCT()
654
655 need to make sure that NTTIME is a round number of seconds when
656 converted from time_t
657
658 not using a zero next offset in SMB_FILE_STREAM_INFORMATION for last
659 entry causes explorer exception under win2000
660
661
662 if the server sets the session key the same for a second SMB socket as
663 an initial socket then the client will not re-authenticate, it will go
664 straight to a tconx, skipping session setup and will use all the
665 existing parameters! This allows two sockets with the same keys!?
666
667
668 removed blocking lock code, we now queue the whole request the same as
669 we queue any other pending request. This allows for things like a
670 close() while a pending blocking lock is being processed to operate
671 sanely.
672
673 disabled change notify code
674
675 disabled oplock code
676
677
678
679 MILESTONES
680 ==========
681
682
683 client library and test code
684 ----------------------------
685
686   convert client library to new structure
687   get smbtorture working
688   get smbclient working
689   expand client library for all requests
690   write per-request test suite
691   gentest randomised test suite
692   separate client code as a library for non-Samba use
693
694 server code
695 -----------
696   add remaining core SMB requests
697   add IPC layer
698   add nttrans layer
699   add rpc layer
700   fix auth models (share, server, rpc)
701   get net command working
702   connect CIFS backend to server level auth
703   get nmbd working
704   get winbindd working
705   reconnect printing code
706   restore removed smbd options
707   add smb.conf macro substitution code
708   add async backend notification 
709   add generic timer event mechanism
710
711 clustering code
712 ---------------
713
714   write CIFS backend
715   new server models (break 1-1)
716   test clustered models
717   add fulcrum statistics gathering
718
719 docs
720 ----
721
722   conference paper
723   developer docs
724
725 svn instructions
726
727 Ideas
728 -----
729
730  - store all config in config.ldb
731
732  - load from smb.conf if modtime changes
733
734  - dump full system config with ldbsearch
735
736  - will need the ability to form a ldif difference file
737
738  - advanced web admin via a web ldb editor
739
740  - normal web admin via web forms -> ldif
741
742  - config.ldb will replace smb.conf, secrets.tdb, shares.tdb etc
743
744  - subsystems in smbd will load config parameters for a share
745    using ldbsearch at tconx time
746
747  - need a loadparm equivalent module that provides parameter defaults
748
749  - start smbd like this:  "smbd -C tdb://etc/samba/config.ldb" or
750    "smbd -C ldapi://var/run/ldapi"
751
752  - write a tool that generates a template ldap schema from an existing
753    ldb+tdb file
754
755  - no need to HUP smbd to reload config
756
757  - how to handle configuration comments? same problem as SWAT
758
759
760 BUGS:
761   add a test case for last_entry_offset in trans2 find interfaces
762   conn refused
763   connect -> errno
764   no 137 resolution not possible
765   should not fallback to anon when pass supplied
766   should check pass-thu cap bit, and skip lots of tests
767   possibly allow the test suite to say "allow oversized replies" for
768      trans2 and other calls
769   handle servers that don't have the setattre call in torture
770   add max file coponent length test and max path len test
771   check for alloc failure in all core reply.c and trans2.c code where
772     allocation size depends on client parameter
773
774 case-insenstive idea:
775   all filenames on disk lowercase
776   real case in extended attribute
777   keep cache of what dirs are all lowercase
778   when searching for name, don't search if dir is definately all lowercase
779   when creating file, use dnotify to tell if someone else creates at
780   same time
781
782 solve del *.* idea:
783   make mangle cache dynamic size
784   fill during a dir scan
785   setup a timer
786   destroy cache after 30 sec
787   destroy if a 2nd dir scan happens on same dir
788