mpmc_queue.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019, 2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
/*
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * ---
 *
 * Copyright (C) 2010-2011 Dmitry Vyukov
 * Copyright (C) 2017, 2019 Robin Gareus <robin@gareus.org>
 *
 * This program 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 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * ---
 */
 
#ifndef __UTILS_MPMC_QUEUE_H__
#define __UTILS_MPMC_QUEUE_H__
 
#include <stddef.h>
 
#define MPMC_USE_STD_ATOMIC 1
 
#if MPMC_USE_STD_ATOMIC
#  include <stdatomic.h>
#  define MPMC_QUEUE_TYPE atomic_uint
#else
#  include <glib.h>
#  define MPMC_QUEUE_TYPE guint
#endif
 
typedef struct cell_t
{
  MPMC_QUEUE_TYPE sequence;
  void *          data;
} cell_t;
 
typedef struct MPMCQueue
{
  char            pad0[64];
  cell_t *        buffer;
  size_t          buffer_mask;
  char            pad1[64 - sizeof (cell_t *) - sizeof (size_t)];
  MPMC_QUEUE_TYPE enqueue_pos;
  char            pad2[64 - sizeof (size_t)];
  MPMC_QUEUE_TYPE dequeue_pos;
  char            pad3[64 - sizeof (size_t)];
 
} MPMCQueue;
 
MPMCQueue *
mpmc_queue_new (void);
 
NONNULL void
mpmc_queue_reserve (MPMCQueue * self, size_t buffer_size);
 
NONNULL void
mpmc_queue_free (MPMCQueue * self);
 
NONNULL void
mpmc_queue_clear (MPMCQueue * self);
 
HOT NONNULL int
mpmc_queue_push_back (MPMCQueue * self, void * const data);
 
HOT NONNULL int
mpmc_queue_dequeue (MPMCQueue * self, void ** data);
 
#endif