lin
2025-08-01 633231e833e21d5b8b1c00cb15aedb62b3b78e8f
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
"""Mul primitive used by the GEMM function.
 
The Mul primitive takes 1-3 zipped rows and 1-3 zipped columns and performs
matrix multiplication on those resulting in a small 1x1 to 3x3 block of results.
"""
 
import neon_emitter
 
 
class Error(Exception):
  """Module level error."""
 
 
class ConfigurationError(Error):
  """Unsupported configuration."""
 
 
class MulLanes(object):
 
  def __init__(self, input_address):
    self.input_address = input_address
    self.lanes = []
 
  def AddLane(self, lane):
    self.lanes.append(lane)
 
  def FreeRegisters(self, registers):
    for i in range(0, len(self.lanes)):
      registers.FreeRegister(self.lanes[i])
      self.lanes[i] = None
 
 
def GenerateMulLanes(registers, lane_count, address):
  lanes = MulLanes(address)
  for unused_i in range(0, lane_count):
    lanes.AddLane(registers.DoubleRegister())
  return lanes
 
 
def Generate3MulLanes(quad_register, registers, address):
  lanes = MulLanes(address)
  lanes.AddLane(registers.Low(quad_register))
  lanes.AddLane(registers.High(quad_register))
  lanes.AddLane(registers.DoubleRegister())
  return lanes
 
 
def GenerateAndClearAggregators(emitter, registers, aggregator_count):
  """Prepare aggregators and emit aggregator clear code."""
  emitter.EmitComment('Clear aggregators.')
  aggregators = []
  for i in range(0, aggregator_count):
    aggregator = registers.QuadRegister()
    aggregators.append(aggregator)
    if i < 3:
      emitter.EmitVMov('i32', aggregator, emitter.ImmediateConstant(0))
    else:
      emitter.EmitVMov('i32', aggregator, aggregators[i - 3])
  emitter.EmitNewline()
  return aggregators
 
 
def GenerateNxMLoadMultiplyAggregate(emitter, registers, left_lanes,
                                     right_lanes, aggregators, count):
  """Emit inner loop for N rows x M cols multiplication."""
  emitter.EmitComment('General NxM lanes loop.')
  emitter.EmitNumericalLabel(1)
  emitter.EmitNewline()
  emitter.EmitComment('Subtract counter.')
  emitter.EmitSubs(count, count, emitter.ImmediateConstant(8))
  emitter.EmitNewline()
 
  emitter.EmitVLoadA('1.8', left_lanes.lanes,
                     emitter.DereferenceIncrement(left_lanes.input_address, 64))
  emitter.EmitVLoadA(
      '1.8', right_lanes.lanes,
      emitter.DereferenceIncrement(right_lanes.input_address, 64))
 
  emitter.EmitPldOffset(left_lanes.input_address, emitter.ImmediateConstant(64))
  emitter.EmitPldOffset(right_lanes.input_address,
                        emitter.ImmediateConstant(64))
 
  rows = len(left_lanes.lanes)
  cols = len(right_lanes.lanes)
 
  multiply_results = []
  for i in range(0, rows * cols):
    multiply_results.append(registers.QuadRegister())
 
  for row in range(0, rows):
    for col in range(0, cols):
      index = row * cols + col
      emitter.EmitVMull('u8', multiply_results[index], right_lanes.lanes[col],
                        left_lanes.lanes[row])
 
  for i in range(0, rows * cols):
    emitter.EmitVPadal('u16', aggregators[i], multiply_results[i])
 
  emitter.EmitNewline()
  emitter.EmitComment('Loop break.')
  emitter.EmitBneBack(1)
  emitter.EmitNewline()
 
  for register in multiply_results:
    registers.FreeRegister(register)
 
 
def Generate3x3LoadMultiplyAggregate(emitter, registers, left_lanes,
                                     right_lanes, aggregators, count,
                                     backup_register):
  """Emit inner loop for 3 rows x 3 cols multiplication (register trick)."""
  emitter.EmitComment('3x3 lanes loop.')
  emitter.EmitNumericalLabel(1)
  emitter.EmitNewline()
  emitter.EmitComment('Subtract counter.')
  emitter.EmitSubs(count, count, emitter.ImmediateConstant(8))
  emitter.EmitNewline()
 
  emitter.EmitVLoadA('1.8', left_lanes.lanes,
                     emitter.DereferenceIncrement(left_lanes.input_address, 64))
  emitter.EmitVLoadA(
      '1.8', right_lanes.lanes,
      emitter.DereferenceIncrement(right_lanes.input_address, 64))
 
  emitter.EmitPldOffset(left_lanes.input_address, emitter.ImmediateConstant(64))
  emitter.EmitPldOffset(right_lanes.input_address,
                        emitter.ImmediateConstant(64))
 
  temp = []
  for unused_i in range(0, 4):
    temp.append(registers.QuadRegister())
 
  emitter.EmitVMull('u8', temp[0], left_lanes.lanes[0], right_lanes.lanes[0])
  emitter.EmitVMull('u8', temp[1], left_lanes.lanes[0], right_lanes.lanes[1])
  emitter.EmitVMull('u8', temp[2], left_lanes.lanes[0], right_lanes.lanes[2])
  emitter.EmitVMull('u8', temp[3], left_lanes.lanes[1], right_lanes.lanes[0])
 
  emitter.EmitVPadal('u16', aggregators[0], temp[0])
  emitter.EmitVPadal('u16', aggregators[1], temp[1])
  emitter.EmitVPadal('u16', aggregators[2], temp[2])
  emitter.EmitVPadal('u16', aggregators[3], temp[3])
 
  emitter.EmitVMull('u8', temp[0], left_lanes.lanes[1], right_lanes.lanes[1])
  emitter.EmitVMull('u8', temp[1], left_lanes.lanes[1], right_lanes.lanes[2])
  emitter.EmitVMull('u8', temp[2], left_lanes.lanes[2], right_lanes.lanes[0])
  emitter.EmitVMull('u8', temp[3], left_lanes.lanes[2], right_lanes.lanes[1])
  emitter.EmitVMull('u8', backup_register, left_lanes.lanes[2],
                    right_lanes.lanes[2])
 
  emitter.EmitVPadal('u16', aggregators[4], temp[0])
  emitter.EmitVPadal('u16', aggregators[5], temp[1])
  emitter.EmitVPadal('u16', aggregators[6], temp[2])
  emitter.EmitVPadal('u16', aggregators[7], temp[3])
  emitter.EmitVPadal('u16', aggregators[8], backup_register)
 
  emitter.EmitNewline()
  emitter.EmitComment('Loop break.')
  emitter.EmitBneBack(1)
  emitter.EmitNewline()
 
  for register in temp:
    registers.FreeRegister(register)
 
 
def ReadParams(emitter, registers, input_address, elements, min_reg):
  if elements == 1 or elements == 2:
    register = registers.DoubleRegister(min_reg * 2)
    emitter.EmitVLoad('1.32', register, emitter.Dereference(input_address, 64))
    return register
  elif elements == 3 or elements == 4:
    register = registers.QuadRegister(min_reg)
    emitter.EmitVLoad('1.32', register, emitter.Dereference(input_address, 64))
    return register
  else:
    raise ConfigurationError('Unsupported elements no: %d' % elements)
 
 
def Duplicate(emitter, registers, rows, cols, min_register, values):
  """Populate a grid of registers duplicating provided values."""
  duplicated = []
  if cols == 1 or cols == 2:
    for unused_i in range(0, rows):
      duplicated.append(registers.DoubleRegister(min_register))
  elif cols == 3 or cols == 4:
    for unused_i in range(0, rows):
      duplicated.append(registers.QuadRegister(min_register))
  else:
    raise ConfigurationError('Unsupported duplicate amount: %d' % cols)
 
  if rows == 1:
    emitter.EmitVDup('32', duplicated[0], emitter.Lane(values, 0))
  elif rows == 2:
    emitter.EmitVDup('32', duplicated[0], emitter.Lane(values, 0))
    emitter.EmitVDup('32', duplicated[1], emitter.Lane(values, 1))
  elif rows == 3:
    emitter.EmitVDup('32', duplicated[0], emitter.Lane(
        registers.Low(values), 0))
    emitter.EmitVDup('32', duplicated[1], emitter.Lane(
        registers.Low(values), 1))
    emitter.EmitVDup('32', duplicated[2], emitter.Lane(
        registers.High(values), 0))
  elif rows == 4:
    emitter.EmitVDup('32', duplicated[0], emitter.Lane(
        registers.Low(values), 0))
    emitter.EmitVDup('32', duplicated[1], emitter.Lane(
        registers.Low(values), 1))
    emitter.EmitVDup('32', duplicated[2], emitter.Lane(
        registers.High(values), 0))
    emitter.EmitVDup('32', duplicated[3], emitter.Lane(
        registers.High(values), 1))
 
  return duplicated
 
 
def DuplicateGeneralRegister(emitter, registers, cols, general_register,
                             min_register):
  if cols == 1 or cols == 2:
    duplicated = registers.DoubleRegister(min_register)
  elif cols == 3 or cols == 4:
    duplicated = registers.QuadRegister(min_register)
  else:
    raise ConfigurationError('Unsupported duplicate amount: %d' % cols)
 
  emitter.EmitVDup('32', duplicated, general_register)
  return duplicated
 
 
def ReduceAggregator(emitter, registers, aggregators, row, cols):
  if cols == 1:
    register = registers.Low(aggregators[row])
    emitter.EmitVPadd('u32', register, register, register)
    return register
  elif cols == 2:
    register = registers.Low(aggregators[row * 2])
    emitter.EmitVPadd('u32', register, register,
                      registers.Low(aggregators[row * 2 + 1]))
    return register
  elif cols == 3:
    register = aggregators[row * 3]
    emitter.EmitVPadd('u32', registers.Low(register), registers.Low(register),
                      registers.Low(aggregators[row * 3 + 1]))
    emitter.EmitVPadd('u32', registers.High(register),
                      registers.Low(aggregators[row * 3 + 2]),
                      registers.Low(aggregators[row * 3 + 2]))
    return register
  elif cols == 4:
    register = aggregators[row * 3]
    emitter.EmitVPadd('u32', registers.Low(register), registers.Low(register),
                      registers.Low(aggregators[row * 3 + 1]))
    emitter.EmitVPadd('u32', registers.High(register),
                      registers.Low(aggregators[row * 3 + 2]),
                      registers.Low(aggregators[row * 3 + 3]))
    return register
  else:
    raise ConfigurationError('Unsupported columns no: %d' % cols)
 
 
def StoreAggregator(emitter, registers, aggregator, cols, result_address,
                    result_stride):
  if cols == 1:
    emitter.EmitVStoreOffset('1.32', emitter.Lane(aggregator, 0),
                             emitter.Dereference(result_address, None),
                             result_stride)
  elif cols == 2:
    emitter.EmitVStoreOffset('1.32', aggregator,
                             emitter.Dereference(result_address, None),
                             result_stride)
  elif cols == 3:
    emitter.EmitVStore('1.32', registers.Low(aggregator),
                       emitter.DereferenceIncrement(result_address, None))
    emitter.EmitVStoreOffset('1.32', emitter.Lane(
        registers.High(aggregator),
        0), emitter.Dereference(result_address, None), result_stride)
    emitter.EmitNewline()
  elif cols == 4:
    emitter.EmitVStoreOffsetA(
        '1.32', [registers.Low(aggregator), registers.High(aggregator)],
        emitter.Dereference(result_address, None), result_stride)
  else:
    raise ConfigurationError('Unsupported columns no: %d' % cols)
 
 
def GenerateAggregatorReduceStore(emitter, registers, aggregators, result_type,
                                  lhs_add, rhs_add, left_lanes, right_lanes,
                                  results, results_stride):
  """Emit code that reduces 4 lane aggregators to 1 value, and stores them."""
  rows = len(left_lanes.lanes)
  cols = len(right_lanes.lanes)
 
  if lhs_add:
    left_offset = ReadParams(emitter, registers, left_lanes.input_address, rows,
                             4)
    left_offsets = Duplicate(emitter, registers, rows, cols, 4, left_offset)
  else:
    left_offsets = None
 
  if rhs_add:
    right_offset = ReadParams(emitter, registers, right_lanes.input_address,
                              cols, 4)
  else:
    right_offset = None
 
  if result_type is 'float':
    result_scale = DuplicateGeneralRegister(
        emitter, registers, cols, registers.MapParameter('result_scale'), 4)
  else:
    result_scale = None
 
  if cols == 3:
    emitter.EmitNewline()
    emitter.EmitComment('Change stride because storing in two ops.')
    emitter.EmitSub(results_stride, results_stride,
                    emitter.ImmediateConstant(8))
 
  emitter.EmitNewline()
  emitter.EmitComment('Horizontal reduce aggregators.')
  for aggregator in aggregators:
    emitter.EmitVPadd('u32', registers.Low(aggregator),
                      registers.Low(aggregator), registers.High(aggregator))
 
  emitter.EmitNewline()
  emitter.EmitComment('Reduce rows.')
  row_temps = []
  for i in range(0, rows):
    row_temps.append(ReduceAggregator(emitter, registers, aggregators, i, cols))
 
  if lhs_add:
    emitter.EmitNewline()
    emitter.EmitComment('Add lhs offsets to aggregated rows.')
    for (row_temp, left_offset) in zip(row_temps, left_offsets):
      emitter.EmitVAdd('s32', row_temp, row_temp, left_offset)
 
  if rhs_add:
    emitter.EmitNewline()
    emitter.EmitComment('Add rhs offset to aggregated rows.')
    for row_temp in row_temps:
      emitter.EmitVAdd('s32', row_temp, row_temp, right_offset)
 
  if result_type is 'float':
    emitter.EmitNewline()
    emitter.EmitComment('Convert to float. Multiply by result scale.')
    for row_temp in row_temps:
      emitter.EmitVCvt('f32', 's32', row_temp, row_temp)
    for row_temp in row_temps:
      emitter.EmitVMul('f32', row_temp, row_temp, result_scale)
 
  emitter.EmitNewline()
  emitter.EmitComment('Store reduced rows.')
  for row_temp in row_temps:
    StoreAggregator(emitter, registers, row_temp, cols, results, results_stride)
 
 
def BuildName(result_type, lhs_add, rhs_add, left, right):
  name = 'mul_%dx8_%dx8_%s' % (left, right, result_type)
  if lhs_add:
    name += '_lhsadd'
  if rhs_add:
    name += '_rhsadd'
  return name
 
 
def CppResultType(result_type):
  if result_type is 'int32':
    return 'std::int32_t*'
  elif result_type is 'float':
    return 'float*'
  else:
    raise ConfigurationError('Unsupported result type: %s' % result_type)
 
 
def GetParameters(result_type):
  params = [['const std::uint8_t*', 'lhs'], ['const std::uint8_t*', 'rhs'],
            ['std::int32_t', 'count'], [CppResultType(result_type), 'result'],
            ['std::int32_t', 'result_stride']]
  if result_type is 'float':
    params.append(['float', 'result_scale'])
  return params
 
 
def GenerateMulNx8Mx8(emitter, result_type, lhs_add, rhs_add, left_lanes_count,
                      right_lanes_count):
  """Emit the multiply code for given rows and cols counts."""
  if left_lanes_count < 1 or left_lanes_count > 4:
    raise ConfigurationError('Left_lanes should be: 1, 2, 3 or 4.')
  if right_lanes_count < 1 or right_lanes_count > 4:
    raise ConfigurationError('Right_lanes should be: 1, 2, 3 or 4.')
 
  emitter.EmitFunctionBeginA(
      BuildName(result_type, lhs_add, rhs_add, left_lanes_count,
                right_lanes_count), GetParameters(result_type), 'inline void')
 
  emitter.EmitAssert('count % 8 == 0')
  emitter.EmitAssert('count >= 8')
  emitter.EmitAsmBegin()
 
  registers = neon_emitter.NeonRegisters()
 
  count = registers.MapParameter('count')
 
  size = left_lanes_count * right_lanes_count
 
  lhs = registers.MapParameter('lhs')
  rhs = registers.MapParameter('rhs')
 
  emitter.EmitPld(lhs)
  emitter.EmitPld(rhs)
 
  aggregators = GenerateAndClearAggregators(emitter, registers, size)
 
  if size < 9:
    left_lanes = GenerateMulLanes(registers, left_lanes_count, lhs)
    right_lanes = GenerateMulLanes(registers, right_lanes_count, rhs)
 
    GenerateNxMLoadMultiplyAggregate(emitter, registers, left_lanes,
                                     right_lanes, aggregators, count)
 
  else:  # left == 3 and right == 3
    backup_register = registers.QuadRegister()
    left_lanes = Generate3MulLanes(backup_register, registers, lhs)
    right_lanes = GenerateMulLanes(registers, right_lanes_count, rhs)
 
    Generate3x3LoadMultiplyAggregate(emitter, registers, left_lanes,
                                     right_lanes, aggregators, count,
                                     backup_register)
  left_lanes.FreeRegisters(registers)
  right_lanes.FreeRegisters(registers)
 
  GenerateAggregatorReduceStore(emitter, registers, aggregators, result_type,
                                lhs_add, rhs_add, left_lanes, right_lanes,
                                registers.MapParameter('result'),
                                registers.MapParameter('result_stride'))
 
  emitter.EmitAsmEnd(registers.MappedParameters(), [],
                     registers.Clobbers() + ['cc', 'memory'])
  emitter.EmitFunctionEnd()
 
 
def GenerateFunctions(emitter, result_type, lhs_add, rhs_add):
  for left_lanes in range(1, 4):
    for right_lanes in range(1, 4):
      GenerateMulNx8Mx8(emitter, result_type, lhs_add, rhs_add, left_lanes,
                        right_lanes)
      emitter.EmitNewline()
 
  GenerateMulNx8Mx8(emitter, result_type, lhs_add, rhs_add, 1, 4)
  emitter.EmitNewline()
 
 
if __name__ == '__main__':
  GenerateFunctions(neon_emitter.NeonEmitter(), 'int32', True, True)