audio_utils/fifo.cpp

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */

//#define LOG_NDEBUG 0
#define LOG_TAG "audio_utils_fifo"

#include <stdlib.h>
#include <string.h>
#include <audio_utils/fifo.h>
#include <audio_utils/roundup.h>
#include <cutils/log.h>
#include <utils/Errors.h>

audio_utils_fifo::audio_utils_fifo(uint32_t frameCount, uint32_t frameSize, void *buffer) :
    mFrameCount(frameCount), mFrameCountP2(roundup(frameCount)),
    mFudgeFactor(mFrameCountP2 - mFrameCount), mFrameSize(frameSize), mBuffer(buffer),
    mLocalFront(0), mLocalRear(0), mSharedFront(0), mSharedRear(0),
    mReadObtained(0), mWriteObtained(0)
{
    // maximum value of frameCount * frameSize is INT_MAX (2^31 - 1), not 2^31, because we need to
    // be able to distinguish successful and error return values from read and write.
    ALOG_ASSERT(frameCount > 0 && frameSize > 0 && buffer != NULL &&
            frameCount <= ((uint32_t) INT_MAX) / frameSize);
}

audio_utils_fifo::~audio_utils_fifo()
{
}

uint32_t audio_utils_fifo::sum(uint32_t index, uint32_t increment)
        __attribute__((no_sanitize("integer")))
{
    if (mFudgeFactor) {
        uint32_t mask = mFrameCountP2 - 1;
        ALOG_ASSERT((index & mask) < mFrameCount);
        ALOG_ASSERT(increment <= mFrameCountP2);
        if ((index & mask) + increment >= mFrameCount) {
            increment += mFudgeFactor;
        }
        index += increment;
        ALOG_ASSERT((index & mask) < mFrameCount);
        return index;
    } else {
        return index + increment;
    }
}

int32_t audio_utils_fifo::diff(uint32_t rear, uint32_t front)
        __attribute__((no_sanitize("integer")))
{
    uint32_t diff = rear - front;
    if (mFudgeFactor) {
        uint32_t mask = mFrameCountP2 - 1;
        uint32_t rearMasked = rear & mask;
        uint32_t frontMasked = front & mask;
        if (rearMasked >= mFrameCount || frontMasked >= mFrameCount) {
            return (int32_t) android::UNKNOWN_ERROR;
        }
        uint32_t genDiff = (rear & ~mask) - (front & ~mask);
        if (genDiff != 0) {
            if (genDiff > mFrameCountP2) {
                return (int32_t) android::UNKNOWN_ERROR;
            }
            diff -= mFudgeFactor;
        }
    }
    // FIFO should not be overfull
    if (diff > mFrameCount) {
        return (int32_t) android::UNKNOWN_ERROR;
    }
    return (int32_t) diff;
}

ssize_t audio_utils_fifo::write(const void *buffer, size_t count)
        __attribute__((no_sanitize("integer")))
{
    audio_utils_iovec iovec[2];
    ssize_t availToWrite = writeObtain(iovec, count);
    if (availToWrite > 0) {
        memcpy(iovec[0].mBase, buffer, iovec[0].mLen * mFrameSize);
        if (iovec[1].mLen > 0) {
            memcpy(iovec[1].mBase, (char *) buffer + (iovec[0].mLen * mFrameSize),
                    iovec[1].mLen * mFrameSize);
        }
        writeRelease(availToWrite);
    }
    return availToWrite;
}

ssize_t audio_utils_fifo::writeObtain(audio_utils_iovec iovec[2], size_t count)
        __attribute__((no_sanitize("integer")))
{
    uint32_t front = (uint32_t) atomic_load_explicit(&mSharedFront, std::memory_order_acquire);
    uint32_t rear = mLocalRear;
    int32_t filled = diff(rear, front);
    if (filled < 0) {
        mWriteObtained = 0;
        return (ssize_t) filled;
    }
    size_t availToWrite = (size_t) mFrameCount - (size_t) filled;
    if (availToWrite > count) {
        availToWrite = count;
    }
    uint32_t rearMasked = rear & (mFrameCountP2 - 1);
    size_t part1 = mFrameCount - rearMasked;
    if (part1 > availToWrite) {
        part1 = availToWrite;
    }
    size_t part2 = part1 > 0 ? availToWrite - part1 : 0;
    iovec[0].mLen = part1;
    iovec[0].mBase = part1 > 0 ? (char *) mBuffer + (rearMasked * mFrameSize) : NULL;
    iovec[1].mLen = part2;
    iovec[1].mBase = part2 > 0 ? mBuffer : NULL;
    mWriteObtained = availToWrite;
    return availToWrite;
}

void audio_utils_fifo::writeRelease(size_t count)
{
    if (count > 0) {
        ALOG_ASSERT(count <= mWriteObtained);
        mLocalRear = sum(mLocalRear, count);
        atomic_store_explicit(&mSharedRear, (uint_fast32_t) mLocalRear,
                std::memory_order_release);
        mWriteObtained -= count;
    }
}

ssize_t audio_utils_fifo::read(void *buffer, size_t count)
        __attribute__((no_sanitize("integer")))
{
    audio_utils_iovec iovec[2];
    ssize_t availToRead = readObtain(iovec, count);
    if (availToRead > 0) {
        memcpy(buffer, iovec[0].mBase, iovec[0].mLen * mFrameSize);
        if (iovec[1].mLen > 0) {
            memcpy((char *) buffer + (iovec[0].mLen * mFrameSize), iovec[1].mBase,
                    iovec[1].mLen * mFrameSize);
        }
        readRelease(availToRead);
    }
    return availToRead;
}

ssize_t audio_utils_fifo::readObtain(audio_utils_iovec iovec[2], size_t count)
        __attribute__((no_sanitize("integer")))
{
    uint32_t rear = (uint32_t) atomic_load_explicit(&mSharedRear, std::memory_order_acquire);
    uint32_t front = mLocalFront;
    int32_t filled = diff(rear, front);
    if (filled < 0) {
        mReadObtained = 0;
        return (ssize_t) filled;
    }
    size_t availToRead = (size_t) filled;
    if (availToRead > count) {
        availToRead = count;
    }
    uint32_t frontMasked = front & (mFrameCountP2 - 1);
    size_t part1 = mFrameCount - frontMasked;
    if (part1 > availToRead) {
        part1 = availToRead;
    }
    size_t part2 = part1 > 0 ? availToRead - part1 : 0;
    iovec[0].mLen = part1;
    iovec[0].mBase = part1 > 0 ? (char *) mBuffer + (frontMasked * mFrameSize) : NULL;
    iovec[1].mLen = part2;
    iovec[1].mBase = part2 > 0 ? mBuffer : NULL;
    mReadObtained = availToRead;
    return availToRead;
}

void audio_utils_fifo::readRelease(size_t count)
{
    if (count > 0) {
        ALOG_ASSERT(count <= mReadObtained);
        mLocalFront = sum(mLocalFront, count);
        atomic_store_explicit(&mSharedFront, (uint_fast32_t) mLocalFront,
                std::memory_order_release);
        mReadObtained -= count;
    }
}