An introduction to libuv

An introduction to libuv(nikhilm.github.io)

112 points by deadwait 12 years ago | 27 comments

josephg 12 years ago |

I've written a couple of C tools directly on top of libuv[1] to play with it. I've got to say, its a great little library. Its basically nodejs's entire cross-platform standard library & event loop exposed to C, without V8 and without npm. It performs well, the code is pretty high quality and the internal documentation is excellent. The external API docs aren't very good though - I found myself reading through nodejs a few times to figure out how I was expected to use some of the functions.

I'm quite curious to see how much performance you lose through libuv compared to using the lower level IO primitives directly (epoll, select and friends). I know redis doesn't use any high level event libraries, but I haven't seen any benchmarks.

[1] https://github.com/josephg/sharedb (Caveat: This was an experiment and libuv has probably changed in incompatible ways since I wrote this code)

SpikeGronim 12 years ago | |

Redis doesn't use libuv, and in fact rejected a patch from MS to add libuv support. The reason is dependency management, not performance. Redis takes very very few dependencies - basically just a C compiler and POSIX. This makes it easier to deploy Redis, and Redis doesn't have to worry about failures in its non-existent dependencies.

jheriko 12 years ago |

i am always a bit of jerk about these things because i constantly work with genuinely performance critical code, but the very first thing puts me off:

uv_loop_t* loop = uv_loop_new();

does the compiler know where this exists, is it allocated on demand, is there a lock involved? i hope to get the good answers to these questions but the naming of the function alone makes me skeptical. this skepticism turns out to be justified.

digging in:

loop = (uv_loop_t* )malloc(sizeof(uv_loop_t));

so the answers to all of my questions are the wrong ones for me. i might override the allocator to be less rubbish in my context. but simple things like this tell me that this library was not architected for the kinds of performance considerations that i need to make.

at this high level its not so important, but the more digging i do the 'worse' it gets...

generally this does look helpful, but it gives me nothing over my existing solutions (in my context) which, for example, require zero run-time memory allocations - outside of OS level API calls that I have zero control over - and lean heavily towards lockless implementations, avoiding the massively (but understandably) heavyweight OS provided threading primitives...

thread safety of malloc and other standard library (i.e. libc) type stuff is, in reality, up to the implementor. even when things have no requirement to be thread safe implementors (Microsoft) will often insert what i call 'sledgehammer thread safety' to protect bad programmers from themselves. i can understand why, but it prevents me from being able to use these libraries.

when i can do a better job than your standard library, you have failed imo. but it is just my opinion...

bnoordhuis 12 years ago | |

Libuv author here. Libuv doesn't try to be all things to all people - its main users are Node.js and Rust - but if you have suggestions on how to improve the API or the implementation, please file issues[1] or join us in #libuv on irc.freenode.org. We welcome outside input.

As a bit of history, the reason why uv_loop_new() mallocs memory for the struct (and it's something of an anomaly in that respect, most other API functions don't) is that the thing that came before libuv, libev, worked like that. It's something we can change if there is demand for it.

[1] https://github.com/joyent/libuv/issues

KenoFischer 12 years ago | | |

And Julia! :)

jheriko 12 years ago | | |

thanks. great reply. :)

tbh, i was angling for 'my criticism isn't great because i am a specialist in a specialist field'.

(also, it does look like a genuinely useful library for most use cases - im just lazy and want everyone else to do my job for me :P)

ricardobeat 12 years ago | |

In general, you can always do a better job than any given library for your specific use case. That might mean 10x more work though, it's all about choices/compromises.

qznc 12 years ago | | |

He probably wants an alternative like:

    uv_loop_t loop;
    uv_loop_init(&loop);

_wmd 12 years ago | |

Various parts of libuv (e.g. the recv path) have pluggable allocators. I'm more interested in why you'd be wanting to create and destroy event loops at a high rate? That seems to imply you're perhaps creating and destroying threads at a high rate, in which case, you have bigger problems than malloc.

qznc 12 years ago | |

My theory: The library was designed for Node.js, not for ultimate performance. Design for Node.js means "easy to create bindings for", which means opaque pointers instead of structs in the API.

9oliYQjP 12 years ago | |

Just wondering if you could recommend some books or open source code that you'd consider to be a good role model of the kind of code you write. I use libuv in one of my projects and I was using it to better my C skills. I don't get to do C very much in my day job. But I'd like to be exposed to different styles of C so that I might understand why one style is used over another in a given context. Thanks.

jheriko 12 years ago | | |

this is part of the problem. most of it is locked away in proprietary source codes - something i am hoping to fix in the coming months by putting something into the public domain myself. :)

JoachimSchipper 12 years ago | |

Genuine question: why would you want to create a significant numbers of loop contexts? (Your way does sometimes save one pointer dereference, but that's not what you appear to be talking about.)

kyberias 12 years ago |

Is there some introductory text available explaining what is the purpose of libuv, it's intended usage scenarios etc.?

ritchiea 12 years ago | |

It's a C library to handle asynchronous IO. The library it replaced, libev, is essentially a wrapper around select which is a unix system call that looks for file descriptors that are ready for reading or writing (for more info you can use the command 'man select' in bash). My understanding is that select can be nondeterministic so there were predictability and performance improvements to be had by replacing it with a better model. The guide also links to this talk by one of the libuv authors which is a great help in understanding why they wrote libuv: https://www.youtube.com/watch?v=nGn60vDSxQ4

jamwt 12 years ago | | |

This is not quite correct. libev is a wrapper around the best available of select/epoll/kqueue (the same syscalls libuv uses), and it provides nice timers, thread wake (eventfd/pipe), etc.

What it doesn't provide that libuv does is high-level support for asynchronous filesystem I/O, a built-in asynchronous DNS resolver, process management abstractions and more high-level cross platform goodies for writing asynchronous apps. libev also doesn't have very good support on windows.

So, the main improvements provided by libuv are a more extensive high-level API and good windows support. I doubt speed (or deterministic latency or scalability.. etc) was a goal, as libev is very, very fast. Just lower-level.

FooBarWidget 12 years ago | |

libuv is like libev and libevent, but with an async API instead of a level-triggered readiness notification API. It was specifically written for Node.js because libev didn't work for them anymore at some point (e.g. limited usefulness on Windows).

shavenwarthog2 12 years ago | |

high performance I/O library, with Windows support. I'm happy to note it has bindings for a lot of languages, including Python:

https://github.com/joyent/libuv/wiki/Projects-that-use-libuv

I'm very familiar with Twisted, Perl AnyEvent, and Gevent/Greenlet -- libuv seems to be like that.

the1 12 years ago |

http://redis.io/topics/internals-rediseventlib ae is good too.

malkia 12 years ago |

Isn't this example wrong: (I'm not much familiar with libuv, but reading from the comments it might be):

http://nikhilm.github.io/uvbook/filesystem.html

  void on_read(uv_fs_t *req) {
       uv_fs_req_cleanup(req); // <-- bug? freeing here, later using req ptr?
       if (req->result < 0) {
           fprintf(stderr, "Read error: %s\n", uv_strerror(uv_last_error(uv_default_loop())));
       }
       else if (req->result == 0) {
           uv_fs_t close_req;
           // synchronous
           uv_fs_close(uv_default_loop(), &close_req, open_req.result, NULL);
       }
       else {
           uv_fs_write(uv_default_loop(), &write_req, 1, buffer, req->result, -1, on_write);
       }
   }

nsm 12 years ago | |

It's correct. uv_fs_req_cleanup() deletes some private data associated with the uv_fs_t. `result` is part of the public interface and is unaffected.

galapago 12 years ago |

It looks like the BeBook.

nsm 12 years ago | |

Author here.

It's because it uses the Haiku standard theme shipped with the sphinx documentation generator, which does come from the Haiku project :)

void on_read(uv_fs_t *req) { uv_fs_req_cleanup(req); // <-- bug? freeing here, later using req ptr? if (req->result < 0) { fprintf(stderr, "Read error: %s\n", uv_strerror(uv_last_error(uv_default_loop()))); } else if (req->result == 0) { uv_fs_t close_req; // synchronous uv_fs_close(uv_default_loop(), &close_req, open_req.result, NULL); } else { uv_fs_write(uv_default_loop(), &write_req, 1, buffer, req->result, -1, on_write); } }