Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | //#define LOG_NDEBUG 0 |
| 18 | #define LOG_TAG "audio_utils_fifo" |
| 19 | |
Glenn Kasten | 9052f3b | 2016-07-08 16:24:41 -0700 | [diff] [blame] | 20 | #include <errno.h> |
Glenn Kasten | 0ab1d86 | 2016-06-20 12:04:56 -0700 | [diff] [blame] | 21 | #include <limits.h> |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 22 | #include <stdlib.h> |
| 23 | #include <string.h> |
Glenn Kasten | 9052f3b | 2016-07-08 16:24:41 -0700 | [diff] [blame] | 24 | |
Glenn Kasten | be9f4d8 | 2016-12-01 08:30:21 -0800 | [diff] [blame] | 25 | #include <audio_utils/clock_nanosleep.h> |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 26 | #include <audio_utils/fifo.h> |
Glenn Kasten | be9f4d8 | 2016-12-01 08:30:21 -0800 | [diff] [blame] | 27 | #include <audio_utils/futex.h> |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 28 | #include <audio_utils/roundup.h> |
Logan Chien | 24fcfdd | 2018-04-23 14:42:50 +0800 | [diff] [blame] | 29 | #include <log/log.h> |
Andy Hung | 74213cb | 2018-10-09 13:55:11 -0700 | [diff] [blame] | 30 | #include <system/audio.h> // FALLTHROUGH_INTENDED |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 31 | #include <utils/Errors.h> |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 32 | |
Glenn Kasten | dc1ff1f | 2016-09-02 13:54:59 -0700 | [diff] [blame] | 33 | audio_utils_fifo_base::audio_utils_fifo_base(uint32_t frameCount, |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 34 | audio_utils_fifo_index& writerRear, audio_utils_fifo_index *throttleFront) |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 35 | __attribute__((no_sanitize("integer"))) : |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 36 | mFrameCount(frameCount), mFrameCountP2(roundup(frameCount)), |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 37 | mFudgeFactor(mFrameCountP2 - mFrameCount), |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 38 | // FIXME need an API to configure the sync types |
| 39 | mWriterRear(writerRear), mWriterRearSync(AUDIO_UTILS_FIFO_SYNC_SHARED), |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 40 | mThrottleFront(throttleFront), mThrottleFrontSync(AUDIO_UTILS_FIFO_SYNC_SHARED), |
| 41 | mIsShutdown(false) |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 42 | { |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 43 | // actual upper bound on frameCount will depend on the frame size |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 44 | LOG_ALWAYS_FATAL_IF(frameCount == 0 || frameCount > ((uint32_t) INT32_MAX)); |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 45 | } |
| 46 | |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 47 | audio_utils_fifo_base::~audio_utils_fifo_base() |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 48 | { |
| 49 | } |
| 50 | |
Glenn Kasten | 3f115ba | 2016-11-22 14:00:53 -0800 | [diff] [blame] | 51 | uint32_t audio_utils_fifo_base::sum(uint32_t index, uint32_t increment) const |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 52 | __attribute__((no_sanitize("integer"))) |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 53 | { |
Glenn Kasten | fc3d707 | 2017-03-06 14:58:33 -0800 | [diff] [blame] | 54 | if (mFudgeFactor > 0) { |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 55 | uint32_t mask = mFrameCountP2 - 1; |
| 56 | ALOG_ASSERT((index & mask) < mFrameCount); |
| 57 | ALOG_ASSERT(increment <= mFrameCountP2); |
| 58 | if ((index & mask) + increment >= mFrameCount) { |
| 59 | increment += mFudgeFactor; |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 60 | } |
| 61 | index += increment; |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 62 | ALOG_ASSERT((index & mask) < mFrameCount); |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 63 | return index; |
| 64 | } else { |
| 65 | return index + increment; |
| 66 | } |
| 67 | } |
| 68 | |
Glenn Kasten | 8c5518a | 2017-04-17 16:34:38 -0700 | [diff] [blame] | 69 | int32_t audio_utils_fifo_base::diff(uint32_t rear, uint32_t front, size_t *lost, bool flush) const |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 70 | __attribute__((no_sanitize("integer"))) |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 71 | { |
Glenn Kasten | 44001d4 | 2016-10-19 15:46:02 -0700 | [diff] [blame] | 72 | // TODO replace multiple returns by a single return point so this isn't needed |
| 73 | if (lost != NULL) { |
| 74 | *lost = 0; |
| 75 | } |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 76 | if (mIsShutdown) { |
| 77 | return -EIO; |
| 78 | } |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 79 | uint32_t diff = rear - front; |
Glenn Kasten | fc3d707 | 2017-03-06 14:58:33 -0800 | [diff] [blame] | 80 | if (mFudgeFactor > 0) { |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 81 | uint32_t mask = mFrameCountP2 - 1; |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 82 | uint32_t rearOffset = rear & mask; |
| 83 | uint32_t frontOffset = front & mask; |
| 84 | if (rearOffset >= mFrameCount || frontOffset >= mFrameCount) { |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 85 | ALOGE("%s frontOffset=%u rearOffset=%u mFrameCount=%u", |
| 86 | __func__, frontOffset, rearOffset, mFrameCount); |
| 87 | shutdown(); |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 88 | return -EIO; |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 89 | } |
Glenn Kasten | fc3d707 | 2017-03-06 14:58:33 -0800 | [diff] [blame] | 90 | // genDiff is the difference between the generation count fields of rear and front, |
| 91 | // and is always a multiple of mFrameCountP2. |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 92 | uint32_t genDiff = (rear & ~mask) - (front & ~mask); |
Glenn Kasten | fc3d707 | 2017-03-06 14:58:33 -0800 | [diff] [blame] | 93 | // It's OK for writer to be one generation beyond reader, |
| 94 | // but reader has lost frames if writer is further than one generation beyond. |
| 95 | if (genDiff > mFrameCountP2) { |
| 96 | if (lost != NULL) { |
| 97 | // Calculate the number of lost frames as the raw difference, |
| 98 | // less the mFrameCount frames that are still valid and can be read on retry, |
| 99 | // less the wasted indices that don't count as true lost frames. |
Glenn Kasten | 8c5518a | 2017-04-17 16:34:38 -0700 | [diff] [blame] | 100 | *lost = diff - (flush ? 0 : mFrameCount) - mFudgeFactor * (genDiff/mFrameCountP2); |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 101 | } |
Glenn Kasten | fc3d707 | 2017-03-06 14:58:33 -0800 | [diff] [blame] | 102 | return -EOVERFLOW; |
| 103 | } |
| 104 | // If writer is one generation beyond reader, skip over the wasted indices. |
| 105 | if (genDiff > 0) { |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 106 | diff -= mFudgeFactor; |
Glenn Kasten | fc3d707 | 2017-03-06 14:58:33 -0800 | [diff] [blame] | 107 | // Note is still possible for diff > mFrameCount. BCD 16 - BCD 1 shows the problem. |
| 108 | // genDiff is 16, fudge is 6, decimal diff is 15 = (22 - 1 - 6). |
| 109 | // So we need to check diff for overflow one more time. See "if" a few lines below. |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 110 | } |
| 111 | } |
| 112 | // FIFO should not be overfull |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 113 | if (diff > mFrameCount) { |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 114 | if (lost != NULL) { |
Glenn Kasten | 8c5518a | 2017-04-17 16:34:38 -0700 | [diff] [blame] | 115 | *lost = diff - (flush ? 0 : mFrameCount); |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 116 | } |
| 117 | return -EOVERFLOW; |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 118 | } |
| 119 | return (int32_t) diff; |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 120 | } |
| 121 | |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 122 | void audio_utils_fifo_base::shutdown() const |
| 123 | { |
| 124 | ALOGE("%s", __func__); |
| 125 | mIsShutdown = true; |
| 126 | } |
| 127 | |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 128 | //////////////////////////////////////////////////////////////////////////////// |
| 129 | |
Glenn Kasten | dc1ff1f | 2016-09-02 13:54:59 -0700 | [diff] [blame] | 130 | audio_utils_fifo::audio_utils_fifo(uint32_t frameCount, uint32_t frameSize, void *buffer, |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 131 | audio_utils_fifo_index& writerRear, audio_utils_fifo_index *throttleFront) |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 132 | __attribute__((no_sanitize("integer"))) : |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 133 | audio_utils_fifo_base(frameCount, writerRear, throttleFront), |
Glenn Kasten | dc1ff1f | 2016-09-02 13:54:59 -0700 | [diff] [blame] | 134 | mFrameSize(frameSize), mBuffer(buffer) |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 135 | { |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 136 | // maximum value of frameCount * frameSize is INT32_MAX (2^31 - 1), not 2^31, because we need to |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 137 | // be able to distinguish successful and error return values from read and write. |
Glenn Kasten | 0ab1d86 | 2016-06-20 12:04:56 -0700 | [diff] [blame] | 138 | LOG_ALWAYS_FATAL_IF(frameCount == 0 || frameSize == 0 || buffer == NULL || |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 139 | frameCount > ((uint32_t) INT32_MAX) / frameSize); |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 140 | } |
| 141 | |
Glenn Kasten | dc1ff1f | 2016-09-02 13:54:59 -0700 | [diff] [blame] | 142 | audio_utils_fifo::audio_utils_fifo(uint32_t frameCount, uint32_t frameSize, void *buffer, |
| 143 | bool throttlesWriter) : |
| 144 | audio_utils_fifo(frameCount, frameSize, buffer, mSingleProcessSharedRear, |
| 145 | throttlesWriter ? &mSingleProcessSharedFront : NULL) |
| 146 | { |
| 147 | } |
| 148 | |
Glenn Kasten | 09acf78 | 2016-06-17 10:28:05 -0700 | [diff] [blame] | 149 | audio_utils_fifo::~audio_utils_fifo() |
| 150 | { |
| 151 | } |
| 152 | |
| 153 | //////////////////////////////////////////////////////////////////////////////// |
| 154 | |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 155 | audio_utils_fifo_provider::audio_utils_fifo_provider(audio_utils_fifo& fifo) : |
| 156 | mFifo(fifo), mObtained(0), mTotalReleased(0) |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 157 | { |
| 158 | } |
| 159 | |
| 160 | audio_utils_fifo_provider::~audio_utils_fifo_provider() |
| 161 | { |
| 162 | } |
| 163 | |
| 164 | //////////////////////////////////////////////////////////////////////////////// |
| 165 | |
| 166 | audio_utils_fifo_writer::audio_utils_fifo_writer(audio_utils_fifo& fifo) : |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 167 | audio_utils_fifo_provider(fifo), mLocalRear(0), |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 168 | mArmLevel(fifo.mFrameCount), mTriggerLevel(0), |
| 169 | mIsArmed(true), // because initial fill level of zero is < mArmLevel |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 170 | mEffectiveFrames(fifo.mFrameCount) |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 171 | { |
| 172 | } |
| 173 | |
| 174 | audio_utils_fifo_writer::~audio_utils_fifo_writer() |
| 175 | { |
| 176 | } |
| 177 | |
Glenn Kasten | d9942f7 | 2016-10-16 14:51:15 -0700 | [diff] [blame] | 178 | ssize_t audio_utils_fifo_writer::write(const void *buffer, size_t count, |
| 179 | const struct timespec *timeout) |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 180 | __attribute__((no_sanitize("integer"))) |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 181 | { |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 182 | audio_utils_iovec iovec[2]; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 183 | ssize_t availToWrite = obtain(iovec, count, timeout); |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 184 | if (availToWrite > 0) { |
Glenn Kasten | 169f3a2 | 2016-06-17 10:43:34 -0700 | [diff] [blame] | 185 | memcpy((char *) mFifo.mBuffer + iovec[0].mOffset * mFifo.mFrameSize, buffer, |
| 186 | iovec[0].mLength * mFifo.mFrameSize); |
| 187 | if (iovec[1].mLength > 0) { |
| 188 | memcpy((char *) mFifo.mBuffer + iovec[1].mOffset * mFifo.mFrameSize, |
| 189 | (char *) buffer + (iovec[0].mLength * mFifo.mFrameSize), |
| 190 | iovec[1].mLength * mFifo.mFrameSize); |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 191 | } |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 192 | release(availToWrite); |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 193 | } |
| 194 | return availToWrite; |
| 195 | } |
| 196 | |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 197 | // iovec == NULL is not part of the public API, but internally it means don't set mObtained |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 198 | ssize_t audio_utils_fifo_writer::obtain(audio_utils_iovec iovec[2], size_t count, |
Glenn Kasten | d9942f7 | 2016-10-16 14:51:15 -0700 | [diff] [blame] | 199 | const struct timespec *timeout) |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 200 | __attribute__((no_sanitize("integer"))) |
| 201 | { |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 202 | int err = 0; |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 203 | size_t availToWrite; |
| 204 | if (mFifo.mThrottleFront != NULL) { |
Glenn Kasten | f277a7c | 2016-10-14 08:51:20 -0700 | [diff] [blame] | 205 | int retries = kRetries; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 206 | uint32_t front; |
| 207 | for (;;) { |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 208 | front = mFifo.mThrottleFront->loadAcquire(); |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 209 | // returns -EIO if mIsShutdown |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 210 | int32_t filled = mFifo.diff(mLocalRear, front); |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 211 | if (filled < 0) { |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 212 | // on error, return an empty slice |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 213 | err = filled; |
| 214 | availToWrite = 0; |
| 215 | break; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 216 | } |
| 217 | availToWrite = mEffectiveFrames > (uint32_t) filled ? |
| 218 | mEffectiveFrames - (uint32_t) filled : 0; |
| 219 | // TODO pull out "count == 0" |
| 220 | if (count == 0 || availToWrite > 0 || timeout == NULL || |
| 221 | (timeout->tv_sec == 0 && timeout->tv_nsec == 0)) { |
| 222 | break; |
| 223 | } |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 224 | // TODO add comments |
| 225 | // TODO abstract out switch and replace by general sync object |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 226 | // the high level code (synchronization, sleep, futex, iovec) should be completely |
| 227 | // separate from the low level code (indexes, available, masking). |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 228 | int op = FUTEX_WAIT; |
| 229 | switch (mFifo.mThrottleFrontSync) { |
| 230 | case AUDIO_UTILS_FIFO_SYNC_SLEEP: |
Glenn Kasten | be9f4d8 | 2016-12-01 08:30:21 -0800 | [diff] [blame] | 231 | err = audio_utils_clock_nanosleep(CLOCK_MONOTONIC, 0 /*flags*/, timeout, |
| 232 | NULL /*remain*/); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 233 | if (err < 0) { |
| 234 | LOG_ALWAYS_FATAL_IF(errno != EINTR, "unexpected err=%d errno=%d", err, errno); |
| 235 | err = -errno; |
| 236 | } else { |
| 237 | err = -ETIMEDOUT; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 238 | } |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 239 | break; |
| 240 | case AUDIO_UTILS_FIFO_SYNC_PRIVATE: |
| 241 | op = FUTEX_WAIT_PRIVATE; |
Andy Hung | 74213cb | 2018-10-09 13:55:11 -0700 | [diff] [blame] | 242 | FALLTHROUGH_INTENDED; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 243 | case AUDIO_UTILS_FIFO_SYNC_SHARED: |
| 244 | if (timeout->tv_sec == LONG_MAX) { |
| 245 | timeout = NULL; |
| 246 | } |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 247 | err = mFifo.mThrottleFront->wait(op, front, timeout); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 248 | if (err < 0) { |
| 249 | switch (errno) { |
Glenn Kasten | f277a7c | 2016-10-14 08:51:20 -0700 | [diff] [blame] | 250 | case EWOULDBLOCK: |
Glenn Kasten | 7cabff9 | 2016-10-19 11:13:55 -0700 | [diff] [blame] | 251 | // Benign race condition with partner: mFifo.mThrottleFront->mIndex |
| 252 | // changed value between the earlier atomic_load_explicit() and sys_futex(). |
| 253 | // Try to load index again, but give up if we are unable to converge. |
Glenn Kasten | f277a7c | 2016-10-14 08:51:20 -0700 | [diff] [blame] | 254 | if (retries-- > 0) { |
| 255 | // bypass the "timeout = NULL;" below |
| 256 | continue; |
| 257 | } |
Andy Hung | 74213cb | 2018-10-09 13:55:11 -0700 | [diff] [blame] | 258 | FALLTHROUGH_INTENDED; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 259 | case EINTR: |
| 260 | case ETIMEDOUT: |
| 261 | err = -errno; |
| 262 | break; |
| 263 | default: |
| 264 | LOG_ALWAYS_FATAL("unexpected err=%d errno=%d", err, errno); |
| 265 | break; |
| 266 | } |
| 267 | } |
| 268 | break; |
| 269 | default: |
| 270 | LOG_ALWAYS_FATAL("mFifo.mThrottleFrontSync=%d", mFifo.mThrottleFrontSync); |
| 271 | break; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 272 | } |
| 273 | timeout = NULL; |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 274 | } |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 275 | } else { |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 276 | if (mFifo.mIsShutdown) { |
| 277 | err = -EIO; |
| 278 | availToWrite = 0; |
| 279 | } else { |
| 280 | availToWrite = mEffectiveFrames; |
| 281 | } |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 282 | } |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 283 | if (availToWrite > count) { |
| 284 | availToWrite = count; |
| 285 | } |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 286 | uint32_t rearOffset = mLocalRear & (mFifo.mFrameCountP2 - 1); |
| 287 | size_t part1 = mFifo.mFrameCount - rearOffset; |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 288 | if (part1 > availToWrite) { |
| 289 | part1 = availToWrite; |
| 290 | } |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 291 | size_t part2 = part1 > 0 ? availToWrite - part1 : 0; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 292 | // return slice |
| 293 | if (iovec != NULL) { |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 294 | iovec[0].mOffset = rearOffset; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 295 | iovec[0].mLength = part1; |
| 296 | iovec[1].mOffset = 0; |
| 297 | iovec[1].mLength = part2; |
| 298 | mObtained = availToWrite; |
| 299 | } |
| 300 | return availToWrite > 0 ? availToWrite : err; |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 301 | } |
| 302 | |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 303 | void audio_utils_fifo_writer::release(size_t count) |
| 304 | __attribute__((no_sanitize("integer"))) |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 305 | { |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 306 | // no need to do an early check for mIsShutdown, because the extra code executed is harmless |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 307 | if (count > 0) { |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 308 | if (count > mObtained) { |
| 309 | ALOGE("%s(count=%zu) > mObtained=%u", __func__, count, mObtained); |
| 310 | mFifo.shutdown(); |
| 311 | return; |
| 312 | } |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 313 | if (mFifo.mThrottleFront != NULL) { |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 314 | uint32_t front = mFifo.mThrottleFront->loadAcquire(); |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 315 | // returns -EIO if mIsShutdown |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 316 | int32_t filled = mFifo.diff(mLocalRear, front); |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 317 | mLocalRear = mFifo.sum(mLocalRear, count); |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 318 | mFifo.mWriterRear.storeRelease(mLocalRear); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 319 | // TODO add comments |
| 320 | int op = FUTEX_WAKE; |
| 321 | switch (mFifo.mWriterRearSync) { |
| 322 | case AUDIO_UTILS_FIFO_SYNC_SLEEP: |
| 323 | break; |
| 324 | case AUDIO_UTILS_FIFO_SYNC_PRIVATE: |
| 325 | op = FUTEX_WAKE_PRIVATE; |
Andy Hung | 74213cb | 2018-10-09 13:55:11 -0700 | [diff] [blame] | 326 | FALLTHROUGH_INTENDED; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 327 | case AUDIO_UTILS_FIFO_SYNC_SHARED: |
| 328 | if (filled >= 0) { |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 329 | if ((uint32_t) filled < mArmLevel) { |
| 330 | mIsArmed = true; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 331 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 332 | if (mIsArmed && filled + count > mTriggerLevel) { |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 333 | int err = mFifo.mWriterRear.wake(op, INT32_MAX /*waiters*/); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 334 | // err is number of processes woken up |
| 335 | if (err < 0) { |
| 336 | LOG_ALWAYS_FATAL("%s: unexpected err=%d errno=%d", |
| 337 | __func__, err, errno); |
| 338 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 339 | mIsArmed = false; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 340 | } |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 341 | } |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 342 | break; |
| 343 | default: |
| 344 | LOG_ALWAYS_FATAL("mFifo.mWriterRearSync=%d", mFifo.mWriterRearSync); |
| 345 | break; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 346 | } |
| 347 | } else { |
| 348 | mLocalRear = mFifo.sum(mLocalRear, count); |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 349 | mFifo.mWriterRear.storeRelease(mLocalRear); |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 350 | } |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 351 | mObtained -= count; |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 352 | mTotalReleased += count; |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 353 | } |
| 354 | } |
| 355 | |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 356 | ssize_t audio_utils_fifo_writer::available() |
| 357 | { |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 358 | // iovec == NULL is not part of the public API, but internally it means don't set mObtained |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 359 | return obtain(NULL /*iovec*/, SIZE_MAX /*count*/, NULL /*timeout*/); |
| 360 | } |
| 361 | |
| 362 | void audio_utils_fifo_writer::resize(uint32_t frameCount) |
| 363 | { |
| 364 | // cap to range [0, mFifo.mFrameCount] |
| 365 | if (frameCount > mFifo.mFrameCount) { |
| 366 | frameCount = mFifo.mFrameCount; |
| 367 | } |
| 368 | // if we reduce the effective frame count, update hysteresis points to be within the new range |
| 369 | if (frameCount < mEffectiveFrames) { |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 370 | if (mArmLevel > frameCount) { |
| 371 | mArmLevel = frameCount; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 372 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 373 | if (mTriggerLevel > frameCount) { |
| 374 | mTriggerLevel = frameCount; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 375 | } |
| 376 | } |
| 377 | mEffectiveFrames = frameCount; |
| 378 | } |
| 379 | |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 380 | uint32_t audio_utils_fifo_writer::size() const |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 381 | { |
| 382 | return mEffectiveFrames; |
| 383 | } |
| 384 | |
| 385 | void audio_utils_fifo_writer::setHysteresis(uint32_t lowLevelArm, uint32_t highLevelTrigger) |
| 386 | { |
| 387 | // cap to range [0, mEffectiveFrames] |
| 388 | if (lowLevelArm > mEffectiveFrames) { |
| 389 | lowLevelArm = mEffectiveFrames; |
| 390 | } |
| 391 | if (highLevelTrigger > mEffectiveFrames) { |
| 392 | highLevelTrigger = mEffectiveFrames; |
| 393 | } |
| 394 | // TODO this is overly conservative; it would be better to arm based on actual fill level |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 395 | if (lowLevelArm > mArmLevel) { |
| 396 | mIsArmed = true; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 397 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 398 | mArmLevel = lowLevelArm; |
| 399 | mTriggerLevel = highLevelTrigger; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 400 | } |
| 401 | |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 402 | void audio_utils_fifo_writer::getHysteresis(uint32_t *armLevel, uint32_t *triggerLevel) const |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 403 | { |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 404 | *armLevel = mArmLevel; |
| 405 | *triggerLevel = mTriggerLevel; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 406 | } |
| 407 | |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 408 | //////////////////////////////////////////////////////////////////////////////// |
| 409 | |
Glenn Kasten | 8c5518a | 2017-04-17 16:34:38 -0700 | [diff] [blame] | 410 | audio_utils_fifo_reader::audio_utils_fifo_reader(audio_utils_fifo& fifo, bool throttlesWriter, |
| 411 | bool flush) : |
Glenn Kasten | 2f99531 | 2016-12-16 12:42:26 -0800 | [diff] [blame] | 412 | audio_utils_fifo_provider(fifo), |
| 413 | |
| 414 | // If we throttle the writer, then initialize our front index to zero so that we see all data |
| 415 | // currently in the buffer. |
| 416 | // Otherwise, ignore everything currently in the buffer by initializing our front index to the |
| 417 | // current value of writer's rear. This avoids an immediate -EOVERFLOW (overrun) in the case |
| 418 | // where reader starts out more than one buffer behind writer. The initial catch-up does not |
| 419 | // contribute towards the totalLost, totalFlushed, or totalReleased counters. |
| 420 | mLocalFront(throttlesWriter ? 0 : mFifo.mWriterRear.loadConsume()), |
| 421 | |
Glenn Kasten | dc1ff1f | 2016-09-02 13:54:59 -0700 | [diff] [blame] | 422 | mThrottleFront(throttlesWriter ? mFifo.mThrottleFront : NULL), |
Glenn Kasten | 8c5518a | 2017-04-17 16:34:38 -0700 | [diff] [blame] | 423 | mFlush(flush), |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 424 | mArmLevel(-1), mTriggerLevel(mFifo.mFrameCount), |
| 425 | mIsArmed(true), // because initial fill level of zero is > mArmLevel |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 426 | mTotalLost(0), mTotalFlushed(0) |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 427 | { |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 428 | } |
| 429 | |
| 430 | audio_utils_fifo_reader::~audio_utils_fifo_reader() |
| 431 | { |
Glenn Kasten | 0ab1d86 | 2016-06-20 12:04:56 -0700 | [diff] [blame] | 432 | // TODO Need a way to pass throttle capability to the another reader, should one reader exit. |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 433 | } |
| 434 | |
Glenn Kasten | d9942f7 | 2016-10-16 14:51:15 -0700 | [diff] [blame] | 435 | ssize_t audio_utils_fifo_reader::read(void *buffer, size_t count, const struct timespec *timeout, |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 436 | size_t *lost) |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 437 | __attribute__((no_sanitize("integer"))) |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 438 | { |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 439 | audio_utils_iovec iovec[2]; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 440 | ssize_t availToRead = obtain(iovec, count, timeout, lost); |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 441 | if (availToRead > 0) { |
Glenn Kasten | 169f3a2 | 2016-06-17 10:43:34 -0700 | [diff] [blame] | 442 | memcpy(buffer, (char *) mFifo.mBuffer + iovec[0].mOffset * mFifo.mFrameSize, |
| 443 | iovec[0].mLength * mFifo.mFrameSize); |
| 444 | if (iovec[1].mLength > 0) { |
| 445 | memcpy((char *) buffer + (iovec[0].mLength * mFifo.mFrameSize), |
| 446 | (char *) mFifo.mBuffer + iovec[1].mOffset * mFifo.mFrameSize, |
| 447 | iovec[1].mLength * mFifo.mFrameSize); |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 448 | } |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 449 | release(availToRead); |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 450 | } |
| 451 | return availToRead; |
| 452 | } |
| 453 | |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 454 | ssize_t audio_utils_fifo_reader::obtain(audio_utils_iovec iovec[2], size_t count, |
Glenn Kasten | d9942f7 | 2016-10-16 14:51:15 -0700 | [diff] [blame] | 455 | const struct timespec *timeout) |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 456 | __attribute__((no_sanitize("integer"))) |
| 457 | { |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 458 | return obtain(iovec, count, timeout, NULL /*lost*/); |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 459 | } |
| 460 | |
| 461 | void audio_utils_fifo_reader::release(size_t count) |
| 462 | __attribute__((no_sanitize("integer"))) |
| 463 | { |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 464 | // no need to do an early check for mIsShutdown, because the extra code executed is harmless |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 465 | if (count > 0) { |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 466 | if (count > mObtained) { |
| 467 | ALOGE("%s(count=%zu) > mObtained=%u", __func__, count, mObtained); |
| 468 | mFifo.shutdown(); |
| 469 | return; |
| 470 | } |
Glenn Kasten | dc1ff1f | 2016-09-02 13:54:59 -0700 | [diff] [blame] | 471 | if (mThrottleFront != NULL) { |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 472 | uint32_t rear = mFifo.mWriterRear.loadAcquire(); |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 473 | // returns -EIO if mIsShutdown |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 474 | int32_t filled = mFifo.diff(rear, mLocalFront); |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 475 | mLocalFront = mFifo.sum(mLocalFront, count); |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 476 | mThrottleFront->storeRelease(mLocalFront); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 477 | // TODO add comments |
| 478 | int op = FUTEX_WAKE; |
| 479 | switch (mFifo.mThrottleFrontSync) { |
| 480 | case AUDIO_UTILS_FIFO_SYNC_SLEEP: |
| 481 | break; |
| 482 | case AUDIO_UTILS_FIFO_SYNC_PRIVATE: |
| 483 | op = FUTEX_WAKE_PRIVATE; |
Andy Hung | 74213cb | 2018-10-09 13:55:11 -0700 | [diff] [blame] | 484 | FALLTHROUGH_INTENDED; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 485 | case AUDIO_UTILS_FIFO_SYNC_SHARED: |
| 486 | if (filled >= 0) { |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 487 | if (filled > mArmLevel) { |
| 488 | mIsArmed = true; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 489 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 490 | if (mIsArmed && filled - count < mTriggerLevel) { |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 491 | int err = mThrottleFront->wake(op, 1 /*waiters*/); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 492 | // err is number of processes woken up |
| 493 | if (err < 0 || err > 1) { |
| 494 | LOG_ALWAYS_FATAL("%s: unexpected err=%d errno=%d", |
| 495 | __func__, err, errno); |
| 496 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 497 | mIsArmed = false; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 498 | } |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 499 | } |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 500 | break; |
| 501 | default: |
| 502 | LOG_ALWAYS_FATAL("mFifo.mThrottleFrontSync=%d", mFifo.mThrottleFrontSync); |
| 503 | break; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 504 | } |
| 505 | } else { |
| 506 | mLocalFront = mFifo.sum(mLocalFront, count); |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 507 | } |
| 508 | mObtained -= count; |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 509 | mTotalReleased += count; |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 510 | } |
| 511 | } |
| 512 | |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 513 | // iovec == NULL is not part of the public API, but internally it means don't set mObtained |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 514 | ssize_t audio_utils_fifo_reader::obtain(audio_utils_iovec iovec[2], size_t count, |
Glenn Kasten | d9942f7 | 2016-10-16 14:51:15 -0700 | [diff] [blame] | 515 | const struct timespec *timeout, size_t *lost) |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 516 | __attribute__((no_sanitize("integer"))) |
| 517 | { |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 518 | int err = 0; |
Glenn Kasten | f277a7c | 2016-10-14 08:51:20 -0700 | [diff] [blame] | 519 | int retries = kRetries; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 520 | uint32_t rear; |
| 521 | for (;;) { |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 522 | rear = mFifo.mWriterRear.loadAcquire(); |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 523 | // TODO pull out "count == 0" |
| 524 | if (count == 0 || rear != mLocalFront || timeout == NULL || |
| 525 | (timeout->tv_sec == 0 && timeout->tv_nsec == 0)) { |
| 526 | break; |
| 527 | } |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 528 | // TODO add comments |
| 529 | int op = FUTEX_WAIT; |
| 530 | switch (mFifo.mWriterRearSync) { |
| 531 | case AUDIO_UTILS_FIFO_SYNC_SLEEP: |
Glenn Kasten | be9f4d8 | 2016-12-01 08:30:21 -0800 | [diff] [blame] | 532 | err = audio_utils_clock_nanosleep(CLOCK_MONOTONIC, 0 /*flags*/, timeout, |
| 533 | NULL /*remain*/); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 534 | if (err < 0) { |
| 535 | LOG_ALWAYS_FATAL_IF(errno != EINTR, "unexpected err=%d errno=%d", err, errno); |
| 536 | err = -errno; |
| 537 | } else { |
| 538 | err = -ETIMEDOUT; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 539 | } |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 540 | break; |
| 541 | case AUDIO_UTILS_FIFO_SYNC_PRIVATE: |
| 542 | op = FUTEX_WAIT_PRIVATE; |
Andy Hung | 74213cb | 2018-10-09 13:55:11 -0700 | [diff] [blame] | 543 | FALLTHROUGH_INTENDED; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 544 | case AUDIO_UTILS_FIFO_SYNC_SHARED: |
| 545 | if (timeout->tv_sec == LONG_MAX) { |
| 546 | timeout = NULL; |
| 547 | } |
Glenn Kasten | 7cc8f54 | 2016-12-01 16:12:59 -0800 | [diff] [blame] | 548 | err = mFifo.mWriterRear.wait(op, rear, timeout); |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 549 | if (err < 0) { |
| 550 | switch (errno) { |
Glenn Kasten | f277a7c | 2016-10-14 08:51:20 -0700 | [diff] [blame] | 551 | case EWOULDBLOCK: |
Glenn Kasten | 7cabff9 | 2016-10-19 11:13:55 -0700 | [diff] [blame] | 552 | // Benign race condition with partner: mFifo.mWriterRear->mIndex |
| 553 | // changed value between the earlier atomic_load_explicit() and sys_futex(). |
| 554 | // Try to load index again, but give up if we are unable to converge. |
Glenn Kasten | f277a7c | 2016-10-14 08:51:20 -0700 | [diff] [blame] | 555 | if (retries-- > 0) { |
| 556 | // bypass the "timeout = NULL;" below |
| 557 | continue; |
| 558 | } |
Andy Hung | 74213cb | 2018-10-09 13:55:11 -0700 | [diff] [blame] | 559 | FALLTHROUGH_INTENDED; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 560 | case EINTR: |
| 561 | case ETIMEDOUT: |
| 562 | err = -errno; |
| 563 | break; |
| 564 | default: |
| 565 | LOG_ALWAYS_FATAL("unexpected err=%d errno=%d", err, errno); |
| 566 | break; |
| 567 | } |
| 568 | } |
| 569 | break; |
| 570 | default: |
| 571 | LOG_ALWAYS_FATAL("mFifo.mWriterRearSync=%d", mFifo.mWriterRearSync); |
| 572 | break; |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 573 | } |
| 574 | timeout = NULL; |
| 575 | } |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 576 | size_t ourLost; |
| 577 | if (lost == NULL) { |
| 578 | lost = &ourLost; |
| 579 | } |
Glenn Kasten | 0b2947b | 2016-11-22 14:00:23 -0800 | [diff] [blame] | 580 | // returns -EIO if mIsShutdown |
Glenn Kasten | 8c5518a | 2017-04-17 16:34:38 -0700 | [diff] [blame] | 581 | int32_t filled = mFifo.diff(rear, mLocalFront, lost, mFlush); |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 582 | mTotalLost += *lost; |
| 583 | mTotalReleased += *lost; |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 584 | if (filled < 0) { |
Glenn Kasten | 3ddacbb | 2016-06-20 14:41:03 -0700 | [diff] [blame] | 585 | if (filled == -EOVERFLOW) { |
Glenn Kasten | fc3d707 | 2017-03-06 14:58:33 -0800 | [diff] [blame] | 586 | // catch up with writer, but preserve the still valid frames in buffer |
Glenn Kasten | 8c5518a | 2017-04-17 16:34:38 -0700 | [diff] [blame] | 587 | mLocalFront = rear - (mFlush ? 0 : mFifo.mFrameCountP2 /*sic*/); |
Glenn Kasten | 6d7ad76 | 2016-06-15 17:05:54 -0700 | [diff] [blame] | 588 | } |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 589 | // on error, return an empty slice |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 590 | err = filled; |
| 591 | filled = 0; |
Glenn Kasten | 9b4fe47 | 2016-06-13 09:34:57 -0700 | [diff] [blame] | 592 | } |
| 593 | size_t availToRead = (size_t) filled; |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 594 | if (availToRead > count) { |
| 595 | availToRead = count; |
| 596 | } |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 597 | uint32_t frontOffset = mLocalFront & (mFifo.mFrameCountP2 - 1); |
| 598 | size_t part1 = mFifo.mFrameCount - frontOffset; |
Glenn Kasten | 9b4c805 | 2015-01-06 14:13:13 -0800 | [diff] [blame] | 599 | if (part1 > availToRead) { |
| 600 | part1 = availToRead; |
| 601 | } |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 602 | size_t part2 = part1 > 0 ? availToRead - part1 : 0; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 603 | // return slice |
| 604 | if (iovec != NULL) { |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 605 | iovec[0].mOffset = frontOffset; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 606 | iovec[0].mLength = part1; |
| 607 | iovec[1].mOffset = 0; |
| 608 | iovec[1].mLength = part2; |
| 609 | mObtained = availToRead; |
| 610 | } |
| 611 | return availToRead > 0 ? availToRead : err; |
| 612 | } |
| 613 | |
| 614 | ssize_t audio_utils_fifo_reader::available() |
| 615 | { |
| 616 | return available(NULL /*lost*/); |
| 617 | } |
| 618 | |
| 619 | ssize_t audio_utils_fifo_reader::available(size_t *lost) |
| 620 | { |
Glenn Kasten | 9ddeb2c | 2016-10-14 08:49:02 -0700 | [diff] [blame] | 621 | // iovec == NULL is not part of the public API, but internally it means don't set mObtained |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 622 | return obtain(NULL /*iovec*/, SIZE_MAX /*count*/, NULL /*timeout*/, lost); |
| 623 | } |
| 624 | |
Glenn Kasten | 0f85039 | 2016-10-19 12:14:46 -0700 | [diff] [blame] | 625 | ssize_t audio_utils_fifo_reader::flush(size_t *lost) |
| 626 | { |
| 627 | audio_utils_iovec iovec[2]; |
| 628 | ssize_t ret = obtain(iovec, SIZE_MAX /*count*/, NULL /*timeout*/, lost); |
| 629 | if (ret > 0) { |
| 630 | size_t flushed = (size_t) ret; |
| 631 | release(flushed); |
| 632 | mTotalFlushed += flushed; |
| 633 | ret = flushed; |
| 634 | } |
| 635 | return ret; |
| 636 | } |
| 637 | |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 638 | void audio_utils_fifo_reader::setHysteresis(int32_t armLevel, uint32_t triggerLevel) |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 639 | { |
| 640 | // cap to range [0, mFifo.mFrameCount] |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 641 | if (armLevel < 0) { |
| 642 | armLevel = -1; |
| 643 | } else if ((uint32_t) armLevel > mFifo.mFrameCount) { |
| 644 | armLevel = mFifo.mFrameCount; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 645 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 646 | if (triggerLevel > mFifo.mFrameCount) { |
| 647 | triggerLevel = mFifo.mFrameCount; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 648 | } |
| 649 | // TODO this is overly conservative; it would be better to arm based on actual fill level |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 650 | if (armLevel < mArmLevel) { |
| 651 | mIsArmed = true; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 652 | } |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 653 | mArmLevel = armLevel; |
| 654 | mTriggerLevel = triggerLevel; |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 655 | } |
| 656 | |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 657 | void audio_utils_fifo_reader::getHysteresis(int32_t *armLevel, uint32_t *triggerLevel) const |
Glenn Kasten | c0924bc | 2016-10-02 13:00:19 -0700 | [diff] [blame] | 658 | { |
Glenn Kasten | b9652ab | 2016-11-18 13:34:01 -0800 | [diff] [blame] | 659 | *armLevel = mArmLevel; |
| 660 | *triggerLevel = mTriggerLevel; |
Glenn Kasten | 547a992 | 2016-06-15 13:07:31 -0700 | [diff] [blame] | 661 | } |