Craig Tiller | 1a61b17 | 2015-02-16 11:53:47 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 6169d5f | 2016-03-31 07:46:18 -0700 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Craig Tiller | 1a61b17 | 2015-02-16 11:53:47 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 34 | #include "channel.h" |
| 35 | |
| 36 | #ifdef HAVE_CONFIG_H |
| 37 | #include "config.h" |
| 38 | #endif |
| 39 | |
murgatroid99 | 8242ba7 | 2015-04-01 15:29:44 -0700 | [diff] [blame] | 40 | #include <php.h> |
| 41 | #include <php_ini.h> |
| 42 | #include <ext/standard/info.h> |
| 43 | #include <ext/spl/spl_exceptions.h> |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 44 | #include "php_grpc.h" |
| 45 | |
murgatroid99 | 8242ba7 | 2015-04-01 15:29:44 -0700 | [diff] [blame] | 46 | #include <zend_exceptions.h> |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 47 | |
| 48 | #include <stdbool.h> |
| 49 | |
murgatroid99 | 8242ba7 | 2015-04-01 15:29:44 -0700 | [diff] [blame] | 50 | #include <grpc/grpc.h> |
murgatroid99 | 8242ba7 | 2015-04-01 15:29:44 -0700 | [diff] [blame] | 51 | #include <grpc/grpc_security.h> |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 52 | |
Stanley Cheung | a63fdd0 | 2015-08-11 15:11:11 -0700 | [diff] [blame] | 53 | #include "completion_queue.h" |
Stanley Cheung | 9c0b35e | 2015-10-21 17:07:56 -0700 | [diff] [blame] | 54 | #include "channel_credentials.h" |
Stanley Cheung | a63fdd0 | 2015-08-11 15:11:11 -0700 | [diff] [blame] | 55 | #include "server.h" |
| 56 | #include "timeval.h" |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 57 | |
Xiaoguang Sun | 8a929a9 | 2015-03-13 14:22:31 +0800 | [diff] [blame] | 58 | zend_class_entry *grpc_ce_channel; |
| 59 | |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 60 | /* Frees and destroys an instance of wrapped_grpc_channel */ |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 61 | void free_wrapped_grpc_channel(void *object TSRMLS_DC) { |
| 62 | wrapped_grpc_channel *channel = (wrapped_grpc_channel *)object; |
| 63 | if (channel->wrapped != NULL) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 64 | grpc_channel_destroy(channel->wrapped); |
| 65 | } |
| 66 | efree(channel); |
| 67 | } |
| 68 | |
| 69 | /* Initializes an instance of wrapped_grpc_channel to be associated with an |
| 70 | * object of a class specified by class_type */ |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 71 | zend_object_value create_wrapped_grpc_channel(zend_class_entry *class_type |
| 72 | TSRMLS_DC) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 73 | zend_object_value retval; |
| 74 | wrapped_grpc_channel *intern; |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 75 | intern = (wrapped_grpc_channel *)emalloc(sizeof(wrapped_grpc_channel)); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 76 | memset(intern, 0, sizeof(wrapped_grpc_channel)); |
| 77 | zend_object_std_init(&intern->std, class_type TSRMLS_CC); |
| 78 | object_properties_init(&intern->std, class_type); |
| 79 | retval.handle = zend_objects_store_put( |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 80 | intern, (zend_objects_store_dtor_t)zend_objects_destroy_object, |
| 81 | free_wrapped_grpc_channel, NULL TSRMLS_CC); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 82 | retval.handlers = zend_get_std_object_handlers(); |
| 83 | return retval; |
| 84 | } |
| 85 | |
Michael Bausor | 4f8e40b | 2016-05-16 11:41:25 -0700 | [diff] [blame] | 86 | void php_grpc_read_args_array(zval *args_array, grpc_channel_args *args TSRMLS_DC) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 87 | HashTable *array_hash; |
| 88 | HashPosition array_pointer; |
| 89 | int args_index; |
| 90 | zval **data; |
| 91 | char *key; |
| 92 | uint key_len; |
| 93 | ulong index; |
| 94 | array_hash = Z_ARRVAL_P(args_array); |
| 95 | args->num_args = zend_hash_num_elements(array_hash); |
| 96 | args->args = ecalloc(args->num_args, sizeof(grpc_arg)); |
| 97 | args_index = 0; |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 98 | for (zend_hash_internal_pointer_reset_ex(array_hash, &array_pointer); |
| 99 | zend_hash_get_current_data_ex(array_hash, (void **)&data, |
| 100 | &array_pointer) == SUCCESS; |
| 101 | zend_hash_move_forward_ex(array_hash, &array_pointer)) { |
| 102 | if (zend_hash_get_current_key_ex(array_hash, &key, &key_len, &index, 0, |
| 103 | &array_pointer) != HASH_KEY_IS_STRING) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 104 | zend_throw_exception(spl_ce_InvalidArgumentException, |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 105 | "args keys must be strings", 1 TSRMLS_CC); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 106 | return; |
| 107 | } |
| 108 | args->args[args_index].key = key; |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 109 | switch (Z_TYPE_P(*data)) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 110 | case IS_LONG: |
| 111 | args->args[args_index].value.integer = (int)Z_LVAL_P(*data); |
Stanley Cheung | 7895da2 | 2016-03-17 16:49:57 -0700 | [diff] [blame] | 112 | args->args[args_index].type = GRPC_ARG_INTEGER; |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 113 | break; |
| 114 | case IS_STRING: |
| 115 | args->args[args_index].value.string = Z_STRVAL_P(*data); |
Stanley Cheung | 7895da2 | 2016-03-17 16:49:57 -0700 | [diff] [blame] | 116 | args->args[args_index].type = GRPC_ARG_STRING; |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 117 | break; |
| 118 | default: |
| 119 | zend_throw_exception(spl_ce_InvalidArgumentException, |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 120 | "args values must be int or string", 1 TSRMLS_CC); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 121 | return; |
| 122 | } |
| 123 | args_index++; |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | /** |
| 128 | * Construct an instance of the Channel class. If the $args array contains a |
Stanley Cheung | 9c0b35e | 2015-10-21 17:07:56 -0700 | [diff] [blame] | 129 | * "credentials" key mapping to a ChannelCredentials object, a secure channel |
| 130 | * will be created with those credentials. |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 131 | * @param string $target The hostname to associate with this channel |
| 132 | * @param array $args The arguments to pass to the Channel (optional) |
| 133 | */ |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 134 | PHP_METHOD(Channel, __construct) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 135 | wrapped_grpc_channel *channel = |
Stanley Cheung | 9c0b35e | 2015-10-21 17:07:56 -0700 | [diff] [blame] | 136 | (wrapped_grpc_channel *)zend_object_store_get_object( |
| 137 | getThis() TSRMLS_CC); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 138 | char *target; |
| 139 | int target_length; |
| 140 | zval *args_array = NULL; |
| 141 | grpc_channel_args args; |
| 142 | HashTable *array_hash; |
| 143 | zval **creds_obj = NULL; |
Stanley Cheung | aeea102 | 2015-10-21 17:00:49 -0700 | [diff] [blame] | 144 | wrapped_grpc_channel_credentials *creds = NULL; |
Stanley Cheung | f77a4ad | 2016-02-16 09:45:51 -0800 | [diff] [blame] | 145 | /* "sa" == 1 string, 1 array */ |
| 146 | if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa", &target, |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 147 | &target_length, &args_array) == FAILURE) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 148 | zend_throw_exception(spl_ce_InvalidArgumentException, |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 149 | "Channel expects a string and an array", 1 TSRMLS_CC); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 150 | return; |
| 151 | } |
Stanley Cheung | cccf929 | 2016-02-12 16:37:19 -0800 | [diff] [blame] | 152 | array_hash = Z_ARRVAL_P(args_array); |
| 153 | if (zend_hash_find(array_hash, "credentials", sizeof("credentials"), |
| 154 | (void **)&creds_obj) == SUCCESS) { |
| 155 | if (Z_TYPE_P(*creds_obj) == IS_NULL) { |
| 156 | creds = NULL; |
| 157 | zend_hash_del(array_hash, "credentials", 12); |
| 158 | } else if (zend_get_class_entry(*creds_obj TSRMLS_CC) != |
| 159 | grpc_ce_channel_credentials) { |
| 160 | zend_throw_exception(spl_ce_InvalidArgumentException, |
| 161 | "credentials must be a ChannelCredentials object", |
| 162 | 1 TSRMLS_CC); |
| 163 | return; |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 164 | } else { |
Stanley Cheung | cccf929 | 2016-02-12 16:37:19 -0800 | [diff] [blame] | 165 | creds = (wrapped_grpc_channel_credentials *)zend_object_store_get_object( |
| 166 | *creds_obj TSRMLS_CC); |
| 167 | zend_hash_del(array_hash, "credentials", 12); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 168 | } |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 169 | } |
Michael Bausor | 4f8e40b | 2016-05-16 11:41:25 -0700 | [diff] [blame] | 170 | php_grpc_read_args_array(args_array, &args TSRMLS_CC); |
Stanley Cheung | cccf929 | 2016-02-12 16:37:19 -0800 | [diff] [blame] | 171 | if (creds == NULL) { |
| 172 | channel->wrapped = grpc_insecure_channel_create(target, &args, NULL); |
| 173 | } else { |
Stanley Cheung | cccf929 | 2016-02-12 16:37:19 -0800 | [diff] [blame] | 174 | channel->wrapped = |
| 175 | grpc_secure_channel_create(creds->wrapped, target, &args, NULL); |
| 176 | } |
| 177 | efree(args.args); |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 178 | } |
| 179 | |
| 180 | /** |
Stanley Cheung | db98e08 | 2015-07-27 10:19:45 -0700 | [diff] [blame] | 181 | * Get the endpoint this call/stream is connected to |
| 182 | * @return string The URI of the endpoint |
| 183 | */ |
| 184 | PHP_METHOD(Channel, getTarget) { |
| 185 | wrapped_grpc_channel *channel = |
| 186 | (wrapped_grpc_channel *)zend_object_store_get_object(getThis() TSRMLS_CC); |
| 187 | RETURN_STRING(grpc_channel_get_target(channel->wrapped), 1); |
| 188 | } |
| 189 | |
| 190 | /** |
Stanley Cheung | e63354a | 2015-08-10 15:46:42 -0700 | [diff] [blame] | 191 | * Get the connectivity state of the channel |
| 192 | * @param bool (optional) try to connect on the channel |
| 193 | * @return long The grpc connectivity state |
| 194 | */ |
| 195 | PHP_METHOD(Channel, getConnectivityState) { |
| 196 | wrapped_grpc_channel *channel = |
| 197 | (wrapped_grpc_channel *)zend_object_store_get_object(getThis() TSRMLS_CC); |
| 198 | bool try_to_connect; |
| 199 | /* "|b" == 1 optional bool */ |
| 200 | if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &try_to_connect) == |
| 201 | FAILURE) { |
| 202 | zend_throw_exception(spl_ce_InvalidArgumentException, |
| 203 | "getConnectivityState expects a bool", 1 TSRMLS_CC); |
| 204 | return; |
| 205 | } |
| 206 | RETURN_LONG(grpc_channel_check_connectivity_state(channel->wrapped, |
| 207 | (int)try_to_connect)); |
| 208 | } |
| 209 | |
| 210 | /** |
Stanley Cheung | a63fdd0 | 2015-08-11 15:11:11 -0700 | [diff] [blame] | 211 | * Watch the connectivity state of the channel until it changed |
| 212 | * @param long The previous connectivity state of the channel |
| 213 | * @param Timeval The deadline this function should wait until |
Stanley Cheung | 4c5c7b8 | 2015-08-12 16:28:58 -0700 | [diff] [blame] | 214 | * @return bool If the connectivity state changes from last_state |
| 215 | * before deadline |
Stanley Cheung | a63fdd0 | 2015-08-11 15:11:11 -0700 | [diff] [blame] | 216 | */ |
| 217 | PHP_METHOD(Channel, watchConnectivityState) { |
| 218 | wrapped_grpc_channel *channel = |
| 219 | (wrapped_grpc_channel *)zend_object_store_get_object(getThis() TSRMLS_CC); |
| 220 | long last_state; |
| 221 | zval *deadline_obj; |
| 222 | /* "lO" == 1 long 1 object */ |
| 223 | if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "lO", |
| 224 | &last_state, &deadline_obj, grpc_ce_timeval) == FAILURE) { |
| 225 | zend_throw_exception(spl_ce_InvalidArgumentException, |
| 226 | "watchConnectivityState expects 1 long 1 timeval", |
| 227 | 1 TSRMLS_CC); |
| 228 | return; |
| 229 | } |
| 230 | |
| 231 | wrapped_grpc_timeval *deadline = |
| 232 | (wrapped_grpc_timeval *)zend_object_store_get_object( |
| 233 | deadline_obj TSRMLS_CC); |
| 234 | grpc_channel_watch_connectivity_state( |
| 235 | channel->wrapped, (grpc_connectivity_state)last_state, |
| 236 | deadline->wrapped, completion_queue, NULL); |
| 237 | grpc_event event = grpc_completion_queue_pluck( |
| 238 | completion_queue, NULL, |
Nicolas "Pixel" Noble | f123443 | 2015-08-13 23:39:43 +0200 | [diff] [blame] | 239 | gpr_inf_future(GPR_CLOCK_REALTIME), NULL); |
Stanley Cheung | 1567c0c | 2015-08-13 11:12:54 -0700 | [diff] [blame] | 240 | RETURN_BOOL(event.success); |
Stanley Cheung | a63fdd0 | 2015-08-11 15:11:11 -0700 | [diff] [blame] | 241 | } |
| 242 | |
| 243 | /** |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 244 | * Close the channel |
| 245 | */ |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 246 | PHP_METHOD(Channel, close) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 247 | wrapped_grpc_channel *channel = |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 248 | (wrapped_grpc_channel *)zend_object_store_get_object(getThis() TSRMLS_CC); |
| 249 | if (channel->wrapped != NULL) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 250 | grpc_channel_destroy(channel->wrapped); |
| 251 | channel->wrapped = NULL; |
| 252 | } |
| 253 | } |
| 254 | |
| 255 | static zend_function_entry channel_methods[] = { |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 256 | PHP_ME(Channel, __construct, NULL, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR) |
Stanley Cheung | db98e08 | 2015-07-27 10:19:45 -0700 | [diff] [blame] | 257 | PHP_ME(Channel, getTarget, NULL, ZEND_ACC_PUBLIC) |
Stanley Cheung | e63354a | 2015-08-10 15:46:42 -0700 | [diff] [blame] | 258 | PHP_ME(Channel, getConnectivityState, NULL, ZEND_ACC_PUBLIC) |
Stanley Cheung | a63fdd0 | 2015-08-11 15:11:11 -0700 | [diff] [blame] | 259 | PHP_ME(Channel, watchConnectivityState, NULL, ZEND_ACC_PUBLIC) |
Stanley Cheung | db98e08 | 2015-07-27 10:19:45 -0700 | [diff] [blame] | 260 | PHP_ME(Channel, close, NULL, ZEND_ACC_PUBLIC) |
| 261 | PHP_FE_END}; |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 262 | |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 263 | void grpc_init_channel(TSRMLS_D) { |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 264 | zend_class_entry ce; |
| 265 | INIT_CLASS_ENTRY(ce, "Grpc\\Channel", channel_methods); |
| 266 | ce.create_object = create_wrapped_grpc_channel; |
| 267 | grpc_ce_channel = zend_register_internal_class(&ce TSRMLS_CC); |
| 268 | } |