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