Replies: 4 comments 35 replies
-
That error is from the API compat tooling and it's highlighting that you've added a method to the implementation assembly but not to the reference assembly. You'd need to also add the signature to the System.Runtime.cs file at https://github.com/dotnet/runtime/blob/main/src/libraries/System.Runtime/ref/System.Runtime.cs.
When you build, e.g. and that will include a .NET host named |
Beta Was this translation helpful? Give feedback.
-
|
You can either use csc directly, using /nostdlib to suppress existing references and using /r to reference the System.Private.CoreLib you built directly (often for basic stuff that's sufficient), or you can overwrite your SDK's System.Runtime ref assembly with the one built from your repo. Or if you're just trying to test out your new API, you can just add code to one of the test projects, which all compile against the ref assemblies you've built in the repo. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for your solutions. I used csc and it works, but it is hard to test different scenarios using it. For the second solution, I have a lot of System.Runtime.dll. Which one do you mean and what is the destination folder address? For the last solution, I received this error for some tests: I think if we can make it easier to add code to the repo, build and test it quickly, researchers can contribute more. |
Beta Was this translation helpful? Give feedback.
-
Making it easier to contribute is always a goal. However, in general contributing is already fairly straightforward. Changing existing implementation, adding tests, even adding new APIs (including tests for them in the test projects associated with the libraries) is all straightforward. The thing that's still more challenging, which is what you're trying to do, is add public APIs and consume them via normal toolchains outside of the repo, e.g. using Visual Studio; that is not something that's currently streamlined. Also note that we gladly accept PRs for improvements, bug fixes, test improvements, optimizations, etc., as well as for approved new APIs. I highlight the "approved" part because when it comes to APIs, we have a dedicated process that involves first submitting an issue to propose the new API(s) and discuss them broadly; there's then a review process that happens to decide whether to actually add those new APIs, and only if/when they're approved do we accept PRs to add them.
How are you trying to run them? The typical workflow is described at https://github.com/dotnet/runtime/tree/main/docs/workflow/building/libraries. At a high level, though, you build the repo once (e.g. from the repo root |
Beta Was this translation helpful? Give feedback.
-
|
Thank you, Stephen, I am trying to change some parts and write some benchmarks to compare related works and it is a research project. Another question, when I build the repo, I receive this error: Also, I want to run tests in Visual Studio and see the result in Test Explorer, but I received this error: When I try to run a library's tests using cmd(For example System.Console) I receive this error: And finally when I use corerun to run my new console application the exception is this: |
Beta Was this translation helpful? Give feedback.
-
|
@stephentoub Do you have any suggestions? What is the source of these errors? |
Beta Was this translation helpful? Give feedback.
-
|
Does anyone have any suggestions? I could change the String class source code and build its entire project successfully. The problem is this: I used CMD and Visual Studio Test Explorer as well. I should mention that I am trying to do research and the process depends on this phase, so any help would be appreciated. |
Beta Was this translation helpful? Give feedback.
-
|
I want to send any implementation of the mentioned interface to String class and when a programmer calls one of the string's methods call one of the interface methods at the first line of the code. This is an example : As you can see, I may use this part(xxx.DoSomthing()) in different methods. |
Beta Was this translation helpful? Give feedback.
-
|
@danmoseley Thank you for your suggestion. What I want to do is not for ordinary projects. I can add extension methods to add more functionalities to my string class. It is a research project and we are working on security in C#, so it is required to change String class and use it among famous libraries like Json and etc. |
Beta Was this translation helpful? Give feedback.
-
|
@danmoseley I cannot send my created String class to other third-party libraries. This is the main reason for what we are going to do. As you know String class is sealed and I also cannot create an inherited class. |
Beta Was this translation helpful? Give feedback.
-
|
You can't do that on String. You can try changing your design to store it separately from the string instance, e.g. private static readonly ConditionalWeakTable<string, XXX> s_table = new();
public void SetXXX(XXX xxx)
{
s_table.Add(this, xxx);
}
public string PadLeft(int totalWidth)
{
if (s_table.TryGetValue(this, out XXX xxx)) xxx.DoSomething();
...
}or not require storing it at all, e.g. public string PadLeft(XXX xxx, int totalWidth)
{
xxx.DoSomething();
...
}or declare your own type that you use, e.g. public class MyString
{
...
}but you can't add fields to String without much, much, much more extensive changes. |
Beta Was this translation helpful? Give feedback.
-
|
@stephentoub Thank you very much, Stephen. I will try your first solution and let everyone knows about the result. |
Beta Was this translation helpful? Give feedback.
-
|
Hi everyone, Thanks, @stephentoub, finally I resolved the problems. If you want to add functionalities to String class you have to follow up these instructions: 1- Add your code to System.Private.CoreLib Solution. It contains a project (System.Private.CoreLib.Shared) and you can find string class source code there. 2- Do not forget that add the signature of your added method to System.Runtime solution. It also contains System.Runtime.cs under the ref folder. 3- Remember that it is not possible to add properties to String class. 4- If you want to rebuild the core libraries use this command : and if you want to rebuild Runtime as well you have to run this command 5- To test your new functionalities just add your test methods to one of the libraries' test projects. 6- If you want to add a field to the String class one of the options is using a static ConditionalWeakTable. Dear @stephentoub, I have a question, when I access a string, where is the "get" method that is called? For example: In the second line, we access the str. I cannot find the getter method in the String class. I want to change the string value before returning it. |
Beta Was this translation helpful? Give feedback.
-
|
You would either need to employ a rewriter to rewrite the IL to include the additional code you want injected, or you'd need to change the JIT. There's no code you could add to String to do what you want. |
Beta Was this translation helpful? Give feedback.
-
|
How can I do that? We are working on a security-related publication and we want to check and prevent possible attacks on C# code. In the beginning, we are working on the String class. Do we have any documentation to apply the required changes that we talked about it? |
Beta Was this translation helpful? Give feedback.
-
|
You'd want to use some existing library for IL rewriting, like Cecil. If you search the web for "IL rewriting", you'll find some tutorials. |
Beta Was this translation helpful? Give feedback.
-
|
So based on my understanding, this is the only solution. Is there any other solution to do something like that |
Beta Was this translation helpful? Give feedback.
-
|
If you can't change the code that's producing the string, and you don't want to change WriteLine, your remaining option is to change the actual code, and that's what IL rewriting does. You can also do it by changing the JIT itself, or you can do it by using the CLR's profiling APIs to rewrite the code at run time, but they're all effectively the same thing, just changing where and when you do it. |
Beta Was this translation helpful? Give feedback.
-
|
Can we add constructors to the String class? I tried to do it and I think it is not possible. |
Beta Was this translation helpful? Give feedback.
-
|
String object is somewhat special for GC as it has variable size so it has special handling for ctors. Why do you need that in the first place? |
Beta Was this translation helpful? Give feedback.
-
|
Thank you for your response. We are working on a research project at the university and it is required to change the source code of some classes to check some criteria and security issues. Is it possible to add another constructor at all? |
Beta Was this translation helpful? Give feedback.
-
Yes, but it requires changes to the VM and not just to string.cs. We do it very rarely. You can see an example of doing so here: |
Beta Was this translation helpful? Give feedback.
-
|
@stephentoub Thank you, Stephen. I will check it. Do you have time or are you interested to cooperate with us so we can publish the result together? If yes please let me know to talk about the details. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hello,
For a specific project, I have to change the String class and test the new functionalities that I want to add to it. I found the System.Private.CoreLib solution and all functionalities related to the String class are there. I changed the class in that project and when I want to build the runtime again, this error occurs:
So the questions are:
1- How can I build the runtime again?
2- How can I use the new DLL in a simple console application? Because when we create a console application a reference to CoreLib is already added to it.
I also checked this answer #12045 (comment) , but the instruction did not work for me and I think something is wrong.
Thank you
Beta Was this translation helpful? Give feedback.
All reactions