mirror of
https://github.com/signalwire/freeswitch.git
synced 2026-11-15 22:08:33 +00:00
610 lines
18 KiB
C
610 lines
18 KiB
C
/*
|
|
* ossp-util - OSS Proxy: Common utilities
|
|
*
|
|
* Copyright (C) 2008-2010 SUSE Linux Products GmbH
|
|
* Copyright (C) 2008-2010 Tejun Heo <tj@kernel.org>
|
|
*
|
|
* This file is released under the GPLv2.
|
|
*/
|
|
|
|
#ifndef _OSSP_UTIL_H
|
|
#define _OSSP_UTIL_H
|
|
|
|
#include <assert.h>
|
|
#include <stddef.h>
|
|
#include <string.h>
|
|
#include <sys/types.h>
|
|
#include <errno.h>
|
|
#include <unistd.h>
|
|
#include "ossp.h"
|
|
|
|
#define OSSP_LOG_NAME_LEN 128
|
|
|
|
enum {
|
|
OSSP_LOG_CRIT = 1,
|
|
OSSP_LOG_ERR,
|
|
OSSP_LOG_WARN,
|
|
OSSP_LOG_INFO,
|
|
OSSP_LOG_DFL = OSSP_LOG_INFO, /* default log level */
|
|
OSSP_LOG_DBG0,
|
|
OSSP_LOG_DBG1,
|
|
OSSP_LOG_MAX = OSSP_LOG_DBG1,
|
|
};
|
|
|
|
extern char ossp_log_name[OSSP_LOG_NAME_LEN];
|
|
extern int ossp_log_level;
|
|
extern int ossp_log_timestamp;
|
|
|
|
#define BITS_PER_BYTE 8
|
|
#define BITS_PER_LONG (BITS_PER_BYTE * sizeof(long))
|
|
#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
|
|
#define BITS_TO_LONGS(nr) DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long))
|
|
|
|
/* ARRAY_SIZE and min/max macros stolen from linux/kernel.h */
|
|
#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
|
|
|
|
#define min(x, y) ({ \
|
|
typeof(x) _min1 = (x); \
|
|
typeof(y) _min2 = (y); \
|
|
(void) (&_min1 == &_min2); \
|
|
_min1 < _min2 ? _min1 : _min2; })
|
|
|
|
#define max(x, y) ({ \
|
|
typeof(x) _max1 = (x); \
|
|
typeof(y) _max2 = (y); \
|
|
(void) (&_max1 == &_max2); \
|
|
_max1 > _max2 ? _max1 : _max2; })
|
|
|
|
#define min_t(type, x, y) ({ \
|
|
type __min1 = (x); \
|
|
type __min2 = (y); \
|
|
__min1 < __min2 ? __min1: __min2; })
|
|
|
|
#define max_t(type, x, y) ({ \
|
|
type __max1 = (x); \
|
|
type __max2 = (y); \
|
|
__max1 > __max2 ? __max1: __max2; })
|
|
|
|
void log_msg(int severity, const char *fmt, ...)
|
|
__attribute__ ((format (printf, 2, 3)));
|
|
|
|
#define fatal(fmt, args...) do { \
|
|
log_msg(OSSP_LOG_CRIT, fmt , ##args); \
|
|
_exit(1); \
|
|
} while (0)
|
|
#define err(fmt, args...) log_msg(OSSP_LOG_ERR, fmt , ##args)
|
|
#define warn(fmt, args...) log_msg(OSSP_LOG_WARN, fmt , ##args)
|
|
#define info(fmt, args...) log_msg(OSSP_LOG_INFO, fmt , ##args)
|
|
#define dbg0(fmt, args...) log_msg(OSSP_LOG_DBG0, fmt , ##args)
|
|
#define dbg1(fmt, args...) log_msg(OSSP_LOG_DBG1, fmt , ##args)
|
|
|
|
#define fatal_e(e, fmt, args...) \
|
|
fatal(fmt" (%s)" , ##args, strerror(-(e)))
|
|
#define err_e(e, fmt, args...) \
|
|
err(fmt" (%s)" , ##args, strerror(-(e)))
|
|
#define warn_e(e, fmt, args...) \
|
|
warn(fmt" (%s)" , ##args, strerror(-(e)))
|
|
#define info_e(e, fmt, args...) \
|
|
info(fmt" (%s)" , ##args, strerror(-(e)))
|
|
#define dbg0_e(e, fmt, args...) \
|
|
dbg0(fmt" (%s)" , ##args, strerror(-(e)))
|
|
#define dbg1_e(e, fmt, args...) \
|
|
dbg1(fmt" (%s)" , ##args, strerror(-(e)))
|
|
|
|
struct ring_buf {
|
|
char *buf;
|
|
size_t size;
|
|
size_t head;
|
|
size_t bytes;
|
|
};
|
|
|
|
static inline size_t ring_size(struct ring_buf *ring)
|
|
{
|
|
return ring->size;
|
|
}
|
|
|
|
static inline size_t ring_bytes(struct ring_buf *ring)
|
|
{
|
|
return ring->bytes;
|
|
}
|
|
|
|
static inline size_t ring_space(struct ring_buf *ring)
|
|
{
|
|
return ring->size - ring->bytes;
|
|
}
|
|
|
|
static inline void ring_consume(struct ring_buf *ring, size_t size)
|
|
{
|
|
assert(ring->bytes >= size);
|
|
ring->bytes -= size;
|
|
}
|
|
|
|
static inline void ring_manual_init(struct ring_buf *ring, void *buf,
|
|
size_t size, size_t head, size_t bytes)
|
|
{
|
|
ring->buf = buf;
|
|
ring->size = size;
|
|
ring->head = head;
|
|
ring->bytes = bytes;
|
|
}
|
|
|
|
void ring_fill(struct ring_buf *ring, const void *buf, size_t size);
|
|
void *ring_data(struct ring_buf *ring, size_t *sizep);
|
|
int ring_resize(struct ring_buf *ring, size_t new_size);
|
|
|
|
struct sized_buf {
|
|
char *buf;
|
|
size_t size;
|
|
};
|
|
|
|
int ensure_sbuf_size(struct sized_buf *sbuf, size_t size);
|
|
|
|
int read_fill(int fd, void *buf, size_t size);
|
|
int write_fill(int fd, const void *buf, size_t size);
|
|
|
|
/*
|
|
* Bitops lifted from linux asm-generic implementation.
|
|
*/
|
|
unsigned long find_next_zero_bit(const unsigned long *addr, unsigned
|
|
long size, unsigned long offset);
|
|
#define find_first_zero_bit(addr, size) find_next_zero_bit((addr), (size), 0)
|
|
extern void __set_bit(int nr, volatile unsigned long *addr);
|
|
extern void __clear_bit(int nr, volatile unsigned long *addr);
|
|
|
|
typedef ssize_t (*ossp_action_fn_t)(enum ossp_opcode opcode,
|
|
void *carg, void *din, size_t din_sz,
|
|
void *rarg, void *dout, size_t *dout_szp,
|
|
int fd);
|
|
|
|
int get_proc_self_info(pid_t tid, pid_t *pgrp,
|
|
char *cmd_buf, size_t cmd_buf_sz);
|
|
|
|
/*
|
|
* Doubly linked list handling code shamelessly stolen from the Linux
|
|
* kernel 2.6.26 include/linux/list.h.
|
|
*/
|
|
|
|
/**
|
|
* container_of - cast a member of a structure out to the containing structure
|
|
* @ptr: the pointer to the member.
|
|
* @type: the type of the container struct this is embedded in.
|
|
* @member: the name of the member within the struct.
|
|
*
|
|
*/
|
|
#define container_of(ptr, type, member) ({ \
|
|
const typeof( ((type *)0)->member ) *__mptr = (ptr); \
|
|
(type *)( (char *)__mptr - offsetof(type,member) );})
|
|
|
|
#define LIST_POISON1 ((void *) 0x00100100)
|
|
#define LIST_POISON2 ((void *) 0x00200200)
|
|
|
|
/*
|
|
* Simple doubly linked list implementation.
|
|
*
|
|
* Some of the internal functions ("__xxx") are useful when
|
|
* manipulating whole lists rather than single entries, as
|
|
* sometimes we already know the next/prev entries and we can
|
|
* generate better code by using them directly rather than
|
|
* using the generic single-entry routines.
|
|
*/
|
|
|
|
struct list_head {
|
|
struct list_head *next, *prev;
|
|
};
|
|
|
|
#define LIST_HEAD_INIT(name) { &(name), &(name) }
|
|
|
|
#define LIST_HEAD(name) \
|
|
struct list_head name = LIST_HEAD_INIT(name)
|
|
|
|
static inline void INIT_LIST_HEAD(struct list_head *list)
|
|
{
|
|
list->next = list;
|
|
list->prev = list;
|
|
}
|
|
|
|
/*
|
|
* Insert a new entry between two known consecutive entries.
|
|
*
|
|
* This is only for internal list manipulation where we know
|
|
* the prev/next entries already!
|
|
*/
|
|
static inline void __list_add(struct list_head *new,
|
|
struct list_head *prev,
|
|
struct list_head *next)
|
|
{
|
|
next->prev = new;
|
|
new->next = next;
|
|
new->prev = prev;
|
|
prev->next = new;
|
|
}
|
|
|
|
/**
|
|
* list_add - add a new entry
|
|
* @new: new entry to be added
|
|
* @head: list head to add it after
|
|
*
|
|
* Insert a new entry after the specified head.
|
|
* This is good for implementing stacks.
|
|
*/
|
|
static inline void list_add(struct list_head *new, struct list_head *head)
|
|
{
|
|
__list_add(new, head, head->next);
|
|
}
|
|
|
|
/**
|
|
* list_add_tail - add a new entry
|
|
* @new: new entry to be added
|
|
* @head: list head to add it before
|
|
*
|
|
* Insert a new entry before the specified head.
|
|
* This is useful for implementing queues.
|
|
*/
|
|
static inline void list_add_tail(struct list_head *new, struct list_head *head)
|
|
{
|
|
__list_add(new, head->prev, head);
|
|
}
|
|
|
|
/*
|
|
* Delete a list entry by making the prev/next entries
|
|
* point to each other.
|
|
*
|
|
* This is only for internal list manipulation where we know
|
|
* the prev/next entries already!
|
|
*/
|
|
static inline void __list_del(struct list_head * prev, struct list_head * next)
|
|
{
|
|
next->prev = prev;
|
|
prev->next = next;
|
|
}
|
|
|
|
/**
|
|
* list_del - deletes entry from list.
|
|
* @entry: the element to delete from the list.
|
|
* Note: list_empty() on entry does not return true after this, the entry is
|
|
* in an undefined state.
|
|
*/
|
|
static inline void list_del(struct list_head *entry)
|
|
{
|
|
__list_del(entry->prev, entry->next);
|
|
entry->next = LIST_POISON1;
|
|
entry->prev = LIST_POISON2;
|
|
}
|
|
|
|
/**
|
|
* list_replace - replace old entry by new one
|
|
* @old : the element to be replaced
|
|
* @new : the new element to insert
|
|
*
|
|
* If @old was empty, it will be overwritten.
|
|
*/
|
|
static inline void list_replace(struct list_head *old,
|
|
struct list_head *new)
|
|
{
|
|
new->next = old->next;
|
|
new->next->prev = new;
|
|
new->prev = old->prev;
|
|
new->prev->next = new;
|
|
}
|
|
|
|
static inline void list_replace_init(struct list_head *old,
|
|
struct list_head *new)
|
|
{
|
|
list_replace(old, new);
|
|
INIT_LIST_HEAD(old);
|
|
}
|
|
|
|
/**
|
|
* list_del_init - deletes entry from list and reinitialize it.
|
|
* @entry: the element to delete from the list.
|
|
*/
|
|
static inline void list_del_init(struct list_head *entry)
|
|
{
|
|
__list_del(entry->prev, entry->next);
|
|
INIT_LIST_HEAD(entry);
|
|
}
|
|
|
|
/**
|
|
* list_move - delete from one list and add as another's head
|
|
* @list: the entry to move
|
|
* @head: the head that will precede our entry
|
|
*/
|
|
static inline void list_move(struct list_head *list, struct list_head *head)
|
|
{
|
|
__list_del(list->prev, list->next);
|
|
list_add(list, head);
|
|
}
|
|
|
|
/**
|
|
* list_move_tail - delete from one list and add as another's tail
|
|
* @list: the entry to move
|
|
* @head: the head that will follow our entry
|
|
*/
|
|
static inline void list_move_tail(struct list_head *list,
|
|
struct list_head *head)
|
|
{
|
|
__list_del(list->prev, list->next);
|
|
list_add_tail(list, head);
|
|
}
|
|
|
|
/**
|
|
* list_is_last - tests whether @list is the last entry in list @head
|
|
* @list: the entry to test
|
|
* @head: the head of the list
|
|
*/
|
|
static inline int list_is_last(const struct list_head *list,
|
|
const struct list_head *head)
|
|
{
|
|
return list->next == head;
|
|
}
|
|
|
|
/**
|
|
* list_empty - tests whether a list is empty
|
|
* @head: the list to test.
|
|
*/
|
|
static inline int list_empty(const struct list_head *head)
|
|
{
|
|
return head->next == head;
|
|
}
|
|
|
|
/**
|
|
* list_empty_careful - tests whether a list is empty and not being modified
|
|
* @head: the list to test
|
|
*
|
|
* Description:
|
|
* tests whether a list is empty _and_ checks that no other CPU might be
|
|
* in the process of modifying either member (next or prev)
|
|
*
|
|
* NOTE: using list_empty_careful() without synchronization
|
|
* can only be safe if the only activity that can happen
|
|
* to the list entry is list_del_init(). Eg. it cannot be used
|
|
* if another CPU could re-list_add() it.
|
|
*/
|
|
static inline int list_empty_careful(const struct list_head *head)
|
|
{
|
|
struct list_head *next = head->next;
|
|
return (next == head) && (next == head->prev);
|
|
}
|
|
|
|
/**
|
|
* list_is_singular - tests whether a list has just one entry.
|
|
* @head: the list to test.
|
|
*/
|
|
static inline int list_is_singular(const struct list_head *head)
|
|
{
|
|
return !list_empty(head) && (head->next == head->prev);
|
|
}
|
|
|
|
static inline void __list_splice(const struct list_head *list,
|
|
struct list_head *head)
|
|
{
|
|
struct list_head *first = list->next;
|
|
struct list_head *last = list->prev;
|
|
struct list_head *at = head->next;
|
|
|
|
first->prev = head;
|
|
head->next = first;
|
|
|
|
last->next = at;
|
|
at->prev = last;
|
|
}
|
|
|
|
/**
|
|
* list_splice - join two lists
|
|
* @list: the new list to add.
|
|
* @head: the place to add it in the first list.
|
|
*/
|
|
static inline void list_splice(const struct list_head *list,
|
|
struct list_head *head)
|
|
{
|
|
if (!list_empty(list))
|
|
__list_splice(list, head);
|
|
}
|
|
|
|
/**
|
|
* list_splice_init - join two lists and reinitialise the emptied list.
|
|
* @list: the new list to add.
|
|
* @head: the place to add it in the first list.
|
|
*
|
|
* The list at @list is reinitialised
|
|
*/
|
|
static inline void list_splice_init(struct list_head *list,
|
|
struct list_head *head)
|
|
{
|
|
if (!list_empty(list)) {
|
|
__list_splice(list, head);
|
|
INIT_LIST_HEAD(list);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* list_entry - get the struct for this entry
|
|
* @ptr: the &struct list_head pointer.
|
|
* @type: the type of the struct this is embedded in.
|
|
* @member: the name of the list_struct within the struct.
|
|
*/
|
|
#define list_entry(ptr, type, member) \
|
|
container_of(ptr, type, member)
|
|
|
|
/**
|
|
* list_first_entry - get the first element from a list
|
|
* @ptr: the list head to take the element from.
|
|
* @type: the type of the struct this is embedded in.
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Note, that list is expected to be not empty.
|
|
*/
|
|
#define list_first_entry(ptr, type, member) \
|
|
list_entry((ptr)->next, type, member)
|
|
|
|
/**
|
|
* list_for_each - iterate over a list
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
* @head: the head for your list.
|
|
*/
|
|
#define list_for_each(pos, head) \
|
|
for (pos = (head)->next; pos != (head); pos = pos->next)
|
|
|
|
/**
|
|
* list_for_each_prev - iterate over a list backwards
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
* @head: the head for your list.
|
|
*/
|
|
#define list_for_each_prev(pos, head) \
|
|
for (pos = (head)->prev; pos != (head); pos = pos->prev)
|
|
|
|
/**
|
|
* list_for_each_safe - iterate over a list safe against removal of list entry
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
* @n: another &struct list_head to use as temporary storage
|
|
* @head: the head for your list.
|
|
*/
|
|
#define list_for_each_safe(pos, n, head) \
|
|
for (pos = (head)->next, n = pos->next; pos != (head); \
|
|
pos = n, n = pos->next)
|
|
|
|
/**
|
|
* list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
* @n: another &struct list_head to use as temporary storage
|
|
* @head: the head for your list.
|
|
*/
|
|
#define list_for_each_prev_safe(pos, n, head) \
|
|
for (pos = (head)->prev, n = pos->prev; \
|
|
pos != (head); pos = n, n = pos->prev)
|
|
|
|
/**
|
|
* list_for_each_entry - iterate over list of given type
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*/
|
|
#define list_for_each_entry(pos, head, member) \
|
|
for (pos = list_entry((head)->next, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = list_entry(pos->member.next, typeof(*pos), member))
|
|
|
|
/**
|
|
* list_for_each_entry_reverse - iterate backwards over list of given type.
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*/
|
|
#define list_for_each_entry_reverse(pos, head, member) \
|
|
for (pos = list_entry((head)->prev, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = list_entry(pos->member.prev, typeof(*pos), member))
|
|
|
|
/**
|
|
* list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
|
|
* @pos: the type * to use as a start point
|
|
* @head: the head of the list
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Prepares a pos entry for use as a start point in list_for_each_entry_continue().
|
|
*/
|
|
#define list_prepare_entry(pos, head, member) \
|
|
((pos) ? : list_entry(head, typeof(*pos), member))
|
|
|
|
/**
|
|
* list_for_each_entry_continue - continue iteration over list of given type
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Continue to iterate over list of given type, continuing after
|
|
* the current position.
|
|
*/
|
|
#define list_for_each_entry_continue(pos, head, member) \
|
|
for (pos = list_entry(pos->member.next, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = list_entry(pos->member.next, typeof(*pos), member))
|
|
|
|
/**
|
|
* list_for_each_entry_continue_reverse - iterate backwards from the given point
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Start to iterate over list of given type backwards, continuing after
|
|
* the current position.
|
|
*/
|
|
#define list_for_each_entry_continue_reverse(pos, head, member) \
|
|
for (pos = list_entry(pos->member.prev, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = list_entry(pos->member.prev, typeof(*pos), member))
|
|
|
|
/**
|
|
* list_for_each_entry_from - iterate over list of given type from the current point
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Iterate over list of given type, continuing from current position.
|
|
*/
|
|
#define list_for_each_entry_from(pos, head, member) \
|
|
for (; &pos->member != (head); \
|
|
pos = list_entry(pos->member.next, typeof(*pos), member))
|
|
|
|
/**
|
|
* list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @n: another type * to use as temporary storage
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*/
|
|
#define list_for_each_entry_safe(pos, n, head, member) \
|
|
for (pos = list_entry((head)->next, typeof(*pos), member), \
|
|
n = list_entry(pos->member.next, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = n, n = list_entry(n->member.next, typeof(*n), member))
|
|
|
|
/**
|
|
* list_for_each_entry_safe_continue
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @n: another type * to use as temporary storage
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Iterate over list of given type, continuing after current point,
|
|
* safe against removal of list entry.
|
|
*/
|
|
#define list_for_each_entry_safe_continue(pos, n, head, member) \
|
|
for (pos = list_entry(pos->member.next, typeof(*pos), member), \
|
|
n = list_entry(pos->member.next, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = n, n = list_entry(n->member.next, typeof(*n), member))
|
|
|
|
/**
|
|
* list_for_each_entry_safe_from
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @n: another type * to use as temporary storage
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Iterate over list of given type from current point, safe against
|
|
* removal of list entry.
|
|
*/
|
|
#define list_for_each_entry_safe_from(pos, n, head, member) \
|
|
for (n = list_entry(pos->member.next, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = n, n = list_entry(n->member.next, typeof(*n), member))
|
|
|
|
/**
|
|
* list_for_each_entry_safe_reverse
|
|
* @pos: the type * to use as a loop cursor.
|
|
* @n: another type * to use as temporary storage
|
|
* @head: the head for your list.
|
|
* @member: the name of the list_struct within the struct.
|
|
*
|
|
* Iterate backwards over list of given type, safe against removal
|
|
* of list entry.
|
|
*/
|
|
#define list_for_each_entry_safe_reverse(pos, n, head, member) \
|
|
for (pos = list_entry((head)->prev, typeof(*pos), member), \
|
|
n = list_entry(pos->member.prev, typeof(*pos), member); \
|
|
&pos->member != (head); \
|
|
pos = n, n = list_entry(n->member.prev, typeof(*n), member))
|
|
|
|
#endif /*_OSSP_UTIL_H*/
|