mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/SingletonPtr.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 158:1c57384330a6 4 /**
AnnaBridge 158:1c57384330a6 5 * \defgroup platform_SingletonPtr SingletonPtr class
AnnaBridge 158:1c57384330a6 6 * @{
AnnaBridge 158:1c57384330a6 7 */
AnnaBridge 156:ff21514d8981 8 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 9 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 12 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 13 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 14 *
AnnaBridge 156:ff21514d8981 15 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 16 *
AnnaBridge 156:ff21514d8981 17 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 18 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 20 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 21 * limitations under the License.
AnnaBridge 156:ff21514d8981 22 */
AnnaBridge 156:ff21514d8981 23 #ifndef SINGLETONPTR_H
AnnaBridge 156:ff21514d8981 24 #define SINGLETONPTR_H
AnnaBridge 156:ff21514d8981 25
AnnaBridge 156:ff21514d8981 26 #include <stdint.h>
AnnaBridge 156:ff21514d8981 27 #include <new>
AnnaBridge 156:ff21514d8981 28 #include "platform/mbed_assert.h"
AnnaBridge 156:ff21514d8981 29 #ifdef MBED_CONF_RTOS_PRESENT
AnnaBridge 156:ff21514d8981 30 #include "cmsis_os2.h"
AnnaBridge 156:ff21514d8981 31 #endif
AnnaBridge 156:ff21514d8981 32
AnnaBridge 156:ff21514d8981 33 #ifdef MBED_CONF_RTOS_PRESENT
AnnaBridge 156:ff21514d8981 34 extern osMutexId_t singleton_mutex_id;
AnnaBridge 156:ff21514d8981 35 #endif
AnnaBridge 156:ff21514d8981 36
AnnaBridge 156:ff21514d8981 37 /** Lock the singleton mutex
AnnaBridge 156:ff21514d8981 38 *
AnnaBridge 156:ff21514d8981 39 * This function is typically used to provide
AnnaBridge 156:ff21514d8981 40 * exclusive access when initializing a
AnnaBridge 156:ff21514d8981 41 * global object.
AnnaBridge 156:ff21514d8981 42 */
AnnaBridge 156:ff21514d8981 43 inline static void singleton_lock(void)
AnnaBridge 156:ff21514d8981 44 {
AnnaBridge 156:ff21514d8981 45 #ifdef MBED_CONF_RTOS_PRESENT
AnnaBridge 171:3a7713b1edbc 46 if (!singleton_mutex_id) {
AnnaBridge 171:3a7713b1edbc 47 // RTOS has not booted yet so no mutex is needed
AnnaBridge 171:3a7713b1edbc 48 return;
AnnaBridge 171:3a7713b1edbc 49 }
AnnaBridge 156:ff21514d8981 50 osMutexAcquire(singleton_mutex_id, osWaitForever);
AnnaBridge 156:ff21514d8981 51 #endif
AnnaBridge 156:ff21514d8981 52 }
AnnaBridge 156:ff21514d8981 53
AnnaBridge 156:ff21514d8981 54 /** Unlock the singleton mutex
AnnaBridge 156:ff21514d8981 55 *
AnnaBridge 156:ff21514d8981 56 * This function is typically used to provide
AnnaBridge 156:ff21514d8981 57 * exclusive access when initializing a
AnnaBridge 156:ff21514d8981 58 * global object.
AnnaBridge 156:ff21514d8981 59 */
AnnaBridge 156:ff21514d8981 60 inline static void singleton_unlock(void)
AnnaBridge 156:ff21514d8981 61 {
AnnaBridge 156:ff21514d8981 62 #ifdef MBED_CONF_RTOS_PRESENT
AnnaBridge 171:3a7713b1edbc 63 if (!singleton_mutex_id) {
AnnaBridge 171:3a7713b1edbc 64 // RTOS has not booted yet so no mutex is needed
AnnaBridge 171:3a7713b1edbc 65 return;
AnnaBridge 171:3a7713b1edbc 66 }
AnnaBridge 170:e95d10626187 67 osMutexRelease(singleton_mutex_id);
AnnaBridge 156:ff21514d8981 68 #endif
AnnaBridge 156:ff21514d8981 69 }
AnnaBridge 156:ff21514d8981 70
AnnaBridge 156:ff21514d8981 71 /** Utility class for creating an using a singleton
AnnaBridge 156:ff21514d8981 72 *
AnnaBridge 156:ff21514d8981 73 * @note Synchronization level: Thread safe
AnnaBridge 156:ff21514d8981 74 *
AnnaBridge 156:ff21514d8981 75 * @note: This class must only be used in a static context -
AnnaBridge 156:ff21514d8981 76 * this class must never be allocated or created on the
AnnaBridge 156:ff21514d8981 77 * stack.
AnnaBridge 156:ff21514d8981 78 *
AnnaBridge 156:ff21514d8981 79 * @note: This class is lazily initialized on first use.
AnnaBridge 156:ff21514d8981 80 * This class is a POD type so if it is not used it will
AnnaBridge 156:ff21514d8981 81 * be garbage collected.
AnnaBridge 156:ff21514d8981 82 */
AnnaBridge 156:ff21514d8981 83 template <class T>
AnnaBridge 156:ff21514d8981 84 struct SingletonPtr {
AnnaBridge 156:ff21514d8981 85
AnnaBridge 156:ff21514d8981 86 /** Get a pointer to the underlying singleton
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 * @returns
AnnaBridge 156:ff21514d8981 89 * A pointer to the singleton
AnnaBridge 156:ff21514d8981 90 */
AnnaBridge 170:e95d10626187 91 T *get()
AnnaBridge 170:e95d10626187 92 {
AnnaBridge 156:ff21514d8981 93 if (NULL == _ptr) {
AnnaBridge 156:ff21514d8981 94 singleton_lock();
AnnaBridge 156:ff21514d8981 95 if (NULL == _ptr) {
AnnaBridge 156:ff21514d8981 96 _ptr = new (_data) T();
AnnaBridge 156:ff21514d8981 97 }
AnnaBridge 156:ff21514d8981 98 singleton_unlock();
AnnaBridge 156:ff21514d8981 99 }
AnnaBridge 156:ff21514d8981 100 // _ptr was not zero initialized or was
AnnaBridge 156:ff21514d8981 101 // corrupted if this assert is hit
AnnaBridge 156:ff21514d8981 102 MBED_ASSERT(_ptr == (T *)&_data);
AnnaBridge 156:ff21514d8981 103 return _ptr;
AnnaBridge 156:ff21514d8981 104 }
AnnaBridge 156:ff21514d8981 105
AnnaBridge 156:ff21514d8981 106 /** Get a pointer to the underlying singleton
AnnaBridge 156:ff21514d8981 107 *
AnnaBridge 156:ff21514d8981 108 * @returns
AnnaBridge 156:ff21514d8981 109 * A pointer to the singleton
AnnaBridge 156:ff21514d8981 110 */
AnnaBridge 170:e95d10626187 111 T *operator->()
AnnaBridge 170:e95d10626187 112 {
AnnaBridge 156:ff21514d8981 113 return get();
AnnaBridge 156:ff21514d8981 114 }
AnnaBridge 156:ff21514d8981 115
AnnaBridge 156:ff21514d8981 116 // This is zero initialized when in global scope
AnnaBridge 156:ff21514d8981 117 T *_ptr;
AnnaBridge 156:ff21514d8981 118 // Force data to be 4 byte aligned
AnnaBridge 156:ff21514d8981 119 uint32_t _data[(sizeof(T) + sizeof(uint32_t) - 1) / sizeof(uint32_t)];
AnnaBridge 156:ff21514d8981 120 };
AnnaBridge 156:ff21514d8981 121
AnnaBridge 156:ff21514d8981 122 #endif
AnnaBridge 158:1c57384330a6 123 /**@}*/
AnnaBridge 156:ff21514d8981 124
AnnaBridge 158:1c57384330a6 125 /**@}*/