mt_inotify.cc

Go to the documentation of this file.

/*MT*
    
    MediaTomb - http://www.mediatomb.cc/
    
    mt_inotify.cc - this file is part of MediaTomb.
    
    Copyright (C) 2005 Gena Batyan <bgeradz@mediatomb.cc>,
                       Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>
    
    Copyright (C) 2006-2010 Gena Batyan <bgeradz@mediatomb.cc>,
                            Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>,
                            Leonhard Wimmer <leo@mediatomb.cc>
    
    MediaTomb is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2
    as published by the Free Software Foundation.
    
    MediaTomb is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    version 2 along with MediaTomb; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
    
    $Id: mt_inotify.cc 2081 2010-03-23 20:18:00Z lww $
*/

/*
    The original version of the next_events function was taken from the 
    inotify-tools package, http://inotify-tools.sf.net/
    The original author is Rohan McGovern  <rohan@mcgovern.id.au>
    inotify tools are licensed under GNU GPL Version 2
*/


#ifdef HAVE_CONFIG_H
    #include "autoconfig.h"
#endif

#ifdef HAVE_INOTIFY

#include <sys/ioctl.h>
#include <unistd.h>
#include <errno.h>
#include <assert.h>

#ifdef HAVE_SYS_UTSNAME_H
    #include <sys/utsname.h>
#endif

#include "mt_inotify.h"
#include "tools.h"

#define MAX_EVENTS 4096
#define MAX_STRLEN 4096

using namespace zmm;

Inotify::Inotify()
{
    inotify_fd = inotify_init();
    if (inotify_fd < 0)
        throw _Exception(_("Unable to initialize inotify!\n"));

    if (pipe(stop_fds_pipe) < 0)
        throw _Exception(_("Unable to create pipe!\n")); 

    stop_fd_read = stop_fds_pipe[0];
    stop_fd_write = stop_fds_pipe[1];
}

Inotify::~Inotify()
{
    if (inotify_fd >= 0)
        close(inotify_fd);
}

bool Inotify::supported()
{
#if defined(HAVE_UNAME) && defined(HAVE_SYS_UTSNAME_H)
    struct utsname info;

    if (uname(&info) == 0)
    {
        // 2.6.13 is the first kernel version that has inotify support
        Ref<Array<StringBase> > kversion = split_string(_(info.release), '.');
        if (kversion->size() >= 3)
        {
            int major = _(kversion->get(0)->data).toInt();
            int minor = _(kversion->get(1)->data).toInt();
            int patch = _(kversion->get(2)->data).toInt();

            if ((major < 2) && (minor < 6) && (patch < 13))
                return false;
        }
    }
#endif   
    int test_fd = inotify_init();
    if (test_fd < 0)
        return false;
    else
    {
        close(test_fd);
        return true;
    }
}

int Inotify::addWatch(String path, int events)
{
    int wd = inotify_add_watch(inotify_fd, path.c_str(), events);
    if (wd < 0 && errno != ENOENT)
    {
        if (errno == ENOSPC)
            throw _Exception(_("The user limit on the total number of inotify watches was reached or the kernel failed to allocate a needed resource."));
        else if (errno == EACCES)
        {
            log_warning("Cannot add inotify watch for %s: %s\n", path.c_str(), strerror(errno));
            return -1;
        }
        else
            throw _Exception(mt_strerror(errno));
    }
    return wd;
}

void Inotify::removeWatch(int wd)
{
    if (inotify_rm_watch(inotify_fd, wd) < 0)
    {
        log_debug("Error removing watch: %s\n", strerror(errno));
    }
}

struct inotify_event *Inotify::nextEvent()
{
    static struct inotify_event event[MAX_EVENTS];
    static struct inotify_event * ret;
    static int first_byte = 0;
    static ssize_t bytes; 

    int fd_max;

    // first_byte is index into event buffer
    if ( first_byte != 0
            && first_byte <= (int)(bytes - sizeof(struct inotify_event)) ) {

        ret = (struct inotify_event *)((char *)&event[0] + first_byte);
        first_byte += sizeof(struct inotify_event) + ret->len;

        // if the pointer to the next event exactly hits end of bytes read,
        // that's good.  next time we're called, we'll read.
        if ( first_byte == bytes ) {
            first_byte = 0;
        }
        else if ( first_byte > bytes ) {
            // oh... no.  this can't be happening.  An incomplete event.
            // Copy what we currently have into first element, call self to
            // read remainder.
            // oh, and they BETTER NOT overlap.
            // Boy I hope this code works.
            // But I think this can never happen due to how inotify is written.
            assert( (long)((char *)&event[0] +
                        sizeof(struct inotify_event) +
                        event[0].len) <= (long)ret);

            // how much of the event do we have?
            bytes = (char *)&event[0] + bytes - (char *)ret;
            memcpy( &event[0], ret, bytes );
            return nextEvent();
        }
        return ret;

    }

    else if ( first_byte == 0 ) {
        bytes = 0;
    }

    static ssize_t this_bytes;
    static unsigned int bytes_to_read;
    static int rc;
    static fd_set read_fds;

    FD_ZERO(&read_fds);
 
    FD_SET(inotify_fd, &read_fds);

    fd_max = inotify_fd;

    FD_SET(stop_fd_read, &read_fds);

    if (stop_fd_read >fd_max)
        fd_max = stop_fd_read;

    rc = select(fd_max + 1, &read_fds,
            NULL, NULL, NULL);
    if ( rc < 0 ) {
        return NULL;
    }
    else if ( rc == 0 ) {
        // timeout
        return NULL;
    }

    if (FD_ISSET(stop_fd_read, &read_fds))
    {
        char buf;
        read(stop_fd_read, &buf, 1);
    }

    if (FD_ISSET(inotify_fd, &read_fds))
    {

        // wait until we have enough bytes to read
        do {
            rc = ioctl( inotify_fd, FIONREAD, &bytes_to_read );
        } while ( !rc &&
                bytes_to_read < sizeof(struct inotify_event));

        if ( rc == -1 ) {
            return NULL;
        }

        this_bytes = read(inotify_fd, &event[0] + bytes,
                sizeof(struct inotify_event)*MAX_EVENTS - bytes);
        if ( this_bytes < 0 ) {
            return NULL;
        }
        if ( this_bytes == 0 ) {
            log_error("Inotify reported end-of-file.  Possibly too many "
                    "events occurred at once.\n");
            return NULL;
        }
        bytes += this_bytes;

        ret = &event[0];
        first_byte = sizeof(struct inotify_event) + ret->len;
        assert( first_byte <= bytes);

        if ( first_byte == bytes ) {
            first_byte = 0;
        }
        
        return ret;
    }

    return NULL;
}


void Inotify::stop()
{
    char stop = 's';
    write(stop_fd_write, &stop, 1);
}

#endif//HAVE_INOTIFY

---