Skip to content

[C][Client] Define and initialize non-primitive variables at the beginning of function#10756

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
ityuhui:yh-init-nonprim-20211102
Nov 5, 2021
Merged

[C][Client] Define and initialize non-primitive variables at the beginning of function#10756
wing328 merged 1 commit intoOpenAPITools:masterfrom
ityuhui:yh-init-nonprim-20211102

Conversation

@ityuhui
Copy link
Copy Markdown
Contributor

@ityuhui ityuhui commented Nov 2, 2021

In the functions *_parseFromJSON of the generated C-libcurl client code, when an error occurs, all the non-primitive variables will be freed before the function exits.
e.g.

pet_t *pet_parseFromJSON(cJSON *petJSON){
...
    // pet->id
    cJSON *id = cJSON_GetObjectItemCaseSensitive(petJSON, "id");
    if (id) { 
        if(!cJSON_IsNumber(id))
        {
            goto end; //Numeric
        }
    }

    // pet->category
    cJSON *category = cJSON_GetObjectItemCaseSensitive(petJSON, "category");
    category_t *category_local_nonprim = NULL;
...

end:
    if (category_local_nonprim) {
        category_free(category_local_nonprim);
        category_local_nonprim = NULL;
    }
    return NULL;
}

But sometimes, the variables are not defined and initialized at this time. e.g. category_local_nonprim is not defined if id is invalid. Freeing category_local_nonprim will cause core-dump.

The fix solution is to define and initialize non-primitive variables at the beginning of function.

e.g.

pet_t *pet_parseFromJSON(cJSON *petJSON){

    // define the local varable for pet->category
    category_t *category_local_nonprim = NULL;

    // pet->id
    cJSON *id = cJSON_GetObjectItemCaseSensitive(petJSON, "id");
    if (id) { 
        if(!cJSON_IsNumber(id))
        {
            goto end; //Numeric
        }
    }

    // pet->category
    cJSON *category = cJSON_GetObjectItemCaseSensitive(petJSON, "category");
...
}

Hi @wing328 @zhemant @michelealbano

Could you please review this PR ? Thanks !

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@ityuhui ityuhui force-pushed the yh-init-nonprim-20211102 branch from 495de59 to 0109266 Compare November 3, 2021 14:06
@ityuhui
Copy link
Copy Markdown
Contributor Author

ityuhui commented Nov 5, 2021

Hi @wing328 @zhemant

Could you please review this PR if you have time ?

@wing328
Copy link
Copy Markdown
Member

wing328 commented Nov 5, 2021

No objection with this change.

@wing328 wing328 merged commit 369133a into OpenAPITools:master Nov 5, 2021
@ityuhui
Copy link
Copy Markdown
Contributor Author

ityuhui commented Nov 5, 2021

Thank you @wing328 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants