README.md

       (    )
        (oo)
 )\.---/(O O)
;       / u
 (  .  |} )
  |/ `;|/;
  "   " "

pycow

Copy-on-write for Python

Python has support for shallow copying and deep copying functionality via its copy module. However it does not provide for copy-on-write semantics. This project aims to remedy this shortcoming. The need for this sort of a functionality was felt when I was implementing a symbolic execution engine in Python using PyPy (called SyPy).

In a symbolic execution engine, the executor conceptually "forks" whenever it hits a decision point in the application. In SyPy, instead of forking, we simply remember the decision point and move back to that point when we are done exploring a given choice in the execution path. However, this also means reverting the heap (object space) to its original state. Creating a separate deep copy of the heap at each fork point is an extremely heavy operation and the need was felt to have some sort of a COW functionality in place. Note that in modern OSes this is automatic. Forking a child process creates a shallow copy of the parent process' memory space which is marked as read only. When the child process attempts to write to the memory space, it triggers a fault that is intercepted by the kernel and recognized as a COW fault. Then the OS creates a fresh copy of the parent's memory space and writes whatever was supposed to have been written to it.

The current implementation of pycow supports partial COW as well as general COW functionality. The implementation requires more testing. Proxy versions of lists and dicts have been implemented.

Usage

Suppose you define a class as follows:

class Point:
    x = None
    y = None
    def __init__(self, x, y):
        self.x = x
        self.y = y

You can initialize the class like so:

>>> a = Point(1, 2)

Now, we will create a copy-on-write version of the above object:

>>> b = Proxy(a)
>>> b.x
1
>>> a.x = 42
>>> b.x
42

For now, b is just a simple reference to a. However, when we modify b, the copy-on-write mechanism kicks in and we see the magic.

>>> b.x = 420
>>> a.x
42
>>> b.x
420

Contributors:

Nikhil Sarda

Cow ascii art from http://ascii.co.uk/art/cow