xref: /qemu/util/id.c (revision 27eb3722)
1f5bebbbbSMarkus Armbruster /*
2f5bebbbbSMarkus Armbruster  * Dealing with identifiers
3f5bebbbbSMarkus Armbruster  *
4f5bebbbbSMarkus Armbruster  * Copyright (C) 2014 Red Hat, Inc.
5f5bebbbbSMarkus Armbruster  *
6f5bebbbbSMarkus Armbruster  * Authors:
7f5bebbbbSMarkus Armbruster  *  Markus Armbruster <armbru@redhat.com>,
8f5bebbbbSMarkus Armbruster  *
9f5bebbbbSMarkus Armbruster  * This work is licensed under the terms of the GNU LGPL, version 2.1
10f5bebbbbSMarkus Armbruster  * or later.  See the COPYING.LIB file in the top-level directory.
11f5bebbbbSMarkus Armbruster  */
12f5bebbbbSMarkus Armbruster 
13aafd7584SPeter Maydell #include "qemu/osdep.h"
14856dfd8aSMarkus Armbruster #include "qemu/ctype.h"
15f348b6d1SVeronia Bahaa #include "qemu/id.h"
16f5bebbbbSMarkus Armbruster 
id_wellformed(const char * id)17f5bebbbbSMarkus Armbruster bool id_wellformed(const char *id)
18f5bebbbbSMarkus Armbruster {
19f5bebbbbSMarkus Armbruster     int i;
20f5bebbbbSMarkus Armbruster 
21f5bebbbbSMarkus Armbruster     if (!qemu_isalpha(id[0])) {
22f5bebbbbSMarkus Armbruster         return false;
23f5bebbbbSMarkus Armbruster     }
24f5bebbbbSMarkus Armbruster     for (i = 1; id[i]; i++) {
25f5bebbbbSMarkus Armbruster         if (!qemu_isalnum(id[i]) && !strchr("-._", id[i])) {
26f5bebbbbSMarkus Armbruster             return false;
27f5bebbbbSMarkus Armbruster         }
28f5bebbbbSMarkus Armbruster     }
29f5bebbbbSMarkus Armbruster     return true;
30f5bebbbbSMarkus Armbruster }
31a0f19136SJeff Cody 
32a0f19136SJeff Cody #define ID_SPECIAL_CHAR '#'
33a0f19136SJeff Cody 
34624533e5SJohn Snow static const char *const id_subsys_str[ID_MAX] = {
35a0f19136SJeff Cody     [ID_QDEV]  = "qdev",
36a0f19136SJeff Cody     [ID_BLOCK] = "block",
371e419ee6SMarc-André Lureau     [ID_CHR] = "chr",
38*27eb3722SThomas Huth     [ID_NET] = "net",
39a0f19136SJeff Cody };
40a0f19136SJeff Cody 
41a0f19136SJeff Cody /*
42a0f19136SJeff Cody  *  Generates an ID of the form PREFIX SUBSYSTEM NUMBER
43a0f19136SJeff Cody  *  where:
44a0f19136SJeff Cody  *
45a0f19136SJeff Cody  *  - PREFIX is the reserved character '#'
46a0f19136SJeff Cody  *  - SUBSYSTEM identifies the subsystem creating the ID
47a0f19136SJeff Cody  *  - NUMBER is a decimal number unique within SUBSYSTEM.
48a0f19136SJeff Cody  *
49a0f19136SJeff Cody  *    Example: "#block146"
50a0f19136SJeff Cody  *
51a0f19136SJeff Cody  * Note that these IDs do not satisfy id_wellformed().
52a0f19136SJeff Cody  *
53a0f19136SJeff Cody  * The caller is responsible for freeing the returned string with g_free()
54a0f19136SJeff Cody  */
id_generate(IdSubSystems id)55a0f19136SJeff Cody char *id_generate(IdSubSystems id)
56a0f19136SJeff Cody {
57a0f19136SJeff Cody     static uint64_t id_counters[ID_MAX];
58a0f19136SJeff Cody     uint32_t rnd;
59a0f19136SJeff Cody 
60624533e5SJohn Snow     assert(id < ARRAY_SIZE(id_subsys_str));
61a0f19136SJeff Cody     assert(id_subsys_str[id]);
62a0f19136SJeff Cody 
63a0f19136SJeff Cody     rnd = g_random_int_range(0, 100);
64a0f19136SJeff Cody 
65a0f19136SJeff Cody     return g_strdup_printf("%c%s%" PRIu64 "%02" PRId32, ID_SPECIAL_CHAR,
66a0f19136SJeff Cody                                                         id_subsys_str[id],
67a0f19136SJeff Cody                                                         id_counters[id]++,
68a0f19136SJeff Cody                                                         rnd);
69a0f19136SJeff Cody }
70