Commit 01b00d75400fefc6f63e249b89b94d3a47368c96

Ran Benita 2012-09-24T12:11:31

keymap, symbols: improve xkb_key memory layout Add struct xkb_group and xkb_level for use in xkb_key, to mirror how it's done in KeyInfo, GroupInfo, LevelInfo in symbols.c. This corresponds more nicely to the logical data layout (i.e. a key has groups which have levels), and also removes a lot of copying and ugly code due to the index indirections and separate arrays which were used before. This uses more memory in some places (e.g. we alloc an action for every level even if the key doesn't have any) but less in other places (e.g. we no longer have to pad each group to ->width levels). The numbers say we use less overall. Signed-off-by: Ran Benita <ran234@gmail.com>

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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
diff --git a/src/keymap-dump.c b/src/keymap-dump.c
index 72db22b..6311813 100644
--- a/src/keymap-dump.c
+++ b/src/keymap-dump.c
@@ -622,29 +622,32 @@ write_symbols(struct xkb_keymap *keymap, struct buf *buf)
 
     xkb_foreach_key(key, keymap) {
         bool simple = true;
+        bool explicit_types = false;
+        bool multi_type = false;
 
         if (key->num_groups == 0)
             continue;
 
         write_buf(buf, "\t\tkey %6s {", KeyNameText(key->name));
 
-        if (key->explicit_groups) {
-            bool multi_type = false;
-            struct xkb_key_type *type = XkbKeyType(keymap, key, 0);
+        for (group = 0; group < key->num_groups; group++) {
+            if (key->groups[group].explicit_type)
+                explicit_types = true;
 
-            simple = false;
+            if (group != 0 &&
+                XkbKeyType(keymap, key, group) != XkbKeyType(keymap, key, 0))
+                multi_type = true;
+        }
 
-            for (group = 1; group < key->num_groups; group++) {
-                if (XkbKeyType(keymap, key, group) != type) {
-                    multi_type = true;
-                    break;
-                }
-            }
+        if (explicit_types) {
+            struct xkb_key_type *type = XkbKeyType(keymap, key, 0);
+            simple = false;
 
             if (multi_type) {
                 for (group = 0; group < key->num_groups; group++) {
-                    if (!(key->explicit_groups & (1 << group)))
+                    if (!key->groups[group].explicit_type)
                         continue;
+
                     type = XkbKeyType(keymap, key, group);
                     write_buf(buf, "\n\t\t\ttype[group%u]= \"%s\",",
                               group + 1,
@@ -685,10 +688,7 @@ write_symbols(struct xkb_keymap *keymap, struct buf *buf)
             break;
         }
 
-        if (key->explicit & EXPLICIT_INTERP)
-            showActions = (key->actions != NULL);
-        else
-            showActions = false;
+        showActions = !!(key->explicit & EXPLICIT_INTERP);
 
         if (key->num_groups > 1 || showActions)
             simple = false;
diff --git a/src/keymap.c b/src/keymap.c
index a36a404..daf3ab2 100644
--- a/src/keymap.c
+++ b/src/keymap.c
@@ -83,25 +83,27 @@ xkb_keymap_ref(struct xkb_keymap *keymap)
 XKB_EXPORT void
 xkb_keymap_unref(struct xkb_keymap *keymap)
 {
-    unsigned int i;
+    unsigned int i, j;
     struct xkb_key *key;
 
     if (!keymap || --keymap->refcnt > 0)
         return;
 
+    darray_foreach(key, keymap->keys) {
+        for (i = 0; i < key->num_groups; i++) {
+            for (j = 0; j < XkbKeyGroupWidth(keymap, key, i); j++)
+                if (key->groups[i].levels[j].num_syms > 1)
+                    free(key->groups[i].levels[j].u.syms);
+            free(key->groups[i].levels);
+        }
+        free(key->groups);
+    }
+    darray_free(keymap->keys);
     for (i = 0; i < keymap->num_types; i++) {
         free(keymap->types[i].map);
         free(keymap->types[i].level_names);
     }
     free(keymap->types);
-    darray_foreach(key, keymap->keys) {
-        free(key->sym_index);
-        free(key->num_syms);
-        free(key->syms);
-        free(key->actions);
-        free(key->kt_index);
-    }
-    darray_free(keymap->keys);
     darray_free(keymap->sym_interpret);
     darray_free(keymap->key_aliases);
     darray_free(keymap->group_names);
diff --git a/src/keymap.h b/src/keymap.h
index 843c223..243a5cf 100644
--- a/src/keymap.h
+++ b/src/keymap.h
@@ -320,34 +320,38 @@ enum xkb_explicit_components {
     EXPLICIT_REPEAT = (1 << 2),
 };
 
+struct xkb_level {
+    union xkb_action action;
+    unsigned int num_syms;
+    union {
+        xkb_keysym_t sym;       /* num_syms == 1 */
+        xkb_keysym_t *syms;     /* num_syms > 1  */
+    } u;
+};
+
+struct xkb_group {
+    bool explicit_type;
+    unsigned type_index;
+    /* Use XkbKeyGroupWidth for the number of levels. */
+    struct xkb_level *levels;
+};
+
 struct xkb_key {
     xkb_keycode_t keycode;
     char name[XKB_KEY_NAME_LENGTH];
 
     enum xkb_explicit_components explicit;
-    xkb_layout_mask_t explicit_groups;
 
     unsigned char modmap;
     xkb_mod_mask_t vmodmap;
 
     bool repeats;
 
-    union xkb_action *actions;
-
-    unsigned *kt_index;
-
-    xkb_layout_index_t num_groups;
-    /* How many levels the largest group has. */
-    xkb_level_index_t width;
-
     enum xkb_range_exceed_type out_of_range_group_action;
     xkb_layout_index_t out_of_range_group_number;
 
-    /* per level/group index into 'syms' */
-    int *sym_index;
-    /* per level/group */
-    unsigned int *num_syms;
-    xkb_keysym_t *syms;
+    xkb_layout_index_t num_groups;
+    struct xkb_group *groups;
 };
 
 typedef darray(xkb_atom_t) darray_xkb_atom_t;
@@ -406,7 +410,7 @@ static inline struct xkb_key_type *
 XkbKeyType(struct xkb_keymap *keymap, const struct xkb_key *key,
            xkb_layout_index_t layout)
 {
-    return &keymap->types[key->kt_index[layout]];
+    return &keymap->types[key->groups[layout].type_index];
 }
 
 static inline xkb_level_index_t
@@ -420,21 +424,24 @@ static inline unsigned int
 XkbKeyNumSyms(const struct xkb_key *key, xkb_layout_index_t layout,
               xkb_level_index_t level)
 {
-    return key->num_syms[layout * key->width + level];
+    return key->groups[layout].levels[level].num_syms;
 }
 
 static inline const xkb_keysym_t *
 XkbKeySymEntry(const struct xkb_key *key, xkb_layout_index_t layout,
                xkb_level_index_t level)
 {
-    return &key->syms[key->sym_index[layout * key->width + level]];
+    if (XkbKeyNumSyms(key, layout, level) <= 1)
+        return &key->groups[layout].levels[level].u.sym;
+    else
+        return key->groups[layout].levels[level].u.syms;
 }
 
 static inline const union xkb_action *
 XkbKeyActionEntry(const struct xkb_key *key, xkb_layout_index_t layout,
                   xkb_level_index_t level)
 {
-    return &key->actions[key->width * layout + level];
+    return &key->groups[layout].levels[level].action;
 }
 
 struct xkb_keymap *
diff --git a/src/state.c b/src/state.c
index ef770cc..22ca9e5 100644
--- a/src/state.c
+++ b/src/state.c
@@ -210,9 +210,6 @@ xkb_key_get_action(struct xkb_state *state, const struct xkb_key *key)
     xkb_layout_index_t layout;
     xkb_level_index_t level;
 
-    if (!key->actions)
-        return &fake;
-
     layout = xkb_state_key_get_layout(state, key->keycode);
     if (layout == XKB_LAYOUT_INVALID)
         return &fake;
diff --git a/src/xkbcomp/keymap.c b/src/xkbcomp/keymap.c
index 6ca91d1..93690a2 100644
--- a/src/xkbcomp/keymap.c
+++ b/src/xkbcomp/keymap.c
@@ -161,16 +161,8 @@ ApplyInterpsToKey(struct xkb_keymap *keymap, struct xkb_key *key)
                     vmodmask |= (1 << interp->virtual_mod);
             }
 
-            if (interp->act.type != ACTION_TYPE_NONE) {
-                if (!key->actions) {
-                    key->actions = calloc(key->num_groups * key->width,
-                                          sizeof(*key->actions));
-                    if (!key->actions)
-                        return false;
-                }
-
-                key->actions[group * key->width + level] = interp->act;
-            }
+            if (interp->act.type != ACTION_TYPE_NONE)
+                key->groups[group].levels[level].action = interp->act;
         }
     }
 
@@ -226,13 +218,11 @@ UpdateDerivedKeymapFields(struct xkb_keymap *keymap)
     }
 
     /* Update action modifiers. */
-    xkb_foreach_key(key, keymap) {
-        if (!key->actions)
-            continue;
-
-        for (i = 0; i < key->num_groups * key->width; i++)
-            UpdateActionMods(keymap, &key->actions[i], key->modmap);
-    }
+    xkb_foreach_key(key, keymap)
+        for (i = 0; i < key->num_groups; i++)
+            for (j = 0; j < XkbKeyGroupWidth(keymap, key, i); j++)
+                UpdateActionMods(keymap, &key->groups[i].levels[j].action,
+                                 key->modmap);
 
     /* Update vmod -> indicator maps. */
     for (led = 0; led < XKB_NUM_INDICATORS; led++)
diff --git a/src/xkbcomp/symbols.c b/src/xkbcomp/symbols.c
index f6c822f..889a915 100644
--- a/src/xkbcomp/symbols.c
+++ b/src/xkbcomp/symbols.c
@@ -80,17 +80,8 @@ enum key_field {
 };
 
 typedef struct {
-    unsigned int num_syms;
-    union {
-        xkb_keysym_t sym;       /* num_syms == 1 */
-        xkb_keysym_t *syms;     /* num_syms > 1  */
-    } u;
-    union xkb_action act;
-} LevelInfo;
-
-typedef struct {
     enum group_field defined;
-    darray(LevelInfo) levels;
+    darray(struct xkb_level) levels;
     xkb_atom_t type;
 } GroupInfo;
 
@@ -112,6 +103,13 @@ typedef struct _KeyInfo {
 } KeyInfo;
 
 static void
+ClearLevelInfo(struct xkb_level *leveli)
+{
+    if (leveli->num_syms > 1)
+        free(leveli->u.syms);
+}
+
+static void
 InitGroupInfo(GroupInfo *groupi)
 {
     memset(groupi, 0, sizeof(*groupi));
@@ -120,10 +118,9 @@ InitGroupInfo(GroupInfo *groupi)
 static void
 ClearGroupInfo(GroupInfo *groupi)
 {
-    LevelInfo *leveli;
+    struct xkb_level *leveli;
     darray_foreach(leveli, groupi->levels)
-        if (leveli->num_syms > 1)
-            free(leveli->u.syms);
+        ClearLevelInfo(leveli);
     darray_free(groupi->levels);
 }
 
@@ -266,18 +263,18 @@ MergeGroups(SymbolsInfo *info, GroupInfo *into, GroupInfo *from, bool clobber,
     /* Merge the actions and syms. */
     levels_in_both = MIN(darray_size(into->levels), darray_size(from->levels));
     for (i = 0; i < levels_in_both; i++) {
-        LevelInfo *intoLevel = &darray_item(into->levels, i);
-        LevelInfo *fromLevel = &darray_item(from->levels, i);
+        struct xkb_level *intoLevel = &darray_item(into->levels, i);
+        struct xkb_level *fromLevel = &darray_item(from->levels, i);
 
-        if (fromLevel->act.type == ACTION_TYPE_NONE) {
+        if (fromLevel->action.type == ACTION_TYPE_NONE) {
         }
-        else if (intoLevel->act.type == ACTION_TYPE_NONE) {
-            intoLevel->act = fromLevel->act;
+        else if (intoLevel->action.type == ACTION_TYPE_NONE) {
+            intoLevel->action = fromLevel->action;
         }
         else {
             union xkb_action *use, *ignore;
-            use = (clobber ? &fromLevel->act : &intoLevel->act);
-            ignore = (clobber ? &intoLevel->act : &fromLevel->act);
+            use = (clobber ? &fromLevel->action : &intoLevel->action);
+            ignore = (clobber ? &intoLevel->action : &fromLevel->action);
 
             if (report)
                 log_warn(info->keymap->ctx,
@@ -287,7 +284,7 @@ MergeGroups(SymbolsInfo *info, GroupInfo *into, GroupInfo *from, bool clobber,
                          ActionTypeText(use->type),
                          ActionTypeText(ignore->type));
 
-            intoLevel->act = *use;
+            intoLevel->action = *use;
         }
 
         if (fromLevel->num_syms == 0) {
@@ -310,6 +307,7 @@ MergeGroups(SymbolsInfo *info, GroupInfo *into, GroupInfo *from, bool clobber,
                          (clobber ? "to" : "from"));
 
             if (clobber) {
+                ClearLevelInfo(intoLevel);
                 intoLevel->num_syms = fromLevel->num_syms;
                 if (fromLevel->num_syms > 1)
                     intoLevel->u.syms = fromLevel->u.syms;
@@ -719,7 +717,7 @@ AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
 
     for (i = 0; i < nLevels; i++) {
         unsigned int sym_index;
-        LevelInfo *leveli = &darray_item(groupi->levels, i);
+        struct xkb_level *leveli = &darray_item(groupi->levels, i);
 
         sym_index = darray_item(value->value.list.symsMapIndex, i);
         leveli->num_syms = darray_item(value->value.list.symsNumEntries, i);
@@ -745,8 +743,7 @@ AddSymbolsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
                          sym_name, LongKeyNameText(keyi->name), ndx + 1,
                          group_name, i);
 
-                if (leveli->num_syms > 1)
-                    free(leveli->u.syms);
+                ClearLevelInfo(leveli);
                 leveli->num_syms = 0;
                 break;
             }
@@ -813,7 +810,7 @@ AddActionsToKey(SymbolsInfo *info, KeyInfo *keyi, ExprDef *arrayNdx,
 
     act = value->value.child;
     for (i = 0; i < nActs; i++) {
-        toAct = &darray_item(groupi->levels, i).act;
+        toAct = &darray_item(groupi->levels, i).action;
 
         if (!HandleActionDef(act, info->keymap, toAct, info->actions))
             log_err(info->keymap->ctx,
@@ -1434,9 +1431,6 @@ CopySymbolsDef(SymbolsInfo *info, KeyInfo *keyi)
     GroupInfo *groupi;
     const GroupInfo *group0;
     xkb_layout_index_t i;
-    bool haveActions;
-    unsigned int sizeSyms;
-    unsigned int symIndex;
 
     /*
      * The name is guaranteed to be real and not an alias (see
@@ -1474,27 +1468,12 @@ CopySymbolsDef(SymbolsInfo *info, KeyInfo *keyi)
         CopyGroupInfo(groupi, group0);
     }
 
-    /* See if we need to allocate an actions array. */
-    haveActions = false;
-    darray_foreach(groupi, keyi->groups) {
-        LevelInfo *leveli;
-        darray_foreach(leveli, groupi->levels) {
-            if (leveli->act.type != ACTION_TYPE_NONE) {
-                haveActions = true;
-                goto out_of_loops;
-            }
-        }
-    }
-out_of_loops:
+    key->groups = calloc(key->num_groups, sizeof(*key->groups));
 
-    /*
-     * Find and assign the groups' types in the keymap. Also find the
-     * key width according to the largest type.
-     */
-    key->kt_index = calloc(key->num_groups, sizeof(*key->kt_index));
-    key->width = 0;
+    /* * Find and assign the groups' types in the keymap. */
     darray_enumerate(i, groupi, keyi->groups) {
         struct xkb_key_type *type;
+        struct xkb_group *group = &key->groups[i];
         bool autoType = false;
 
         /* Find the type of the group, if it is missing. */
@@ -1513,9 +1492,9 @@ out_of_loops:
         }
 
         /* Find the type in the keymap, if it was defined in xkb_types. */
-        if (FindNamedType(keymap, groupi->type, &key->kt_index[i])) {
+        if (FindNamedType(keymap, groupi->type, &group->type_index)) {
             if (!autoType || darray_size(groupi->levels) > 2)
-                key->explicit_groups |= (1 << i);
+                key->groups[i].explicit_type = true;
         }
         else {
             log_vrb(info->keymap->ctx, 3,
@@ -1527,12 +1506,14 @@ out_of_loops:
              * Index 0 is guaranteed to contain something, usually
              * ONE_LEVEL or at least some default one-level type.
              */
-            key->kt_index[i] = 0;
+            group->type_index = 0;
         }
 
-        /* If the type specifies fewer levels than the key has, shrink the key. */
-        type = &keymap->types[key->kt_index[i]];
+        /* Always have as many levels as the type specifies. */
+        type = &keymap->types[group->type_index];
         if (type->num_levels < darray_size(groupi->levels)) {
+            struct xkb_level *leveli;
+
             log_vrb(info->keymap->ctx, 1,
                     "Type \"%s\" has %d levels, but %s has %d levels; "
                     "Ignoring extra symbols\n",
@@ -1540,41 +1521,22 @@ out_of_loops:
                     type->num_levels,
                     LongKeyNameText(keyi->name),
                     (int) darray_size(groupi->levels));
-            darray_resize(groupi->levels, type->num_levels);
-        }
 
-        /*
-         * Why type->num_levels and not darray_size(groupi->levels)?
-         * Because the type may have more levels, and each group must
-         * have at least as many levels as its type. Because the
-         * key->syms array is indexed by (group * width + level), we
-         * must take the largest one.
-         * Maybe we can change it to save some space.
-         */
-        key->width = MAX(key->width, type->num_levels);
+            darray_foreach_from(leveli, groupi->levels, type->num_levels)
+                ClearLevelInfo(leveli);
+        }
+        darray_resize0(groupi->levels, type->num_levels);
     }
 
-    /* Find the size of the syms array. */
-    sizeSyms = 0;
-    darray_foreach(groupi, keyi->groups) {
-        LevelInfo *leveli;
-        darray_foreach(leveli, groupi->levels)
-            sizeSyms += leveli->num_syms;
+    /* Copy levels. */
+    darray_enumerate(i, groupi, keyi->groups) {
+        key->groups[i].levels = darray_mem(groupi->levels, 0);
+        darray_init(groupi->levels);
     }
 
-    /* Initialize the xkb_key, now that we know the sizes. */
-    key->syms = calloc(sizeSyms, sizeof(*key->syms));
-    key->sym_index = calloc(key->num_groups * key->width,
-                            sizeof(*key->sym_index));
-    key->num_syms = calloc(key->num_groups * key->width,
-                           sizeof(*key->num_syms));
     key->out_of_range_group_number = keyi->out_of_range_group_number;
     key->out_of_range_group_action = keyi->out_of_range_group_action;
-    if (haveActions) {
-        key->actions = calloc(key->num_groups * key->width,
-                              sizeof(*key->actions));
-        key->explicit |= EXPLICIT_INTERP;
-    }
+
     if (keyi->defined & KEY_FIELD_VMODMAP) {
         key->vmodmap = keyi->vmodmap;
         key->explicit |= EXPLICIT_VMODMAP;
@@ -1585,28 +1547,10 @@ out_of_loops:
         key->explicit |= EXPLICIT_REPEAT;
     }
 
-    /* Copy keysyms and actions. */
-    symIndex = 0;
-    darray_enumerate(i, groupi, keyi->groups) {
-        xkb_level_index_t j;
-        LevelInfo *leveli;
-
-        /* We rely on calloc having zeroized the arrays up to key->width. */
-        darray_enumerate(j, leveli, groupi->levels) {
-            if (leveli->act.type != ACTION_TYPE_NONE)
-                key->actions[i * key->width + j] = leveli->act;
-
-            if (leveli->num_syms <= 0)
-                continue;
-
-            if (leveli->num_syms == 1)
-                key->syms[symIndex] = leveli->u.sym;
-            else
-                memcpy(&key->syms[symIndex], leveli->u.syms,
-                       leveli->num_syms * sizeof(*key->syms));
-            key->sym_index[i * key->width + j] = symIndex;
-            key->num_syms[i * key->width + j] = leveli->num_syms;
-            symIndex += key->num_syms[i * key->width + j];
+    darray_foreach(groupi, keyi->groups) {
+        if (groupi->defined & GROUP_FIELD_ACTS) {
+            key->explicit |= EXPLICIT_INTERP;
+            break;
         }
     }