libdllink.h revision 8431:a7ddfd0e9ee1 
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 2008 Sun Microsystems, Inc.  All rights reserved.
23 * Use is subject to license terms.
24 */
25
26#ifndef _LIBDLLINK_H
27#define	_LIBDLLINK_H
28
29/*
30 * This file includes structures, macros and routines used by general
31 * link administration (i.e. not limited to one specific type of link).
32 */
33
34#include <stdio.h>
35#include <sys/types.h>
36#include <sys/param.h>
37#include <libdladm.h>
38#include <libdladm_impl.h>
39#include <sys/mac_flow.h>
40
41#ifdef	__cplusplus
42extern "C" {
43#endif
44
45typedef struct dladm_attr {
46	uint_t			da_max_sdu;
47} dladm_attr_t;
48
49typedef struct dladm_phys_attr {
50	char		dp_dev[MAXLINKNAMELEN];
51	/*
52	 * Whether this physical link supports vanity naming (links with media
53	 * types not supported by GLDv3 don't have vanity naming support).
54	 */
55	boolean_t	dp_novanity;
56} dladm_phys_attr_t;
57
58typedef enum {
59	DLADM_PROP_VAL_CURRENT = 1,
60	DLADM_PROP_VAL_DEFAULT,
61	DLADM_PROP_VAL_PERM,
62	DLADM_PROP_VAL_MODIFIABLE,
63	DLADM_PROP_VAL_PERSISTENT
64} dladm_prop_type_t;
65
66/*
67 * Maximum size of secobj value. Note that it should not be greater than
68 * DLD_SECOBJ_VAL_MAX.
69 */
70#define	DLADM_SECOBJ_VAL_MAX	256
71
72/*
73 * Maximum size of secobj name. Note that it should not be greater than
74 * DLD_SECOBJ_NAME_MAX.
75 */
76#define	DLADM_SECOBJ_NAME_MAX	32
77
78#define	DLADM_MAX_PROP_VALCNT	32
79/*
80 * Size of prop_val buffer passed to pd_get function must be at
81 * least DLADM_PROP_VAL_MAX
82 */
83#define	DLADM_PROP_VAL_MAX	128
84
85#define		DLADM_SECOBJ_CLASS_WEP	0
86#define		DLADM_SECOBJ_CLASS_WPA	1
87typedef int	dladm_secobj_class_t;
88
89typedef int (dladm_walkcb_t)(const char *, void *);
90
91/* possible flags for ma_flags below */
92#define	DLADM_MACADDR_USED	0x1
93
94typedef enum {
95	DLADM_HWGRP_TYPE_RX = 0x1,
96	DLADM_HWGRP_TYPE_TX
97} dladm_hwgrp_type_t;
98
99typedef struct dladm_hwgrp_attr {
100	char		hg_link_name[MAXLINKNAMELEN];
101	uint_t		hg_grp_num;
102	dladm_hwgrp_type_t	hg_grp_type;
103	uint_t		hg_n_rings;
104	uint_t		hg_n_clnts;
105	char		hg_client_names[MAXCLIENTNAMELEN];
106} dladm_hwgrp_attr_t;
107
108typedef struct dladm_macaddr_attr {
109	uint_t		ma_slot;
110	uint_t		ma_flags;
111	uchar_t		ma_addr[MAXMACADDRLEN];
112	uint_t		ma_addrlen;
113	char		ma_client_name[MAXNAMELEN];
114	datalink_id_t	ma_client_linkid;
115} dladm_macaddr_attr_t;
116
117extern dladm_status_t	dladm_walk(dladm_walkcb_t *, void *, datalink_class_t,
118			    datalink_media_t, uint32_t);
119extern dladm_status_t	dladm_mac_walk(dladm_walkcb_t *, void *);
120extern dladm_status_t	dladm_info(datalink_id_t, dladm_attr_t *);
121extern dladm_status_t	dladm_setzid(const char *, char *);
122
123extern dladm_status_t	dladm_rename_link(const char *, const char *);
124
125extern dladm_status_t	dladm_set_linkprop(datalink_id_t, const char *,
126			    char **, uint_t, uint_t);
127extern dladm_status_t	dladm_get_linkprop(datalink_id_t, dladm_prop_type_t,
128			    const char *, char **, uint_t *);
129extern dladm_status_t	dladm_walk_linkprop(datalink_id_t, void *,
130			    int (*)(datalink_id_t, const char *, void *));
131
132extern dladm_status_t	dladm_set_secobj(const char *, dladm_secobj_class_t,
133			    uint8_t *, uint_t, uint_t);
134extern dladm_status_t	dladm_get_secobj(const char *, dladm_secobj_class_t *,
135			    uint8_t *, uint_t *, uint_t);
136extern dladm_status_t	dladm_unset_secobj(const char *, uint_t);
137extern dladm_status_t	dladm_walk_secobj(void *,
138			    boolean_t (*)(void *, const char *), uint_t);
139
140extern const char	*dladm_linkstate2str(link_state_t, char *);
141extern const char	*dladm_linkduplex2str(link_duplex_t, char *);
142extern const char	*dladm_secobjclass2str(dladm_secobj_class_t, char *);
143extern dladm_status_t	dladm_str2secobjclass(const char *,
144			    dladm_secobj_class_t *);
145
146extern dladm_status_t	dladm_init_linkprop(datalink_id_t, boolean_t);
147extern dladm_status_t	dladm_init_secobj(void);
148extern boolean_t	dladm_valid_secobj_name(const char *);
149
150extern dladm_status_t	dladm_create_datalink_id(const char *, datalink_class_t,
151			    uint_t, uint32_t, datalink_id_t *);
152extern dladm_status_t	dladm_destroy_datalink_id(datalink_id_t, uint32_t);
153extern dladm_status_t	dladm_remap_datalink_id(datalink_id_t, const char *);
154extern dladm_status_t	dladm_up_datalink_id(datalink_id_t);
155extern dladm_status_t	dladm_name2info(const char *, datalink_id_t *,
156			    uint32_t *, datalink_class_t *, uint32_t *);
157extern dladm_status_t	dladm_datalink_id2info(datalink_id_t, uint32_t *,
158			    datalink_class_t *, uint32_t *, char *, size_t);
159extern dladm_status_t	dladm_walk_datalink_id(int (*)(datalink_id_t, void *),
160			    void *, datalink_class_t, datalink_media_t,
161			    uint32_t);
162extern dladm_status_t	dladm_create_conf(const char *, datalink_id_t,
163			    datalink_class_t, uint32_t, dladm_conf_t *);
164extern dladm_status_t	dladm_read_conf(datalink_id_t, dladm_conf_t *);
165extern dladm_status_t	dladm_write_conf(dladm_conf_t);
166extern dladm_status_t	dladm_remove_conf(datalink_id_t);
167extern void		dladm_destroy_conf(dladm_conf_t);
168extern dladm_status_t	dladm_get_conf_field(dladm_conf_t, const char *,
169			    void *, size_t);
170extern dladm_status_t	dladm_set_conf_field(dladm_conf_t, const char *,
171			    dladm_datatype_t, const void *);
172extern dladm_status_t	dladm_unset_conf_field(dladm_conf_t, const char *);
173
174extern dladm_status_t	dladm_dev2linkid(const char *, datalink_id_t *);
175extern dladm_status_t	dladm_linkid2legacyname(datalink_id_t, char *, size_t);
176extern dladm_status_t	dladm_phys_delete(datalink_id_t);
177
178extern dladm_status_t	dladm_phys_info(datalink_id_t, dladm_phys_attr_t *,
179			    uint32_t);
180extern dladm_status_t	dladm_parselink(const char *, char *, uint_t *);
181
182extern int		dladm_walk_macaddr(datalink_id_t, void *,
183			    boolean_t (*)(void *, dladm_macaddr_attr_t *));
184extern int		dladm_walk_hwgrp(datalink_id_t, void *,
185			    boolean_t (*)(void *, dladm_hwgrp_attr_t *));
186
187extern dladm_status_t	dladm_link_get_proplist(datalink_id_t,
188			    dladm_arg_list_t **);
189
190extern dladm_status_t	i_dladm_set_link_proplist_db(char *,
191			    dladm_arg_list_t *);
192
193#ifdef	__cplusplus
194}
195#endif
196
197#endif	/* _LIBDLLINK_H */
198