157 lines
5.0 KiB
C
157 lines
5.0 KiB
C
/*
|
|
* Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership.
|
|
* The OpenAirInterface Software Alliance licenses this file to You under
|
|
* the OAI Public License, Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.openairinterface.org/?page_id=698
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*-------------------------------------------------------------------------------
|
|
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
|
* contact@openairinterface.org
|
|
*/
|
|
|
|
/*! \file flexran_agent_task_manager.h
|
|
* \brief Implementation of scheduled tasks manager for the FlexRAN agent
|
|
* \author Xenofon Foukas
|
|
* \date January 2016
|
|
* \version 0.1
|
|
* \email: x.foukas@sms.ed.ac.uk
|
|
* @ingroup _mac
|
|
*/
|
|
|
|
#ifndef FLEXRAN_AGENT_TASK_MANAGER_
|
|
#define FLEXRAN_AGENT_TASK_MANAGER_
|
|
|
|
#include <stdint.h>
|
|
#include <pthread.h>
|
|
|
|
#include "flexran.pb-c.h"
|
|
|
|
#include "flexran_agent_common.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define DEFAULT_CAPACITY 512
|
|
|
|
/**
|
|
* The structure containing the enb agent task to be executed
|
|
*/
|
|
typedef struct flexran_agent_task_s {
|
|
/* The frame in which the task needs to be executed */
|
|
uint16_t frame_num;
|
|
/* The subframe in which the task needs to be executed */
|
|
uint8_t subframe_num;
|
|
/* The task to be executed in the form of a Protocol__FlexranMessage */
|
|
Protocol__FlexranMessage *task;
|
|
} flexran_agent_task_t;
|
|
|
|
/**
|
|
* Priority Queue Structure for tasks
|
|
*/
|
|
typedef struct flexran_agent_task_queue_s {
|
|
mid_t mod_id;
|
|
/* The amount of allocated memory for agent tasks in the heap*/
|
|
volatile size_t capacity;
|
|
/* The actual size of the tasks heap at a certain time */
|
|
volatile size_t count;
|
|
/* The earliest frame that has a pending task */
|
|
volatile uint16_t first_frame;
|
|
/* The earliest subframe within the frame that has a pending task */
|
|
volatile uint8_t first_subframe;
|
|
/* An array of prioritized tasks stored in a heap */
|
|
flexran_agent_task_t **task;
|
|
/* A pointer to a comparator function, used to prioritize elements */
|
|
int (*cmp)(mid_t mod_id, const flexran_agent_task_t *t1, const flexran_agent_task_t *t2);
|
|
pthread_mutex_t *mutex;
|
|
} flexran_agent_task_queue_t;
|
|
|
|
typedef enum {
|
|
HEAP_OK = 0,
|
|
HEAP_EMPTY,
|
|
HEAP_FAILED,
|
|
HEAP_REALLOCERROR,
|
|
HEAP_NOREALLOC,
|
|
HEAP_FATAL,
|
|
} heapstatus_e;
|
|
|
|
/**
|
|
* Allocate memory for a task in the queue
|
|
*/
|
|
flexran_agent_task_t *flexran_agent_task_create(Protocol__FlexranMessage *msg,
|
|
uint16_t frame_num, uint8_t subframe_num);
|
|
|
|
/**
|
|
* Free memory for a task of the queue
|
|
*/
|
|
void flexran_agent_task_destroy(flexran_agent_task_t *task);
|
|
|
|
/**
|
|
* Allocate initial memory for storing the tasks
|
|
*/
|
|
flexran_agent_task_queue_t *flexran_agent_task_queue_init(mid_t mod_id, size_t capacity,
|
|
int (*cmp)(mid_t mod_id, const flexran_agent_task_t *t1,
|
|
const flexran_agent_task_t *t2));
|
|
|
|
/**
|
|
* Allocate initial memory for storing the tasks using default parameters
|
|
*/
|
|
flexran_agent_task_queue_t *flexran_agent_task_queue_default_init(mid_t mod_id);
|
|
|
|
/**
|
|
* De-allocate memory for the tasks queue
|
|
*/
|
|
void flexran_agent_task_queue_destroy(flexran_agent_task_queue_t *queue);
|
|
|
|
/**
|
|
* Insert task into the queue
|
|
*/
|
|
int flexran_agent_task_queue_put(flexran_agent_task_queue_t *queue, flexran_agent_task_t *task);
|
|
|
|
/**
|
|
* Remove the task with the highest priority from the queue
|
|
* task becomes NULL if there is no task for the current frame and subframe
|
|
*/
|
|
int flexran_agent_task_queue_get_current_task(flexran_agent_task_queue_t *queue, flexran_agent_task_t **task);
|
|
|
|
/**
|
|
* Check if the top priority task is for a specific frame and subframe
|
|
*/
|
|
int flexran_agent_task_queue_has_upcoming_task (flexran_agent_task_queue_t *queue,
|
|
const uint16_t frame, const uint8_t subframe);
|
|
|
|
/**
|
|
* Restructure heap after modifications
|
|
*/
|
|
void _flexran_agent_task_queue_heapify(flexran_agent_task_queue_t *queue, size_t idx);
|
|
|
|
/**
|
|
* Reallocate memory once the heap reaches max size
|
|
*/
|
|
int _flexran_agent_task_queue_realloc_heap(flexran_agent_task_queue_t *queue);
|
|
|
|
/**
|
|
* Compare two agent tasks based on frame and subframe
|
|
* returns 0 if tasks t1, t2 have the same priority
|
|
* return negative value if t1 needs to be executed after t2
|
|
* return positive value if t1 preceeds t2
|
|
* Need to give eNB id for the comparisson based on the current frame-subframe
|
|
*/
|
|
int _flexran_agent_task_queue_cmp(mid_t mod_id, const flexran_agent_task_t *t1, const flexran_agent_task_t *t2);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /*FLEXRAN_AGENT_TASK_MANAGER_*/
|