source: mainline/uspace/lib/c/generic/net/packet.c@ 16ac756

/*
 * Copyright (c) 2009 Lukas Mejdrech
 * 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
 *  Packet map and queue implementation.
 *  This file has to be compiled with both the packet server and the client.
 */

#include <malloc.h>
#include <mem.h>
#include <fibril_synch.h>
#include <unistd.h>
#include <errno.h>

#include <sys/mman.h>

#include <adt/generic_field.h>
#include <net/packet.h>
#include <net/packet_header.h>

/** Packet map page size. */
#define PACKET_MAP_SIZE 100

/** Returns the packet map page index.
 * @param[in] packet_id The packet identifier.
 */
#define PACKET_MAP_PAGE(packet_id)      (((packet_id) - 1) / PACKET_MAP_SIZE)

/** Returns the packet index in the corresponding packet map page.
 *  @param[in] packet_id The packet identifier.
 */
#define PACKET_MAP_INDEX(packet_id)     (((packet_id) - 1) % PACKET_MAP_SIZE)

/** Type definition of the packet map page. */
typedef packet_t packet_map_t[PACKET_MAP_SIZE];

/** Type definition of the packet map page pointer. */
typedef packet_map_t * packet_map_ref;

/** Packet map.
 * Maps packet identifiers to the packet references.
 * @see generic_field.h
 */
GENERIC_FIELD_DECLARE(gpm, packet_map_t);

/** Packet map global data. */
static struct {
        /** Safety lock. */
        fibril_rwlock_t lock;
        /** Packet map. */
        gpm_t packet_map;
} pm_globals;

GENERIC_FIELD_IMPLEMENT(gpm, packet_map_t);

/** Initializes the packet map.
 *
 * @returns             EOK on success.
 * @returns             ENOMEM if there is not enough memory left.
 */
int pm_init(void)
{
        int rc;

        fibril_rwlock_initialize(&pm_globals.lock);
        
        fibril_rwlock_write_lock(&pm_globals.lock);
        rc = gpm_initialize(&pm_globals.packet_map);
        fibril_rwlock_write_unlock(&pm_globals.lock);
        
        return rc;
}

/** Finds the packet mapping.
 *
 * @param[in] packet_id The packet identifier to be found.
 * @returns             The found packet reference.
 * @returns             NULL if the mapping does not exist.
 */
packet_t pm_find(packet_id_t packet_id)
{
        packet_map_ref map;
        packet_t packet;

        if (!packet_id)
                return NULL;

        fibril_rwlock_read_lock(&pm_globals.lock);
        if (packet_id > PACKET_MAP_SIZE * gpm_count(&pm_globals.packet_map)) {
                fibril_rwlock_read_unlock(&pm_globals.lock);
                return NULL;
        }
        map = gpm_get_index(&pm_globals.packet_map, PACKET_MAP_PAGE(packet_id));
        if (!map) {
                fibril_rwlock_read_unlock(&pm_globals.lock);
                return NULL;
        }
        packet = (*map) [PACKET_MAP_INDEX(packet_id)];
        fibril_rwlock_read_unlock(&pm_globals.lock);
        return packet;
}

/** Adds the packet mapping.
 *
 * @param[in] packet    The packet to be remembered.
 * @returns             EOK on success.
 * @returns             EINVAL if the packet is not valid.
 * @returns             EINVAL if the packet map is not initialized.
 * @returns             ENOMEM if there is not enough memory left.
 */
int pm_add(packet_t packet)
{
        packet_map_ref map;
        int rc;

        if (!packet_is_valid(packet))
                return EINVAL;

        fibril_rwlock_write_lock(&pm_globals.lock);

        if (PACKET_MAP_PAGE(packet->packet_id) <
            gpm_count(&pm_globals.packet_map)) {
                map = gpm_get_index(&pm_globals.packet_map,
                    PACKET_MAP_PAGE(packet->packet_id));
        } else {
                do {
                        map = (packet_map_ref) malloc(sizeof(packet_map_t));
                        if (!map) {
                                fibril_rwlock_write_unlock(&pm_globals.lock);
                                return ENOMEM;
                        }
                        bzero(map, sizeof(packet_map_t));
                        rc = gpm_add(&pm_globals.packet_map, map);
                        if (rc < 0) {
                                fibril_rwlock_write_unlock(&pm_globals.lock);
                                free(map);
                                return rc;
                        }
                } while (PACKET_MAP_PAGE(packet->packet_id) >=
                    gpm_count(&pm_globals.packet_map));
        }

        (*map) [PACKET_MAP_INDEX(packet->packet_id)] = packet;
        fibril_rwlock_write_unlock(&pm_globals.lock);
        return EOK;
}

/** Releases the packet map. */
void pm_destroy(void)
{
        int count;
        int index;
        packet_map_ref map;
        packet_t packet;

        fibril_rwlock_write_lock(&pm_globals.lock);
        count = gpm_count(&pm_globals.packet_map);
        while (count > 0) {
                map = gpm_get_index(&pm_globals.packet_map, count - 1);
                for (index = PACKET_MAP_SIZE - 1; index >= 0; --index) {
                        packet = (*map)[index];
                        if (packet_is_valid(packet))
                                munmap(packet, packet->length);
                }
        }
        gpm_destroy(&pm_globals.packet_map);
        // leave locked
}

/** Add packet to the sorted queue.
 *
 * The queue is sorted in the ascending order.
 * The packet is inserted right before the packets of the same order value.
 *
 * @param[in,out] first The first packet of the queue. Sets the first packet of
 *                      the queue. The original first packet may be shifted by
 *                      the new packet.
 * @param[in] packet    The packet to be added.
 * @param[in] order     The packet order value.
 * @param[in] metric    The metric value of the packet.
 * @returns             EOK on success.
 * @returns             EINVAL if the first parameter is NULL.
 * @returns             EINVAL if the packet is not valid.
 */
int pq_add(packet_t * first, packet_t packet, size_t order, size_t metric)
{
        packet_t item;

        if (!first || !packet_is_valid(packet))
                return EINVAL;

        pq_set_order(packet, order, metric);
        if (packet_is_valid(*first)) {
                item = * first;
                do {
                        if (item->order < order) {
                                if (item->next) {
                                        item = pm_find(item->next);
                                } else {
                                        item->next = packet->packet_id;
                                        packet->previous = item->packet_id;
                                        return EOK;
                                }
                        } else {
                                packet->previous = item->previous;
                                packet->next = item->packet_id;
                                item->previous = packet->packet_id;
                                item = pm_find(packet->previous);
                                if (item)
                                        item->next = packet->packet_id;
                                else
                                        *first = packet;
                                return EOK;
                        }
                } while (packet_is_valid(item));
        }
        *first = packet;
        return EOK;
}

/** Finds the packet with the given order.
 *
 * @param[in] first     The first packet of the queue.
 * @param[in] order     The packet order value.
 * @returns             The packet with the given order.
 * @returns             NULL if the first packet is not valid.
 * @returns             NULL if the packet is not found.
 */
packet_t pq_find(packet_t packet, size_t order)
{
        packet_t item;

        if (!packet_is_valid(packet))
                return NULL;

        item = packet;
        do {
                if (item->order == order)
                        return item;

                item = pm_find(item->next);
        } while (item && (item != packet) && packet_is_valid(item));

        return NULL;
}

/** Inserts packet after the given one.
 *
 * @param[in] packet    The packet in the queue.
 * @param[in] new_packet The new packet to be inserted.
 * @returns             EOK on success.
 * @returns             EINVAL if etiher of the packets is invalid.
 */
int pq_insert_after(packet_t packet, packet_t new_packet)
{
        packet_t item;

        if (!packet_is_valid(packet) || !packet_is_valid(new_packet))
                return EINVAL;

        new_packet->previous = packet->packet_id;
        new_packet->next = packet->next;
        item = pm_find(packet->next);
        if (item)
                item->previous = new_packet->packet_id;
        packet->next = new_packet->packet_id;

        return EOK;
}

/** Detach the packet from the queue.
 *
 * @param[in] packet    The packet to be detached.
 * @returns             The next packet in the queue. If the packet is the first
 *                      one of the queue, this becomes the new first one.
 * @returns             NULL if there is no packet left.
 * @returns             NULL if the packet is not valid.
 */
packet_t pq_detach(packet_t packet)
{
        packet_t next;
        packet_t previous;

        if (!packet_is_valid(packet))
                return NULL;

        next = pm_find(packet->next);
        if (next) {
                next->previous = packet->previous;
                previous = pm_find(next->previous);
                if (previous)
                        previous->next = next->packet_id;
        }
        packet->previous = 0;
        packet->next = 0;
        return next;
}

/** Sets the packet order and metric attributes.
 *
 * @param[in] packeti   The packet to be set.
 * @param[in] order     The packet order value.
 * @param[in] metric    The metric value of the packet.
 * @returns             EOK on success.
 * @returns             EINVAL if the packet is invalid.
 */
int pq_set_order(packet_t packet, size_t order, size_t metric)
{
        if (!packet_is_valid(packet))
                return EINVAL;

        packet->order = order;
        packet->metric = metric;
        return EOK;
}

/** Sets the packet order and metric attributes.
 *
 * @param[in] packet    The packet to be set.
 * @param[out] order    The packet order value.
 * @param[out] metric   The metric value of the packet.
 * @returns             EOK on success.
 * @returns             EINVAL if the packet is invalid.
 */
int pq_get_order(packet_t packet, size_t *order, size_t *metric)
{
        if (!packet_is_valid(packet))
                return EINVAL;

        if (order)
                *order = packet->order;

        if (metric)
                *metric = packet->metric;

        return EOK;
}

/** Releases the whole queue.
 *
 * Detaches all packets of the queue and calls the packet_release() for each of
 * them.
 *
 * @param[in] first     The first packet of the queue.
 * @param[in] packet_release The releasing function called for each of the
 *                      packets after its detachment.
 */
void pq_destroy(packet_t first, void (*packet_release)(packet_t packet))
{
        packet_t actual;
        packet_t next;

        actual = first;
        while (packet_is_valid(actual)) {
                next = pm_find(actual->next);
                actual->next = 0;
                actual->previous = 0;
                if(packet_release)
                        packet_release(actual);
                actual = next;
        }
}

/** Returns the next packet in the queue.
 *
 * @param[in] packet    The packet queue member.
 * @returns             The next packet in the queue.
 * @returns             NULL if there is no next packet.
 * @returns             NULL if the packet is not valid.
 */
packet_t pq_next(packet_t packet)
{
        if (!packet_is_valid(packet))
                return NULL;

        return pm_find(packet->next);
}

/** Returns the previous packet in the queue.
 *
 * @param[in] packet    The packet queue member.
 * @returns             The previous packet in the queue.
 * @returns             NULL if there is no previous packet.
 * @returns             NULL if the packet is not valid.
 */
packet_t pq_previous(packet_t packet)
{
        if (!packet_is_valid(packet))
                return NULL;

        return pm_find(packet->previous);
}

/** @}
 */