ui/common/threadpool.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2024 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 UIC_THREADPOOL_H
#define UIC_THREADPOOL_H

#include "../ui/toolkit.h"

#ifndef _WIN32
#include <pthread.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif
    
void uic_init_threads(void);
int uic_mainthread_calls_is_buffered(void);
void uic_add_buffered_mainthread_call(ui_threadfunc func, void *data);
    
typedef struct UiQueueElm UiQueueElm;
typedef struct UiQueue    UiQueue;
    
typedef struct UiJob {
    UiObject      *obj;
    ui_threadfunc job_func;
    void          *job_data;
    ui_callback   finish_callback;
    void          *finish_data;
} UiJob;
    
struct UiQueueElm {
    void       *data;
    UiQueueElm *next;
};

struct UiQueue {
    UiQueueElm      *elements;
    size_t          length;
    pthread_mutex_t lock;
    pthread_mutex_t avlbl_lock;
    pthread_cond_t  available;
};
    
typedef struct  _threadpool_job   threadpool_job;
typedef void*(*job_callback_f)(void *data);
    
typedef struct _pool_queue pool_queue_t;
struct UiThreadpool {
    UiQueue   *queue;
    uint32_t  num_idle;
    int       min_threads;
    int       max_threads;
    pthread_t *threads;
    int       nthreads;
};

struct _threadpool_job {
    job_callback_f      callback;
    void                *data;
};

struct _pool_queue {
    threadpool_job   *job;
    pool_queue_t     *next;
};

UiThreadpool* threadpool_new(int min, int max);
int threadpool_start(UiThreadpool *pool);
int threadpool_join(UiThreadpool *pool);
void* threadpool_func(void *data);
threadpool_job* threadpool_get_job(UiThreadpool *pool);
void threadpool_run(UiThreadpool *pool, job_callback_f func, void *data);

UiQueue* ui_queue_create(void);
void ui_queue_free(UiQueue *queue);
void ui_queue_put(UiQueue *queue, void *data);
void* ui_queue_get_wait(UiQueue *queue);

#ifdef __cplusplus
}
#endif

#endif /* UIC_THREADPOOL_H */