HTML mupad C++ Perl Arc Racket Other
Latest commit 85553e5 Feb 7, 2017 @akkartik 3747
Permalink
Failed to load latest commit information.
arc 3166 Aug 12, 2016
cleave 3726 Dec 30, 2016
edit 3745 Feb 7, 2017
enumerate 3726 Dec 30, 2016
html 3747 Feb 7, 2017
linkify 3729 Jan 4, 2017
sandbox 3733 Jan 12, 2017
tangle 3726 Dec 30, 2016
termbox 3711 Dec 26, 2016
.travis.yml 3128 Jul 22, 2016
000organization.cc 3557 Oct 22, 2016
001help.cc 3707 Dec 12, 2016
002test.cc 3561 Oct 22, 2016
003trace.cc 3675 Nov 16, 2016
003trace.test.cc 3547 Oct 22, 2016
010vm.cc 3744 Feb 7, 2017
011load.cc 3742 - move instruction.old_name to a later layer Feb 7, 2017
012transform.cc 3561 Oct 22, 2016
013update_operation.cc 3707 Dec 12, 2016
014literal_string.cc 3561 Oct 22, 2016
015literal_noninteger.cc 2803 Mar 21, 2016
016dilated_reagent.cc 3539 Oct 21, 2016
017parse_tree.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
018type_abbreviations.cc 3522 Oct 20, 2016
020run.cc 3707 Dec 12, 2016
021check_instruction.cc 3707 Dec 12, 2016
022arithmetic.cc 3624 - new rounding instruction: 'truncate' Nov 6, 2016
023boolean.cc 3522 Oct 20, 2016
024jump.cc 3380 Sep 17, 2016
025compare.cc 3522 Oct 20, 2016
026call.cc 3380 Sep 17, 2016
027call_ingredient.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
028call_return.cc 3664 Nov 11, 2016
029tools.cc 3694 Nov 27, 2016
030container.cc 3723 Dec 28, 2016
031merge.cc 3707 Dec 12, 2016
032array.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
033exclusive_container.cc 3643 Nov 7, 2016
034address.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
035lookup.cc 3592 - warn on *any* lookup of address 0 Oct 25, 2016
036refcount.cc 3741 Feb 7, 2017
037abandon.cc 3707 Dec 12, 2016
038new_text.cc 3694 Nov 27, 2016
039location_array.cc 3522 Oct 20, 2016
040brace.cc 3742 - move instruction.old_name to a later layer Feb 7, 2017
041jump_target.cc 3549 Oct 22, 2016
042name.cc 3723 Dec 28, 2016
043space.cc 3747 Feb 7, 2017
044space_surround.cc 3707 Dec 12, 2016
045closure_name.cc 3522 Oct 20, 2016
046global.cc 3688 Nov 25, 2016
047check_type_by_name.cc 3701 Nov 30, 2016
050scenario.cc 3724 - flag duplicate scenarios Dec 28, 2016
051scenario_test.mu 3385 Sep 17, 2016
052tangle.cc 3675 Nov 16, 2016
053recipe_header.cc 3744 Feb 7, 2017
054static_dispatch.cc 3685 Nov 24, 2016
055shape_shifting_container.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
056shape_shifting_recipe.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
057immutable.cc 3689 Nov 26, 2016
058to_text.cc 3669 Nov 12, 2016
059to_text.mu 3390 Sep 17, 2016
060rewrite_literal_string.cc 3744 Feb 7, 2017
061text.mu 3699 Nov 28, 2016
062convert_ingredients_to_text.cc 3747 Feb 7, 2017
063array.mu 3432 Oct 1, 2016
064list.mu 3656 Nov 10, 2016
065duplex_list.mu 3429 - standardize Mu scenarios Sep 29, 2016
066stream.mu 3390 Sep 17, 2016
067random.cc 3536 Oct 21, 2016
068random.mu 3656 Nov 10, 2016
069hash.cc 3654 Nov 8, 2016
070table.mu 3688 Nov 25, 2016
071recipe.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
072scheduler.cc 3656 Nov 10, 2016
073wait.cc 3707 Dec 12, 2016
074deep_copy.cc 3663 - fix a refcounting bug: '(type)' != 'type' Nov 11, 2016
075channel.mu 3688 Nov 25, 2016
080display.cc 3597 - typo in screen checking Oct 27, 2016
081print.mu 3736 - support printing booleans Jan 22, 2017
082scenario_screen.cc 3643 Nov 7, 2016
083scenario_screen_test.mu 3429 - standardize Mu scenarios Sep 29, 2016
084console.mu 3574 Oct 24, 2016
085scenario_console.cc 3643 Nov 7, 2016
086scenario_console_test.mu 3565 Oct 23, 2016
087file.cc 3433 Oct 2, 2016
088file.mu 3705 - switch to tested file-system primitives Dec 12, 2016
089scenario_filesystem.cc 3668 - $read a word, stopping at whitespace Nov 12, 2016
090scenario_filesystem_test.mu 3705 - switch to tested file-system primitives Dec 12, 2016
091socket.cc 3602 Oct 27, 2016
092socket.mu 3705 - switch to tested file-system primitives Dec 12, 2016
100trace_browser.cc 3682 Nov 22, 2016
101run_sandboxed.cc 3730 Jan 7, 2017
998check_type_pointers.cc 2463 - make edit/ robust to errors in client code Nov 19, 2015
999spaces.cc 3561 Oct 22, 2016
Readme.md 3620 Nov 4, 2016
build 3712 Dec 26, 2016
build_and_test_until 3506 Oct 16, 2016
cannot_write_tests_for 3705 - switch to tested file-system primitives Dec 12, 2016
channel.mu 3483 Oct 8, 2016
chessboard.mu 3735 - get rid of 'print-integer' Jan 22, 2017
clean 3460 Oct 7, 2016
console.mu 3483 Oct 8, 2016
counters.mu 3394 Sep 17, 2016
display.mu 3380 Sep 17, 2016
example1.mu 3380 Sep 17, 2016
exuberant_ctags_rc 3734 Jan 12, 2017
factorial.mu 3483 Oct 8, 2016
filesystem.mu 3483 Oct 8, 2016
fork.mu 2735 - define recipes using 'def' Mar 8, 2016
git_log_filtered 3455 Oct 7, 2016
global.mu 3394 Sep 17, 2016
http-client.mu 3603 Oct 27, 2016
http-server.mu 3594 Oct 25, 2016
immutable-error.mu 3400 Sep 18, 2016
index.html 3641 Nov 7, 2016
lambda-to-mu.mu 3688 Nov 25, 2016
mu 3561 Oct 22, 2016
mu.vim 3702 Dec 6, 2016
mutable.mu 3389 Sep 17, 2016
new_lesson 3561 Oct 22, 2016
nqueens.mu 3681 Nov 22, 2016
real-files.mu 3483 Oct 8, 2016
relayout 3711 Dec 26, 2016
screen.mu 3380 Sep 17, 2016
static-dispatch.mu 3400 Sep 18, 2016
tangle.mu 3483 Oct 8, 2016
test_layers 3454 Oct 7, 2016
update_html 3725 Dec 28, 2016
vimrc.vim 3707 Dec 12, 2016
x.mu 3380 Sep 17, 2016

Readme.md

by Stephen Malina and Kartik Agaram

Mu explores ways to turn arbitrary manual tests into reproducible automated tests. Hoped-for benefits:

  1. Projects release with confidence without requiring manual QA or causing regressions for their users.

  2. Open source projects become easier for outsiders to comprehend, since they can more confidently try out changes with the knowledge that they'll get rapid feedback if they break something. Projects also become more rewrite-friendly for insiders: it's easier to leave your project's historical accidents and other baggage behind if you can be confident of not causing regressions.

  3. It becomes easier to teach programming by emphasizing tests far earlier than we do today.

The hypothesis is that designing the entire system to be testable from day 1 and from the ground up would radically impact the culture of an eco-system in a way that no bolted-on tool or service at higher levels can replicate. It would make it easier to write programs that can be easily understood by newcomers. It would reassure authors that an app is free from regression if all automated tests pass. It would make the stack easy to rewrite and simplify by dropping features, without fear that a subset of targeted apps might break. As a result people might fork projects more easily, and also exchange code between disparate forks more easily (copy the tests over, then try copying code over and making tests pass, rewriting and polishing where necessary). The community would have in effect a diversified portfolio of forks, a “wavefront” of possible combinations of features and alternative implementations of features instead of the single trunk with monotonically growing complexity that we get today. Application writers who wrote thorough tests for their apps (something they just can’t do today) would be able to bounce around between forks more easily without getting locked in to a single one as currently happens.

In this quest, Mu is currently experimenting with the following mechanisms:

  1. New, testable interfaces for the operating system. Currently manual tests are hard to automate because a file you assumed might vanish, the network might go down, etc. To make manual tests reproducible it suffices to improve the 15 or so OS syscalls through which a computer talks to the outside world. We have to allow programs to transparently write to a fake screen, read from a fake disk/network, etc. In Mu, printing to screen explicitly takes a screen object, so it can be called on the real screen, or on a fake screen inside tests, so that we can then check the expected state of the screen at the end of a test. Here's a test for a little text-mode chessboard program in Mu (delimiting the edge of the 'screen' with dots):

          a screen test

    We've built up similarly dependency-injected interfaces to the keyboard, mouse, disk and network.

  2. Support for testing side-effects like performance, deadlock-freedom, race-freeness, memory usage, etc. Mu's white-box tests can check not just the results of a function call, but also the presence or absence of specific events in the log of its progress. For example, here's a test that our string-comparison function doesn't scan individual characters unless it has to:

          white-box test

    Another example: if a sort function logs each swap, a performance test can ensure that the number of swaps doesn't quadruple when the size of the input doubles.

    Besides expanding the scope of tests, this ability also allows more radical refactoring without needing to modify tests. All Mu's tests call a top-level function rather than individual sub-systems directly. As a result the way the subsystems are invoked can be radically changed (interface changes, making synchronous functions asynchronous, etc.). As long as the new versions emit the same implementation-independent events in the logs, the tests will continue to pass. (More information.)

  3. Organizing code and tests in layers of functionality, so that outsiders can build simple and successively more complex versions of a project, gradually enabling more peripheral features. Think of it as a cleaned-up git log for the project. (More information.)

You can see these mechanisms in action below in the context of a platform for teaching programming 1:1. It allows students to spin up a fake screen, keyboard, file system and network neighborhood in tests. The Basic-like Assembly language of the Mu VM is as powerful as C for low-level pointer operations and manual memory management, but much safer, paying some run-time checking overhead to validate pointers. It is as powerful as high-level languages (providing strong type safety, general lexical scope, generic types, and higher-order functions) but should be easier to write a compiler for since it gives up some expressiveness by not allowing recursive expressions. It is also more expressive than conventional high-level languages in some ways: Literate Programming turns out to be a great fit for a statement-oriented language, and labels make great join points.

Balancing these strengths, however, Mu is currently interpreted and slow. Too slow for graphics or sound, among other things. Rather than try to build a compiler for it, our next milestone is to "backport" the lessons of Mu back to a real-world unix-like system: OpenBSD, a reasonable compromise between the complexity (ahem bloat) of GNU and the over-simplification of xv6. The goal is to continue to have a self-contained, self-hosting system without external dependencies as we add support for new kinds of tests. The goal is explicitly not to blindly reimplement our Basic-like language atop OpenBSD, or to port the OpenBSD sources to our language. Instead, we will modify the C compiler to provide some of the greater safety we prototyped here, and make use of it in the OpenBSD sources.

Things are pretty open-ended right now as we learn about OpenBSD, so the action will mostly be on the wiki for some time to come. This project is still very much active, though. Questions, bug reports and Pull Requests will be promptly addressed.

Taking Mu for a spin

Mu is currently implemented in C++ and requires a Unix-like environment. It's been tested on Ubuntu, Mac OS X and OpenBSD; on x86, x86_64 and ARMv7; and on recent versions of GCC and Clang. Since it uses no bleeding-edge language features and has no exotic dependencies, it should work with most reasonable versions, compilers or processors.

Build Status

Running Mu will always recompile it if necessary:

  $ cd mu
  $ ./mu

As a simple example, here's a program with some arithmetic:

code example

As stated before, Mu functions are lists of instructions, one to a line. Each instruction operates on some ingredients and returns some products.

  [products] <- instruction [ingredients]

Result and ingredient reagents cannot contain instructions or infix expressions. On the other hand, you can have any number of them. In particular, you can have any number of products. For example, you can perform integer division as follows:

  quotient:number, remainder:number <- divide-with-remainder 11, 3

Each reagent consists of a name and its type, separated by a colon. You only have to specify the type the first time you mention a name, but you can be more explicit if you choose. Types can be multiple words and even arbitrary trees, like:

  x:array:number:3  # x is an array of 3 numbers
  y:list:number  # y is a list of numbers
  # ':' is just syntactic sugar
  {z: (map (address array character) (list number))}   # map from string to list of numbers

Try out the program now:

  $ ./mu example1.mu
  $

Not much to see yet, since it doesn't print anything. To print the result, try adding the instruction $print a to the function.


Here's a second example, of a function that can take ingredients:

fahrenheit to celsius

Functions can specify headers showing their expected ingredients and products, separated by -> (unlike the <- in calls).

Once defined, functions can be called just like primitives. No need to mess with a CALL instruction or push/pop arguments to the stack.

Since Mu is a low-level VM language, it provides extra control at the cost of verbosity. Using local-scope, you have explicit control over stack frames to isolate your functions in a type-safe manner. You can also create more sophisticated setups like closures. One consequence of this extra control: you have to explicitly load-ingredients after you set up the stack.

An alternative syntax is what the above example is converted to internally:

fahrenheit to celsius desugared

The header gets dropped after checking types at call-sites, and after replacing load-ingredients with explicit instructions to load each ingredient separately, and to explicitly return products to the caller. After this translation functions are once again just lists of instructions.

This alternative syntax isn't just an implementation detail. It turns out to be easier to teach functions to non-programmers by starting with this syntax, so that they can visualize a pipe from caller to callee, and see the names of variables get translated one by one through the pipe.


A third example, this time illustrating conditionals:

factorial example

In spite of how it looks, this is still just a list of instructions and labels. Internally, the instructions break and loop get converted to jump instructions to after the enclosing } or { labels, respectively.

Try out the factorial program now:

  $ ./mu factorial.mu
  result: 120  # factorial of 5

You can also run its unit tests:

  $ ./mu test factorial.mu

Here's what one of the tests inside factorial.mu looks like:

test example

Every test conceptually spins up a really lightweight virtual machine, so you can do things like check the value of specific locations in memory. You can also print to screen and check that the screen contains what you expect at the end of a test. For example, you've seen earlier how chessboard.mu checks the initial position of a game of chess (delimiting the edges of the screen with dots):

screen test

Similarly you can fake the keyboard to pretend someone typed something:

fake keyboard

..or clicked somewhere:

fake console (keyboard, mouse, ..)

Within tests you can map arbitrary paths (local files or URLs) to contents:

fake file-system and network

As we add graphics, audio, and so on, we'll augment scenarios with corresponding abilities.


Mu assumes that all ingredients passed in to functions are immutable by default -- unless they are also products. So this program will throw an error:

immutable ingredient triggering an error

To modify foo's ingredient, you have to add it to the list of products returned:

mutable ingredient

The names of the variables are important here: a function that takes an (immutable) address and returns a different one is different from a function that takes a mutable address (and also returns it).

Immutability checks can be annoying sometimes, but the benefit they provide is that you always know what a function modifies just by looking at its header. They provide all the benefits of referential transparency that we typically associate with (particularly purely functional) high-level languages -- but without giving up the flexibility to imperatively modify variables willy-nilly.


You can append arbitrary properties to reagents besides types and spaces. Just separate them with slashes.

  x:array:number:3/uninitialized
  y:string/tainted:yes
  z:number/assign-once:true/assigned:false

Most properties are meaningless to Mu, and it'll silently skip them when running, but they are fodder for meta-programs to check or modify your programs, a task other languages typically hide from their programmers. For example, where other programmers are restricted to the checks their type system permits and forces them to use, you'll learn to create new checks that make sense for your specific program. If it makes sense to perform different checks in different parts of your program, you'll be able to do that.

You can imagine each reagent as a table, rows separated by slashes, columns within a row separated by colons. So the last example above would become something like this:

  z           : integer  /
  assign-once : true     /
  assigned    : false

An alternative way to define factorial is by inserting labels and later inserting code at them.

literate programming

(You'll find this version in tangle.mu.)

By convention we use the prefix '+' to indicate function-local label names you can jump to, and surround in '<>' global label names for inserting code at.


Another example, this time with concurrency:

forking concurrent routines

  $ ./mu fork.mu

Notice that it repeatedly prints either '34' or '35' at random. Hit ctrl-c to stop.

Yet another example forks two 'routines' that communicate over a channel:

  $ ./mu channel.mu
  produce: 0
  produce: 1
  produce: 2
  produce: 3
  consume: 0
  consume: 1
  consume: 2
  produce: 4
  consume: 3
  consume: 4

  # The exact order above might shift over time, but you'll never see a number
  # consumed before it's produced.

Channels are the unit of synchronization in Mu. Blocking on a channel is the only way for the OS to put a task to sleep. The plan is to do all I/O over channels.

Routines are expected to communicate purely by message passing, though nothing stops them from sharing memory since all routines share a common address space. However, idiomatic Mu will make it hard to accidentally read or clobber random memory locations. Bounds checking is baked deeply into the semantics, and pointers can never be invalidated.


Mu has a programming environment:

  $ ./mu edit

Screenshot:

programming environment

You write functions on the left and try them out in sandboxes on the right. Hit F4 to rerun all sandboxes with the latest version of the code. More details: http://akkartik.name/post/mu. Beware, it won't save your edits by default. But if you create a sub-directory called lesson/ under mu/ it will. If you turn that directory into a git repo with git init, it will also back up your changes each time you hit F4. Use the provided new_lesson script to take care of these details.

Once you have a sandbox you can click on its result to mark it as expected:

expected result

Later if the result changes it'll be flagged in red to draw your attention to it. Thus, manually tested sandboxes become reproducible automated tests.

unexpected result

Another feature: Clicking on the code in a sandbox expands its trace for you to browse. To add to the trace, use stash. For example:

  stash [first ingredient is], x

Invaluable for understanding complex control flow without cluttering up the screen.


If you're still reading, here are some more things to check out:

a) Look at the chessboard program for a more complex example with tests of blocking reads from the keyboard and what gets printed to the screen -- things we don't typically associate with automated tests.

b) Try skimming the colorized source code. You should be able to get a pretty good sense for how things work just by skimming the files in order, skimming the top of each file and ignoring details lower down.

c) Try running the tests:

  $ ./mu test

Credits

Mu builds on many ideas that have come before, especially:

  • Peter Naur for articulating the paramount problem of programming: communicating a codebase to others;
  • Christopher Alexander and Richard Gabriel for the intellectual tools for reasoning about the higher order design of a codebase;
  • Unix and C for showing us how to co-evolve language and OS, and for teaching the (much maligned, misunderstood and underestimated) value of concise implementation in addition to a clean interface;
  • Donald Knuth's literate programming for liberating "code for humans to read" from the tyranny of compiler order;
  • David Parnas and others for highlighting the value of separating concerns and stepwise refinement;
  • Lisp for showing the power of dynamic languages, late binding and providing the right primitives a la carte, especially lisp macros;
  • The folklore of debugging by print and the trace facility in many lisp systems;
  • Automated tests for showing the value of developing programs inside an elaborate harness;
  • Python doctest for exemplifying interactive documentation that doubles as tests;
  • ReStructuredText and its antecedents for showing that markup can be clean;
  • BDD for challenging us all to write tests at a higher level;
  • JavaScript and CSS for demonstrating the power of a DOM for complex structured documents.
  • Rust for demonstrating that a system-programming language can be safe.