1a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten/* 2a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * Copyright (C) 2010 The Android Open Source Project 3a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * 4a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * Licensed under the Apache License, Version 2.0 (the "License"); 5a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * you may not use this file except in compliance with the License. 6a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * You may obtain a copy of the License at 7a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * 8a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * http://www.apache.org/licenses/LICENSE-2.0 9a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * 10a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * Unless required by applicable law or agreed to in writing, software 11a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * distributed under the License is distributed on an "AS IS" BASIS, 12a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * See the License for the specific language governing permissions and 14a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten * limitations under the License. 15a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten */ 16a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten 17369f3138f19f7102bf0f98b890ab84c8df633a93Glenn Kasten/** \file locks.h Mutual exclusion and condition variables */ 18369f3138f19f7102bf0f98b890ab84c8df633a93Glenn Kasten 19fe96fa06360516c60490c7a697e1148017b4c1b2Glenn Kasten#ifdef USE_DEBUG 20bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_lock_exclusive_(IObject *thiz, const char *file, int line); 21bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_unlock_exclusive_(IObject *thiz, const char *file, int line); 22bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_unlock_exclusive_attributes_(IObject *thiz, unsigned attr, 234597a7427b697df31d0bbf4c2040806d0c27b6e0Glenn Kasten const char *file, int line); 24bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_cond_wait_(IObject *thiz, const char *file, int line); 25fe96fa06360516c60490c7a697e1148017b4c1b2Glenn Kasten#else 26bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_lock_exclusive(IObject *thiz); 27bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_unlock_exclusive(IObject *thiz); 28bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_unlock_exclusive_attributes(IObject *thiz, unsigned attr); 29bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_cond_wait(IObject *thiz); 304597a7427b697df31d0bbf4c2040806d0c27b6e0Glenn Kasten#endif 31bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_cond_signal(IObject *thiz); 32bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kastenextern void object_cond_broadcast(IObject *thiz); 33a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten 34fe96fa06360516c60490c7a697e1148017b4c1b2Glenn Kasten#ifdef USE_DEBUG 35bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_lock_exclusive(thiz) object_lock_exclusive_((thiz), __FILE__, __LINE__) 36bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_unlock_exclusive(thiz) object_unlock_exclusive_((thiz), __FILE__, __LINE__) 37bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_unlock_exclusive_attributes(thiz, attr) \ 38bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten object_unlock_exclusive_attributes_((thiz), (attr), __FILE__, __LINE__) 39bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_cond_wait(thiz) object_cond_wait_((thiz), __FILE__, __LINE__) 40fe96fa06360516c60490c7a697e1148017b4c1b2Glenn Kasten#endif 41fe96fa06360516c60490c7a697e1148017b4c1b2Glenn Kasten 42a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten// Currently shared locks are implemented as exclusive, but don't count on it 43a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten 44bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_lock_shared(thiz) object_lock_exclusive(thiz) 45bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_unlock_shared(thiz) object_unlock_exclusive(thiz) 46a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten 47d07ed7df4ec9338f97f12627690d58ed9b34f25bGlenn Kasten// Currently interface locks are actually on whole object, but don't count on it. 48d07ed7df4ec9338f97f12627690d58ed9b34f25bGlenn Kasten// These operations are undefined on IObject, as it lacks an mThis. 49d07ed7df4ec9338f97f12627690d58ed9b34f25bGlenn Kasten// If you have an IObject, then use the object_ functions instead. 50a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten 51bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_lock_exclusive(thiz) object_lock_exclusive(InterfaceToIObject(thiz)) 52bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_unlock_exclusive(thiz) object_unlock_exclusive(InterfaceToIObject(thiz)) 53bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_unlock_exclusive_attributes(thiz, attr) \ 54bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten object_unlock_exclusive_attributes(InterfaceToIObject(thiz), (attr)) 55bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_lock_shared(thiz) object_lock_shared(InterfaceToIObject(thiz)) 56bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_unlock_shared(thiz) object_unlock_shared(InterfaceToIObject(thiz)) 57bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_cond_wait(thiz) object_cond_wait(InterfaceToIObject(thiz)) 58bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_cond_signal(thiz) object_cond_signal(InterfaceToIObject(thiz)) 59bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_cond_broadcast(thiz) object_cond_broadcast(InterfaceToIObject(thiz)) 60a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten 615c8bd83295b2752bb7ac34f83dfb19dcdb1be5e5Glenn Kasten// Peek and poke are an optimization for small atomic fields that don't "matter". 625c8bd83295b2752bb7ac34f83dfb19dcdb1be5e5Glenn Kasten// Don't use for struct, as struct copy might not be atomic. 635c8bd83295b2752bb7ac34f83dfb19dcdb1be5e5Glenn Kasten// On uniprocessor they can be no-ops, on SMP they could be memory barriers but locks are easier. 64a6d984c32855a239f7f79a3d3b7f2ddfb8cb9697Glenn Kasten 65bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_lock_peek(thiz) object_lock_shared(thiz) 66bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define object_unlock_peek(thiz) object_unlock_shared(thiz) 67bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_lock_poke(thiz) interface_lock_exclusive(thiz) 68bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_unlock_poke(thiz) interface_unlock_exclusive(thiz) 69bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_lock_peek(thiz) interface_lock_shared(thiz) 70bcc5c7225e3b7a1dbf2e9e830987f69167acf06fGlenn Kasten#define interface_unlock_peek(thiz) interface_unlock_shared(thiz) 71