src/server/daemon/resourcepool.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 Olaf Wintermann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. 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.
 *
 * 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 HOLDER 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.
 */

#ifndef WS_RESOURCEPOOL_H
#define WS_RESOURCEPOOL_H

#include "../public/nsapi.h"

#include "config.h"

#include <pthread.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct ResourceDataPrivate ResourceDataPrivate;

struct ResourceDataPrivate {
    ResourceData data;
    
    /*
     * the void* pointer returned by respool->type->createresource
     * 
     * ResourceData.data contains the pointer returned by
     * respool->type->getresourcedata(resdata))
     */
    void *resdata;
};

struct ResourcePool {
    /*
     * Memory pool
     */
    pool_handle_t *pool;
    
    /*
     * Type information of this resource pool
     * The type object is stored in the registered types map and should not
     * be freed, when the resource pool is destroyed
     */
    ResourceType *type;
    
    /*
     * The name of the resource pool
     */
    char *name;
    
    /*
     * Data returned by the ResourceType init function
     * When the pool is destroyed, the data should be passed to
     * ResourceType.destroy
     */
    void *data;
    
    pthread_mutex_t lock;
    pthread_cond_t available;
    
    /*
     * Array of available resources
     * each entry is created with ResourceType.createresource
     */
    ResourceDataPrivate **resources;
    
    /*
     * Allocated size of the resources array
     */
    size_t resalloc;
    
    /*
     * Number of currently available resources in the array
     */
    size_t numresources;
    
    
    /*
     * Number of created resources (in use + available)
     */
    size_t numcreated;
    
    /*
     * resource pool min parameter
     */
    int min;
    
    /*
     * resource pool max parameter
     */
    int max;
};

int init_resource_pools(void);

void resource_pool_cleanup(void);

int resourcepool_new(ServerConfiguration *cfg, cxstring type, cxstring name, ConfigNode *node);

void resourcepool_destroy_resource(ResourceDataPrivate *res);

void resourcepool_destroy(ResourcePool *respool);

#ifdef __cplusplus
}
#endif

#endif /* WS_RESOURCEPOOL_H */