1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/**
 * Copyright (c) 2008-2024 by Altair Engineering, Inc.
 * All rights reserved.
 *
 * Altair Engineering, Inc. makes this software available as part of the Vision
 * tool platform.  As long as you are a licensee of the Vision tool platform
 * you may make copies of the software and modify it to be used within the
 * Vision tool platform, but you must include all of this notice on any copy.
 * Redistribution without written permission to any third party, with or
 * without modification, is not permitted.
 * Altair Engineering, Inc. does not warrant that this software is error free
 * or fit for any purpose.  Altair Engineering, Inc. disclaims any liability for
 * all claims, expenses, losses, damages and costs any user may incur as a
 * result of using, copying or modifying the software.
 * ============================================================================
 *   @c-code
 *       Create And Use Oids Via C-Level API
 *   @section
 *       C Level Examples
 *   @description
 *       Create and use OIDs the C-Level API.
 *   @files
 *       zdb/useOids.c
 *   @tag
 *       zdb
 */


#include <stdio.h>

#include "zos/ztypes.h"
#include "zos/zos.h"
#include "zos/zerror.h"
#include "util/zlicenseOEM.h"
#include "zdb/zdb.h"
#include "zdb/zdbmem.h"
#include "zdb/zvalidate.h"
#include "zdb/zoid.h"


/**
 * This is an error handling function. Print the given msg to stderr and
 * return an error code (not equal 0).
 */
static int errorAndQuit(const char* msg) {
    fprintf(stderr, "%s\n", msg);

    return 1;
}

/**
 * Main function.
 */
int main(int argc, char** argv) {
    DB*         zdb     = NULL;
    Module*     top     = NULL;
    Module*     sub     = NULL;
    Module*     low     = NULL;
    Inst*       instLow = NULL;
    Inst*       instSub = NULL;
    Net*        net1    = NULL;
    Net*        net2    = NULL;
    Inst*       path[2];
    const char* strPath[3];
    OID         oidA1, oidB1, oidC1;
    OID         oidA2, oidB2, oidC2;
    zBool       ok;
    UNUSED(argc);
    UNUSED(argv);

    /**
     * Create a new database. Use a binfile to store the data.
     */
    zdb = zNewDataBase();
    if (!zdb) {
        return errorAndQuit(zGetError());
    }

    /**
     * Set the creator feature (aka parser bit).
     */
    if (!zLicenseSetParserBit(zdb, "Userware_Demo")) {
        return errorAndQuit(zGetError());
    }

    /**
     * Create a low-module.
     */
    low = zNewModule(zdb, "LOW");
    if (!low) {
        return errorAndQuit(zGetError());
    }

    /**
     * Create nets.
     */
    net1 = zNewNet(zdb, low, "net1");
    net2 = zNewNet(zdb, low, "net2");
    if (!net1 || !net2) {
        return errorAndQuit(zGetError());
    }

    /**
     * Create a sub-module.
     */
    sub = zNewModule(zdb, "SUB");
    if (!sub) {
        return errorAndQuit(zGetError());
    }

    /**
     * Create one instance of the SUB module.
     */
    instLow = zNewInst(zdb, sub, "iLow", (Cell*)low);

    /**
     * Create a new top level module.
     */
    top = zNewModule(zdb, "TOP");
    if (!top) {
        return errorAndQuit(zGetError());
    }
    if (!zTopModule(zdb, top)) {
        return errorAndQuit(zGetError());
    }

    /**
     * Create one instance of the SUB module.
     */
    instSub = zNewInst(zdb, top, "iSub", (Cell*)sub);
    if (!instSub) {
        return errorAndQuit(zGetError());
    }

    /**
     * Validate the database.
     */
    if (!zValidateDB(zdb, 0)) {
        return errorAndQuit(zGetError());
    }

    /**
     * Create path.
     */
    path[0] = instSub;
    path[1] = instLow;

    /**
     * Create Oids from path with pointers.
     */
    zOID_setNet(&oidA1, top, path, 2, net1);
    zOID_ref(&oidA1);
    zOID_setNet(&oidA2, top, path, 2, net2);
    zOID_ref(&oidA2);

    /**
     * Create Oids from string.
     */
    ok = zOID_createFromString(zdb, &oidB1, OidNet, top,
                               "iSub/iLow/net1", '/', '/', '\0', NULL,
                               zFalse, zFalse, zFalse, zFalse);
    if (!ok) {
        return errorAndQuit(zGetError());
    }
    zOID_ref(&oidB1);
    ok = zOID_createFromString(zdb, &oidB2, OidNet, top,
                               "iSub/iLow/net2", '/', '/', '\0', NULL,
                               zFalse, zFalse, zFalse, zFalse);
    if (!ok) {
        return errorAndQuit(zGetError());
    }
    zOID_ref(&oidB2);

    if (!zOID_IsEqual(oidA1, oidB1) ||
        !zOID_IsEqual(oidA2, oidB2)
    ) {
        return errorAndQuit("oids A and B differ");
    }


    /**
     * Create Oids from string path list.
     */
    strPath[0] = "TOP";
    strPath[1] = "iSub";
    strPath[2] = "iLow";
    ok = zOID_createFromStringList(zdb, OidNet, strPath, 3, "net1",
                               zFalse, zFalse, zFalse, zFalse, &oidC1);
    if (!ok) {
        return errorAndQuit(zGetError());
    }
    zOID_ref(&oidC1);
    ok = zOID_createFromStringList(zdb, OidNet, strPath, 3, "net2",
                               zFalse, zFalse, zFalse, zFalse, &oidC2);
    if (!ok) {
        return errorAndQuit(zGetError());
    }
    zOID_ref(&oidC2);

    if (!zOID_IsEqual(oidB1, oidC1) ||
        !zOID_IsEqual(oidB2, oidC2)
    ) {
        return errorAndQuit("oids B and C differ");
    }

    /**
     * Unref all oids.
     */
    zOID_unref(&oidA1);
    zOID_unref(&oidA2);
    zOID_unref(&oidB1);
    zOID_unref(&oidB2);
    zOID_unref(&oidC1);
    zOID_unref(&oidC2);

    /**
     * Close the database.
     */
    if (!zCloseDataBase(zdb)) {
        return errorAndQuit(zGetError());
    }

    return 0;
}