Jump to content

CodingStyle: handle name vs create's string name. To match or not?

Recommended Posts

CodingStyle: handle name vs create's string name.  To match or not to match?


What pros, cons, or team rules can you share about whether the string name passed into create should match the handle?




//1) object declared, with handle name m_xyz_agent

xyz_agent  m_xyz_agent;


//2) object created.  what-string-name will you pass in to ::create?   m_xyz_agent or smthg else?

m_xyz_agent = xyz_agent::type_id::create("what-string-name",this);



When I first started with uvm, I was tripped up a bunch in situations where I confused the handle and the string.  A prime example is in the place of what-string-name below.

uvm_config_db#(uvm_object_wrapper)::set(this,"*.what-string-name.asdf.main_phase", "default_sequence",xyz_seq::type_id::get());



When different developers use different styles, it can be a headache.


So, besides suggesting 'just be consistent', which I fully agree with, what are your preferences, and why?






Most examples I find have the string name passed to create and the handle match.

(Having them differ does help a newbie understand what is going on a bit better, I believe.)


Link to comment
Share on other sites



The reason for this is more than just visual consistency, but for better interoperability with debugging aids.


Unlike the static Verilog module hierarchical world, there is no authoritative ownership of objects for the tool to construct a hierarchical pathname. In other words, there is no permanent relationship between the object being created, and the object creating it. The Verilog elaboration process builds a pathname for you for you. When you call new as part of a dynamic procedural thread, you just get a handle to an object that you can store, or you can pass it around to another object. In fact, when you call the factory's create, you are delegating creation to another object; a proxy for that object.


For objects derived from uvm_component and uvm_sequence, the UVM has a mechanism to assemble a string pathname for you that is used in reporting. When you debug, it is much easier to navigate through your environment when the pathnames match the actual class variable names that you would use to reference a class variable.

Link to comment
Share on other sites



normally i have the vlog name and the logical name being the same. exceptions for me are when arrays,QDA etc are involved or when generic code is used



some examples when the logical name and the vlog instance path can diverge (for me).



string names[$] ='{"AHB","FOO","BLA"};
uvm_component c[$];

// stored in assoc array

btw althrough its convenient to use the string or logical names they are typically unchecked strings and may certain errors during compile. using the facility has a likelihood to hide static errors and only reveal them at runtime. for most code situations the vlog names are a better choice while for debug situations the string names are the better choice.



Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Create New...