1//
2// Copyright 2012 Francisco Jerez
3//
4// Permission is hereby granted, free of charge, to any person obtaining a
5// copy of this software and associated documentation files (the "Software"),
6// to deal in the Software without restriction, including without limitation
7// the rights to use, copy, modify, merge, publish, distribute, sublicense,
8// and/or sell copies of the Software, and to permit persons to whom the
9// Software is furnished to do so, subject to the following conditions:
10//
11// The above copyright notice and this permission notice shall be included in
12// all copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18// OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20// OTHER DEALINGS IN THE SOFTWARE.
21//
22
23#ifndef CLOVER_API_UTIL_HPP
24#define CLOVER_API_UTIL_HPP
25
26#include <cassert>
27#include <iostream>
28
29#include "core/error.hpp"
30#include "core/property.hpp"
31#include "util/algorithm.hpp"
32
33#ifdef HAVE_CLOVER_ICD
34#define CLOVER_API
35#define CLOVER_ICD_API PUBLIC
36#else
37#define CLOVER_API PUBLIC
38#define CLOVER_ICD_API PUBLIC
39#endif
40
41#define CLOVER_NOT_SUPPORTED_UNTIL(version)                    \
42   do {                                                        \
43      std::cerr << "CL user error: " << __func__               \
44                << "() requires OpenCL version " << (version)  \
45                << " or greater." << std::endl;                \
46   } while (0)
47
48namespace clover {
49   ///
50   /// Return an error code in \a p if non-zero.
51   ///
52   inline void
53   ret_error(cl_int *p, const clover::error &e) {
54      if (p)
55         *p = e.get();
56   }
57
58   ///
59   /// Return a clover object in \a p if non-zero incrementing the
60   /// reference count of the object.
61   ///
62   template<typename T>
63   void
64   ret_object(typename T::descriptor_type **p,
65              const intrusive_ref<T> &v) {
66      if (p) {
67         v().retain();
68         *p = desc(v());
69      }
70   }
71
72   ///
73   /// Return an API object from an intrusive reference to a Clover object,
74   /// incrementing the reference count of the object.
75   ///
76   template<typename T>
77   typename T::descriptor_type *
78   ret_object(const intrusive_ref<T> &v) {
79      v().retain();
80      return desc(v());
81   }
82}
83
84#endif
85