An Introduction to Celluloid, Part I

Dhaivat Pandya
This entry is part 1 of 3 in the series An Introduction to Celluloid

An Introduction to Celluloid

A few years ago, there used to be a very easy way to optimize code. If you found out that your processor-heavy code was running a bit slower than you wanted it to, the simple solution was just to wait for the next hardware iteration, which would magically amp up the clock rate on the CPUs and your app would suddenly run faster.

Unfortunately, those times are now past. Because of a little something called “transition energy” inside the logic gates (the incredibly tiny electronically controlled “switches” that run processors), it has become close to impossible to push the clock rate any further at a reasonable price. But, a smart solution was quickly uncovered. Instead of trying to push one processor to run at break neck speed, we instead spread out the workload over multiple processors. What an excellent idea!

For people that write software, understanding concurrency and using it well suddenly becomes incredibly important. In order to scale up with the hardware, your code MUST use concurrency! This seemed simple enough to everyone at first; it couldn’t be that hard right? Well, it was. The mechanism that is (arguably) most popular for concurrency is threads, which are immensely complicated. A few small mistakes here and there can wreak havoc. If you’re really interested in this sort of stuff, I’d recommend you read up a little.

If you were brave enough to click a a few of those links, it shouldn’t take long to realize that thread management isn’t always a walk in the park. Consider, as an example, deadlocking.

(dead) Locking

Suppose you have two people that have a single copy of a book that they both want to read. Assuming that they won’t both be able to read the same book at the same time, so one person will have to wait until the other is done reading it. Now, consider a situation where each person thinks that the other person isn’t done reading the book and, as such, decides not to start reading it. Now, neither person reads the book.

This situation is known as a deadlock.

If your program has two “threads” (which are analogous to the two people we discussed) and they both write to a file called “steve”. Both of them cannot write to the file at the same time, so the file is “locked” while one thread is writing to it. A similar situation can be present for shared variables.

Of course, this situation works just great, but the problem occurs when there is some error that causes the file to be locked for both threads. If you’ve written any amount of thread driven code, you know this happens a lot. When it does, it is a complete pain to track down and fix.

Race Conditions

In deadlocking, the two threads wait around for each other forever. However, deadlocking has a cousin that is just as bad, if not worse.

Race conditions occur when two threads try to access and write to a variable at the same time. So, both threads read the variable, then each one races to see who can write to the variable first/last.

This causes all kinds of problems, because it might cause one thread’s changes to the variable to be completely hammered by the other.

Solution?

The two problems mentioned above are just the tip of the iceberg – there’s all kinds of other issues to be dealt with when using threads.

Around the 1980’s, people began thinking about where all of these problems were really coming from and how to deal with them. They found that nearly all of these issues are caused by sharing of state (i.e. variables, files, etc.) and locking. If you forget to lock a single shared resource, there’s going to be a boatload of trouble waiting for you with threads.

Multiple solutions were proposed, one of which is evented I/O, which means eventmachine for Rubyists.

Along with that, some bright academics came up with a new model that had taken some ideas from quantum physics. Instead of sharing state, the entire concurrency system would be based on passing messages. They called this the actor model.

Actor Model

In the actor model, each object is an actor. Each actor is meant to send and receive messages to other actors and may also create other actors if need be. The main point around which all of this pivots is the fact that all communications can be asynchronous and no state is shared between the actors. That means that messages can be being sent while others are being received. Also, when an actor sends a message it doesn’t always have to wait for a response. State that is to be shared between processes is done entirely through means of messaging.

If you didn’t understand a large portion of this, that’s perfectly fine, just follow along.

Of course, none of this happens by itself. A library called (Celluloid)[http://celluloid.io/] makes this stuff happen and that’s what we’ll be using!

Celluloid

Celluloid brings the actor model to Ruby, making writing concurrent applications incredibly easy.

First of all, Celluloid comes with built in deadlock protection, because all of the messaging between actors between is handled in a such a way that deadlocking is darn near impossible, as long as you’re not doing something crazy or messing with native (i.e. C) code.

If you’re familiar with Erlang (it is okay if you’re not), Celluloid borrows one of its most important ideas: fault tolerance. Celluloid automatically restarts and handles crashed actors, so you don’t have to worry about every last thing that could go wrong.

There’s all kinds of other features (linking, futures, etc.) that make threading a breeze, but there a few things to keep in mind.

The GIL

The “regular” or vanilla ruby that we’re all used to is backed by either MRI or YARV, which are different types of interpreters/vitual machines for Ruby.

Now, there is, debatably, a problem with this interpreter. The thing is, all threads inside MRI/YARV aren’t really concurrent – everything is run under a single thread. This is called the Global Interpreter Lock. Ruby isn’t the only language with an interpreter that has this – so does Python and don’t even get me started on threading with PHP.

When a new thread is created, the result is the computation that is performed isn’t actually performed at the same time as other stuff is being done. An illusion is created that makes the user think that this is what is happening.

Fortunately, there is a solution. Just use a different interpreter! Take your pick:

  • (JRuby)[jruby.org]
  • (Rubini.us)[http://rubini.us/]

Note that if you do choose to go with one of the above interpreters, make sure you are operating in 1.9 mode in order to be compaitible with Celluloid.

Diving In

Let’s get started with Celluloid by writing a small actor – let’s make it read a file we tell it to, and then display the results when they are wanted.

Running that (with your choice of interpreter), you should get a dump of the kernel log (of course, assuming you’re using a POSIX system, Windows users can replace that line with any file of their choice) followed by a message from Celluloid telling you that two actors have been terminated.

Alright, so, what just happened?

We defined the FilePutter actor and created an instance of it, which Celluloid automatically pushes into its own thread! There’s no difference in how we are calling the methods; it is just like we would for a regular class, and it dumps the contents of a file.

First, calling load_file loads the file, then we proceed on to printing the contents. Not too complicated.

But, one thread isn’t all that interesting; how about five? Easy enough:

And, just like that, we’ve created five threads which each read the files in the “files” array.

But, all of the methods we’ve called so far have been called syncronously, meaning that we have to wait for them to end before proceeding. What if we just pushed them to the side and moved on?

This is where Celluloid really shines:

This is where it gets interesting. First of all, we combined the loading of the file and printing the contents into one method, namely load_file_and_print. Then, notice inside the loop over the files array, we don’t call load_file_and_print, instead, we call load_file_and_print! (i.e. with a bang).

Wrapping It Up

When we call the given method with the bang, Celluloid runs that call asynchronously, allowing our program to move right along without waiting for the file to load or the printing to occur.

As we know, methods with an exclamation mark at the end are usually noted as “dangerous” in Ruby. As an example:

That changes the value of “a” itself, which could lead to problems.

The same case is present with bang methods in Celluloid; the asynchronous message delivering isn’t perfect. The message might not be delivered, the actor might not respond, etc.

But, how do you figure out when this happens?

Also, threads are never really completely independent of each other – how do you have them talking to each other?

This, and, several other important actor model features and niceties are coming in part II, so, stay tuned!

If you felt this article went a bit too slow, you’ll be satisfied with Part II :)

Please ask questions if you have any in the comments section.

An Introduction to Celluloid

An Introduction to Celluloid, Part II >>

Free book: Jump Start HTML5 Basics

Grab a free copy of one our latest ebooks! Packed with hints and tips on HTML5's most powerful new features.

  • http://bibwild.wordpress.com Jonathan Rochkind

    This is great, eagerly awaiting part II.

    But I feel an obligation to continually point out that the GIL isn’t neccesarily a problem, and you might want to use Celluloid even with MRI, in some circumstances: Mainly when the actors will be I/O bound, spend a lot of time waiting on I/O (for instance, an external network resource).
    MRI 1.9 is perfect happy to context switch your threads around when they are waiting on I/O.

    I use Celluloid (and used ‘manual’ multi-threading before Celluloid) in just such a situation to great effect. It’s not true that you’d never want to use Celluloid in an interpreter with a GIL!

  • Mik

    I’d just like to point out a factual error regarding the threading model in CRuby. It is true that in Ruby 1.8, all threads are run in the same OS thread, and no thread can run concurrently with another due to the GIL.

    In 1.9, every ruby thread runs in it’s own OS thread, but the GIL is still there, meaning even though these threads *could* run in parallel (depending on the number of cores you have), only one of them are allowed to run ruby code at any given moment.

  • http://edivandecastro.blogspot.com.br edivandecastro@gmail.com

    I follow all of your example See my code:

    https://gist.github.com/3425523

    But this error occurred:

    https://gist.github.com/3425547

  • http://bibwild.wordpress.com Jonathan Rochkind

    Note that in the latest version of celluloid, you don’t call actor methods async with the bang anymore, “fp.load_file_and_print!”, instead you do “fp.async.load_file_and_print”, same thing, new way to call.