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) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright 2017 Joyent, Inc.
  25  */
  26 
  27 /*
  28  * Functions to maintain a table of datalink configuration information.
  29  */
  30 
  31 #ifndef _DLMGMT_IMPL_H
  32 #define _DLMGMT_IMPL_H
  33 
  34 #ifdef  __cplusplus
  35 extern "C" {
  36 #endif
  37 
  38 #include <door.h>
  39 #include <libdllink.h>
  40 #include <sys/avl.h>
  41 
  42 /*
  43  * datalink attribute structure
  44  */
  45 typedef struct dlmgmt_linkattr_s {
  46         struct dlmgmt_linkattr_s        *lp_next;
  47         struct dlmgmt_linkattr_s        *lp_prev;
  48         char                            lp_name[MAXLINKATTRLEN];
  49         void                            *lp_val;
  50         dladm_datatype_t                lp_type;
  51         uint_t                          lp_sz;
  52         boolean_t                       lp_linkprop;
  53 } dlmgmt_linkattr_t;
  54 
  55 /*
  56  * datalink structure
  57  */
  58 typedef struct dlmgmt_link_s {
  59         dlmgmt_linkattr_t       *ll_head;
  60         char                    ll_link[MAXLINKNAMELEN];
  61         datalink_class_t        ll_class;
  62         uint32_t                ll_media;
  63         datalink_id_t           ll_linkid;
  64 
  65         /*
  66          * The zone that owns the link. If this is set to the id of
  67          * an NGZ and ll_onloan is set then the link was created and
  68          * is owned by the GZ but is currently being loaned out to an
  69          * NGZ. E.g., when the GZ admin creates a VNIC for exclusive
  70          * use by an NGZ. If ll_onloan is set then ll_zoneid cannot be 0.
  71          *
  72          * If ll_zoneid is set to the id of an NGZ but ll_onloan is
  73          * not set then the link was created and is owned by the NGZ.
  74          */
  75         zoneid_t                ll_zoneid;
  76         boolean_t               ll_onloan;
  77         avl_node_t              ll_name_node;
  78         avl_node_t              ll_id_node;
  79         uint32_t                ll_flags;
  80         uint32_t                ll_gen;         /* generation number */
  81         boolean_t               ll_trans;       /* transient link */
  82 } dlmgmt_link_t;
  83 
  84 /*
  85  * datalink configuration request structure
  86  */
  87 typedef struct dlmgmt_dlconf_s {
  88         dlmgmt_linkattr_t       *ld_head;
  89         char                    ld_link[MAXLINKNAMELEN];
  90         datalink_id_t           ld_linkid;
  91         datalink_class_t        ld_class;
  92         uint32_t                ld_media;
  93         int                     ld_id;
  94         zoneid_t                ld_zoneid;
  95         uint32_t                ld_gen;
  96         avl_node_t              ld_node;
  97 } dlmgmt_dlconf_t;
  98 
  99 extern boolean_t        debug;
 100 extern const char       *progname;
 101 extern char             cachefile[];
 102 extern dladm_handle_t   dld_handle;
 103 extern datalink_id_t    dlmgmt_nextlinkid;
 104 extern avl_tree_t       dlmgmt_name_avl;
 105 extern avl_tree_t       dlmgmt_id_avl;
 106 extern avl_tree_t       dlmgmt_dlconf_avl;
 107 
 108 boolean_t       linkattr_equal(dlmgmt_linkattr_t **, const char *, void *,
 109                     size_t);
 110 dlmgmt_linkattr_t *linkattr_find(dlmgmt_linkattr_t *, const char *);
 111 void            linkattr_unset(dlmgmt_linkattr_t **, const char *);
 112 int             linkattr_set(dlmgmt_linkattr_t **, const char *, void *,
 113                     size_t, dladm_datatype_t);
 114 int             linkattr_get(dlmgmt_linkattr_t **, const char *, void **,
 115                     size_t *, dladm_datatype_t *);
 116 void            linkattr_destroy(dlmgmt_link_t *);
 117 
 118 void            link_destroy(dlmgmt_link_t *);
 119 int             link_activate(dlmgmt_link_t *);
 120 boolean_t       link_is_visible(dlmgmt_link_t *, zoneid_t);
 121 dlmgmt_link_t   *link_by_id(datalink_id_t, zoneid_t);
 122 dlmgmt_link_t   *link_by_name(const char *, zoneid_t);
 123 int             dlmgmt_create_common(const char *, datalink_class_t,
 124                     uint32_t, zoneid_t, uint32_t, dlmgmt_link_t **);
 125 int             dlmgmt_destroy_common(dlmgmt_link_t *, uint32_t);
 126 int             dlmgmt_getattr_common(dlmgmt_linkattr_t **, const char *,
 127                     dlmgmt_getattr_retval_t *);
 128 
 129 void            dlmgmt_advance(dlmgmt_link_t *);
 130 void            dlmgmt_table_lock(boolean_t);
 131 void            dlmgmt_table_unlock();
 132 
 133 int             dlconf_create(const char *, datalink_id_t, datalink_class_t,
 134                     uint32_t, zoneid_t, dlmgmt_dlconf_t **);
 135 void            dlconf_destroy(dlmgmt_dlconf_t *);
 136 void            dlmgmt_advance_dlconfid(dlmgmt_dlconf_t *);
 137 void            dlmgmt_dlconf_table_lock(boolean_t);
 138 void            dlmgmt_dlconf_table_unlock(void);
 139 
 140 int             dlmgmt_generate_name(const char *, char *, size_t, zoneid_t);
 141 
 142 void            dlmgmt_linktable_init(void);
 143 void            dlmgmt_linktable_fini(void);
 144 
 145 int             dlmgmt_zone_init(zoneid_t);
 146 int             dlmgmt_elevate_privileges(void);
 147 int             dlmgmt_drop_privileges();
 148 void            dlmgmt_handler(void *, char *, size_t, door_desc_t *, uint_t);
 149 void            dlmgmt_log(int, const char *, ...);
 150 int             dlmgmt_write_db_entry(const char *, dlmgmt_link_t *, uint32_t);
 151 int             dlmgmt_delete_db_entry(dlmgmt_link_t *, uint32_t);
 152 int             dlmgmt_db_init(zoneid_t, char *);
 153 void            dlmgmt_db_fini(zoneid_t);
 154 
 155 #ifdef  __cplusplus
 156 }
 157 #endif
 158 
 159 #endif  /* _DLMGMT_IMPL_H */