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 /*
23 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2014 Nexenta Systems, Inc. All rights reserved.
25 */
26
27 #ifndef _IPMGMT_IMPL_H
28 #define _IPMGMT_IMPL_H
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #include <net/if.h>
35 #include <libnvpair.h>
36 #include <libipadm.h>
37 #include <ipadm_ipmgmt.h>
38 #include <syslog.h>
39 #include <pthread.h>
40 #include <libscf.h>
41
42 #define IPMGMT_STRSIZE 256
43 #define IPMGMTD_FMRI "svc:/network/ip-interface-management:default"
44
45 /* ipmgmt_door.c */
46 extern void ipmgmt_handler(void *, char *, size_t, door_desc_t *, uint_t);
47
48 /* ipmgmt_util.c */
49 extern void ipmgmt_log(int, const char *, ...);
50 extern int ipmgmt_cpfile(const char *, const char *, boolean_t);
51
52 /* ipmgmt_persist.c */
53 extern boolean_t ipmgmt_persist_if_exists(const char *, sa_family_t);
54 extern void ipmgmt_get_group_interface(const char *, char *, size_t);
55
56 /*
57 * following are the list of DB walker callback functions and the callback
58 * arguments for each of the callback functions used by the daemon
59 */
60 /* following functions take 'ipmgmt_prop_arg_t' as the callback argument */
61 extern db_wfunc_t ipmgmt_db_getprop, ipmgmt_db_resetprop;
62
63 /* following functions take ipadm_dbwrite_cbarg_t as callback argument */
64 extern db_wfunc_t ipmgmt_db_add, ipmgmt_db_update, ipmgmt_db_update_if;
65
66 typedef struct {
67 char *cb_ifname;
68 char *cb_aobjname;
69 nvlist_t *cb_onvl;
70 int cb_ocnt;
71 } ipmgmt_get_cbarg_t;
72 extern db_wfunc_t ipmgmt_db_getif;
73 extern db_wfunc_t ipmgmt_db_getaddr;
74
75 typedef struct {
76 sa_family_t cb_family;
77 char *cb_ifname;
78 boolean_t cb_ipv4exists;
79 boolean_t cb_ipv6exists;
80 } ipmgmt_if_cbarg_t;
81 extern db_wfunc_t ipmgmt_db_setif, ipmgmt_db_resetif;
82
83 typedef struct {
84 char *cb_aobjname;
85 } ipmgmt_resetaddr_cbarg_t;
86 extern db_wfunc_t ipmgmt_db_resetaddr;
87
88 typedef struct {
89 sa_family_t cb_family;
90 nvlist_t *cb_invl;
91 nvlist_t *cb_onvl;
92 int cb_ocnt;
93 } ipmgmt_initif_cbarg_t;
94 extern db_wfunc_t ipmgmt_db_initif;
95
96 /*
97 * A linked list of address object nodes. Each node in the list tracks
98 * following information for the address object identified by `am_aobjname'.
99 * - interface on which the address is created
100 * - logical interface number on which the address is created
101 * - address family
102 * - `am_nextnum' identifies the next number to use to generate user part
103 * of `aobjname'.
104 * - address type (static, dhcp or addrconf)
105 * - `am_flags' indicates if this addrobj in active and/or persist config
106 * - if `am_atype' is IPADM_ADDR_IPV6_ADDRCONF then `am_ifid' holds the
107 * interface-id used to configure auto-configured addresses
108 */
109 typedef struct ipmgmt_aobjmap_s {
110 struct ipmgmt_aobjmap_s *am_next;
111 char am_aobjname[IPADM_AOBJSIZ];
112 char am_ifname[LIFNAMSIZ];
113 int32_t am_lnum;
114 sa_family_t am_family;
115 ipadm_addr_type_t am_atype;
116 uint32_t am_nextnum;
117 uint32_t am_flags;
118 boolean_t am_linklocal;
119 struct sockaddr_storage am_ifid;
120 } ipmgmt_aobjmap_t;
121
122 /* linked list of `aobjmap' nodes, protected by RW lock */
123 typedef struct ipmgmt_aobjmap_list_s {
124 ipmgmt_aobjmap_t *aobjmap_head;
125 pthread_rwlock_t aobjmap_rwlock;
126 } ipmgmt_aobjmap_list_t;
127
128 /* global `aobjmap' defined in ipmgmt_main.c */
129 extern ipmgmt_aobjmap_list_t aobjmap;
130
131 /* operations on the `aobjmap' linked list */
132 #define ADDROBJ_ADD 0x00000001
133 #define ADDROBJ_DELETE 0x00000002
134 #define ADDROBJ_LOOKUPADD 0x00000004
135 #define ADDROBJ_SETLIFNUM 0x00000008
136
137 /* Permanent data store for ipadm */
138 #define IPADM_DB_FILE "/etc/ipadm/ipadm.conf"
139 #define IPADM_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)
140
141 /*
142 * With the initial integration of the daemon (PSARC 2010/080), the version
143 * of the ipadm data-store (/etc/ipadm/ipadm.conf) was 0. A subsequent fix
144 * needed an upgrade to the data-store and we bumped the version to 1.
145 */
146 #define IPADM_DB_VERSION 1
147
148 /*
149 * A temporary file created in SMF volatile filesystem. This file captures the
150 * in-memory copy of list `aobjmap' on disk. This is done to recover from
151 * daemon reboot (using svcadm) or crashes.
152 */
153 #define IPADM_TMPFS_DIR "/etc/svc/volatile/ipadm"
154 #define ADDROBJ_MAPPING_DB_FILE IPADM_TMPFS_DIR"/aobjmap.conf"
155
156 /*
157 * A temporary copy of the ipadm configuration file might need
158 * to be created if write requests are encountered during boottime
159 * and the root filesystem is mounted read-only.
160 */
161 #define IPADM_VOL_DB_FILE IPADM_TMPFS_DIR"/ipadm.conf"
162
163 /* SCF resources required to interact with svc.configd */
164 typedef struct scf_resources {
165 scf_handle_t *sr_handle;
166 scf_instance_t *sr_inst;
167 scf_propertygroup_t *sr_pg;
168 scf_property_t *sr_prop;
169 scf_value_t *sr_val;
170 scf_transaction_t *sr_tx;
171 scf_transaction_entry_t *sr_ent;
172 } scf_resources_t;
173
174 extern int ipmgmt_update_family_nvp(nvlist_t *,
175 sa_family_t, uint_t);
176 extern int ipmgmt_db_walk(db_wfunc_t *, void *, ipadm_db_op_t);
177 extern int ipmgmt_aobjmap_op(ipmgmt_aobjmap_t *, uint32_t);
178 extern boolean_t ipmgmt_aobjmap_init(void *, nvlist_t *, char *,
179 size_t, int *);
180 extern int ipmgmt_persist_aobjmap(ipmgmt_aobjmap_t *,
181 ipadm_db_op_t);
182 extern boolean_t ipmgmt_ngz_firstboot_postinstall();
183 extern int ipmgmt_persist_if(ipmgmt_if_arg_t *);
184 extern void ipmgmt_init_prop();
185 extern boolean_t ipmgmt_db_upgrade(void *, nvlist_t *, char *,
186 size_t, int *);
187 extern int ipmgmt_create_scf_resources(const char *,
188 scf_resources_t *);
189 extern void ipmgmt_release_scf_resources(scf_resources_t *);
190 extern boolean_t ipmgmt_needs_upgrade(scf_resources_t *);
191 extern void ipmgmt_update_dbver(scf_resources_t *);
192
193 #ifdef __cplusplus
194 }
195 #endif
196
197 #endif /* _IPMGMT_IMPL_H */