/*
 * Copyright (C) 2011-2013 Karlsruhe Institute of Technology
 *
 * This file is part of Ufo.
 *
 * This library is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __UFO_BASE_SCHEDULER_H
#define __UFO_BASE_SCHEDULER_H

#if !defined (__UFO_H_INSIDE__) && !defined (UFO_COMPILATION)
#error "Only <ufo/ufo.h> can be included directly."
#endif

#include <ufo/ufo-task-graph.h>

G_BEGIN_DECLS

#define UFO_TYPE_BASE_SCHEDULER             (ufo_base_scheduler_get_type())
#define UFO_BASE_SCHEDULER(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), UFO_TYPE_BASE_SCHEDULER, UfoBaseScheduler))
#define UFO_IS_BASE_SCHEDULER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), UFO_TYPE_BASE_SCHEDULER))
#define UFO_BASE_SCHEDULER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), UFO_TYPE_BASE_SCHEDULER, UfoBaseSchedulerClass))
#define UFO_IS_BASE_SCHEDULER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), UFO_TYPE_BASE_SCHEDULER))
#define UFO_BASE_SCHEDULER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), UFO_TYPE_BASE_SCHEDULER, UfoBaseSchedulerClass))

#define UFO_BASE_SCHEDULER_ERROR            ufo_base_scheduler_error_quark()

typedef struct _UfoBaseScheduler           UfoBaseScheduler;
typedef struct _UfoBaseSchedulerClass      UfoBaseSchedulerClass;
typedef struct _UfoBaseSchedulerPrivate    UfoBaseSchedulerPrivate;

typedef enum {
    UFO_BASE_SCHEDULER_ERROR_SETUP,
    UFO_BASE_SCHEDULER_ERROR_EXECUTION
} UfoBaseSchedulerError;

/**
 * UfoBaseScheduler:
 *
 * The base class scheduler is responsible of assigning command queues to
 * filters (thus managing GPU device resources) and decide if to run a GPU or a
 * CPU. The actual schedule planning can be overriden.
 */
struct _UfoBaseScheduler {
    /*< private >*/
    GObject parent_instance;

    UfoBaseSchedulerPrivate *priv;
};

/**
 * UfoBaseSchedulerClass:
 *
 * #UfoBaseScheduler class
 */
struct _UfoBaseSchedulerClass {
    /*< private >*/
    GObjectClass parent_class;

    void (*run) (UfoBaseScheduler *scheduler, UfoTaskGraph *graph, GError **error);
};

void            ufo_base_scheduler_run              (UfoBaseScheduler   *scheduler,
                                                     UfoTaskGraph       *task_graph,
                                                     GError            **error);
void            ufo_base_scheduler_set_resources    (UfoBaseScheduler   *scheduler,
                                                     UfoResources       *resources);
UfoResources   *ufo_base_scheduler_get_resources    (UfoBaseScheduler   *scheduler,
                                                     GError            **error);
void            ufo_base_scheduler_set_gpu_nodes    (UfoBaseScheduler   *scheduler,
                                                     GList              *gpu_nodes);
GType           ufo_base_scheduler_get_type         (void);
GQuark          ufo_base_scheduler_error_quark      (void);

G_END_DECLS

#endif
