gem-graph-server/include/base.h

//=-------------------------------------------------------------------------=//
//  base definition                                                         //
//                                                                           //
//  Copyright © 2021 The Gem-graph Project                                   //
//                                                                           //
//  This file is part of gem-graph.                                          //
//                                                                           //
//  This program is free software: you can redistribute it and/or modify     //
//  it under the terms of the GNU Affero General Public License as           //
//  published by the Free Software Foundation, either version 3 of the       //
//  License, or (at your option) any later version.                          //
//                                                                           //
//  This program is distributed in the hope that it will be useful,          //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of           //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            //
//  GNU Affero General Public License for more details.                      //
//                                                                           //
//  You should have received a copy of the GNU Affero General Public License //
//  along with this program.  If not, see <https://www.gnu.org/licenses/>.   //
//=-------------------------------------------------------------------------=//

#include <sys/param.h>
#include <stdbool.h>
#include <pthread.h>
#include <unistd.h>
#include <malloc.h>
#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <stdio.h>
#include <netinet/in.h>

#define BASE_H

/* -------------------------------------------------------------------------- */

#define LOGMSG "[%s]"
#define printLog(FORMAT, ...) printf("\e[0m" LOGMSG " " FORMAT "\e[0m", \
                                                 __func__, ##__VA_ARGS__)
#define LEN(x)  (sizeof(x) / sizeof((x)[0]))

/* -------------------------------------------------------------------------- */

struct IntArray_t {
    size_t size;
    int *space;
} typedef IntArray_t;

struct Arrow_t {
    int x;
    int y;
    int z;
    int siteId;
} typedef Arrow_t;

struct ArrowArray_t {
    size_t size;
    pthread_spinlock_t lock;
    Arrow_t *array;
} typedef ArrowArray_t;

struct Site_t {
    char *label;
    int nArrow;
} typedef Site_t;

struct SpaceUnit_t {
    int nSite;
    char *label;
    Site_t *sites;
} typedef SpaceUnit_t;

struct Space_t {
    int xMax;
    int yMax;
    int zMax;
    size_t size;
    SpaceUnit_t *space;
} typedef Space_t;

/* -------------------------------------------------------------------------- */

//
// Scheduler
//
struct Scheduler_t {
    pthread_t id;
    bool pleaseStop;
    Space_t *globalDrawingSpace;
    IntArray_t *conditionTree;
    ArrowArray_t *arrowArray;
    int nMaxThread;
    int nMaxCycles;
    int ruleRadius;
} typedef Scheduler_t;

/* -------------------------------------------------------------------------- */

//
// Local threads
//
struct Center_t {
    int x;
    int y;
    int z;
    struct Center_t *next;
    struct Center_t *prev;
} typedef Center_t;

struct Worker_t {
    pthread_t id;
    Center_t *localWorkAreaCenter;
    Space_t *globalDrawingSpace;
    IntArray_t *conditionTree;      // XXX
    ArrowArray_t *arrowArray;
    bool pleaseStop;
    bool terminated;
    int returnValue;
} typedef Worker_t;

/* -------------------------------------------------------------------------- */

//
// Server
//
struct Server_t {
    pthread_t id;
    bool pleaseStop;
    int returnValue;
    int sockfd;                     // Socket file descriptor
} typedef Server_t;

struct ServerCommunication_t {
    pthread_t id;
    bool pleaseStop;
    Server_t *associatedServer;
    int sockfd;                     // Socket file descriptor
    struct sockaddr_in clientAddr;
    socklen_t sockLen;
} typedef ServerCommunication_t;

/* -------------------------------------------------------------------------- */

//
// Supervisor
//
struct Supervisor_t {
    pthread_t id;
    bool pleaseStop;
    int *workerCreationOccurency;   // XXX ???
} typedef Supervisor_t;

/* -------------------------------------------------------------------------- */

//
// Model
//
struct Model_t {
    // Identity
    int id;
    bool validated;             // true if model has been correctly parsed
    char *name;
    char *owner;
    char *owner_id;
    time_t date;
    char *version;
    char *filename;
    // Parameters
    int space_xMax;             // TODO more than 3 dimension ?
    int space_yMax;
    int space_zMax;
    int nmaxThread;
    int nmaxCycles;
    int siteNumber;
    // Model instance
    bool isRunning;
    Scheduler_t *scheduler;
    Supervisor_t *supervisor;
} typedef Model_t;

struct ModelField_t {
    bool mandatory;             // true if field must exist in file
    char tag[25];               // XML tag attached to that field
    char *destination;          // data destination of that field
    size_t size;                // max size of data allowed
    struct ModelField_t *son;   // son in XML tree
    struct ModelField_t *next;  // brother in XML tree
} typedef ModelField_t;

/* -------------------------------------------------------------------------- */

//
// Parameters
//
struct Parameters_t {
    char *configDir;
    char *modelDir;
    char *userDir;
} typedef Parameters_t;