1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_SA_H 27 #define _SYS_SA_H 28 29 #include <sys/dmu.h> 30 31 /* 32 * Currently available byteswap functions. 33 * If it all possible new attributes should used 34 * one of the already defined byteswap functions. 35 * If a new byteswap function is added then the 36 * ZPL/Pool version will need to be bumped. 37 */ 38 39 typedef enum sa_bswap_type { 40 SA_UINT64_ARRAY, 41 SA_UINT32_ARRAY, 42 SA_UINT16_ARRAY, 43 SA_UINT8_ARRAY, 44 SA_ACL, 45 } sa_bswap_type_t; 46 47 typedef uint16_t sa_attr_type_t; 48 49 /* 50 * Attribute to register support for. 51 */ 52 typedef struct sa_attr_reg { 53 char *sa_name; /* attribute name */ 54 uint16_t sa_length; 55 sa_bswap_type_t sa_byteswap; /* bswap functon enum */ 56 sa_attr_type_t sa_attr; /* filled in during registration */ 57 } sa_attr_reg_t; 58 59 60 typedef void (sa_data_locator_t)(void **, uint32_t *, uint32_t, 61 boolean_t, void *userptr); 62 63 /* 64 * array of attributes to store. 65 * 66 * This array should be treated as opaque/private data. 67 * The SA_BULK_ADD_ATTR() macro should be used for manipulating 68 * the array. 69 * 70 * When sa_replace_all_by_template() is used the attributes 71 * will be stored in the order defined in the array, except that 72 * the attributes may be split between the bonus and the spill buffer 73 * 74 */ 75 typedef struct sa_bulk_attr { 76 void *sa_data; 77 sa_data_locator_t *sa_data_func; 78 uint16_t sa_length; 79 sa_attr_type_t sa_attr; 80 /* the following are private to the sa framework */ 81 void *sa_addr; 82 uint16_t sa_buftype; 83 uint16_t sa_size; 84 } sa_bulk_attr_t; 85 86 87 /* 88 * special macro for adding entries for bulk attr support 89 * bulk - sa_bulk_attr_t 90 * count - integer that will be incremented during each add 91 * attr - attribute to manipulate 92 * func - function for accessing data. 93 * data - pointer to data. 94 * len - length of data 95 */ 96 97 #define SA_ADD_BULK_ATTR(b, idx, attr, func, data, len) \ 98 { \ 99 b[idx].sa_attr = attr;\ 100 b[idx].sa_data_func = func; \ 101 b[idx].sa_data = data; \ 102 b[idx++].sa_length = len; \ 103 } 104 105 typedef struct sa_os sa_os_t; 106 107 typedef enum sa_handle_type { 108 SA_HDL_SHARED, 109 SA_HDL_PRIVATE 110 } sa_handle_type_t; 111 112 struct sa_handle; 113 typedef void *sa_lookup_tab_t; 114 typedef struct sa_handle sa_handle_t; 115 116 typedef void (sa_update_cb_t)(sa_handle_t *, dmu_tx_t *tx); 117 118 int sa_handle_get(objset_t *, uint64_t, void *userp, 119 sa_handle_type_t, sa_handle_t **); 120 int sa_handle_get_from_db(objset_t *, dmu_buf_t *, void *userp, 121 sa_handle_type_t, sa_handle_t **); 122 void sa_handle_destroy(sa_handle_t *); 123 int sa_buf_hold(objset_t *, uint64_t, void *, dmu_buf_t **); 124 void sa_buf_rele(dmu_buf_t *, void *); 125 int sa_lookup(sa_handle_t *, sa_attr_type_t, void *buf, uint32_t buflen); 126 int sa_update(sa_handle_t *, sa_attr_type_t, void *buf, 127 uint32_t buflen, dmu_tx_t *); 128 int sa_remove(sa_handle_t *, sa_attr_type_t, dmu_tx_t *); 129 int sa_bulk_lookup(sa_handle_t *, sa_bulk_attr_t *, int count); 130 int sa_bulk_lookup_locked(sa_handle_t *, sa_bulk_attr_t *, int count); 131 int sa_bulk_update(sa_handle_t *, sa_bulk_attr_t *, int count, dmu_tx_t *); 132 int sa_size(sa_handle_t *, sa_attr_type_t, int *); 133 int sa_update_from_cb(sa_handle_t *, sa_attr_type_t, 134 uint32_t buflen, sa_data_locator_t *, void *userdata, dmu_tx_t *); 135 void sa_object_info(sa_handle_t *, dmu_object_info_t *); 136 void sa_object_size(sa_handle_t *, uint32_t *, u_longlong_t *); 137 void sa_update_user(sa_handle_t *, sa_handle_t *); 138 void *sa_get_userdata(sa_handle_t *); 139 void sa_set_userp(sa_handle_t *, void *); 140 dmu_buf_t *sa_get_db(sa_handle_t *); 141 uint64_t sa_handle_object(sa_handle_t *); 142 boolean_t sa_attr_would_spill(sa_handle_t *, sa_attr_type_t, int size); 143 void sa_register_update_callback(objset_t *, sa_update_cb_t *); 144 sa_attr_type_t *sa_setup(objset_t *, uint64_t, sa_attr_reg_t *, int); 145 void sa_tear_down(objset_t *); 146 int sa_replace_all_by_template(sa_handle_t *, sa_bulk_attr_t *, 147 int, dmu_tx_t *); 148 int sa_replace_all_by_template_locked(sa_handle_t *, sa_bulk_attr_t *, 149 int, dmu_tx_t *); 150 boolean_t sa_enabled(objset_t *); 151 void sa_cache_init(); 152 void sa_cache_fini(); 153 int sa_set_sa_object(objset_t *, uint64_t); 154 int sa_hdrsize(void *); 155 void sa_handle_lock(sa_handle_t *); 156 void sa_handle_unlock(sa_handle_t *); 157 158 #ifdef _KERNEL 159 int sa_lookup_uio(sa_handle_t *, sa_attr_type_t, uio_t *); 160 #endif 161 162 #ifdef __cplusplus 163 extern "C" { 164 #endif 165 166 167 #ifdef __cplusplus 168 } 169 #endif 170 171 #endif /* _SYS_SA_H */ 172