functions.h

/*
 * Copyright 2014-2017 Frank Hunleth
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef FUNCTIONS_H
#define FUNCTIONS_H

#include <stddef.h>
#include <stdbool.h>
#include <sys/types.h>
#include <confuse.h>
#include "uboot_env.h"

enum fun_context_type {
    FUN_CONTEXT_INIT,
    FUN_CONTEXT_FINISH,
    FUN_CONTEXT_ERROR,
    FUN_CONTEXT_FILE
};

#define FUN_MAX_ARGS  (10)
struct archive;
struct fwup_progress;
struct block_cache;

struct fun_context {
    // Context of where the function is called
    enum fun_context_type type;

    // Function name and arguments
    int argc;
    const char *argv[FUN_MAX_ARGS];

    // Root meta.conf configuration
    cfg_t *cfg;

    // Task configuration
    cfg_t *task;

    // Lists of task configurations
    cfg_t *tasks[16];

    // When processing events (on-init, on-resource, on-finish, etc.) this is that configuration
    cfg_t *on_event;

    // Progress reporting
    struct fwup_progress *progress;

    // If the context supplies data, this function gets it. If read returns 0,
    // no more data is available. If <0, then there's an error.
    int (*read)(struct fun_context *fctx, const void **buffer, size_t *len, off_t *offset);

    // Output location (NULL if not opened yet.)
    struct block_cache *output;

    // Delta update processing (NULL if not in use)
    struct xdelta_state *xd;
    off_t xd_source_offset;
    size_t xd_source_count;

    void *cookie;
};

int fun_validate(struct fun_context *fctx);
int fun_compute_progress(struct fun_context *fctx);
int fun_run(struct fun_context *fctx);
int fun_apply_funlist(struct fun_context *fctx, cfg_opt_t *funlist, int (*fun)(struct fun_context *fctx));

#endif // FUNCTIONS_H