xref: /dports/devel/gearmand/gearmand-1.0.6/libgearman/worker.cc

/*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 *
 *  Gearmand client and server library.
 *
 *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
 *  Copyright (C) 2008 Brian Aker, Eric Day
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *
 *      * Redistributions of source code must retain the above copyright
 *  notice, this list of conditions and the following disclaimer.
 *
 *      * Redistributions in binary form must reproduce the above
 *  copyright notice, this list of conditions and the following disclaimer
 *  in the documentation and/or other materials provided with the
 *  distribution.
 *
 *      * The names of its contributors may not be used to endorse or
 *  promote products derived from this software without specific prior
 *  written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#include "gear_config.h"

#include <libgearman/common.h>
#include <libgearman/function/base.hpp>
#include <libgearman/function/make.hpp>

#include "libgearman/pipe.h"

#include "libgearman/assert.hpp"

#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <memory>
#include <unistd.h>
#include <fcntl.h>
#include <cerrno>

/**
 * @addtogroup gearman_worker_static Static Worker Declarations
 * @ingroup gearman_worker
 * @{
 */

static inline struct _worker_function_st *_function_exist(gearman_worker_st *worker, const char *function_name, size_t function_length)
{
  struct _worker_function_st *function;

  for (function= worker->function_list; function;
       function= function->next)
  {
    if (function_length == function->function_length)
    {
      if (memcmp(function_name, function->function_name, function_length) == 0)
      {
        break;
      }
    }
  }

  return function;
}

/**
 * Allocate a worker structure.
 */
static gearman_worker_st *_worker_allocate(gearman_worker_st *worker, bool is_clone);

/**
 * Initialize common packets for later use.
 */
static gearman_return_t _worker_packet_init(gearman_worker_st *worker);

/**
 * Callback function used when parsing server lists.
 */
static gearman_return_t _worker_add_server(const char *host, in_port_t port, void *context);

/**
 * Allocate and add a function to the register list.
 */
static gearman_return_t _worker_function_create(gearman_worker_st *worker,
                                                const char *function_name, size_t function_length,
                                                const gearman_function_t &function,
                                                uint32_t timeout,
                                                void *context);

/**
 * Free a function.
 */
static void _worker_function_free(gearman_worker_st *worker,
                                  struct _worker_function_st *function);


/** @} */

/*
 * Public Definitions
 */

gearman_worker_st *gearman_worker_create(gearman_worker_st *worker)
{
  worker= _worker_allocate(worker, false);

  if (worker == NULL)
  {
    return NULL;
  }

  if (gearman_failed(_worker_packet_init(worker)))
  {
    gearman_worker_free(worker);
    return NULL;
  }

  return worker;
}

gearman_worker_st *gearman_worker_clone(gearman_worker_st *worker,
                                        const gearman_worker_st *source)
{
  if (source == NULL)
  {
    return _worker_allocate(worker, false);
  }

  worker= _worker_allocate(worker, true);

  if (worker == NULL)
  {
    return worker;
  }

  worker->options.non_blocking= source->options.non_blocking;
  worker->options.change= source->options.change;
  worker->options.grab_uniq= source->options.grab_uniq;
  worker->options.grab_all= source->options.grab_all;
  worker->options.timeout_return= source->options.timeout_return;

  gearman_universal_clone(worker->universal, source->universal, true);

  if (gearman_failed(_worker_packet_init(worker)))
  {
    gearman_worker_free(worker);
    return NULL;
  }

  return worker;
}

void gearman_worker_free(gearman_worker_st *worker)
{
  if (worker == NULL)
  {
    return;
  }

  if (worker->universal.wakeup_fd[0] != INVALID_SOCKET)
  {
    close(worker->universal.wakeup_fd[0]);
  }

  if (worker->universal.wakeup_fd[1] != INVALID_SOCKET)
  {
    close(worker->universal.wakeup_fd[1]);
  }

  gearman_worker_unregister_all(worker);

  if (worker->options.packet_init)
  {
    gearman_packet_free(&worker->grab_job);
    gearman_packet_free(&worker->pre_sleep);
  }

  gearman_job_free(worker->job);
  worker->work_job= NULL;

  if (worker->work_result)
  {
    gearman_free(worker->universal, worker->work_result);
  }

  while (worker->function_list)
  {
    _worker_function_free(worker, worker->function_list);
  }

  gearman_job_free_all(worker);

  gearman_universal_free(worker->universal);

  if (worker->options.allocated)
  {
    delete worker;
  }
}

const char *gearman_worker_error(const gearman_worker_st *worker)
{
  if (worker == NULL)
  {
    return NULL;
  }

  return gearman_universal_error(worker->universal);
}

int gearman_worker_errno(gearman_worker_st *worker)
{
  if (worker == NULL)
  {
    return EINVAL;
  }

  return gearman_universal_errno(worker->universal);
}

gearman_worker_options_t gearman_worker_options(const gearman_worker_st *worker)
{
  if (worker == NULL)
  {
    return gearman_worker_options_t();
  }

  int options;
  memset(&options, 0, sizeof(gearman_worker_options_t));

  if (worker->options.allocated)
    options|= int(GEARMAN_WORKER_ALLOCATED);
  if (worker->options.non_blocking)
    options|= int(GEARMAN_WORKER_NON_BLOCKING);
  if (worker->options.packet_init)
    options|= int(GEARMAN_WORKER_PACKET_INIT);
  if (worker->options.change)
    options|= int(GEARMAN_WORKER_CHANGE);
  if (worker->options.grab_uniq)
    options|= int(GEARMAN_WORKER_GRAB_UNIQ);
  if (worker->options.grab_all)
    options|= int(GEARMAN_WORKER_GRAB_ALL);
  if (worker->options.timeout_return)
    options|= int(GEARMAN_WORKER_TIMEOUT_RETURN);

  return gearman_worker_options_t(options);
}

void gearman_worker_set_options(gearman_worker_st *worker,
                                gearman_worker_options_t options)
{
  if (worker == NULL)
  {
    return;
  }

  gearman_worker_options_t usable_options[]= {
    GEARMAN_WORKER_NON_BLOCKING,
    GEARMAN_WORKER_GRAB_UNIQ,
    GEARMAN_WORKER_GRAB_ALL,
    GEARMAN_WORKER_TIMEOUT_RETURN,
    GEARMAN_WORKER_MAX
  };

  gearman_worker_options_t *ptr;


  for (ptr= usable_options; *ptr != GEARMAN_WORKER_MAX ; ptr++)
  {
    if (options & *ptr)
    {
      gearman_worker_add_options(worker, *ptr);
    }
    else
    {
      gearman_worker_remove_options(worker, *ptr);
    }
  }
}

void gearman_worker_add_options(gearman_worker_st *worker,
                                gearman_worker_options_t options)
{
  if (worker == NULL)
  {
    return;
  }

  if (options & GEARMAN_WORKER_NON_BLOCKING)
  {
    gearman_universal_add_options(worker->universal, GEARMAN_NON_BLOCKING);
    worker->options.non_blocking= true;
  }

  if (options & GEARMAN_WORKER_GRAB_UNIQ)
  {
    worker->grab_job.command= GEARMAN_COMMAND_GRAB_JOB_UNIQ;
    gearman_return_t rc= gearman_packet_pack_header(&(worker->grab_job));
    (void)(rc);
    assert(gearman_success(rc));
    worker->options.grab_uniq= true;
  }

  if (options & GEARMAN_WORKER_GRAB_ALL)
  {
    worker->grab_job.command= GEARMAN_COMMAND_GRAB_JOB_ALL;
    gearman_return_t rc= gearman_packet_pack_header(&(worker->grab_job));
    (void)(rc);
    assert(gearman_success(rc));
    worker->options.grab_all= true;
  }

  if (options & GEARMAN_WORKER_TIMEOUT_RETURN)
  {
    worker->options.timeout_return= true;
  }
}

void gearman_worker_remove_options(gearman_worker_st *worker,
                                   gearman_worker_options_t options)
{
  if (worker)
  {
    if (options & GEARMAN_WORKER_NON_BLOCKING)
    {
      gearman_universal_remove_options(worker->universal, GEARMAN_NON_BLOCKING);
      worker->options.non_blocking= false;
    }

    if (options & GEARMAN_WORKER_TIMEOUT_RETURN)
    {
      worker->options.timeout_return= false;
      gearman_universal_set_timeout(worker->universal, GEARMAN_WORKER_WAIT_TIMEOUT);
    }

    if (options & GEARMAN_WORKER_GRAB_UNIQ)
    {
      worker->grab_job.command= GEARMAN_COMMAND_GRAB_JOB;
      (void)gearman_packet_pack_header(&(worker->grab_job));
      worker->options.grab_uniq= false;
    }

    if (options & GEARMAN_WORKER_GRAB_ALL)
    {
      worker->grab_job.command= GEARMAN_COMMAND_GRAB_JOB;
      (void)gearman_packet_pack_header(&(worker->grab_job));
      worker->options.grab_all= false;
    }
  }
}

int gearman_worker_timeout(gearman_worker_st *worker)
{
  if (worker == NULL)
  {
    return 0;
  }

  return gearman_universal_timeout(worker->universal);
}

void gearman_worker_set_timeout(gearman_worker_st *worker, int timeout)
{
  if (worker)
  {
    gearman_worker_add_options(worker, GEARMAN_WORKER_TIMEOUT_RETURN);
    gearman_universal_set_timeout(worker->universal, timeout);
  }
}

void *gearman_worker_context(const gearman_worker_st *worker)
{
  if (worker)
  {
    return worker->context;
  }

  return NULL;
}

void gearman_worker_set_context(gearman_worker_st *worker, void *context)
{
  if (worker)
  {
    worker->context= context;
  }
}

void gearman_worker_set_log_fn(gearman_worker_st *worker,
                               gearman_log_fn *function, void *context,
                               gearman_verbose_t verbose)
{
  gearman_set_log_fn(worker->universal, function, context, verbose);
}

void gearman_worker_set_workload_malloc_fn(gearman_worker_st *worker,
                                           gearman_malloc_fn *function,
                                           void *context)
{
  if (worker)
  {
    gearman_set_workload_malloc_fn(worker->universal, function, context);
  }
}

void gearman_worker_set_workload_free_fn(gearman_worker_st *worker,
                                         gearman_free_fn *function,
                                         void *context)
{
  if (worker)
  {
    gearman_set_workload_free_fn(worker->universal, function, context);
  }
}

gearman_return_t gearman_worker_add_server(gearman_worker_st *worker,
                                           const char *host, in_port_t port)
{
  if (worker)
  {
    if (gearman_connection_create_args(worker->universal, host, port) == NULL)
    {
      return gearman_universal_error_code(worker->universal);
    }

    return GEARMAN_SUCCESS;
  }

  return GEARMAN_INVALID_ARGUMENT;
}

gearman_return_t gearman_worker_add_servers(gearman_worker_st *worker, const char *servers)
{
  return gearman_parse_servers(servers, _worker_add_server, worker);
}

void gearman_worker_remove_servers(gearman_worker_st *worker)
{
  if (worker)
  {
    gearman_free_all_cons(worker->universal);
  }
}

gearman_return_t gearman_worker_wait(gearman_worker_st *worker)
{
  if (worker)
  {
    return gearman_wait(worker->universal);
  }

  return GEARMAN_INVALID_ARGUMENT;
}

gearman_return_t gearman_worker_register(gearman_worker_st *worker,
                                         const char *function_name,
                                         uint32_t timeout)
{
  gearman_function_t null_func= gearman_function_create_null();
  return _worker_function_create(worker, function_name, strlen(function_name), null_func, timeout, NULL);
}

bool gearman_worker_function_exist(gearman_worker_st *worker,
                                   const char *function_name,
                                   size_t function_length)
{
  if (worker)
  {
    struct _worker_function_st *function;

    function= _function_exist(worker, function_name, function_length);

    return (function && function->options.remove == false) ? true : false;
  }

  return false;
}

static inline gearman_return_t _worker_unregister(gearman_worker_st *worker,
                                                  const char *function_name, size_t function_length)
{
  if (worker)
  {
    _worker_function_st *function= _function_exist(worker, function_name, function_length);

    if (function == NULL || function->options.remove)
    {
      return GEARMAN_NO_REGISTERED_FUNCTION;
    }

    if (function->options.packet_in_use)
    {
      gearman_packet_free(&(function->packet()));
      function->options.packet_in_use= false;
    }

    const void *args[1];
    size_t args_size[1];
    args[0]= function->name();
    args_size[0]= function->length();
    gearman_return_t ret= gearman_packet_create_args(worker->universal, function->packet(),
                                                     GEARMAN_MAGIC_REQUEST, GEARMAN_COMMAND_CANT_DO,
                                                     args, args_size, 1);
    if (gearman_failed(ret))
    {
      function->options.packet_in_use= false;
      return ret;
    }
    function->options.packet_in_use= true;

    function->options.change= true;
    function->options.remove= true;

    worker->options.change= true;

    return GEARMAN_SUCCESS;
  }

  return GEARMAN_INVALID_ARGUMENT;
}

gearman_return_t gearman_worker_unregister(gearman_worker_st *worker,
                                           const char *function_name)
{
  return _worker_unregister(worker, function_name, strlen(function_name));
}

gearman_return_t gearman_worker_unregister_all(gearman_worker_st *worker)
{
  if (worker)
  {
    struct _worker_function_st *function;
    uint32_t count= 0;

    if (worker->function_list == NULL)
    {
      return GEARMAN_NO_REGISTERED_FUNCTIONS;
    }

    /* Lets find out if we have any functions left that are valid */
    for (function= worker->function_list; function;
         function= function->next)
    {
      if (function->options.remove == false)
      {
        count++;
      }
    }

    if (count == 0)
    {
      return GEARMAN_NO_REGISTERED_FUNCTIONS;
    }

    gearman_packet_free(&(worker->function_list->packet()));

    gearman_return_t ret= gearman_packet_create_args(worker->universal,
                                                     worker->function_list->packet(),
                                                     GEARMAN_MAGIC_REQUEST,
                                                     GEARMAN_COMMAND_RESET_ABILITIES,
                                                     NULL, NULL, 0);
    if (gearman_failed(ret))
    {
      worker->function_list->options.packet_in_use= false;

      return ret;
    }

    while (worker->function_list->next)
    {
      _worker_function_free(worker, worker->function_list->next);
    }

    worker->function_list->options.change= true;
    worker->function_list->options.remove= true;

    worker->options.change= true;

    return GEARMAN_SUCCESS;
  }

  return GEARMAN_INVALID_ARGUMENT;
}

gearman_job_st *gearman_worker_grab_job(gearman_worker_st *worker,
                                        gearman_job_st *job,
                                        gearman_return_t *ret_ptr)
{
  if (worker)
  {
    struct _worker_function_st *function;
    uint32_t active;

    gearman_return_t unused;
    if (not ret_ptr)
    {
      ret_ptr= &unused;
    }

    while (1)
    {
      switch (worker->state)
      {
      case GEARMAN_WORKER_STATE_START:
        /* If there are any new functions changes, send them now. */
        if (worker->options.change)
        {
          worker->function= worker->function_list;
          while (worker->function)
          {
            if (not (worker->function->options.change))
            {
              worker->function= worker->function->next;
              continue;
            }

            for (worker->con= (&worker->universal)->con_list; worker->con;
                 worker->con= worker->con->next)
            {
              if (worker->con->fd == -1)
              {
                continue;
              }

            case GEARMAN_WORKER_STATE_FUNCTION_SEND:
              *ret_ptr= worker->con->send_packet(worker->function->packet(), true);
              if (gearman_failed(*ret_ptr))
              {
                if (*ret_ptr == GEARMAN_IO_WAIT)
                {
                  worker->state= GEARMAN_WORKER_STATE_FUNCTION_SEND;
                }
                else if (*ret_ptr == GEARMAN_LOST_CONNECTION)
                {
                  continue;
                }

                return NULL;
              }
            }

            if (worker->function->options.remove)
            {
              function= worker->function->prev;
              _worker_function_free(worker, worker->function);
              if (function == NULL)
                worker->function= worker->function_list;
              else
                worker->function= function;
            }
            else
            {
              worker->function->options.change= false;
              worker->function= worker->function->next;
            }
          }

          worker->options.change= false;
        }

        if (not worker->function_list)
        {
          gearman_error(worker->universal, GEARMAN_NO_REGISTERED_FUNCTIONS, "no functions have been registered");
          *ret_ptr= GEARMAN_NO_REGISTERED_FUNCTIONS;
          return NULL;
        }

        for (worker->con= (&worker->universal)->con_list; worker->con;
             worker->con= worker->con->next)
        {
          /* If the connection to the job server is not active, start it. */
          if (worker->con->fd == -1)
          {
            for (worker->function= worker->function_list;
                 worker->function;
                 worker->function= worker->function->next)
            {
            case GEARMAN_WORKER_STATE_CONNECT:
              *ret_ptr= worker->con->send_packet(worker->function->packet(), true);
              if (gearman_failed(*ret_ptr))
              {
                if (*ret_ptr == GEARMAN_IO_WAIT)
                {
                  worker->state= GEARMAN_WORKER_STATE_CONNECT;
                }
                else if (*ret_ptr == GEARMAN_COULD_NOT_CONNECT or *ret_ptr == GEARMAN_LOST_CONNECTION)
                {
                  break;
                }

                return NULL;
              }
            }

            if (*ret_ptr == GEARMAN_COULD_NOT_CONNECT)
            {
              continue;
            }
          }

        case GEARMAN_WORKER_STATE_GRAB_JOB_SEND:
          if (worker->con->fd == -1)
            continue;

          *ret_ptr= worker->con->send_packet(worker->grab_job, true);
          if (gearman_failed(*ret_ptr))
          {
            if (*ret_ptr == GEARMAN_IO_WAIT)
            {
              worker->state= GEARMAN_WORKER_STATE_GRAB_JOB_SEND;
            }
            else if (*ret_ptr == GEARMAN_LOST_CONNECTION)
            {
              continue;
            }

            return NULL;
          }

          if (not worker->job)
          {
            worker->job= gearman_job_create(worker, job);
            if (not worker->job)
            {
              *ret_ptr= GEARMAN_MEMORY_ALLOCATION_FAILURE;
              return NULL;
            }
          }

          while (1)
          {
          case GEARMAN_WORKER_STATE_GRAB_JOB_RECV:
            assert(worker->job);
            (void)worker->con->receiving(worker->job->assigned, *ret_ptr, true);

            if (gearman_failed(*ret_ptr))
            {
              if (*ret_ptr == GEARMAN_IO_WAIT)
              {
                worker->state= GEARMAN_WORKER_STATE_GRAB_JOB_RECV;
              }
              else
              {
                gearman_job_free(worker->job);
                worker->job= NULL;

                if (*ret_ptr == GEARMAN_LOST_CONNECTION)
                {
                  break;
                }
              }

              return NULL;
            }

            if (worker->job->assigned.command == GEARMAN_COMMAND_JOB_ASSIGN or
                worker->job->assigned.command == GEARMAN_COMMAND_JOB_ASSIGN_ALL or
                worker->job->assigned.command == GEARMAN_COMMAND_JOB_ASSIGN_UNIQ)
            {
              worker->job->options.assigned_in_use= true;
              worker->job->con= worker->con;
              worker->state= GEARMAN_WORKER_STATE_GRAB_JOB_SEND;
              job= worker->job;
              worker->job= NULL;

              return job;
            }

            if (worker->job->assigned.command == GEARMAN_COMMAND_NO_JOB or
                worker->job->assigned.command == GEARMAN_COMMAND_OPTION_RES)
            {
              gearman_packet_free(&(worker->job->assigned));
              break;
            }

            if (worker->job->assigned.command != GEARMAN_COMMAND_NOOP)
            {
              gearman_universal_set_error(worker->universal, GEARMAN_UNEXPECTED_PACKET, GEARMAN_AT,
                                          "unexpected packet:%s",
                                          gearman_command_info(worker->job->assigned.command)->name);
              gearman_packet_free(&(worker->job->assigned));
              gearman_job_free(worker->job);
              worker->job= NULL;
              *ret_ptr= GEARMAN_UNEXPECTED_PACKET;
              return NULL;
            }

            gearman_packet_free(&(worker->job->assigned));
          }
        }

      case GEARMAN_WORKER_STATE_PRE_SLEEP:
        for (worker->con= (&worker->universal)->con_list; worker->con;
             worker->con= worker->con->next)
        {
          if (worker->con->fd == INVALID_SOCKET)
          {
            continue;
          }

          *ret_ptr= worker->con->send_packet(worker->pre_sleep, true);
          if (gearman_failed(*ret_ptr))
          {
            if (*ret_ptr == GEARMAN_IO_WAIT)
            {
              worker->state= GEARMAN_WORKER_STATE_PRE_SLEEP;
            }
            else if (*ret_ptr == GEARMAN_LOST_CONNECTION)
            {
              continue;
            }

            return NULL;
          }
        }

        worker->state= GEARMAN_WORKER_STATE_START;

        /* Set a watch on all active connections that we sent a PRE_SLEEP to. */
        active= 0;
        for (worker->con= worker->universal.con_list; worker->con; worker->con= worker->con->next)
        {
          if (worker->con->fd == INVALID_SOCKET)
          {
            continue;
          }

          worker->con->set_events(POLLIN);
          active++;
        }

        if ((&worker->universal)->options.non_blocking)
        {
          *ret_ptr= GEARMAN_NO_JOBS;
          return NULL;
        }

        if (active == 0)
        {
          if (worker->universal.timeout < 0)
          {
            gearman_nap(GEARMAN_WORKER_WAIT_TIMEOUT);
          }
          else
          {
            if (worker->universal.timeout > 0)
            {
              gearman_nap(worker->universal);
            }

            if (worker->options.timeout_return)
            {
              *ret_ptr= gearman_error(worker->universal, GEARMAN_TIMEOUT, "Option timeout return reached");

              return NULL;
            }
          }
        }
        else
        {
          *ret_ptr= gearman_wait(worker->universal);
          if (gearman_failed(*ret_ptr) and (*ret_ptr != GEARMAN_TIMEOUT or worker->options.timeout_return))
          {
            return NULL;
          }
        }

        break;
      }
    }
  }

  return NULL;
}

void gearman_job_free_all(gearman_worker_st *worker)
{
  if (worker)
  {
    while (worker->job_list)
    {
      gearman_job_free(worker->job_list);
    }
  }
}

gearman_return_t gearman_worker_add_function(gearman_worker_st *worker,
                                             const char *function_name,
                                             uint32_t timeout,
                                             gearman_worker_fn *worker_fn,
                                             void *context)
{
  if (worker)
  {
    if (function_name == NULL)
    {
      return gearman_error(worker->universal, GEARMAN_INVALID_ARGUMENT, "function name not given");
    }

    if (worker_fn == NULL)
    {
      return gearman_error(worker->universal, GEARMAN_INVALID_ARGUMENT, "function not given");
    }
    gearman_function_t local= gearman_function_create_v1(worker_fn);

    return _worker_function_create(worker,
                                   function_name, strlen(function_name),
                                   local,
                                   timeout,
                                   context);
  }

  return GEARMAN_INVALID_ARGUMENT;
}

gearman_return_t gearman_worker_define_function(gearman_worker_st *worker,
                                                const char *function_name, const size_t function_name_length,
                                                const gearman_function_t function,
                                                const uint32_t timeout,
                                                void *context)
{
  if (worker)
  {
    if (function_name == NULL or function_name_length == 0)
    {
      return gearman_error(worker->universal, GEARMAN_INVALID_ARGUMENT, "function name not given");
    }

    return _worker_function_create(worker,
                                   function_name, function_name_length,
                                   function,
                                   timeout,
                                   context);
  }

  return GEARMAN_INVALID_ARGUMENT;
}

void gearman_worker_reset_error(gearman_worker_st *worker)
{
  if (worker)
  {
    universal_reset_error(worker->universal);
  }
}

gearman_return_t gearman_worker_work(gearman_worker_st *worker)
{
  bool shutdown= false;

  if (worker)
  {
    universal_reset_error(worker->universal);

    switch (worker->work_state)
    {
    case GEARMAN_WORKER_WORK_UNIVERSAL_GRAB_JOB:
      {
        gearman_return_t ret;
        worker->work_job= gearman_worker_grab_job(worker, NULL, &ret);

        if (gearman_failed(ret))
        {
          if (ret == GEARMAN_COULD_NOT_CONNECT)
          {
            gearman_reset(worker->universal);
          }
          return ret;
        }
        assert(worker->work_job);

        for (worker->work_function= worker->function_list;
             worker->work_function;
             worker->work_function= worker->work_function->next)
        {
          if (not strcmp(gearman_job_function_name(worker->work_job),
                         worker->work_function->function_name))
          {
            break;
          }
        }

        if (not worker->work_function)
        {
          gearman_job_free(worker->work_job);
          worker->work_job= NULL;
          return gearman_error(worker->universal, GEARMAN_INVALID_FUNCTION_NAME, "Function not found");
        }

        if (not worker->work_function->has_callback())
        {
          gearman_job_free(worker->work_job);
          worker->work_job= NULL;
          return gearman_error(worker->universal, GEARMAN_INVALID_FUNCTION_NAME, "Neither a gearman_worker_fn, or gearman_function_fn callback was supplied");
        }

        worker->work_result_size= 0;
      }

    case GEARMAN_WORKER_WORK_UNIVERSAL_FUNCTION:
      {
        switch (worker->work_function->callback(worker->work_job,
                                                static_cast<void *>(worker->work_function->context)))
        {
        case GEARMAN_FUNCTION_INVALID_ARGUMENT:
          worker->work_job->error_code= gearman_error(worker->universal, GEARMAN_INVALID_ARGUMENT, "worker returned an invalid response, gearman_return_t");
        case GEARMAN_FUNCTION_FATAL:
          if (gearman_job_send_fail_fin(worker->work_job) == GEARMAN_LOST_CONNECTION) // If we fail this, we have no connection, @note this causes us to lose the current error
          {
            worker->work_job->error_code= GEARMAN_LOST_CONNECTION;
            break;
          }
          worker->work_state= GEARMAN_WORKER_WORK_UNIVERSAL_FAIL;
          return worker->work_job->error_code;

        case GEARMAN_FUNCTION_ERROR: // retry
          gearman_reset(worker->universal);
          worker->work_job->error_code= GEARMAN_LOST_CONNECTION;
          break;

        case GEARMAN_FUNCTION_SHUTDOWN:
          shutdown= true;

        case GEARMAN_FUNCTION_SUCCESS:
          break;
        }

        if (worker->work_job->error_code == GEARMAN_LOST_CONNECTION)
        {
          break;
        }
      }

    case GEARMAN_WORKER_WORK_UNIVERSAL_COMPLETE:
      {
        worker->work_job->error_code= gearman_job_send_complete_fin(worker->work_job,
                                                                    worker->work_result, worker->work_result_size);
        if (worker->work_job->error_code == GEARMAN_IO_WAIT)
        {
          worker->work_state= GEARMAN_WORKER_WORK_UNIVERSAL_COMPLETE;
          return gearman_error(worker->universal, worker->work_job->error_code,
                               "A failure occurred after worker had successful complete, unless gearman_job_send_complete() was called directly by worker, client has not been informed of success.");
        }

        if (worker->work_result)
        {
          gearman_free(worker->universal, worker->work_result);
          worker->work_result= NULL;
        }

        // If we lost the connection, we retry the work, otherwise we error
        if (worker->work_job->error_code == GEARMAN_LOST_CONNECTION)
        {
          break;
        }
        else if (worker->work_job->error_code == GEARMAN_SHUTDOWN)
        { }
        else if (gearman_failed(worker->work_job->error_code))
        {
          worker->work_state= GEARMAN_WORKER_WORK_UNIVERSAL_FAIL;

          return worker->work_job->error_code;
        }
      }
      break;

    case GEARMAN_WORKER_WORK_UNIVERSAL_FAIL:
      {
        if (gearman_failed(worker->work_job->error_code= gearman_job_send_fail_fin(worker->work_job)))
        {
          if (worker->work_job->error_code == GEARMAN_LOST_CONNECTION)
          {
            break;
          }

          return worker->work_job->error_code;
        }
      }
      break;
    }

    gearman_job_free(worker->work_job);
    worker->work_job= NULL;

    worker->work_state= GEARMAN_WORKER_WORK_UNIVERSAL_GRAB_JOB;

    if (shutdown)
    {
      return GEARMAN_SHUTDOWN;
    }

    return GEARMAN_SUCCESS;
  }

  return GEARMAN_INVALID_ARGUMENT;
}

gearman_return_t gearman_worker_echo(gearman_worker_st *worker,
                                     const void *workload,
                                     size_t workload_size)
{
  if (worker)
  {
    return gearman_echo(worker->universal, workload, workload_size);
  }

  return GEARMAN_INVALID_ARGUMENT;
}

/*
 * Static Definitions
 */

static gearman_worker_st *_worker_allocate(gearman_worker_st *worker, bool is_clone)
{
  if (worker)
  {
    worker->options.allocated= false;
  }
  else
  {
    worker= new (std::nothrow) gearman_worker_st;
    if (worker == NULL)
    {
      return NULL;
    }

    worker->options.allocated= true;
  }

  worker->options.non_blocking= false;
  worker->options.packet_init= false;
  worker->options.change= false;
  worker->options.grab_uniq= true;
  worker->options.grab_all= true;
  worker->options.timeout_return= false;

  worker->state= GEARMAN_WORKER_STATE_START;
  worker->work_state= GEARMAN_WORKER_WORK_UNIVERSAL_GRAB_JOB;
  worker->function_count= 0;
  worker->job_count= 0;
  worker->work_result_size= 0;
  worker->context= NULL;
  worker->con= NULL;
  worker->job= NULL;
  worker->job_list= NULL;
  worker->function= NULL;
  worker->function_list= NULL;
  worker->work_function= NULL;
  worker->work_result= NULL;

  if (is_clone == false)
  {
    gearman_universal_initialize(worker->universal);
#if 0
    gearman_universal_set_timeout(worker->universal, GEARMAN_WORKER_WAIT_TIMEOUT);
#endif
  }

  if (setup_shutdown_pipe(worker->universal.wakeup_fd) == false)
  {
    if (worker->options.allocated)
    {
      delete worker;
    }

    return NULL;
  }

  return worker;
}

static gearman_return_t _worker_packet_init(gearman_worker_st *worker)
{
  gearman_return_t ret= gearman_packet_create_args(worker->universal, worker->grab_job,
                                                   GEARMAN_MAGIC_REQUEST, GEARMAN_COMMAND_GRAB_JOB_ALL,
                                                   NULL, NULL, 0);
  if (gearman_failed(ret))
  {
    return ret;
  }

  ret= gearman_packet_create_args(worker->universal, worker->pre_sleep,
                                  GEARMAN_MAGIC_REQUEST, GEARMAN_COMMAND_PRE_SLEEP,
                                  NULL, NULL, 0);
  if (gearman_failed(ret))
  {
    gearman_packet_free(&(worker->grab_job));
    return ret;
  }

  worker->options.packet_init= true;

  return GEARMAN_SUCCESS;
}

static gearman_return_t _worker_add_server(const char *host, in_port_t port, void *context)
{
  return gearman_worker_add_server(static_cast<gearman_worker_st *>(context), host, port);
}

static gearman_return_t _worker_function_create(gearman_worker_st *worker,
                                                const char *function_name, size_t function_length,
                                                const gearman_function_t &function_arg,
                                                uint32_t timeout,
                                                void *context)
{
  const void *args[2];
  size_t args_size[2];

  if (worker == NULL)
  {
    return GEARMAN_INVALID_ARGUMENT;
  }

  if (function_length == 0 or function_name == NULL or function_length > GEARMAN_FUNCTION_MAX_SIZE)
  {
    if (function_length > GEARMAN_FUNCTION_MAX_SIZE)
    {
      gearman_error(worker->universal, GEARMAN_INVALID_ARGUMENT, "function name longer then GEARMAN_MAX_FUNCTION_SIZE");
    }
    else
    {
      gearman_error(worker->universal, GEARMAN_INVALID_ARGUMENT, "invalid function");
    }

    return GEARMAN_INVALID_ARGUMENT;
  }

  _worker_function_st *function= make(worker->universal._namespace, function_name, function_length, function_arg, context);
  if (function == NULL)
  {
    gearman_perror(worker->universal, "_worker_function_st::new()");
    return GEARMAN_MEMORY_ALLOCATION_FAILURE;
  }

  gearman_return_t ret;
  if (timeout > 0)
  {
    char timeout_buffer[11];
    snprintf(timeout_buffer, sizeof(timeout_buffer), "%u", timeout);
    args[0]= function->name();
    args_size[0]= function->length() + 1;
    args[1]= timeout_buffer;
    args_size[1]= strlen(timeout_buffer);
    ret= gearman_packet_create_args(worker->universal, function->packet(),
                                    GEARMAN_MAGIC_REQUEST,
                                    GEARMAN_COMMAND_CAN_DO_TIMEOUT,
                                    args, args_size, 2);
  }
  else
  {
    args[0]= function->name();
    args_size[0]= function->length();
    ret= gearman_packet_create_args(worker->universal, function->packet(),
                                    GEARMAN_MAGIC_REQUEST, GEARMAN_COMMAND_CAN_DO,
                                    args, args_size, 1);
  }

  if (gearman_failed(ret))
  {
    delete function;

    return ret;
  }

  if (worker->function_list)
  {
    worker->function_list->prev= function;
  }

  function->next= worker->function_list;
  function->prev= NULL;
  worker->function_list= function;
  worker->function_count++;

  worker->options.change= true;

  return GEARMAN_SUCCESS;
}

static void _worker_function_free(gearman_worker_st *worker,
                                  struct _worker_function_st *function)
{
  if (worker->function_list == function)
  {
    worker->function_list= function->next;
  }

  if (function->prev)
  {
    function->prev->next= function->next;
  }

  if (function->next)
  {
    function->next->prev= function->prev;
  }
  worker->function_count--;

  delete function;
}

gearman_return_t gearman_worker_set_memory_allocators(gearman_worker_st *worker,
                                                      gearman_malloc_fn *malloc_fn,
                                                      gearman_free_fn *free_fn,
                                                      gearman_realloc_fn *realloc_fn,
                                                      gearman_calloc_fn *calloc_fn,
                                                      void *context)
{
  if (worker == NULL)
  {
    return GEARMAN_INVALID_ARGUMENT;
  }

  return gearman_set_memory_allocator(worker->universal.allocator, malloc_fn, free_fn, realloc_fn, calloc_fn, context);
}

bool gearman_worker_set_server_option(gearman_worker_st *self, const char *option_arg, size_t option_arg_size)
{
  gearman_string_t option= { option_arg, option_arg_size };

  return gearman_request_option(self->universal, option);
}

void gearman_worker_set_namespace(gearman_worker_st *self, const char *namespace_key, size_t namespace_key_size)
{
  if (self)
  {
    gearman_universal_set_namespace(self->universal, namespace_key, namespace_key_size);
  }
}

gearman_id_t gearman_worker_id(gearman_worker_st *self)
{
  if (self == NULL)
  {
    gearman_id_t handle= { INVALID_SOCKET, INVALID_SOCKET };
    return handle;
  }

  return gearman_universal_id(self->universal);
}

gearman_worker_st *gearman_job_clone_worker(gearman_job_st *job)
{
  if (job)
  {
    return gearman_worker_clone(NULL, job->worker);
  }

  return NULL;
}

gearman_return_t gearman_worker_set_identifier(gearman_worker_st *worker,
                                               const char *id, size_t id_size)
{
  if (worker)
  {
    return gearman_set_identifier(worker->universal, id, id_size);
  }

  return GEARMAN_INVALID_ARGUMENT;
}

const char *gearman_worker_namespace(gearman_worker_st *self)
{
  return gearman_univeral_namespace(self->universal);
}