Class: HRPSVCPlugin

Inherits:
ThroughPlugin show all
Defined in:
lib/tecsgen/plugin/HRPSVCPlugin.rb

Overview

拡張サービスコールを用いたドメイン間通信の

throughプラグイン
HRPドメインプラグインによって挿入される
前提条件: 呼出し先がカーネルオブジェクトかどうかの判定はHRPドメインプラグイン
　　　　　で実施されるため，ここでは判定しないこととした

Constant Summary collapse

NUM_SVC_ARG_MAX =

HRP3 の拡張サービスコールで扱うことのできる引数の最大個数

5
@@generated_celltype_header =

RPCPlugin の initialize

説明は ThroughPlugin (plugin.rb) を参照

{}

Constants inherited from Plugin

Plugin::PluginArgProc

Instance Method Summary collapse

Methods inherited from ThroughPlugin

#check_plugin_arg, #gen_cdl_file, gen_post_code, #get_cell_name, #get_through_entry_port_name, #get_through_entry_port_subscript, #set_through_info, #show_tree, #subst_name

Methods inherited from Plugin

#cdl_error, #check_plugin_arg, #gen_cdl_file, #gen_ep_func?, #gen_postamble, #gen_preamble, #new_cell, #parse_plugin_arg, #print_msg, #set_locale, #set_silent

Methods inherited from Node

#cdl_error, #cdl_error2, #cdl_error3, #cdl_info, #cdl_info2, #cdl_warning, #cdl_warning2, #get_locale, #locale_str, #set_locale

Constructor Details

#initialize(cell_name, plugin_arg, next_cell, next_cell_port_name, next_cell_port_subscript, signature, celltype, caller_cell) ⇒ HRPSVCPlugin

Returns a new instance of HRPSVCPlugin.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 104

def initialize(cell_name, plugin_arg, next_cell, next_cell_port_name, next_cell_port_subscript, signature, celltype, caller_cell)
  super

  # 受け口配列の場合、配列添数ごとに別のセルタイプとする
  # セルタイプをシングルトン化したいため。
  # さもないと、セルを識別する引数を渡す必要があり、NUM_SVC_ARG_MAX(5) つしか渡せない引数の一つを消費することになるため。
  if @next_cell_port_subscript
    subscript = "__" + @next_cell_port_subscript.to_s
  else
    subscript = ""
  end
  @ct_name_body = "#{@ct_name}SVCBody_#{@next_cell.get_name}_#{@next_cell_port_name}#{subscript}".to_sym
  @ct_name = "#{@ct_name}SVCCaller_#{@next_cell.get_name}_#{@next_cell_port_name}#{subscript}".to_sym
  @cell_name_body = "#{@cell_name}SVCBody".to_sym
  @cell_name = "#{@cell_name}SVCCaller".to_sym
  # puts "%%%% "
  # p @next_cell.get_name
  # p @caller_cell.get_name
  @b_printed_include_stdint = false
  check_signature signature
end

Instance Method Details

#gen_ep_func_body(file, b_singleton, ct_name, global_ct_name, sig_name, ep_name, func_name, func_global_name, func_type, params) ⇒ Object

受け口関数の本体(C言語)を生成する

通常であれば、ジェネレータは受け口関数のテンプレートを生成する
プラグインの場合、変更する必要のないセルタイプコードを生成する
file

FILE 出力先ファイル

b_singleton

bool true if singleton

ct_name

Symbol

global_ct_name

string

sig_name

string

ep_name

string

func_name

string

func_global_name

string

func_type

class derived from Type



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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 284

def gen_ep_func_body(file, b_singleton, ct_name, global_ct_name, sig_name, ep_name, func_name, func_global_name, func_type, params)
      # puts "generate ep_func for #{ct_name}"

      #
      #  拡張サービスコール呼出し側の関数生成
      #
      #  完成形のイメージ
      #
      # ER_UINT
      # eThroughEntry_write(CELLIDX idx, const char* buffer, uint_t length)
      # {
      #   ER_UINT  retval;
      #   tHRPSVCPlugin_<Sig>SVCCaller_<Cell>_<Entry>_CB    *p_cellcb;
      #   if( VALID_IDX( idx ) ){
      #       p_cellcb = tHRPSVCPlugin_<Sig>SVCBody_<Cell>_<Entry>_GET_CELLCB(idx);
      #   }else{
      #       /* エラー処理コードをここに記述 */
      #   }
      #
      #   retval = (ER_UINT)cal_svc( TFN_TECSGEN_ORIGIN + svcid,
      #                              (intptr_t)par1, (intptr_t)par2, 0, 0, 0 );
      #
      #   return retval;
      # }

  if !func_type.get_type.is_a?(VoidType)
    file.print("  #{func_type.get_type_str}  retval;\n")
  end

      # p "celltype_name, sig_name, func_name, func_global_name"
      # p "#{ct_name}, #{sig_name}, #{func_name}, #{func_global_name}"

      delim = ""
      if !func_type.get_type.is_a?(VoidType)
        file.print("  retval = (#{func_type.get_type_str})")
      else
        file.print("  ")
      end

      # file.print( "#{@call_port_name}_#{func_name}(" )
      SVCManage.set_func_id("#{@ct_name_body}_#{func_name}")
      svcid = SVCManage.get_func_id("#{@ct_name_body}_#{func_name}")
      # file.print( "cal_svc( #{@ct_name_body}_#{func_name}" )
      file.print("cal_svc( TFN_TECSGEN_ORIGIN + #{svcid}")

      #    if ( ! b_singleton ) then
      #      file.print( " tecs_this" )
      #      delim = ","
      #    end

      i = 0
      passed_param = {}
      params.each{|param|
        delim = ","
          file.printf("#{delim} (intptr_t)#{param.get_name}")
          passed_param[i] = param.get_name
          i += 1
      }

      while i < NUM_SVC_ARG_MAX do
        delim = ","
          file.printf("#{delim} 0")
          passed_param[i] = "par#{i + 1}"
          i += 1
      end

      file.print(" );\n\n")

      if !func_type.get_type.is_a?(VoidType)
        file.print("  return retval;\n")
      end

      #
      #  拡張サービスコール本体側の関数生成
      #
      #  完成形のイメージ
      #
      # ER_UINT
      # eThroughEntry_write(CELLIDX idx, const char* buffer, uint_t length)
      # {
      #   ER_UINT  retval;
      #   tHRPSVCPlugin_<Sig>SVCBody_<Cell>_<Entry>_CB    *p_cellcb;
      #   if( VALID_IDX( idx ) ){
      #       p_cellcb = tHRPSVCPlugin_<Sig>SVCBody_<Cell>_<Entry>_GET_CELLCB(idx);
      #   }else{
      #       /* エラー処理コードをここに記述 */
      #   }
      #
      #   retval = (ER_UINT)cal_svc( TFN_TECSGEN_ORIGIN + svcid,
      #                              (intptr_t)par1, (intptr_t)par2, 0, 0, 0 );
      #
      #   return retval;
      # }
          file2 = AppFile.open("#{$gen}/#{@ct_name_body}.c")
          if @b_printed_include_stdint == false
            file2.print <<EOT
#ifndef SIZE_MAX
#define  SIZE_MAX   (~0UL)
#endif

EOT
            @b_printed_include_stdint = true
          end

          if func_type.get_type.is_a?(VoidType)
            retval_assign = ""
          else
            retval_assign = "retval = (ER_UINT)"
          end

          file2.print <<EOT
/* HRPSVC0006 */
ER_UINT
#{@ct_name_body}_#{func_name}(intptr_t #{passed_param[0]}, intptr_t #{passed_param[1]}, intptr_t #{passed_param[2]}, intptr_t #{passed_param[3]}, intptr_t #{passed_param[4]}, ID cdmid)
{
  ER_UINT retval = E_OK;

EOT

          #
          #  エラーチェック処理の生成
          #

          #
          #  呼出し元ドメインのチェック
          #   * private method: gen_caller_check_code参照
          #
          generated_check_code = gen_caller_check_code(func_name)
          check_code = generated_check_code["check_code"]
          user_cannot_callable = generated_check_code["user_cannot_callable"]

          #
          #  パラメータにポインタが存在する場合，呼出し元タスクに対する
          #  アクセス権のチェック処理を出力する
          #  ※ cdmidがカーネルドメイン(拡張サービスコール呼出し中のユーザ
          #    ドメインを含む)であればprb_memの処理をスキップし，初段の
          #    拡張サービスコールのみprb_memを呼出し元タスクに発行する
          #
          num = 0
          params.each{|param|
            if param.get_declarator.get_ptr_level > 0
              align_check_str = "!ALIGN_TYPE(#{passed_param[num]}, #{param.get_type.get_referto.get_type_str}) || "

                if param.get_type.get_referto.is_a?(IntType)
                  case param.get_type.get_referto.get_bit_size
                  when -11, -1, 8 # char, char_t, int8_t (無符号含む)
                  #
                  #  charデータの場合，ALIGN_TYPEは必ずTRUE
                  #  となるので，エラーチェックを省略
                  #  char型の@bit_sizeは-11
                  #  tecsgen/tecslib/core/types.rbを参照
                  #
                    align_check_str = ""
                  end
                end
                if param.get_direction == :IN
                    #
                    #  入力([in])のポインタパラメータは，呼出し元タスクに
                    #  TPM_READ(読出し可能)のアクセス権が必要
                    #
                    # 二重ポインタが不可のため、size_is と string が同時に設定されることはない
                  prb_func = "prb_mem"
                    if param.get_size
                      size_str = param.get_size.to_s
                    elsif param.get_string == -1
                      size_str = "SIZE_MAX"
                      prb_func = "prb_str"
                    elsif param.get_string
                      size_str = param.get_string.to_s
                      prb_func = "prb_str"
                    else
                      size_str = "1"
                    end
                    check_code.concat <<EOT
      /* HRPSVC0007 */
      if (#{align_check_str}#{prb_func}((void *)#{passed_param[num]}, sizeof(#{param.get_type.get_referto.get_type_str}) * (#{size_str}), TSK_SELF, TPM_READ) != E_OK) {
          return E_MACV;
      }
EOT

                elsif param.get_direction == :OUT || param.get_direction == :INOUT
                    #
                    #  出力([out])のポインタパラメータは，呼出し元タスクに
                    #  TPM_WRITE(書込み可能)のアクセス権が必要
                    #
                  prb_func = "prb_mem"
                    if param.get_size
                      size_str = param.get_size.to_s
                    elsif param.get_string # 引数なしの string はない
                      size_str = param.get_string.to_s
                      # prb_func = "prb_str"             # out, inout の場合、必ず領域を確保する. prb_mem を用いる
                    else
                      size_str = "1"
                    end
                    check_code.concat <<EOT
      /* HRPSVC0008 */
      if (#{align_check_str}#{prb_func}((void *)#{passed_param[num]}, sizeof(#{param.get_type.get_referto.get_type_str}) * (#{size_str}), TSK_SELF, TPM_WRITE) != E_OK) {
          return E_MACV;
      }
EOT

                end
            end
              num += 1
          }

          #
          #  呼出し元がカーネルドメインのみ許可されている場合，
          #  すべてのユーザドメインからの呼出しに対し，E_OACVを返す
          #
          if user_cannot_callable
            check_code = "\t\treturn E_OACV;"
          end

          if check_code != ""
              #
              #  呼出し元がカーネルドメインの場合，アクセス権のチェック
              #  処理をスキップさせる
              #
            file2.print <<eot
  if (cdmid != TDOM_KERNEL) {
#{check_code}
  }
eot
          end

          #
          #  拡張サービスコール本体(本来の受け口関数)を呼び出す
          #
          file2.print"    #{retval_assign}#{@call_port_name}_#{func_name}("

          delim = ""
          num = 0
          params.each{|param|
            file2.print delim.to_s
              delim = ", "
              file2.print "(#{param.get_type.get_type_str})"
              file2.print passed_param[num]
              file2.print param.get_type.get_type_str_post
              num += 1
          }

          file2.print ");\n"

          file2.print "\n    return retval;\n"
          file2.print "}\n\n"

          file2.close

          #
          #  拡張サービスコールの登録
          #
          file2 = AppFile.open("#{$gen}/tecsgen.cfg")
          file2.print "\n/* Generated by HRPSVCPlugin */\n\n"
          file2.print <<EOT
/* HRPSVC0009 */
KERNEL_DOMAIN{
  DEF_SVC( TFN_TECSGEN_ORIGIN + #{svcid}, { TA_NULL, #{@ct_name_body}_#{func_name}, SSZ_#{func_global_name} } );
}
EOT
          file2.close

          #
          #  拡張サービスコール登録に必要な情報をヘッダに出力
          #   - 拡張サービスコール呼出し時のチェックで使用するスタックサイズを出力
          #   - 拡張サービスコールとして登録する関数名のextern宣言を出力
          #
          file2 = AppFile.open("#{$gen}/#{@ct_name_body}_factory.h")
          file2.print "\n/* Generated by HRPSVCPlugin */\n\n"
          file2.print <<EOT
/* HRPSVC0010 */
#ifndef SSZ_#{func_global_name}
#define SSZ_#{func_global_name}	DefaultExtsvcStackSize
#endif /* SSZ_#{func_global_name} */

/* HRPSVC0011 */
extern ER_UINT #{@ct_name_body}_#{func_name}(intptr_t par1, intptr_t par2, intptr_t par3, intptr_t par4, intptr_t par5, ID cdmid);
EOT
          file2.close
end

#gen_plugin_decl_code(file) ⇒ Object 



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
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 134

def gen_plugin_decl_code(file)
  # このセルタイプ（同じシグニチャ）は既に生成されているか？
  if @@generated_celltype[@ct_name_body].nil?
    @@generated_celltype[@ct_name_body] = [self]
      file2 = CFile.open("#{$gen}/#{@ct_name_body}.cdl", "w")
      file2.print <<EOT
import_C( "t_stdlib.h" );

/* HRPSVC0001 */
[active,singleton]
celltype #{@ct_name_body} {
  call #{@signature.get_name} #{@call_port_name};
  FACTORY {
write("$ct$_tecsgen.h", "#include \\"kernel_cfg.h\\"");
  };
};
EOT
      file2.close
  else
    @@generated_celltype[@ct_name_body] << self
  end
  file.print "import( \"#{$gen}/#{@ct_name_body}.cdl\" );\n"

  # このセルタイプ（同じシグニチャ）は既に生成されているか？
  if @@generated_celltype[@ct_name].nil?
    @@generated_celltype[@ct_name] = [self]
      file2 = CFile.open("#{$gen}/#{@ct_name}.cdl", "w")
      file2.print <<EOT
/* HRPSVC0002 */
celltype #{@ct_name} {
  entry #{@signature.get_name} #{@entry_port_name};
  FACTORY {
write("$ct$_tecsgen.h", "#include \\"extsvc_fncode.h\\"");
  };
};
EOT
      file2.close
  else
    @@generated_celltype[@ct_name] << self
  end
  file.print "import( \"#{$gen}/#{@ct_name}.cdl\" );\n"

=begin
  # TODO: send. receive 対応
  send_receive = []
  if @signature != nil then
    @signature.each_param{ |fd,param|
      dir =param.get_direction
      case dir
      when :SEND, :RECEIVE
        send_receive << [ dir, fd, param ]
      end
    }
  end
=end

=begin
composite #{@ct_name} {
  entry #{@signature.get_name} #{@entry_port_name};
  call #{@signature.get_name} #{@call_port_name};

  cell #{@ct_name}Client #{@cell_name}Client{
  };

  [active]
  cell #{@ct_name}Server #{@cell_name}Server{
      #{@call_port_name} => composite.#{@call_port_name};
  };

  composite.#{@entry_port_name} => #{@cell_name}.#{@entry_port_name};
};
=end
end

#gen_through_cell_code(file) ⇒ Object

through cell コードを生成



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
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 211

def gen_through_cell_code(file)
 gen_plugin_decl_code(file)

 # セルを探す
 # path =["::",@next_cell.get_name]  # mikan namespace
 # cell = Namespace.find( path )
 # cell = Namespace.find( @next_cell.get_namespace_path )

 ##### クライアント側のセルの生成 #####
 # file.print "[domain(HRP, \"kernel\")]"
 nest = @start_region.gen_region_str_pre file
 nest_str = "  " * nest

 # クライアント側チャンネルの生成
 # 拡張サービスコール呼出し
 file.print <<EOT
/* HRPSVC0003 */
#{nest_str}  //  Client Side Channel
#{nest_str}  cell #{@ct_name} #{@cell_name}{
#{nest_str}  };

EOT

 @start_region.gen_region_str_post file
 file.print "\n\n"

 ##### サーバー側のセルの生成 #####
 nest = @end_region.gen_region_str_pre file
 nest_str = "  " * nest
 if @next_cell_port_subscript
   subscript = "[" + @next_cell_port_subscript.to_s + "]"
 else
   subscript = ""
 end

 # サーバー側チャンネルの生成
 # 拡張サービスコール本体
 file.print <<EOT

/* HRPSVC0004 */
#{nest_str}  //  Server Side Channel
#{nest_str}  cell #{@ct_name_body} #{@cell_name_body}{
#{nest_str}    #{@call_port_name} = #{@next_cell.get_namespace_path.get_path_str}.#{@next_cell_port_name}#{subscript};
#{nest_str}  };
EOT

 @end_region.gen_region_str_post file

 file2 = AppFile.open("#{$gen}/tecsgen.cfg")
 file2.print "\n/* Generated by HRPSVCPlugin */\n\n"
 file2.print <<EOT
/* HRPSVC0005 */
#include "#{@ct_name_body}_factory.h"
EOT
 file2.close

 # callee_cell のget_restricted_regions を呼び出しておく
 # restrict が参照された印をつけるため
 @callee_cell.get_restricted_regions( :dummy_entry_name, :dummy_func_name )
end

#get_callee_cell ⇒ Object 



565
566
567
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 565

def get_callee_cell
  return @callee_cell
end

#get_callee_ep_name ⇒ Object 



573
574
575
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 573

def get_callee_ep_name
  return @join.get_port_name
end

#get_caller_cell ⇒ Object 



569
570
571
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 569

def get_caller_cell
  return @caller_cell
end

#get_cell_namespace_path ⇒ Object

NamespacePath を得る

生成するセルの namespace path を生成する



128
129
130
131
132
 
# File 'lib/tecsgen/plugin/HRPSVCPlugin.rb', line 128

def get_cell_namespace_path
#    nsp = @region.get_namespace.get_namespace_path
  nsp = @start_region.get_namespace_path
  return nsp.append(@cell_name)
end