Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 6169d5f | 2016-03-31 07:46:18 -0700 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -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 | |
Craig Tiller | 5b676a6 | 2016-10-26 21:09:29 -0700 | [diff] [blame] | 34 | #ifndef GRPC_SLICE_H |
| 35 | #define GRPC_SLICE_H |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 36 | |
David Garcia Quintas | 2425bbb | 2016-01-25 17:32:48 -0800 | [diff] [blame] | 37 | #include <grpc/impl/codegen/slice.h> |
David Garcia Quintas | 61887dc | 2016-07-27 23:17:34 -0700 | [diff] [blame] | 38 | #include <grpc/support/sync.h> |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 39 | |
| 40 | #ifdef __cplusplus |
| 41 | extern "C" { |
| 42 | #endif |
| 43 | |
| 44 | /* Increment the refcount of s. Requires slice is initialized. |
| 45 | Returns s. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 46 | GPRAPI grpc_slice grpc_slice_ref(grpc_slice s); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 47 | |
| 48 | /* Decrement the ref count of s. If the ref count of s reaches zero, all |
| 49 | slices sharing the ref count are destroyed, and considered no longer |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 50 | initialized. If s is ultimately derived from a call to grpc_slice_new(start, |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 51 | len, dest) where dest!=NULL , then (*dest)(start) is called, else if s is |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 52 | ultimately derived from a call to grpc_slice_new_with_len(start, len, dest) |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 53 | where dest!=NULL , then (*dest)(start, len). Requires s initialized. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 54 | GPRAPI void grpc_slice_unref(grpc_slice s); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 55 | |
| 56 | /* Create a slice pointing at some data. Calls malloc to allocate a refcount |
| 57 | for the object, and arranges that destroy will be called with the pointer |
| 58 | passed in at destruction. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 59 | GPRAPI grpc_slice grpc_slice_new(void *p, size_t len, void (*destroy)(void *)); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 60 | |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 61 | /* Equivalent to grpc_slice_new, but with a separate pointer that is |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 62 | passed to the destroy function. This function can be useful when |
| 63 | the data is part of a larger structure that must be destroyed when |
| 64 | the data is no longer needed. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 65 | GPRAPI grpc_slice grpc_slice_new_with_user_data(void *p, size_t len, |
| 66 | void (*destroy)(void *), |
| 67 | void *user_data); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 68 | |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 69 | /* Equivalent to grpc_slice_new, but with a two argument destroy function that |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 70 | also takes the slice length. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 71 | GPRAPI grpc_slice grpc_slice_new_with_len(void *p, size_t len, |
| 72 | void (*destroy)(void *, size_t)); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 73 | |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 74 | /* Equivalent to grpc_slice_new(malloc(len), len, free), but saves one malloc() |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 75 | call. |
| 76 | Aborts if malloc() fails. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 77 | GPRAPI grpc_slice grpc_slice_malloc(size_t length); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 78 | |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 79 | /* Intern a slice: |
| 80 | |
| 81 | The return value for two invocations of this function with the same sequence |
| 82 | of bytes is a slice which points to the same memory. */ |
| 83 | GPRAPI grpc_slice grpc_slice_intern(grpc_slice slice); |
| 84 | |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 85 | /* Create a slice by copying a string. |
| 86 | Does not preserve null terminators. |
| 87 | Equivalent to: |
| 88 | size_t len = strlen(source); |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 89 | grpc_slice slice = grpc_slice_malloc(len); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 90 | memcpy(slice->data, source, len); */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 91 | GPRAPI grpc_slice grpc_slice_from_copied_string(const char *source); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 92 | |
| 93 | /* Create a slice by copying a buffer. |
| 94 | Equivalent to: |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 95 | grpc_slice slice = grpc_slice_malloc(len); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 96 | memcpy(slice->data, source, len); */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 97 | GPRAPI grpc_slice grpc_slice_from_copied_buffer(const char *source, size_t len); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 98 | |
| 99 | /* Create a slice pointing to constant memory */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 100 | GPRAPI grpc_slice grpc_slice_from_static_string(const char *source); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 101 | |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 102 | /* Create a slice pointing to constant memory */ |
| 103 | GPRAPI grpc_slice grpc_slice_from_static_buffer(const void *source, size_t len); |
| 104 | |
David Garcia Quintas | 2f4679e | 2017-04-14 13:06:27 -0700 | [diff] [blame^] | 105 | /* Return a result slice derived from s, which shares a ref count with \a s, |
| 106 | where result.data==s.data+begin, and result.length==end-begin. The ref count |
| 107 | of \a s is increased by one. Do not assign result back to \a s. |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 108 | Requires s initialized, begin <= end, begin <= s.length, and |
| 109 | end <= source->length. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 110 | GPRAPI grpc_slice grpc_slice_sub(grpc_slice s, size_t begin, size_t end); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 111 | |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 112 | /* The same as grpc_slice_sub, but without altering the ref count */ |
| 113 | GPRAPI grpc_slice grpc_slice_sub_no_ref(grpc_slice s, size_t begin, size_t end); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 114 | |
| 115 | /* Splits s into two: modifies s to be s[0:split], and returns a new slice, |
| 116 | sharing a refcount with s, that contains s[split:s.length]. |
| 117 | Requires s intialized, split <= s.length */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 118 | GPRAPI grpc_slice grpc_slice_split_tail(grpc_slice *s, size_t split); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 119 | |
| 120 | /* Splits s into two: modifies s to be s[split:s.length], and returns a new |
| 121 | slice, sharing a refcount with s, that contains s[0:split]. |
| 122 | Requires s intialized, split <= s.length */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 123 | GPRAPI grpc_slice grpc_slice_split_head(grpc_slice *s, size_t split); |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 124 | |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 125 | GPRAPI grpc_slice grpc_empty_slice(void); |
| 126 | |
| 127 | GPRAPI uint32_t grpc_slice_default_hash_impl(grpc_slice s); |
| 128 | GPRAPI int grpc_slice_default_eq_impl(grpc_slice a, grpc_slice b); |
| 129 | |
| 130 | GPRAPI int grpc_slice_eq(grpc_slice a, grpc_slice b); |
Craig Tiller | 0451c3d | 2016-11-17 09:34:14 -0800 | [diff] [blame] | 131 | |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 132 | /* Returns <0 if a < b, ==0 if a == b, >0 if a > b |
| 133 | The order is arbitrary, and is not guaranteed to be stable across different |
| 134 | versions of the API. */ |
Craig Tiller | d41a4a7 | 2016-10-26 16:16:06 -0700 | [diff] [blame] | 135 | GPRAPI int grpc_slice_cmp(grpc_slice a, grpc_slice b); |
| 136 | GPRAPI int grpc_slice_str_cmp(grpc_slice a, const char *b); |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 137 | GPRAPI int grpc_slice_buf_cmp(grpc_slice a, const void *b, size_t blen); |
| 138 | |
| 139 | /* return non-zero if the first blen bytes of a are equal to b */ |
| 140 | GPRAPI int grpc_slice_buf_start_eq(grpc_slice a, const void *b, size_t blen); |
| 141 | |
| 142 | /* return the index of the last instance of \a c in \a s, or -1 if not found */ |
| 143 | GPRAPI int grpc_slice_rchr(grpc_slice s, char c); |
| 144 | GPRAPI int grpc_slice_chr(grpc_slice s, char c); |
| 145 | |
| 146 | /* return the index of the first occurance of \a needle in \a haystack, or -1 if |
| 147 | * it's not found */ |
| 148 | GPRAPI int grpc_slice_slice(grpc_slice haystack, grpc_slice needle); |
| 149 | |
| 150 | GPRAPI uint32_t grpc_slice_hash(grpc_slice s); |
Craig Tiller | e52bbb1 | 2016-11-10 15:34:06 -0800 | [diff] [blame] | 151 | |
Craig Tiller | b121fc7 | 2016-11-03 15:22:59 -0700 | [diff] [blame] | 152 | /* Do two slices point at the same memory, with the same length |
| 153 | If a or b is inlined, actually compares data */ |
Craig Tiller | d57a148 | 2016-11-16 14:45:10 -0800 | [diff] [blame] | 154 | GPRAPI int grpc_slice_is_equivalent(grpc_slice a, grpc_slice b); |
Craig Tiller | b121fc7 | 2016-11-03 15:22:59 -0700 | [diff] [blame] | 155 | |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 156 | /* Return a slice pointing to newly allocated memory that has the same contents |
| 157 | * as \a s */ |
| 158 | GPRAPI grpc_slice grpc_slice_dup(grpc_slice a); |
| 159 | |
| 160 | /* Return a copy of slice as a C string. Offers no protection against embedded |
| 161 | NULL's. Returned string must be freed with gpr_free. */ |
| 162 | GPRAPI char *grpc_slice_to_c_string(grpc_slice s); |
| 163 | |
David Garcia Quintas | e8fd66b | 2016-07-27 22:05:37 -0700 | [diff] [blame] | 164 | #ifdef __cplusplus |
| 165 | } |
| 166 | #endif |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 167 | |
Craig Tiller | 5b676a6 | 2016-10-26 21:09:29 -0700 | [diff] [blame] | 168 | #endif /* GRPC_SLICE_H */ |