Subversion Repositories HelenOS

/*

 * Copyright (c) 2008 Jiri Svoboda

 * 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 name of the author may not be used to endorse or promote products

 *   derived from this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.

 */

/** @addtogroup libc

 * @{

 */

/** @file

 */

#include <ipc/ipc.h>

#include <ipc/loader.h>

#include <ipc/services.h>

#include <libc.h>

#include <task.h>

#include <string.h>

#include <stdlib.h>

#include <async.h>

#include <errno.h>

#include <vfs/vfs.h>

#include <loader/loader.h>

/** Connect to a new program loader.

 *

 * Spawns a new program loader task and returns the connection structure.

 *

 * @param name Symbolic name to set on the newly created task.

 *

 * @return Pointer to the loader connection structure (should be

 *         deallocated using free() after use).

 *

 */

int loader_spawn(const char *name)

{

    return __SYSCALL2(SYS_PROGRAM_SPAWN_LOADER,

        (sysarg_t) name, str_size(name));

}

loader_t *loader_connect(void)

{

    int phone_id = ipc_connect_me_to_blocking(PHONE_NS, SERVICE_LOAD, 0, 0);

    if (phone_id < 0)

        return NULL;

    loader_t *ldr = malloc(sizeof(loader_t));

    if (ldr == NULL)

        return NULL;

    ldr->phone_id = phone_id;

    return ldr;

}

/** Get ID of the new task.

 *

 * Retrieves the ID of the new task from the loader.

 *

 * @param ldr     Loader connection structure.

 * @param task_id Points to a variable where the ID should be stored.

 *

 * @return Zero on success or negative error code.

 *

 */

int loader_get_task_id(loader_t *ldr, task_id_t *task_id)

{

    /* Get task ID. */

    ipc_call_t answer;

    aid_t req = async_send_0(ldr->phone_id, LOADER_GET_TASKID, &answer);

    int rc = ipc_data_read_start(ldr->phone_id, task_id, sizeof(task_id_t));

    if (rc != EOK) {

        async_wait_for(req, NULL);

        return rc;

    }

    ipcarg_t retval;

    async_wait_for(req, &retval);

    return (int) retval;

}

/** Set pathname of the program to load.

 *

 * Sets the name of the program file to load. The name can be relative

 * to the current working directory (it will be absolutized before

 * sending to the loader).

 *

 * @param ldr  Loader connection structure.

 * @param path Pathname of the program file.

 *

 * @return Zero on success or negative error code.

 *

 */

int loader_set_pathname(loader_t *ldr, const char *path)

{

    size_t pa_len;

    char *pa = absolutize(path, &pa_len);

    if (!pa)

        return 0;

    /* Send program pathname */

    ipc_call_t answer;

    aid_t req = async_send_0(ldr->phone_id, LOADER_SET_PATHNAME, &answer);

    int rc = ipc_data_write_start(ldr->phone_id, (void *) pa, pa_len);

    if (rc != EOK) {

        async_wait_for(req, NULL);

        return rc;

    }

    free(pa);

    ipcarg_t retval;

    async_wait_for(req, &retval);

    return (int) retval;

}

/** Set command-line arguments for the program.

 *

 * Sets the vector of command-line arguments to be passed to the loaded

 * program. By convention, the very first argument is typically the same as

 * the command used to execute the program.

 *

 * @param ldr  Loader connection structure.

 * @param argv NULL-terminated array of pointers to arguments.

 *

 * @return Zero on success or negative error code.

 *

 */

int loader_set_args(loader_t *ldr, char *const argv[])

{

    /*

     * Serialize the arguments into a single array. First

     * compute size of the buffer needed.

     */

    char *const *ap = argv;

    size_t buffer_size = 0;

    while (*ap != NULL) {

        buffer_size += str_size(*ap) + 1;

        ap++;

    }

    char *arg_buf = malloc(buffer_size);

    if (arg_buf == NULL)

        return ENOMEM;

    /* Now fill the buffer with null-terminated argument strings */

    ap = argv;

    char *dp = arg_buf;

    while (*ap != NULL) {

        str_cpy(dp, buffer_size - (dp - arg_buf), *ap);

        dp += str_size(*ap) + 1;

        ap++;

    }

    /* Send serialized arguments to the loader */

    ipc_call_t answer;

    aid_t req = async_send_0(ldr->phone_id, LOADER_SET_ARGS, &answer);

    ipcarg_t rc = ipc_data_write_start(ldr->phone_id, (void *) arg_buf, buffer_size);

    if (rc != EOK) {

        async_wait_for(req, NULL);

        return rc;

    }

    async_wait_for(req, &rc);

    if (rc != EOK)

        return rc;

    /* Free temporary buffer */

    free(arg_buf);

    return EOK;

}

/** Set preset files for the program.

 *

 * Sets the vector of preset files to be passed to the loaded

 * program. By convention, the first three files represent stdin,

 * stdout and stderr respectively.

 *

 * @param ldr   Loader connection structure.

 * @param files NULL-terminated array of pointers to files.

 *

 * @return Zero on success or negative error code.

 *

 */

int loader_set_files(loader_t *ldr, fs_node_t *const files[])

{

    /*

     * Serialize the arguments into a single array. First

     * compute size of the buffer needed.

     */

    fs_node_t *const *ap = files;

    size_t count = 0;

    while (*ap != NULL) {

        count++;

        ap++;

    }

    fs_node_t *files_buf = (fs_node_t *) malloc(count * sizeof(fs_node_t));

    if (files_buf == NULL)

        return ENOMEM;

    /* Fill the buffer */

    size_t i;

    for (i = 0; i < count; i++)

        files_buf[i] = *files[i];

    /* Send serialized files to the loader */

    ipc_call_t answer;

    aid_t req = async_send_0(ldr->phone_id, LOADER_SET_FILES, &answer);

    ipcarg_t rc = ipc_data_write_start(ldr->phone_id, (void *) files_buf,

        count * sizeof(fs_node_t));

    if (rc != EOK) {

        async_wait_for(req, NULL);

        return rc;

    }

    async_wait_for(req, &rc);

    if (rc != EOK)

        return rc;

    /* Free temporary buffer */

    free(files_buf);

    return EOK;

}

/** Instruct loader to load the program.

 *

 * If this function succeeds, the program has been successfully loaded

 * and is ready to be executed.

 *

 * @param ldr Loader connection structure.

 *

 * @return Zero on success or negative error code.

 *

 */

int loader_load_program(loader_t *ldr)

{

    return (int) async_req_0_0(ldr->phone_id, LOADER_LOAD);

}

/** Instruct loader to execute the program.

 *

 * Note that this function blocks until the loader actually replies

 * so you cannot expect this function to return if you are debugging

 * the task and its thread is stopped.

 *

 * After using this function, no further operations must be performed

 * on the loader structure. It should be de-allocated using free().

 *

 * @param ldr Loader connection structure.

 *

 * @return Zero on success or negative error code.

 *

 */

int loader_run(loader_t *ldr)

{

    int rc = async_req_0_0(ldr->phone_id, LOADER_RUN);

    if (rc != EOK)

        return rc;

    ipc_hangup(ldr->phone_id);

    ldr->phone_id = 0;

    return EOK;

}

/** Cancel the loader session.

 *

 * Tells the loader not to load any program and terminate.

 * After using this function, no further operations must be performed

 * on the loader structure. It should be de-allocated using free().

 *

 * @param ldr Loader connection structure.

 *

 * @return Zero on success or negative error code.

 *

 */

void loader_abort(loader_t *ldr)

{

    ipc_hangup(ldr->phone_id);

    ldr->phone_id = 0;

}

/** @}

 */