forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommon.h
More file actions
166 lines (129 loc) · 4.11 KB
/
Copy pathcommon.h
File metadata and controls
166 lines (129 loc) · 4.11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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.
#ifndef ARROW_PYTHON_COMMON_H
#define ARROW_PYTHON_COMMON_H
#include <memory>
#include <string>
#include "arrow/python/config.h"
#include "arrow/buffer.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
namespace arrow {
class MemoryPool;
namespace py {
class ARROW_EXPORT PyAcquireGIL {
public:
PyAcquireGIL() : acquired_gil_(false) { acquire(); }
~PyAcquireGIL() { release(); }
void acquire() {
if (!acquired_gil_) {
state_ = PyGILState_Ensure();
acquired_gil_ = true;
}
}
// idempotent
void release() {
if (acquired_gil_) {
PyGILState_Release(state_);
acquired_gil_ = false;
}
}
private:
bool acquired_gil_;
PyGILState_STATE state_;
ARROW_DISALLOW_COPY_AND_ASSIGN(PyAcquireGIL);
};
#define PYARROW_IS_PY2 PY_MAJOR_VERSION <= 2
// A RAII primitive that DECREFs the underlying PyObject* when it
// goes out of scope.
class ARROW_EXPORT OwnedRef {
public:
OwnedRef() : obj_(NULLPTR) {}
OwnedRef(OwnedRef&& other) : OwnedRef(other.detach()) {}
explicit OwnedRef(PyObject* obj) : obj_(obj) {}
~OwnedRef() { reset(); }
void reset(PyObject* obj) {
Py_XDECREF(obj_);
obj_ = obj;
}
void reset() { reset(NULLPTR); }
PyObject* detach() {
PyObject* result = obj_;
obj_ = NULLPTR;
return result;
}
PyObject* obj() const { return obj_; }
PyObject** ref() { return &obj_; }
private:
ARROW_DISALLOW_COPY_AND_ASSIGN(OwnedRef);
PyObject* obj_;
};
// Same as OwnedRef, but ensures the GIL is taken when it goes out of scope.
// This is for situations where the GIL is not always known to be held
// (e.g. if it is released in the middle of a function for performance reasons)
class ARROW_EXPORT OwnedRefNoGIL : public OwnedRef {
public:
OwnedRefNoGIL() : OwnedRef() {}
OwnedRefNoGIL(OwnedRefNoGIL&& other) : OwnedRef(other.detach()) {}
explicit OwnedRefNoGIL(PyObject* obj) : OwnedRef(obj) {}
~OwnedRefNoGIL() {
PyAcquireGIL lock;
reset();
}
};
struct ARROW_EXPORT PyObjectStringify {
OwnedRef tmp_obj;
const char* bytes;
Py_ssize_t size;
explicit PyObjectStringify(PyObject* obj) {
PyObject* bytes_obj;
if (PyUnicode_Check(obj)) {
bytes_obj = PyUnicode_AsUTF8String(obj);
tmp_obj.reset(bytes_obj);
bytes = PyBytes_AsString(bytes_obj);
size = PyBytes_GET_SIZE(bytes_obj);
} else if (PyBytes_Check(obj)) {
bytes = PyBytes_AsString(obj);
size = PyBytes_GET_SIZE(obj);
} else {
bytes = NULLPTR;
size = -1;
}
}
};
Status CheckPyError(StatusCode code = StatusCode::UnknownError);
Status PassPyError();
// TODO(wesm): We can just let errors pass through. To be explored later
#define RETURN_IF_PYERROR() RETURN_NOT_OK(CheckPyError());
#define PY_RETURN_IF_ERROR(CODE) RETURN_NOT_OK(CheckPyError(CODE));
// Return the common PyArrow memory pool
ARROW_EXPORT void set_default_memory_pool(MemoryPool* pool);
ARROW_EXPORT MemoryPool* get_memory_pool();
class ARROW_EXPORT PyBuffer : public Buffer {
public:
/// While memoryview objects support multi-dimensional buffers, PyBuffer only supports
/// one-dimensional byte buffers.
~PyBuffer();
static Status FromPyObject(PyObject* obj, std::shared_ptr<Buffer>* out);
private:
PyBuffer();
Status Init(PyObject*);
Py_buffer py_buf_;
};
} // namespace py
} // namespace arrow
#endif // ARROW_PYTHON_COMMON_H