mirror of
https://git.proxmox.com/git/mirror_frr
synced 2025-11-04 11:45:06 +00:00
ca1f4309e6
Support stubby and totally stubby areas in OSPFv3 Signed-off-by: Dinesh G Dutt <ddutt at cumulusnetworks.com> Reviewed-by: Pradosh Mohapatra <pmohapat at cumulusnetworks.com>
242 lines
8.1 KiB
C
242 lines
8.1 KiB
C
/* Thread management routine header.
|
|
* Copyright (C) 1998 Kunihiro Ishiguro
|
|
* Portions Copyright (c) 2008 Everton da Silva Marques <everton.marques@gmail.com>
|
|
*
|
|
* This file is part of GNU Zebra.
|
|
*
|
|
* GNU Zebra is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation; either version 2, or (at your option) any
|
|
* later version.
|
|
*
|
|
* GNU Zebra 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
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with GNU Zebra; see the file COPYING. If not, write to the Free
|
|
* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
* 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef _ZEBRA_THREAD_H
|
|
#define _ZEBRA_THREAD_H
|
|
|
|
#include <zebra.h>
|
|
|
|
struct rusage_t
|
|
{
|
|
#ifdef HAVE_RUSAGE
|
|
struct rusage cpu;
|
|
#endif
|
|
struct timeval real;
|
|
};
|
|
#define RUSAGE_T struct rusage_t
|
|
|
|
#define GETRUSAGE(X) thread_getrusage(X)
|
|
|
|
/* Linked list of thread. */
|
|
struct thread_list
|
|
{
|
|
struct thread *head;
|
|
struct thread *tail;
|
|
int count;
|
|
};
|
|
|
|
struct pqueue;
|
|
|
|
/* Master of the theads. */
|
|
struct thread_master
|
|
{
|
|
struct thread_list read;
|
|
struct thread_list write;
|
|
struct pqueue *timer;
|
|
struct thread_list event;
|
|
struct thread_list ready;
|
|
struct thread_list unuse;
|
|
struct pqueue *background;
|
|
fd_set readfd;
|
|
fd_set writefd;
|
|
fd_set exceptfd;
|
|
unsigned long alloc;
|
|
};
|
|
|
|
typedef unsigned char thread_type;
|
|
|
|
/* ISO C99 maximum function name length is 63 */
|
|
#define FUNCNAME_LEN 64
|
|
|
|
/* Thread itself. */
|
|
struct thread
|
|
{
|
|
thread_type type; /* thread type */
|
|
thread_type add_type; /* thread type */
|
|
struct thread *next; /* next pointer of the thread */
|
|
struct thread *prev; /* previous pointer of the thread */
|
|
struct thread_master *master; /* pointer to the struct thread_master. */
|
|
int (*func) (struct thread *); /* event function */
|
|
void *arg; /* event argument */
|
|
union {
|
|
int val; /* second argument of the event. */
|
|
int fd; /* file descriptor in case of read/write. */
|
|
struct timeval sands; /* rest of time sands value. */
|
|
} u;
|
|
int index; /* used for timers to store position in queue */
|
|
struct timeval real;
|
|
struct cpu_thread_history *hist; /* cache pointer to cpu_history */
|
|
unsigned long yield; /* yield time in us */
|
|
char funcname[FUNCNAME_LEN];
|
|
};
|
|
|
|
struct cpu_thread_history
|
|
{
|
|
int (*func)(struct thread *);
|
|
unsigned int total_calls;
|
|
struct time_stats
|
|
{
|
|
unsigned long total, max;
|
|
} real;
|
|
#ifdef HAVE_RUSAGE
|
|
struct time_stats cpu;
|
|
#endif
|
|
thread_type types;
|
|
char funcname[FUNCNAME_LEN];
|
|
};
|
|
|
|
/* Clocks supported by Quagga */
|
|
enum quagga_clkid {
|
|
QUAGGA_CLK_REALTIME = 0, /* ala gettimeofday() */
|
|
QUAGGA_CLK_MONOTONIC, /* monotonic, against an indeterminate base */
|
|
QUAGGA_CLK_REALTIME_STABILISED, /* like realtime, but non-decrementing */
|
|
};
|
|
|
|
/* Struct timeval's tv_usec one second value. */
|
|
#define TIMER_SECOND_MICRO 1000000L
|
|
|
|
/* Thread types. */
|
|
#define THREAD_READ 0
|
|
#define THREAD_WRITE 1
|
|
#define THREAD_TIMER 2
|
|
#define THREAD_EVENT 3
|
|
#define THREAD_READY 4
|
|
#define THREAD_BACKGROUND 5
|
|
#define THREAD_UNUSED 6
|
|
#define THREAD_EXECUTE 7
|
|
|
|
/* Thread yield time. */
|
|
#define THREAD_YIELD_TIME_SLOT 10 * 1000L /* 10ms */
|
|
|
|
/* Macros. */
|
|
#define THREAD_ARG(X) ((X)->arg)
|
|
#define THREAD_FD(X) ((X)->u.fd)
|
|
#define THREAD_VAL(X) ((X)->u.val)
|
|
|
|
#define THREAD_READ_ON(master,thread,func,arg,sock) \
|
|
do { \
|
|
if (! thread) \
|
|
thread = thread_add_read (master, func, arg, sock); \
|
|
} while (0)
|
|
|
|
#define THREAD_WRITE_ON(master,thread,func,arg,sock) \
|
|
do { \
|
|
if (! thread) \
|
|
thread = thread_add_write (master, func, arg, sock); \
|
|
} while (0)
|
|
|
|
#define THREAD_TIMER_ON(master,thread,func,arg,time) \
|
|
do { \
|
|
if (! thread) \
|
|
thread = thread_add_timer (master, func, arg, time); \
|
|
} while (0)
|
|
|
|
#define THREAD_TIMER_MSEC_ON(master,thread,func,arg,time) \
|
|
do { \
|
|
if (! thread) \
|
|
thread = thread_add_timer_msec (master, func, arg, time); \
|
|
} while (0)
|
|
|
|
#define THREAD_OFF(thread) \
|
|
do { \
|
|
if (thread) \
|
|
{ \
|
|
thread_cancel (thread); \
|
|
thread = NULL; \
|
|
} \
|
|
} while (0)
|
|
|
|
#define THREAD_READ_OFF(thread) THREAD_OFF(thread)
|
|
#define THREAD_WRITE_OFF(thread) THREAD_OFF(thread)
|
|
#define THREAD_TIMER_OFF(thread) THREAD_OFF(thread)
|
|
|
|
#define thread_add_read(m,f,a,v) funcname_thread_add_read(m,f,a,v,#f)
|
|
#define thread_add_write(m,f,a,v) funcname_thread_add_write(m,f,a,v,#f)
|
|
#define thread_add_timer(m,f,a,v) funcname_thread_add_timer(m,f,a,v,#f)
|
|
#define thread_add_timer_msec(m,f,a,v) funcname_thread_add_timer_msec(m,f,a,v,#f)
|
|
#define thread_add_event(m,f,a,v) funcname_thread_add_event(m,f,a,v,#f)
|
|
#define thread_execute(m,f,a,v) funcname_thread_execute(m,f,a,v,#f)
|
|
|
|
/* The 4th arg to thread_add_background is the # of milliseconds to delay. */
|
|
#define thread_add_background(m,f,a,v) funcname_thread_add_background(m,f,a,v,#f)
|
|
|
|
/* Prototypes. */
|
|
extern struct thread_master *thread_master_create (void);
|
|
extern void thread_master_free (struct thread_master *);
|
|
|
|
extern struct thread *funcname_thread_add_read (struct thread_master *,
|
|
int (*)(struct thread *),
|
|
void *, int, const char*);
|
|
extern struct thread *funcname_thread_add_write (struct thread_master *,
|
|
int (*)(struct thread *),
|
|
void *, int, const char*);
|
|
extern struct thread *funcname_thread_add_timer (struct thread_master *,
|
|
int (*)(struct thread *),
|
|
void *, long, const char*);
|
|
extern struct thread *funcname_thread_add_timer_msec (struct thread_master *,
|
|
int (*)(struct thread *),
|
|
void *, long, const char*);
|
|
extern struct thread *funcname_thread_add_event (struct thread_master *,
|
|
int (*)(struct thread *),
|
|
void *, int, const char*);
|
|
extern struct thread *funcname_thread_add_background (struct thread_master *,
|
|
int (*func)(struct thread *),
|
|
void *arg,
|
|
long milliseconds_to_delay,
|
|
const char *funcname);
|
|
extern struct thread *funcname_thread_execute (struct thread_master *,
|
|
int (*)(struct thread *),
|
|
void *, int, const char *);
|
|
extern void thread_cancel (struct thread *);
|
|
extern unsigned int thread_cancel_event (struct thread_master *, void *);
|
|
extern struct thread *thread_fetch (struct thread_master *, struct thread *);
|
|
extern void thread_call (struct thread *);
|
|
extern unsigned long thread_timer_remain_second (struct thread *);
|
|
extern int thread_should_yield (struct thread *);
|
|
extern unsigned long timeval_elapsed (struct timeval a, struct timeval b);
|
|
/* set yield time for thread */
|
|
extern void thread_set_yield_time (struct thread *, unsigned long);
|
|
|
|
/* Internal libzebra exports */
|
|
extern void thread_getrusage (RUSAGE_T *);
|
|
extern struct cmd_element show_thread_cpu_cmd;
|
|
extern struct cmd_element clear_thread_cpu_cmd;
|
|
|
|
/* replacements for the system gettimeofday(), clock_gettime() and
|
|
* time() functions, providing support for non-decrementing clock on
|
|
* all systems, and fully monotonic on /some/ systems.
|
|
*/
|
|
extern int quagga_gettime (enum quagga_clkid, struct timeval *);
|
|
extern time_t quagga_time (time_t *);
|
|
|
|
/* Returns elapsed real (wall clock) time. */
|
|
extern unsigned long thread_consumed_time(RUSAGE_T *after, RUSAGE_T *before,
|
|
unsigned long *cpu_time_elapsed);
|
|
|
|
/* Global variable containing a recent result from gettimeofday. This can
|
|
be used instead of calling gettimeofday if a recent value is sufficient.
|
|
This is guaranteed to be refreshed before a thread is called. */
|
|
extern struct timeval recent_time;
|
|
/* Similar to recent_time, but a monotonically increasing time value */
|
|
extern struct timeval recent_relative_time (void);
|
|
#endif /* _ZEBRA_THREAD_H */
|