Larry Osterman's WebLog

Confessions of an Old Fogey
Blog - Title

Contractual obligations

Contractual obligations

  • Comments 8

Once upon a time, I watched the TV show The Paper Chase.  As I recall it, the feared and respected professor Kingman tought contract law, which could be thought as the organic chemistry of the legal profession (organic chem was the class that the chemical engineers at Carnegie-Mellon used to dread, because it was so difficult). 

Software contracts are almost as complicated as legal contracts.  And we use them every single day without thinking about them.

Every function that's ever been written specifies a contract.  It doesn't matter if the function is public or private, every single function has a contract.

And just like in contract law, there's a HUGE body of work that exists to help specify the contract for a function.  This is a big topic, and I suspect it will take several posts to cover it (and I'm sure I can't do it justice).  Much like the "programming with style" series, I'm mostly going to be making this up as I go along - I have a huge number of thoughts about software contracts, and it may take a drunkards walk before I can finally get all them out.

What is a software contract?

"Let's start at the very beginning, a very good place to start".

A function's software contract, simply put, defines the behavior of a function.  It allows the caller of a function to know what the function does, how it fails, and (in general) what happens when the function executes.

Contracts can be both explicit and implicit - an explicit contract is expressed directly,

A function's explicit contract is embodied in many forms, and is expressed in different places.  It's embodied in the documentation of the function (either in official published documentation or just in the comments in the function header).  It can be embodied in annotations applied to the function definition (SAL annotations are a great example of this).  It can be embodied in the names of the parameters to a function.  And some contracts are expressed by some well known conventions.

Implicit contracts, on the other hand are never expressed.  Implicit contracts are embodied in something that is called "The principle of least surprise".  These are the unwritten parts of a function's contract that fall into the general area of "common sense".

The principle of least surprise.

Simply stated, the principle of least surprise is: "Whatever happens when a function executes, it should not behave in a manner that is unexpected".

So CreateFile shouldn't reformat the hard disk if it fails.  Or, to use a somewhat less drastic version: If CreateFile fails, the filesystem is left in the state it was before the CreateFile call was made.  In other words, if you did a DIR of the filesystem before the failed call to CreateFile, and did the same DIR afterwards, you would get the same results.  This isn't to say that under the covers changes were made to the filesystem - that's possible. But the externally visible behaviors should remain the same.

Similarly, an API that retrieves some data shouldn't modify that data.  Or an API that takes an input parameter shouldn't modify that parameter without notification.  As I've mentioned before, CreateProcess fails this.  If your function DOES violate the principle of least surprise, you need to make that violation explicit in the contract for your function (usually in the documentation, as was done in the CreateProcess example).

Contract Enforcement

The enforcement of a function's contract varies.  For example, when the RPC runtime library marshals a function from one process/machine/thread to another process/machine/thread, it enforces the contract specified in the MIDL annotations on the function.  So when you're writing the server stub for a function with the function prototype: "HRESULT Function([out] int * returnedInt);" you don't have to check for the "returnedInt" parameter being null - the RPC runtime library guarantees that the server side of the function will always have valid storage to hold that value.  Other times, the code of a function enforces the contract - it checks for non optional parameters being non null, for example.  And sometimes there are external tools that check for contract enforcement (the SAL annotations mentioned above are perfect examples of that - the compiler (with the /analyze switch) ensures that the contract specified in the annotation is met.

 

Why do we care about software contracts? 

We care about software contracts because they help us write better code.  In order to interact with a function, you MUST know its contract.  In addition, knowing a function's contract allows you to make certain assumptions, and allows you to avoid pitfalls.  For example, the problem in this example becomes blindingly obvious once you knew that CoUnitialize's contract destroyed the apartment on the last call to CoUnitialize, and that destroying an apartment destroyed all the objects created within that apartment (btw, I couldn't find any documentation that spelled this out - bad Microsoft :().

  • As an addendum to the 'Principle of Least Surprise', one thing that needs to happen and often doesn't is that if part of the implied contract is in the name of the function, and that part changes, the name needs to change as well.

    As an example, on a project I worked on a few years ago there was a function that was, essentially:

      ArrayList ReturnMatchingObjects();

    There was a need in the UI, added, to display all of the objects, with a checkbox indicating whether or not they matched.   So someone got the bright idea to add a bool Matched property to the object, and return all the objects, with it just set appropriately.

    I spent a number of hours tracking down issues caused by people assuming that the method name actually represented the method's contact.

  • Please talk about reverse contracts.  By that I mean the contract that the caller places on the callee.  For example, programmers who just call functions different ways until they get the behavior they want.  I have seen far too much fragile software created in such ways.  It isn't just a problem for the caller, but the callee has to be mindful of breaking the unwanted contracts when refactoring implementation.

  • > the feared and respected professor Kingman

    Close, actually the character was called Charles W. Kingsfield Jr. - played brilliantly by the late John Houseman.

  • I recently got quite surprised when Raymond Chen discussed the way that monochrome bitmaps are coloured when blitting to a colour DC (specifically, that black pixels are set to the current text colour, while white pixels are set to the current background colour [SetBkColor]). These operations are _not_ spelled out in BitBlt's documentation (although I've now discovered they _are_ in StretchBlt's). I had simply assumed that the resulting pixels would be black or white respectively.

    It wasn't that I got caught out by this behaviour, it was that this was explicitly the behaviour that I wanted but didn't know how to achieve! I'd originally used multiple BitBlt operations with intermediate DCs to get the result, until a different article of Raymond's pointed out that you could invent your own ternary raster operations, rather than just those listed in BitBlt's documentation (upon which I managed to work out a single opcode that would take the source bitmap, the current colour of the destination bitmap as the background, and the brush selected into the DC as the foreground colour to do it all in one go).

  • mem: Interesting - I actually looked the name up, obviously I got it wrong.

  • > mem: Interesting - I actually looked the name up, obviously I

    > got it wrong.

    Yup.  If you look closer, it's mgm.

  • Yesterday , I started talking about software contracts. Today I'd like to start talking about how contracts

  • I'm more discombobulated than usual on this series, I totally missed the third article in the series

Page 1 of 1 (8 items)